← Project README · Getting started
Every document in the repository, and what it is for. If a fact is not where this map says it lives, the map is the thing to fix.
| Document | Purpose |
|---|---|
| FEATURES.md | The feature tour: what the app does, with a picture per feature. |
| ARCHITECTURE.md | Source of truth for crate boundaries, the prime directive, the data model, and scheduling. |
| STATUS.md | Where the project is: release, platforms, per-feature state. The only file that states status. |
| ../TODO.md | The single list of unfinished work, by area and priority. |
| ../CHANGELOG.md | What changed, for users, newest first. |
| ../RELEASE_NOTES.md | The current release, written for someone deciding whether to update. |
| Document | Purpose |
|---|---|
| features/ | One note per feature: what it is, how it is built, why it is bounded that way. Indexed by topic. |
| GPUI-UPSTREAM.md | The relationship with the gpui / gpui-component upstreams: pinning, local deltas, and how to move the pins. |
| DOCUMENTATION.md | The rules this tree follows, and the checker that keeps it honest. |
| Document | Purpose |
|---|---|
| ../GETTING_STARTED.md | Zero to running, per platform, with the permission caveats. |
| ../CONTRIBUTING.md | How a change gets in. |
| ../CLAUDE.md | The operating manual for AI and human edits. |
| REPORTING_BUGS.md | Exactly which crash and freeze files to attach to a report. |
| testing/WINDOWS_RELIABILITY_TEST_PLAN.md | The Windows environments, corpora, measurements and sign-off procedure, including the four-million-row regression gate. |
| testing/WINDOWS_HANDOVER.md | How to resume the Windows campaign on a real Windows machine: resume point, queue, invariants, handback template. |
| Document | Purpose |
|---|---|
| ../PRIVACY.md | Local storage, update requests, diagnostics, permissions, deletion. |
| ../SECURITY.md | How to report a vulnerability. |
| ../CODE_OF_CONDUCT.md | Expected conduct. |
| ../THIRD-PARTY-NOTICES.md | Components incorporated into a built binary, and their licences. |
| ../CHANGELOG-DEPS.md | Dependency pin movements, kept out of the user changelog. |
Point-in-time documents. Nothing here is a current statement about the app.
| Document | Purpose |
|---|---|
| ../NOTES.md | The engineering journal: what was attempted, what it cost, what it taught. |
| memos/2026-09-01-docs-restructure.md | What this documentation tree looked like before it was reorganized, and what moved. |
| memos/windows-sessions-2026-08.md | The Windows session log, newest first. |
| memos/gpui-migration-2026-08.md | The August 2026 move to the current gpui-component / Zed pair. |
| memos/2026-07-02-manual-test-checklist.md | A manual test pass from July 2026. |