This tree is not the primary user documentation.
Use extended-docs/ for product guides (11 chapters × 6 languages), glossary, API Explorer, and GitHub Pages deploy.
Doc sync rule: agent/rules/code-to-docs-sync.mdc (alwaysApply: true) — update extended-docs (×6), glossary, and legacy docs/ whenever code or features change.
make extended-docs-serve # http://127.0.0.1:8000
make extended-docs-check # strict build (CI)| Path | Purpose |
|---|---|
adr/ |
Architecture decision records |
DOCKER.md |
Docker Hub & compose |
self-hosted/ |
Self-host ops (audit, RBAC, tenants, metrics, airgap, K8s) — all MIT, no tier gating |
dockerhub/ |
Hub overview text & settings checklist |
RELEASE.md |
Semver tags and GitHub Release workflow |
GITHUB_PAGES.md |
Pages / blog subpath deploy |
OPENAPI.md |
OpenAPI sync workflow |
glossary.md |
Pointer to extended-docs glossary |
en/, fa/, … |
Legacy short MkDocs (frozen — do not extend partial locales) |
Legacy MkDocs only:
make docs-serve