Start here
Use this section before diving into architecture. The goal is to get a new engineer from clone to a useful local loop, then give them the map for where code lives.
30-minute path
Section titled “30-minute path”| Step | Outcome | Page |
|---|---|---|
| Install dependencies | Dependencies installed | Local setup |
| Run the core stack | Docs, web, and API can start locally | Local setup |
| Run checks | You know the first PR gates | First checks |
| Learn the boundaries | You know when to edit web, API, worker, contract, or native code | Mental model |
| Make a change | You can follow a task playbook instead of guessing touched files | Common tasks |
Where to look first
Section titled “Where to look first”- Apps inventory explains every deployable and mobile app.
- Packages inventory explains shared packages and blast radius.
- Workspace inventory is generated from the repo.
- Architecture overview gives the system topology.
- Troubleshooting covers the common first-week failures.
Documentation sources
Section titled “Documentation sources”| Source | Purpose |
|---|---|
apps/docs | Primary searchable internal docs site. |
README.md | Fast repo entrypoint and quickstart. |
docs/README.md | Documentation policy and source-of-truth map. |
Colocated FEATURE.md | Canonical behavior notes near the owning code. |
| Generated references | API, Knock workflow, design token, and workspace inventory pages. |