Skip to content

docs(planning): adopt portable two-axis planning convention#120

Merged
lesnik512 merged 13 commits into
mainfrom
docs/portable-planning-convention
Jun 13, 2026
Merged

docs(planning): adopt portable two-axis planning convention#120
lesnik512 merged 13 commits into
mainfrom
docs/portable-planning-convention

Conversation

@lesnik512

Copy link
Copy Markdown
Member

Summary

Adopts the portable OpenSpec-shaped planning convention from faststream-outbox (its #77). Docs/file-moves only — no runtime code, tests, or public API touched (full test suite still 194 passed / 100% coverage).

  • New architecture/ truth home at the repo root — one file per capability (config-model.md, instruments.md, bootstrappers.md), seeded from CLAUDE.md + docs/. This is the promotion target on every future ship.
  • planning/changes/{active,archive}/<YYYY-MM-DD.NN-slug>/ bundles. Existing artifacts migrated:
    • 4 clean design+plan pairs → full bundles (design.md + plan.md).
    • 3 audit arcs → per-arc bundles (sequencing doc = design.md, PR plans grouped as plan-pr*.md).
    • Audits → planning/audits/; retros → planning/retros/.
  • planning/README.md## Conventions copied byte-identical from faststream-outbox, fresh repo-specific Index.
  • planning/_templates/{design,plan,change}.md copied byte-identical; old lightweight-plan-template.md removed; planning/deferred.md added.
  • CLAUDE.md ## Planning artifacts## Workflow (names architecture/ as the promotion target); Justfile gains docs-build; stray .gitignore plan.md rule removed (it would have swallowed every bundle's plan.md).
  • Dogfooded: this change is its own bundle (changes/active/2026-06-13.01-portable-planning-convention/), to be moved to archive/ on merge.

Test Plan

  • just lint-ci — clean (eof-fixer, ruff format/check, ty)
  • just docs-buildmkdocs build --strict exits 0 (architecture/ + planning/ are outside docs_dir)
  • just test — 194 passed, 100% coverage
  • Frontmatter parses on all bundle design.md/plan.md; outcome values with # quoted (YAML comment trap)
  • Stale-pointer sweep clean; README Index + releases links resolve
  • ## Conventions block + _templates/ byte-identical to faststream-outbox

On merge

Move changes/active/2026-06-13.01-portable-planning-convention/archive/, fill status: shipped/pr:/outcome:, and shift its README Index line from Active to Archived. (No architecture/ promotion — this change defines the convention, not a library capability.)

🤖 Generated with Claude Code

lesnik512 and others added 13 commits June 13, 2026 19:31
Design for migrating lite-bootstrap's planning/ to the two-axis
OpenSpec-shaped convention from faststream-outbox: architecture/ truth
home + planning/changes/ bundles, per-arc bundling of audit arcs, fresh
README Index. Dogfooded as its own change bundle.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Eight-task migration plan for the portable convention. Also removes the
stray `.gitignore` rule that ignored the literal filename `plan.md`, which
would block every change bundle's plan under the new convention.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…trappers)

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…retros

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Unquoted `outcome: ... #NN` was silently truncated by YAML (treats ` #`
as a comment), dropping the PR ranges on four bundle design.md files.
Quote them; also fix the examples in this change's plan.md.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…uild

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The bug-audit findings moved to planning/audits/ and retros to
planning/retros/ under the new convention; CLAUDE.md's Key design
decisions pointer was still aimed at the removed planning/specs/ glob.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…aths

The bug-audit-v2 audit/sequencing/retro moved out of planning/specs/ into
audits/, changes/archive/2026-06-05.01-bug-audit-v2/, and retros/ — the
release notes' inbound links and pointers followed them.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Completes the dogfooding step in-PR so merged main lands in final state:
move 2026-06-13.01-portable-planning-convention to changes/archive/, set
status: shipped / pr: "120", and shift its README Index line from Active
(now empty) to the top of Archived. No architecture/ promotion — this
change defines the convention itself.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@lesnik512 lesnik512 merged commit cc8d708 into main Jun 13, 2026
7 checks passed
@lesnik512 lesnik512 deleted the docs/portable-planning-convention branch June 13, 2026 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant