Documentation — Bilingual Status
English = main (.md). Russian = secondary (.ru.md).
Workflow
- Structure & rewrite — information architecture, audience paths, tables over rambling text (technical writer).
- EN primary — ship polished English in
DOC.mdfirst (basis for site & community). - RU — mirror in
DOC.ru.mdwhere needed (translator / maintainer).
“Translate only” is not the default: pages should stay usable as site sections and article source.
Archive cleanup (done)
Removed from archive/: ROLLBACK_LOST_FEATURES, SYSTEM_UI_AND_FRIGATE_REFERENCE, COLLABORATIVE_LABELING, UX_IMPROVEMENTS, FRIGATE_EVENT_LOSS_AUDIT (content folded into TROUBLESHOOTING). Shortened: REACT_19_MIGRATION.
Pattern
DOC.md— English (primary)DOC.ru.md— Russian
Each paired doc links to the other at the top: [Русский](./DOC.ru.md) / [English](./DOC.md).
Status
| Document | EN | RU |
|---|---|---|
| Root | ||
| README | ✅ | ✅ |
| CONTRIBUTING | ✅ | ✅ |
| CODE_OF_CONDUCT | ✅ | ✅ |
| SECURITY | ✅ | ✅ |
| docs/ | ||
| README (hub) | ✅ | ✅ |
| REPOSITORY_LAYOUT | ✅ | ✅ |
| OVERVIEW (story / landing source) | ✅ | ✅ |
| INSTALL | ✅ | ✅ |
| DEPLOY_SERVER (checklist) | ✅ | ✅ |
| Documentation (meta guide) | ✅ | ✅ |
| SCENARIOS | ✅ | ✅ |
| CONFIGURATION | ✅ | ✅ |
| GLOSSARY | ✅ | ✅ |
| FEATURES | ✅ | ✅ |
| TESTING | ✅ | ✅ |
| TROUBLESHOOTING | ✅ | ✅ |
| LOCAL_DEV | ✅ | ✅ |
| CODEQL (CI) | ✅ | ✅ |
| A11Y | ✅ | ✅ |
| UX_TOOLTIPS | ✅ EN only | — |
| UX_UNKNOWN_VIDEO_CORRECTION | ✅ single page | — |
| ARCHITECTURE | ✅ | ✅ |
| API | ✅ | ✅ |
| reference/openapi (Redoc embed) | ✅ | ✅ |
| MCP_SETUP | ✅ | ✅ |
| ACCESS_CONTROL | ✅ | ✅ |
| RECOVERY_CONFIG | ✅ | ✅ |
SITE_MAP (sections ↔ files, MkDocs nav) |
✅ | ✅ |
| TRAINING | ✅ | ✅ |
| DATASETS | ✅ | ✅ |
| ROADMAP (incl. Issues/board reporting) | ✅ | ✅ |
| VERSIONING | ✅ | ✅ |
| VERIFICATION (release checks log) | ✅ | ✅ |
| PRE_IMPLEMENTATION_UNKNOWN_TIMELINE | ✅ | ✅ |
| SECURITY (analysis in docs/) | ✅ | ✅ |
| SECRETS_ROTATION (ops runbook) | ✅ | ✅ |
| OPEN_SOURCE_PREP | ✅ | ✅ |
| GOVERNANCE (process / observer) | ✅ | ✅ |
| GITHUB_SETUP_GH | ✅ | ✅ (RU primary) |
| WIKI_AUTOMATION | ✅ | ✅ |
| docs/project/ (stubs → root files / OpenAPI; MkDocs) | ✅ | — (optional later) |
Adding or refreshing a doc
- Write or rewrite English in
DOC.md(instructional, placeholders, cross-links). - If Russian is required: create/update
DOC.ru.md(same structure). - Register in docs/README.md (and README.ru.md).
- Update this table.