Repository navigation
Shrink README.md to two screens and move its detail into CONTRIBUTING.md and docs/ #541
Description
Summary
README.md should fit on two screens, as #170 asked. Today it has 387 raw lines, about 200 rendered lines outside the two collapsed <details> blocks. #170 closed without this part, and the maintainer moved it to v2.3.0 (ruling 2026-10-19).
The target shape is the one #170 gave, eight parts: hero, one paragraph, a three-command start, a docs table, an extensions table, contributing, license and support.
Plan, one row per section
| Section | Action |
|---|---|
| Tech Stack | Cut the pinned versions, which go stale. |
| 📋 Prerequisites | Move to CONTRIBUTING.md; contributors need the version floors. Self-hosters already have them in docs/self-hosting/README.md. |
<details> full Docker |
Move to CONTRIBUTING.md. |
<details> Supabase Cloud |
Steps 3 and 6 already live in docs/self-hosting/install.md. Delete them and leave a link. Check steps 2, 4 and 5 before they go. |
| ⚙️ Environment Files | docs/self-hosting/configuration.md already holds part of it. Delete and link. Today the section has no link to its new home. |
| 📖 Command Reference, 📁 Project Structure | Move to CONTRIBUTING.md. |
| 🚀 Production Deployment | Delete and link to install.md. The make scale-* commands have no home under docs/, so move them to configuration.md#scaling-past-the-defaults. |
| 🎨 Badges | Not part of the target. Needs a ruling on where it goes. |
Links that must move with their sections
These anchors point into the README today. Each must follow its section, or bun run check:agent-docs fails:
CONTRIBUTING.md→#-prerequisites,#-quick-start,#-command-reference,#-project-structureAGENTS.mdnames the README Quick Start.
Acceptance criteria
-
README.mdhas the eight parts above and fits on two screens (about 120 rendered lines). - Every removed subject has exactly one link to its new home.
- Every moved anchor resolves, and
bun run check:agent-docspasses. - The Badges ruling is recorded here.
Activity