Files
Salon/docs/README.md
T

727 B

Docs Index

Use this file first.

Start Here

  • Repo setup: README.md
  • Agent rules: AGENTS.md
  • Plan rules + active plan: docs/PLANS.md
  • Active ExecPlan: docs/execplans/auth-phone-first-hardening.md
  • Architecture: docs/architecture.md
  • Risks: docs/risks.md

Map

  • docs/execplans/: feature execution plans (living docs)
  • docs/adr/: architecture decisions
  • docs/runbooks/: operational response guides
  • docs/templates/: ADR/runbook templates

Update Rules (short)

  • Behavior/flow changes: update architecture + affected runbook.
  • Cross-cutting hard-to-reverse decision: add ADR.
  • Significant risk added/closed: update docs/risks.md.
  • Significant feature/refactor: update or add ExecPlan.