Skip to content

Commit 2897cd8

Browse files
committed
docs: update path references for docs reorg
1 parent 7588c07 commit 2897cd8

21 files changed

Lines changed: 116 additions & 117 deletions

‎CLAUDE.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,11 @@ Guidance for AI agents (Claude Code, etc.) working in this repository.
88

99
**Where to find what:**
1010

11-
- [`docs/engineering.md`](docs/engineering.md) — the distilled design reference: invariants and *why*, the five protocol seams, exception contract, module layout, testing patterns, optional-extras pattern, remaining roadmap. Read this before adding any new module or extension point.
12-
- [`docs/deferred-work.md`](docs/deferred-work.md) — review-surfaced items that are real but not actionable now.
13-
- [`docs/superpowers/specs/`](docs/superpowers/specs/) and [`docs/superpowers/plans/`](docs/superpowers/plans/) — per-feature design specs and implementation plans (active work).
14-
- [`docs/archive/`](docs/archive/) — historical bmad-era planning bundle (PRD, architecture, epics, product briefs, per-story specs for 1-1 through 1-5). Consult only for original rationale or specific FR/NFR citations.
11+
- [`docs/dev/engineering.md`](docs/dev/engineering.md) — the distilled design reference: invariants and *why*, the five protocol seams, exception contract, module layout, testing patterns, optional-extras pattern, remaining roadmap. Read this before adding any new module or extension point.
12+
- [`planning/deferred-work.md`](planning/deferred-work.md) — review-surfaced items that are real but not actionable now.
13+
- [`planning/specs/`](planning/specs/) and [`planning/plans/`](planning/plans/) — per-feature design specs and implementation plans (active work).
1514

16-
**Per-feature workflow:** brainstorming → spec in `docs/superpowers/specs/` → writing-plans → plan in `docs/superpowers/plans/` → executing-plans (or subagent-driven-development) → requesting-code-review → finishing-a-development-branch. Topic slugs are kebab-case descriptions (`msgspec-decoder-adapter`), not story IDs.
15+
**Per-feature workflow:** brainstorming → spec in `planning/specs/` → writing-plans → plan in `planning/plans/` → executing-plans (or subagent-driven-development) → requesting-code-review → finishing-a-development-branch. Topic slugs are kebab-case descriptions (`msgspec-decoder-adapter`), not story IDs.
1716

1817
## Commands
1918

@@ -99,5 +98,5 @@ Five documented internal boundaries. AI agents must respect them — never cross
9998

10099
## When in doubt
101100

102-
- Check [`docs/engineering.md`](docs/engineering.md) before adding a new module or extension point; `docs/archive/architecture.md` has the deeper historical rationale if needed.
101+
- Check [`docs/dev/engineering.md`](docs/dev/engineering.md) before adding a new module or extension point.
103102
- Surface ambiguity as a documentation gap rather than improvising.

‎docs/dev/engineering.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Caller-facing pattern: consumers select the implementation by passing it explici
131131

132132
## 8. Remaining roadmap
133133

134-
Twenty-seven stories remain. Topic slugs in `docs/superpowers/specs/` and `docs/superpowers/plans/` use kebab-case descriptions, not the story IDs — these IDs are retained as a stable identifier convention from the original epic structure.
134+
Twenty-seven stories remain. Topic slugs in `planning/specs/` and `planning/plans/` use kebab-case descriptions, not the story IDs — these IDs are retained as a stable identifier convention from the original epic structure.
135135

136136
### Epic 1 — Make typed HTTP requests with sensible defaults
137137

@@ -178,7 +178,7 @@ Twenty-seven stories remain. Topic slugs in `docs/superpowers/specs/` and `docs/
178178
- **6-4** CI enforcement gates (codify the invariants in Section 2 as CI jobs).
179179
- **6-5** Release flow with Trusted Publishers + Sigstore.
180180

181-
When work starts on a roadmap item, it gets a spec at `docs/superpowers/specs/YYYY-MM-DD-<topic>-design.md` and a plan at `docs/superpowers/plans/YYYY-MM-DD-<topic>-plan.md`.
181+
When work starts on a roadmap item, it gets a spec at `planning/specs/YYYY-MM-DD-<topic>-design.md` and a plan at `planning/plans/YYYY-MM-DD-<topic>-plan.md`.
182182

183183
## 9. Deferred work
184184

‎planning/plans/2026-05-31-asyncclient-plan.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
**Branch:** `story/1-7-asyncclient` (already created; spec commit `bebb1dd` is on it).
1212

13-
**Spec:** `docs/superpowers/specs/2026-05-31-asyncclient-design.md`.
13+
**Spec:** `planning/specs/2026-05-31-asyncclient-design.md`.
1414

1515
---
1616

@@ -1805,7 +1805,7 @@ Expected: `eof-fixer`, `ruff format --check`, `ruff check --no-fix`, `ty check`
18051805
- [ ] **Step 3: Confirm the working tree is clean**
18061806

18071807
Run: `git status --short`
1808-
Expected: only the untracked plan file `docs/superpowers/plans/2026-05-31-asyncclient-plan.md`.
1808+
Expected: only the untracked plan file `planning/plans/2026-05-31-asyncclient-plan.md`.
18091809

18101810
- [ ] **Step 4: Review the branch diff**
18111811

@@ -1818,7 +1818,7 @@ Expected: changes to `CHANGELOG.md`, `src/httpware/__init__.py`, `src/httpware/c
18181818
- [ ] **Step 5: Stage and commit the plan file**
18191819

18201820
```bash
1821-
git add docs/superpowers/plans/2026-05-31-asyncclient-plan.md
1821+
git add planning/plans/2026-05-31-asyncclient-plan.md
18221822
git commit -m "docs(story-1.7): implementation plan for AsyncClient
18231823
18241824
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>"
@@ -1845,7 +1845,7 @@ gh pr create --title "feat(story-1.7): AsyncClient — the v0.1.0 public surface
18451845
18461846
**Out of scope and deferred:** `auth=` (Story 2-4), `data=`/`files=` body params, transport reference-counting, streaming (Epic 4), observability (Epic 5).
18471847
1848-
Spec + plan: `docs/superpowers/specs/2026-05-31-asyncclient-design.md`, `docs/superpowers/plans/2026-05-31-asyncclient-plan.md`.
1848+
Spec + plan: `planning/specs/2026-05-31-asyncclient-design.md`, `planning/plans/2026-05-31-asyncclient-plan.md`.
18491849
18501850
## Test plan
18511851

0 commit comments

Comments
 (0)