Skip to content

Getting Started

This repo is intentionally docs-first right now. The goal is to make the documentation site the stable memory for future AI-assisted implementation work.

Reading Order

Use the docs in this order:

  1. Read Requirements to understand the product scope, canonical terms, and first-slice acceptance criteria.
  2. Read ADRs to understand decisions that should not be re-litigated in every implementation task.
  3. Read Specs for feature-slice behavior and contracts.
  4. Read Tasks for implementation-ready scope, non-scope, and verification expectations.

Repo Workflow

The intended workflow is Speckit-style without installing the toolkit:

  1. Refine or clarify requirements only when the source of truth is still ambiguous.
  2. Record important design choices as ADRs.
  3. Write a slice spec that references exact requirements sections.
  4. Write a task file that names the acceptance criteria and tests.
  5. Implement in small reviewable changes.

Local Docs Commands

bash
npm install
npm run docs:dev
npm run docs:build

The dev server is configured for port 7156 so it does not collide with the reference messaging repo's docs site.

Docs-first project memory for AI-assisted implementation.