Skip to content

Commit

Permalink
update: readme for mkdocs local test
Browse files Browse the repository at this point in the history
  • Loading branch information
McHaillet committed Aug 2, 2024
1 parent 3e53e67 commit 29e3687
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,13 @@ you make PRs:
pre-commit install
```

This uses Ruff to check and format whenever you make commits.
This uses Ruff to check and format whenever you make commits.

If you update anything in the (documentation) `docs/` folder make sure to test build the website locally:

```commandline
mkdocs serve
```

## Tests

Expand Down

0 comments on commit 29e3687

Please sign in to comment.