agnocast_doc

Document is published at https://autowarefoundation.github.io/agnocast_doc/

Development

pre-commit

This repository uses pre-commit to run markdownlint on every commit. The same hook is executed in CI, so installing it locally lets you catch (and auto-fix) Markdown lint errors before pushing.

Install once after cloning:

pip install pre-commit
pre-commit install

From then on, git commit will run markdownlint --fix automatically against the staged Markdown files.

Docs build check & PR preview

Apply the check-page label to a PR to trigger a full documentation build (mkdocs build --strict, including Doxygen API reference generation). If the build succeeds, a live preview is deployed to GitHub Pages and linked from the PR. The preview is removed automatically when the PR is closed.