Start here. This index is for readers — anyone evaluating, self-hosting, or learning Graphden. (Contributors working on the codebase should read the root CLAUDE.md, which additionally indexes the internal engineering records — ADRs, RFCs, perf notes, migration ledgers.)
| Topic | Doc |
|---|---|
| Deploy & configure (self-host) | DEPLOYMENT.md · CONFIGURATION.md |
| Day-2 ops — backups, restore, PG-HA, upgrades | OPERATIONS.md |
| Monitoring — usage rollups, error viewer, alerting | MONITORING.md |
| Accounts & sign-in (the opt-in identity module) | ACCOUNTS.md |
| Keyboard & screen-reader use, and the contract for new UI | ACCESSIBILITY.md |
| Security & tenant isolation | SECURITY_MODEL.md |
| Plans & tiers (what each includes), and where funding goes | PLANS.md |
| Support lanes, implementation work, commercial licence | SUPPORT.md · COMMERCIAL.md |
| Scaling & the executor fleet | SCALING.md · FLEET_DEPLOY.md |
| BYO executor — run your own executor against the hub | BYO_RUNBOOK.md |
| What’s shipped vs planned | ROADMAP.md |
| Error codes | ERROR_CODES.md |
| Topic | Doc |
|---|---|
| Writing base-fns & fn-defs | PACKAGES.md |
Checking a composition against what the graph already defines (bb graph-lint) |
GRAPH_LINT.md |
| The type system | TYPES.md |
| Effects & secrets | SECRETS.md |
| Branches, diff, merge | VERSIONING.md |
| Services (long-running fns) | SERVICES.md |
Tests (tests namespace convention) |
TESTS.md |
| Frontend coverage snapshot (what the e2e suite reaches) | TESTS_JS_COVERAGE.md |
| Executing a fn (HTTP API) | EXECUTION.md |
| Graph constraints | CONSTRAINTS.md |
| Distributing packages | PACKAGE_DISTRIBUTION.md |
| Marketplace — listings, reviews, themes, keymaps | MARKETPLACE.md |
| Extending below the package layer | EXTENDING.md |
| Guide served to external AI authors | AI_CONTEXT.md |
Connecting AI clients (Claude Code / Cursor) to /mcp |
MCP_CLIENTS.md |
Design records (ADRs), RFCs, performance notes, and other engineering-internal documents live alongside these but are aimed at contributors; they are indexed from CLAUDE.md and capture history and rationale, not user-facing behaviour.