Leonid Pershin
ad94c6ef22
- Revised the CLAUDE.md and README.md files to reflect the current MVP status, emphasizing completed features and intentionally omitted elements such as traffic limits and billing. - Enhanced clarity in the documentation regarding the architecture, tech stack, and user roles. - Removed the outdated roadmap section and streamlined references to tech stack decisions. - Updated API design documentation to clarify the absence of versioning in the MVP and the handling of configuration details.
16 lines
1.4 KiB
Markdown
16 lines
1.4 KiB
Markdown
# PnvPanel — Документация
|
||
|
||
Документация описывает систему как она построена: архитектура, домен, конвенции кода, как запускать
|
||
и как пользоваться.
|
||
|
||
Индекс. Читать в этом порядке для погружения:
|
||
|
||
1. **[Product Vision & Scope](vision.md)** — продукт, роли, пользовательские сценарии, функциональность.
|
||
2. **[Architecture](architecture.md)** — Clean Architecture, слои, CQRS, интеграция с 3x-ui, realtime, безопасность, фоновые задачи.
|
||
3. **[Domain Model](domain-model.md)** — сущности, value objects, связи, инварианты, уведомления/аудит.
|
||
4. **[Tech Stack](tech-stack.md)** — используемые технологии и ключевые решения по домену.
|
||
5. **[Backend Conventions](backend-conventions.md)** — структура решения, паттерны, соглашения по коду.
|
||
6. **[Frontend](frontend.md)** — стек, структура, работа с API и realtime.
|
||
7. **[Telegram Bot](telegram-bot.md)** — бот: ссылка на сайт, просмотр конфигов, passwordless-вход через привязку Telegram.
|
||
8. **[API Design](api-design.md)** — контракты REST и SignalR.
|