Skip to main content

Documentation Methodology

This documentation follows an incremental commit-history methodology:

  1. Start from the first commit.
  2. Track major architectural changes commit by commit.
  3. Maintain narrative phase summaries for onboarding.
  4. Keep full first-parent commit appendices for v2 main and frozen v1.
  5. Update the relevant docs page when future commits change behavior.

Maintaining these docs

For each future engineering change:

  • Update the topic page that describes the changed behavior.
  • Add a short note to the project evolution page if the change affects architecture or operations.
  • Keep v1/v2 branch notes accurate.
  • Run:
npm run docs:typecheck
npm run docs:build