RestartCrew

Documentation Index

Quick navigation for all project documentation. Start here to find the right document for your question.

Where Do I Find…?

Question Document Location
How do I set up the project? README Root
What are we building? (Full dev plan) MAIN_DEVPLAN_RESTARTCREW docs/
How do we build it? (Execution plan) MAIN_DEVPLAN_RESTARTCREW docs/
What’s the high-level roadmap? ROADMAP docs/
What decisions have been made and why? DECISIONS docs/
What work has been completed? DEVLOG docs/
Who are our competitors? COMPETITIVE_ANALYSIS docs/
What are the coding standards? AGENTS.md Root
What’s in the dev/ folder? dev/README dev/

Document Hierarchy

README.md ......................... Start here — setup & tech stack
  ↓
MAIN_DEVPLAN_RESTARTCREW.md ...... Single source of truth (product spec + execution plan)
  ↓
AGENTS.md ........................ Engineering standards & architecture rules
  ↓
DECISIONS.md ..................... Why we chose what we chose
  ↓
DEVLOG.md ........................ What's been done (activity log)
  ↓
ROADMAP.md ....................... Big picture (milestones, post-launch, v2)
  ↓
COMPETITIVE_ANALYSIS.md ......... Market context & positioning

Document Roles

Document Role Who reads it
MAIN_DEVPLAN_RESTARTCREW Single source of truth — product spec, technical decisions, design system, execution plan Developers, designers, AI agents
ROADMAP Summary view — completed/in-progress/next/future/v2 Everyone
DECISIONS Architecture Decision Records — context, options, chosen, reason Architecture review
DEVLOG Activity log — what was done, files changed, blockers, next steps Project team
COMPETITIVE_ANALYSIS Market research — competitors, SWOT, positioning Strategy, PM
AGENTS.md AI Engineering Guidelines — coding standards, security, testing AI agents, developers

Rules