documentationlisted

# Documentation The published documentation site is built with **MkDocs Material** from `docs/manual/`, configured by `mkdocs.yml` at the repository root, and published to GitHub Pages by `.github/workflows/docs.yml`. ## The rule **Every PR that changes behavior, portal pages, the REST API, or configuration updates the affected documentation pages in the same PR.** Documentation is not a follow-up task; a feature is not done until its pages describe it. Concretely, if a change touches: - a REST endpoint → update the matching page under `docs/manual/reference/api/` - a `skills-gateway.*` property or `application.yaml` → update `docs/manual/reference/configuration.md` - a portal page or control → update `docs/manual/reference/portal.md` - the facade, allowlists or pinned-ref behavior → update `docs/manual/reference/git-facade.md` and `docs/manual/reference/compatibility.md` - a new user-facing capability → add or update a guide, and cross-link it ## Verify locally ```bash pip install -r docs/requirements.txt mkdocs build --strict ``` `--strict` turns broken internal links and nav warnings into failures, which is what makes it usable as a gate. It is the **fifth gate** alongside `mvnw clean verify`, the portal e2e suite, reqstool and OpenSpec. ## Structure `docs/manual/` is the site root (`docs_dir`). The sibling `docs/reqstool/` and `docs/decisions/` are **not** part of the site and must not be moved into it. | Section | Answers | Contains | | --- | --- | --- |