Start here
The reading order for the development documentation, and which page answers which question
This section is for people and agents who change code in this repository. The pages cover local setup, planning, decisions, and implementation. They link to the documents that own each rule.
Reading order
A new contributor reads these pages in this order:
- Getting started installs the tools and starts the apps.
- Planning / Development Process connects Issue discussion, requirements, decisions, and implementation.
- Command reference lists every root command and what it does.
- Architecture overview shows where code lives and where a change belongs.
- Standards state the rules for modules, names, comments, tests, performance, responsive layout, and documentation.
- Deployment configures Vercel, Turso, Resend, and GitHub for the application.
- Rackspace schemas covers local schema generation and deployed verification.
- Glossary defines the terms these pages use.
The Applications and Packages pages link to workspace README guides on GitHub. The repository README describes the workspace setup.
Before you change the shape of a package or an app, read the module shape standard.
Which page answers which question
| Question | Page |
|---|---|
| How does discussion become implementation? | Planning / Development Process |
| What behavior do users need? | PRDs and user stories |
| How do I run this locally? | Getting started |
| What does this command do? | Command reference |
| How do I run CI without GitHub Actions? | Local CI |
| Where does my change belong? | Architecture overview |
| How do I work in this workspace? | Applications or Packages, with links to README guides |
| What shape must this module have? | Standards |
| How do I deploy or recover? | Deployment |
| How do I refresh a Rackspace schema? | Rackspace operations |
| What does this domain word mean? | The context's CONTEXT.md, then the Glossary |
| Why is it built this way? | Decision records |
| What current module exceptions exist? | Module shape |
If a question has two answers, one page is wrong. Delete the weaker one and link to the other. The Documentation standard states this rule and how it is checked.