index.md

RusTok: карта документации

Этот файл является канонической точкой входа в документацию репозитория. С него нужно начинать работу по правилам AGENTS.md.

Документация в docs/ описывает платформу целиком. Локальные документы приложений и crate-ов лежат в apps/*/docs/, crates/*/docs/ и README.md рядом с кодом.

Как пользоваться картой

1. Сначала откройте обзор платформы и нужный архитектурный раздел.
2. Для изменений в модульной системе переходите в docs/modules/*.
3. Для UI-срезов используйте docs/UI/* и локальные docs приложений.
4. Для проверок, rollout и quality-gates используйте docs/verification/* и docs/guides/*.
5. Для изменений конкретного модуля сверяйтесь с docs/modules/registry.md и локальными docs соответствующего crate.

Обязательные стартовые документы

• Обзор платформы
• Архитектурные принципы
• API и surface-контракты
• Маршрутизация
• Модульная архитектура
• Карта модулей и владельцев

Модульная система

• Обзор модульной платформы
• План и текущее состояние module-system
• Контракт rustok-module.toml
• Реестр crate-ов модульной платформы
• Индекс документации по модулям
• Индекс UI-пакетов модулей
• Quickstart по UI-пакетам

UI и клиентские поверхности

• UI README
• GraphQL и Leptos server functions
• Storefront
• Быстрый старт для Admin ↔ Server
• Каталог Rust UI-компонентов
• Архитектура i18n — request locale chain, storefront locale-prefixed routes, outbound reset-email locale contract, manifest-level module UI bundle contract

Архитектура и foundation

• Диаграмма платформы
• Database
• Channels
• DataLoader
• Event flow contract
• Matryoshka / composition model
• Performance baseline

Руководства и стандарты

• Quickstart
• Testing
• Observability quickstart
• Runtime guardrails
• Input validation
• Error handling
• Security audit
• Logging
• Errors
• Security
• Coding
• RT JSON v1

Активные планы исполнения

• Активный remediation-план платформы — текущий исполняемый план; не относится к weekly verification-прогонам

Проверка платформы

• Главный verification README
• Сводный verification plan
• Foundation verification
• API surfaces verification
• Frontend surfaces verification
• Core integrity verification
• Quality operations verification

AI, исследования и шаблоны

• AI context
• AI session template
• Известные pitfalls
• Шаблон документации модуля
• Исследования и ADR-черновики

Документация приложений

• Server docs
• Admin docs
• Storefront docs
• Next Admin docs
• Next Frontend docs

Документация crate-ов

• Для foundation и shared-инфраструктуры: crates/rustok-core, crates/rustok-api, crates/rustok-events, crates/rustok-cache, crates/rustok-outbox, crates/rustok-telemetry, crates/rustok-tenant.
• Для UI-библиотек: crates/leptos-*, crates/flex, crates/leptos-ui.
• Для доменных модулей: crates/rustok-* согласно реестру модулей.
• У каждого crate должен быть актуальный README.md, а при необходимости и docs/.

Правила поддержки актуальности

• Центральные документы в docs/ ведутся на русском языке.
• README.md, AGENTS.md, CONTRIBUTING.md и публичные контрактные документы ведутся на английском.
• Один файл — один язык.
• Не создавайте новый документ, если подходящий уже существует: расширяйте текущий.
• При изменении архитектуры, API, tenancy, routing, observability или module-system обновляйте и локальные docs компонента, и центральные документы в docs/.

Architecture Decisions

• ADR index