From 814cd666666d179310afc413a8dd0734912125ba Mon Sep 17 00:00:00 2001 From: Ken Matsui <26405363+ken-matsui@users.noreply.github.com> Date: Wed, 11 Dec 2024 20:21:19 -0500 Subject: [PATCH] CONTRIBUTING: added about docs --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a7d1c9116..819732b46 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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