Skip to content

vX.Y — Milestone Name Here

One-sentence headline. The thing this milestone makes true. Replace this blockquote.

Summary

Two or three paragraphs of narrative. What problem existed before this milestone. What shipped. Why the work mattered to the product, the platform, or the team.

Write it so a new collaborator can read only this section and understand what changed. Past tense for shipped milestones; present/future tense for in-progress.

Goal

Quote the milestone's original goal verbatim from .planning/milestones/vX.Y-ROADMAP.md. Keep it short — one paragraph.

Scope — What Shipped

Bulleted list of concrete outcomes. Think of this as the "diff" view of the codebase before and after.

  • New models, interactions, mutations, services, jobs
  • New frontend views, composables, components
  • New infrastructure (Cloud Run services, Firebase targets, migrations, cron jobs)
  • Removed legacy code paths or feature flags flipped permanently
  • Operational surfaces (runbooks, admin dashboards, alert channels)

For in-progress milestones, replace this section with Scope — What's In Flight and use present tense.

Phases

PhaseNameStatusPlansHighlights
NPhase nameShipped / In Progress / PlannedNOne-line summary of what this phase delivered

Key Decisions

Bulleted list of architecturally important decisions. Each entry is a sentence or two — the call, and briefly why. Future-you reading this page should be able to answer "why did we do it that way?" without opening any other file.

  • Decision name — What we chose and the short rationale.

Requirements Coverage

X / Y requirements satisfied (quote from MILESTONE-AUDIT.md if it exists).

Optional: a table breaking requirements into their prefix categories (e.g. PLAT-*, AGENT-*).

CategoryCountStatus
PREFIX-NNNAll satisfied / N deferred

Full requirements list: vX.Y-REQUIREMENTS.md on GitHub.

Outcomes

What is true for users, operators, or the platform now that this milestone has shipped. One paragraph or a few short bullets. For in-progress milestones, write what is expected to be true on completion.

Tech Debt

Optional section. Any INFO-level deferrals, known-unknown deviations, or items logged in the MILESTONE-AUDIT for future cleanup. Short bullets, each with a one-line description.

  • (phase N) Short description of the item.

Notable commits — typically the milestone "complete" commit, the feature PRs, and any post-ship follow-up fixes.

  • <sha> — Commit subject
  • <sha> — Commit subject

How to use this template

  1. Copy this file to docs/milestones/vX.Y-milestone-slug.md.
  2. Fill in the frontmatter (every field).
  3. Pull narrative content from .planning/milestones/vX.Y-ROADMAP.md, vX.Y-REQUIREMENTS.md, and vX.Y-MILESTONE-AUDIT.md.
  4. Add the new milestone to the Project History sidebar section in docs_site/.vitepress/config.ts.
  5. Update docs/milestones/index.md with a new row in the milestone index.
  6. Commit and push — the Docs Deployment workflow picks up changes under docs/** and redeploys within ~2 minutes.

Last updated: 2026-07-21

Loading…