Skip to content

Commit

Permalink
Merge pull request #246 from rebeccaalpert/docs
Browse files Browse the repository at this point in the history
chore(docs): Update README
  • Loading branch information
nicolethoen authored Oct 29, 2024
2 parents 9e1efca + eb49a24 commit d7399c8
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ When adding/making changes to a component, always make sure your code is tested:

### Styling:

- for styling always use JSS
- for styling always use CSS
- 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.)
- 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)

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

- 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
- npm run serve:a11y to locally view the generated report

## Generating screenshots

From root folder:

```sh
npm install
npm run build
cd packages/module
npm run docs:build
npm run docs:serve
```

Open a new terminal tab while serving; make sure you are in package/module folder:

```sh
npm run docs:screenshots
```

These files will not be picked up by git; you'll have to look for them and add them manually.

0 comments on commit d7399c8

Please sign in to comment.