Skip to content

Commit d7399c8

Browse files
authored
Merge pull request #246 from rebeccaalpert/docs
chore(docs): Update README
2 parents 9e1efca + eb49a24 commit d7399c8

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ When adding/making changes to a component, always make sure your code is tested:
142142

143143
### Styling:
144144

145-
- for styling always use JSS
145+
- for styling always use CSS
146146
- new classNames should be named in camelCase starting with the name of a given component and following with more details clarifying its purpose/component's subsection to which the class is applied (`actionMenu`, `actionMenuDropdown`, `actionMenuDropdownToggle`, etc.)
147147
- do not use `pf-v6-u-XXX` classes, use CSS variables in a custom class instead (styles for the utility classes are not bundled with the standard patternfly.css - it would require the consumer to import also addons.css)
148148

@@ -167,3 +167,23 @@ When adding/making changes to a component, always make sure your code is tested:
167167

168168
- run npm run build:docs followed by npm run serve:docs, then run npm run test:a11y in a new terminal window to run our accessibility tests. Once the accessibility tests have finished running you can run
169169
- npm run serve:a11y to locally view the generated report
170+
171+
## Generating screenshots
172+
173+
From root folder:
174+
175+
```sh
176+
npm install
177+
npm run build
178+
cd packages/module
179+
npm run docs:build
180+
npm run docs:serve
181+
```
182+
183+
Open a new terminal tab while serving; make sure you are in package/module folder:
184+
185+
```sh
186+
npm run docs:screenshots
187+
```
188+
189+
These files will not be picked up by git; you'll have to look for them and add them manually.

0 commit comments

Comments
 (0)