B9-1: README — обновить под актуальное состояние + quick start #83

New issue

Closed

opened 2026-05-11 20:37:03 +00:00 by lekss361 · 1 comment

lekss361 commented

2026-05-11 20:37:03 +00:00

(Migrated from github.com)

Эшелон: 📖 Documentation / Onboarding

Зачем

Если привлекается подрядчик / второй разработчик — README должен позволить поднять проект за 30 мин. Сейчас README состояние неизвестно.

Что сделать

Прочитать текущий README.md — насколько актуален?
Update sections:
- What — 2 предложения о проекте
- Quick start — 5 команд (clone, .env copy, docker compose up, curl /health, npm install)
- Architecture — простая ASCII или mermaid диаграмма
- Tech stack — список с версиями
- Vault — где живут knowledge / decisions (Obsidian + CouchDB)
- Subagents — 5 кастомных Claude Code subagents
- Deploy — где живёт prod, GHA pipeline
Add: link на OpenAPI docs (https://gendsgn.ru/api/docs), link на Obsidian vault, link на CLAUDE.md
Optional: getting prod DB dump для локальной разработки (SSH tunnel + pg_dump инструкция)

Acceptance

New developer может поднять локально за 30 мин (test с пустого state)
Все ссылки работают
Badges (CI status, coverage) — если есть данные

Owner

backend-engineer

Effort

~0.5 дня

**Эшелон:** 📖 Documentation / Onboarding ## Зачем Если привлекается подрядчик / второй разработчик — README должен позволить поднять проект за 30 мин. Сейчас README состояние неизвестно. ## Что сделать - Прочитать текущий README.md — насколько актуален? - Update sections: - **What** — 2 предложения о проекте - **Quick start** — 5 команд (clone, .env copy, docker compose up, curl /health, npm install) - **Architecture** — простая ASCII или mermaid диаграмма - **Tech stack** — список с версиями - **Vault** — где живут knowledge / decisions (Obsidian + CouchDB) - **Subagents** — 5 кастомных Claude Code subagents - **Deploy** — где живёт prod, GHA pipeline - Add: link на OpenAPI docs (https://gendsgn.ru/api/docs), link на Obsidian vault, link на CLAUDE.md - Optional: getting prod DB dump для локальной разработки (SSH tunnel + pg_dump инструкция) ## Acceptance - [ ] New developer может поднять локально за 30 мин (test с пустого state) - [ ] Все ссылки работают - [ ] Badges (CI status, coverage) — если есть данные ## Owner `backend-engineer` ## Effort ~0.5 дня

lekss361 commented

2026-05-23 12:25:20 +00:00

Owner

Status check 2026-05-23

Issue остаётся в силе. README не обновлялся под:

Caddy basic_auth gate (PR #426) — gendsgn.ru теперь требует credentials.
Pilot users provisioning через scripts/auth/add_user.sh.
Удаление X-Admin-Token (PR #437) — старые dev-инструкции устарели.
GlitchTip auth forwarder sidecar (PR #430).

Priority после pilot demo 28.05: low — cleanup, но желательно до scaling pilot.

Привязка: добавлен в umbrella epic(infra): Pilot infra status 2026-05-23 — после security pivot.

## Status check 2026-05-23 Issue остаётся в силе. README не обновлялся под: - Caddy basic_auth gate (PR #426) — `gendsgn.ru` теперь требует credentials. - Pilot users provisioning через `scripts/auth/add_user.sh`. - Удаление `X-Admin-Token` (PR #437) — старые dev-инструкции устарели. - GlitchTip auth forwarder sidecar (PR #430). **Priority после pilot demo 28.05**: low — cleanup, но желательно до scaling pilot. Привязка: добавлен в umbrella `epic(infra): Pilot infra status 2026-05-23 — после security pivot`.