When to use
Use before publishing docs or after changing guides/architecture files.
Inputs
- •Poetry environment with docs extras available
Steps
- •Install docs dependencies:
poetry install --with docs. - •Build docs:
poetry run mkdocs build. - •(Optional) Preview locally:
poetry run mkdocs serve. - •If navigation or new pages were added, ensure links from
mkdocs.ymlresolve and include any new images/assets.
Outputs
- •Successful MkDocs build (site/ directory)
- •Notes on any broken links or warnings