gitrusprusandCursor
6dff3c1c3d
Add developer docs for CA/CP/PI flows and wire cp-workers to the host SOCKS proxy so local Telegram auth and parsing work reliably. Co-authored-by: Cursor <cursoragent@cursor.com>
36 lines
2.1 KiB
Markdown
36 lines
2.1 KiB
Markdown
# Документация MapMil для разработчиков
|
||
|
||
Карта документов. Начните с обзора, затем углубитесь в нужный центр.
|
||
|
||
## С чего начать
|
||
|
||
1. [Обзор архитектуры](architecture-overview.md) — общая картина, затем детали
|
||
2. [Поток данных](data-flow.md) — от парсера до карты и ПИ
|
||
3. [Локальный запуск](local-dev.md) — `.env`, сессия, Docker
|
||
|
||
## По зонам
|
||
|
||
| Документ | Содержание |
|
||
|----------|------------|
|
||
| [architecture-overview.md](architecture-overview.md) | Платформа целиком: ЦА, ЦП, ПИ, границы, сервисы |
|
||
| [data-flow.md](data-flow.md) | E2E: admin → Redis → адаптер → ingest → карта → ПИ |
|
||
| [contracts.md](contracts.md) | Shared-схемы `contracts/` |
|
||
| [local-dev.md](local-dev.md) | Разработка и отладка локально |
|
||
| [ЦА: ARCHITECTURE](../centers/analytics/ARCHITECTURE.md) | API, модели, UI, scheduler |
|
||
| [ЦА: DISTRIBUTION (ПИ)](../centers/analytics/DISTRIBUTION.md) | External API для потребителей |
|
||
| [ЦП: ARCHITECTURE](../centers/parsing/ARCHITECTURE.md) | Адаптеры, очереди, Telegram listener |
|
||
|
||
## Корень репозитория
|
||
|
||
| Файл | Для кого |
|
||
|------|----------|
|
||
| [`README.md`](../README.md) | Быстрый старт и краткий API |
|
||
| [`AGENTS.md`](../AGENTS.md) | Ориентация для AI-агентов |
|
||
| [`.cursor/skills/add-parser-adapter/`](../.cursor/skills/add-parser-adapter/) | Чеклист нового `source_type` |
|
||
|
||
## Принцип
|
||
|
||
- **Contracts first** — изменение формы данных или маршрутизации начинается в `contracts/`.
|
||
- **Одна зона за раз** — не смешивать контракты + UI + инфра в одном несвязанном изменении.
|
||
- **ЦП не трогает БД ЦА** — только Redis и `POST/PATCH /internal/*`.
|