Skip to content

Planning Docs Guide

Use this directory for product and design context, not as the default source of implementation truth.

Which planning docs are canonical now

  • ROADMAP.md: single prioritized view of all open work — start here
  • active/: PRDs open or immediately next up; active/drafts/ for queued-but-not-started work
  • strategy/: long-horizon and exploratory docs — useful direction, not committed scope
  • archive/: historical plans whose primary deliverables have already shipped or decisions that have been made
  • rewrite/: targeted rewrite briefs for regenerating specific doc sections

If code, tests, and planning docs disagree, trust the current implementation and then check active/README.md for the best explanation of what remains open.

How to use planning docs safely

  • Read planning docs after you have identified the current implementation seam in src/.
  • Prefer docs/reference/ for current contracts, workflow routing, and contributor maps.
  • Treat archived plans as historical context, not instructions.
  • When a new plan becomes the canonical guide for active work, add or update a note in active/README.md.

Best starting points for contributors and agents