Skip to content

Commit

Permalink
CONTRIBUTING: added about docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ken-matsui committed Dec 12, 2024
1 parent 0b22f3c commit 814cd66
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,30 @@ break existing functionality:
poac test # or make test
```

## Documentation

If your changes affect the project's documentation, ensure you update the
relevant files in the `docs/` directory. You can preview your changes by
running the following command:

```bash
pip install mkdocs
mkdocs serve
```

This will start a local server at `http://127.0.0.1:8000/`.

Make sure to update the table of contents in the `mkdocs.yml` file to reflect
your changes. Also, ensure that the documentation is clear, concise, and
formatted correctly.

Before committing anything, ensure that the documentation builds without
errors by running:

```bash
mkdocs build --strict
```

## Commit Message

We generally follow the
Expand Down

0 comments on commit 814cd66

Please sign in to comment.