Карта сайта документации (рекомендация)
Сопоставление разделов и файлов и проверка, что nav в mkdocs.yml не разъехался. Сайт собирается MkDocs Material из корня репозитория.
Верхнее меню
| Пункт | Файл | Примечание |
|---|---|---|
| Обзор | OVERVIEW.ru.md | Первый пункт MkDocs (секция «Русский») |
| Оглавление | README.ru.md | Таблицы по темам и входы |
| GitHub | внешняя ссылка | Репозиторий |
Сайдбар — «Использование»
| Страница | Источник |
|---|---|
| Установка | INSTALL.ru.md |
| Чеклист деплоя на сервер | DEPLOY_SERVER.ru.md · EN |
| Сценарии | SCENARIOS.ru.md |
| Конфигурация | CONFIGURATION.ru.md |
| Возможности | FEATURES.ru.md |
| Проблемы | TROUBLESHOOTING.ru.md |
| Восстановление конфига | RECOVERY_CONFIG.ru.md |
| Глоссарий | GLOSSARY.ru.md |
Сайдбар — «Разработка и интеграции»
| Страница | Источник |
|---|---|
| Архитектура | ARCHITECTURE.ru.md |
| HTTP API | API.ru.md + OpenAPI |
| OpenAPI (Redoc) | reference/openapi.ru.md · EN |
| Доступ и роли | ACCESS_CONTROL.ru.md |
| MCP | MCP_SETUP.ru.md |
| Локальная разработка | LOCAL_DEV.ru.md |
| CodeQL (CI) | CODEQL.ru.md |
| Тесты | TESTING.ru.md |
| Доступность | A11Y.ru.md · EN |
| UX: подсказки и тултипы | UX_TOOLTIPS.md |
| UX: неизвестные и правки в видео | UX_UNKNOWN_VIDEO_CORRECTION.md |
Сайдбар — «ML и проект»
| Страница | Источник |
|---|---|
| Обучение | TRAINING.ru.md |
| Датасеты | DATASETS.ru.md |
| Версионирование | VERSIONING.ru.md |
| Roadmap | ROADMAP.ru.md |
Мета
| Страница | Источник |
|---|---|
| Contributing | project/contributing.md → корневой CONTRIBUTING.md на GitHub |
| Политика безопасности | project/security-policy.md → корневой SECURITY.md |
| Code of Conduct | project/code-of-conduct.md → корень репозитория |
| Changelog | project/changelog.md → корневой CHANGELOG.md |
| OpenAPI YAML | project/openapi.md → app/web/openapi.yaml |
| Корневой README | project/root-readme.md |
| Структура репозитория | REPOSITORY_LAYOUT.ru.md · EN |
| Журнал верификации релизов | VERIFICATION.ru.md · EN |
| Чеклист до реализации (issues) | PRE_IMPLEMENTATION_UNKNOWN_TIMELINE.ru.md · EN |
| Правила доков | Documentation.ru.md |
| Анализ безопасности | SECURITY.ru.md |
| Ротация секретов (прод) | SECRETS_ROTATION.ru.md · EN |
| Подготовка к open-source | OPEN_SOURCE_PREP.ru.md |
| Локализация | I18N_STATUS.md |
| Управление и наблюдатель | GOVERNANCE.ru.md · EN |
| Issues, доска и roadmap | ROADMAP.ru.md § Триаж · EN; корень репо CONTRIBUTING.ru.md |
Настройка GitHub (gh) |
GITHUB_SETUP_GH.ru.md · EN |
| Wiki и отчёты CI | WIKI_AUTOMATION.ru.md · EN |
Генератор: mkdocs.yml в корне репозитория (MkDocs Material); русские страницы — отдельная секция в nav.
Два языка
Дублировать структуру для /ru/ или держать пары *.md / *.ru.md — см. I18N_STATUS.md.