Documentation site map (suggested)
Section → file map for humans and for keeping mkdocs.yml nav aligned. The built site is MkDocs Material at repo root.
Top navigation
| Label | Source file | Notes |
|---|---|---|
| Overview | OVERVIEW.md | MkDocs first item |
| Documentation index | README.md | Topic tables / entry paths |
| GitHub | external | Repository URL |
Sidebar — “Use the hub”
| Page | Source |
|---|---|
| Install | INSTALL.md |
| Server deploy checklist | DEPLOY_SERVER.md · RU |
| Scenarios | SCENARIOS.md |
| Configuration | CONFIGURATION.md |
| Features | FEATURES.md |
| Troubleshooting | TROUBLESHOOTING.md |
| Recover config | RECOVERY_CONFIG.md |
| Glossary | GLOSSARY.md |
Sidebar — “Develop & integrate”
| Page | Source |
|---|---|
| Architecture | ARCHITECTURE.md |
| HTTP API | API.md + OpenAPI import |
| OpenAPI (Redoc) | reference/openapi.md · RU |
| Access control | ACCESS_CONTROL.md |
| MCP | MCP_SETUP.md |
| Local dev | LOCAL_DEV.md |
| CodeQL (CI) | CODEQL.md |
| Testing | TESTING.md |
| Accessibility | A11Y.md · RU |
| UX: Tooltips & inline hints | UX_TOOLTIPS.md |
| UX: Unknowns vs video | UX_UNKNOWN_VIDEO_CORRECTION.md |
Sidebar — “ML & project”
| Page | Source |
|---|---|
| Training | TRAINING.md |
| Datasets | DATASETS.md |
| Versioning | VERSIONING.md |
| Roadmap | ROADMAP.md |
Meta (footer or “Project”)
| Page | Source |
|---|---|
| Contributing | project/contributing.md → root CONTRIBUTING.md on GitHub |
| Security policy | project/security-policy.md → root SECURITY.md |
| Code of Conduct | project/code-of-conduct.md → root CODE_OF_CONDUCT.md |
| Changelog | project/changelog.md → root CHANGELOG.md |
| OpenAPI YAML | project/openapi.md → app/web/openapi.yaml |
| Root README | project/root-readme.md → root README.md |
| Repository layout | REPOSITORY_LAYOUT.md · RU |
| Verification log (releases) | VERIFICATION.md · RU |
| Pre-implementation checklist | PRE_IMPLEMENTATION_UNKNOWN_TIMELINE.md · RU |
| Doc conventions | Documentation.md |
| Security analysis (deep dive) | SECURITY.md · RU |
| Secrets rotation (ops) | SECRETS_ROTATION.md · RU |
| Open-source prep (maintainers) | OPEN_SOURCE_PREP.md · RU |
| i18n status | I18N_STATUS.md |
| Governance & observer | GOVERNANCE.md · RU |
| Issues, board & roadmap | ROADMAP.md § Triage · RU; repo root CONTRIBUTING.md |
GitHub via gh CLI |
GITHUB_SETUP_GH.md · RU |
| Wiki & CI reports | WIKI_AUTOMATION.md · RU |
Implemented generator: mkdocs.yml at repo root (MkDocs Material); Russian pages are a section in the same nav.
Russian
Mirror each published page as *.ru.md or use a /ru/ locale folder; keep the same structure. See I18N_STATUS.md.