Skip to content

README.md

Latest commit

 

History

History
20 lines (15 loc) · 1.19 KB

README.md

File metadata and controls

20 lines (15 loc) · 1.19 KB
Raw

Documentation

This directory is the single source of truth for how this project is built, organized, and evolved by agents.

Domain map

  • project/ — project overview, goals, architecture, and boundaries.
  • frontend/ — Feature-Sliced Design (FSD) conventions.
  • backend/ — Domain-Driven Design (DDD) layered conventions.
  • operations/ — local development, CI/CD, and deployment.
  • quality/ — testing strategy and code-review expectations.
  • decisions/ — architecture decision records (ADRs).

How to use this documentation

  1. If you are new to the project, read project/README.md and project/architecture.md first.
  2. Before writing frontend code, read frontend/README.md.
  3. Before writing backend code, read backend/README.md.
  4. Before changing deployment, build, or operational behavior, read operations/README.md.
  5. If you change behavior, architecture, or conventions, update the relevant doc in the same change set.