Skip to content

Commit 85d50a7

Browse files
intendednullclaude
andauthored
docs(organization): close out spec — flip [draft]→[landed], backfill plan headers, sync pointer (#653)
Audit-and-align pass surfaced five actionable findings against the 2026-05-07-docs-organization-design.md spec: 1. Spec header still said `draft` while the migration plan was landed and the README catalog tag was `[active]`. Flipped to `[landed]` and added `**Implementation plan:**` back-pointer to the plan. 2. "Open questions" section listed two items the migration had already resolved (same-date spec/plan pairs verified as genuine; nine-area catalog populated cleanly). Converted to "Resolved questions" so future readers don't re-litigate. 3. CLAUDE.md pointer already carried a trailing "Cemented in `docs/specs/2026-05-07-docs-organization-design.md`." sentence that the spec didn't quote. Updated the spec's quoted block so it remains the source of truth, not the lagging reference. 4. Two post-convention plans (2026-05-08 phase-3b and phase-3c) regressed on the required header fields. Added `**Date:**` and `**Spec:**` to both. 5. Pinned-message-metadata spec (2026-05-21) introduced `**Parent specs:**` and `**Implementation plan:**` header fields that the convention didn't yet legitimize. Extended the Document headers section to document them as optional extensions plus a general "additional `**Key:**` extensions allowed when sparing" clause. Master index `docs/README.md` flipped the spec badge `[active]` → `[landed]`. Two AMBIGUOUS findings (3-5 reading list at exactly 4; README conventions restated as table not tree) are intentional shape choices per the spec's own §4 distillation contract — no fix. Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 1d4e015 commit 85d50a7

4 files changed

Lines changed: 39 additions & 16 deletions

File tree

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ See also: [`plans/STATUS.md`](plans/STATUS.md) — point-in-time audit of which
173173
**Specs**
174174

175175
- [Machine-readable wire-rejection reasons](specs/2026-04-24-error-prefixes.md) — typed `WireRejectReason` enum in `WireMessage::Reject` replacing free-form error strings. `[active]`
176-
- [Docs organization — target structure](specs/2026-05-07-docs-organization-design.md) — target structure for `docs/`, master index, naming conventions, and nesting rules. `[active]`
176+
- [Docs organization — target structure](specs/2026-05-07-docs-organization-design.md) — target structure for `docs/`, master index, naming conventions, and nesting rules. `[landed]`
177177

178178
**Plans**
179179

docs/plans/2026-05-08-ui-phase-3b-files-inline.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# UI Phase 3b — Files & Inline Attachments Implementation Plan
22

3+
**Date:** 2026-05-08
34
**Status:** landed (e98ed26, 2026-05-08)
5+
**Spec:** [`docs/specs/2026-04-19-ui-design/files-inline.md`](../specs/2026-04-19-ui-design/files-inline.md)
46

57
> **For agentic workers:** REQUIRED SUB-SKILL: superpowers:subagent-driven-development + superpowers:test-driven-development. Every task = one commit; tick the checkbox in the same commit.
68

docs/plans/2026-05-08-ui-phase-3c-reactions-pins.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# UI Phase 3c — Reactions & Pins Implementation Plan
22

3+
**Date:** 2026-05-08
34
**Status:** landed (foundation PR #634 + picker wireup PR #635 + initial close-out PR #637 + cascade close-out PRs #643 visibility wiring, #644 pinned-by footer + `PinMetadata`, #646 plan/spec/index close-out, #647 same-channel react-recency refresh, #648 DOM coverage tests)
5+
**Spec:** [`docs/specs/2026-04-19-ui-design/reactions-pins.md`](../specs/2026-04-19-ui-design/reactions-pins.md)
46

57
> **For agentic workers:** REQUIRED SUB-SKILL: superpowers:subagent-driven-development + superpowers:test-driven-development. Every task = one commit; tick the checkbox in the same commit.
68

docs/specs/2026-05-07-docs-organization-design.md

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Docs organization — target structure
22

33
**Date:** 2026-05-07
4-
**Status:** draft
4+
**Status:** landed (migration plan landed 2026-05-07; README + skill + CLAUDE.md pointer in place; STATUS frontmatter backfilled across all landed plans in PRs #651 / #652)
5+
**Implementation plan:** [`docs/plans/2026-05-07-docs-organization.md`](../plans/2026-05-07-docs-organization.md)
56

67
## Purpose
78

@@ -90,10 +91,19 @@ predating this convention are not retrofitted (see *Non-goals*).
9091
```
9192
**Date:** YYYY-MM-DD
9293
**Status:** draft | active | landed | superseded
93-
**Spec:** docs/specs/... (plans only — REQUIRED, points at the spec being realized)
94-
**Supersedes:** docs/specs/... (if applicable)
94+
**Spec:** docs/specs/... (plans only — REQUIRED, points at the spec being realized)
95+
**Supersedes:** docs/specs/... (if applicable)
96+
**Parent specs:** docs/specs/... (optional — for specs that descend from one or more existing specs)
97+
**Implementation plan:** docs/plans/...(optional — back-pointer when the doc is a spec and the plan is known)
9598
```
9699

100+
The first four fields are the minimum. `**Parent specs:**` and
101+
`**Implementation plan:**` are optional extensions used when the doc lives in
102+
a richer cross-reference graph (e.g. a child spec descending from a multi-file
103+
parent, or a freestanding spec whose realizing plan is already known).
104+
Additional `**Key:**` extensions are allowed when they make navigation
105+
cheaper for the next reader — keep them rare and self-explanatory.
106+
97107
Status semantics:
98108

99109
- `draft` — being written, target not yet stable
@@ -242,7 +252,12 @@ of the surfaces above:
242252
> **Docs entry point:** `docs/README.md` is the master index of specs and
243253
> plans, grouped by feature area. Read it before adding any new spec or plan,
244254
> or before searching for an existing one. The `organizing-willow-docs` skill
245-
> mirrors the conventions for on-demand loading.
255+
> mirrors the conventions for on-demand loading. Cemented in
256+
> `docs/specs/2026-05-07-docs-organization-design.md`.
257+
258+
The trailing back-pointer to this spec gives the reader a one-hop path to the
259+
canonical rules when they want more than the pointer paragraph itself
260+
contains.
246261

247262
Existing CLAUDE.md sections that duplicate doc-discovery information (e.g.
248263
the per-task "see `docs/specs/...`" pointers in *Architecture Notes*) are
@@ -261,14 +276,18 @@ left in place — they are useful inline context, not redundant with the index.
261276
project-management tool. Stale tags are tolerable; missing entries are not.
262277
- **Per-area sub-READMEs.** Single-file index until volume justifies a split.
263278

264-
## Open questions
265-
266-
- A handful of filenames currently appear in both `docs/specs/` and
267-
`docs/plans/` with the same date and topic (e.g.
268-
`2026-04-12-state-authority-and-mutations.md`,
269-
`2026-04-12-willow-channel-removal.md`). The migration plan must verify
270-
whether each pair is genuinely a spec + plan (correct, keep both) or an
271-
accidental misclassification (move to the right folder).
272-
- The exact set of nine feature areas may shift slightly during catalog
273-
population if a real entry resists a clean home; the area list is
274-
load-bearing for navigation and worth a final pass during the migration.
279+
## Resolved questions
280+
281+
The migration closed out two open questions; recorded here so future readers
282+
don't re-litigate them.
283+
284+
- **Same-date spec/plan pairs.** Pairs like
285+
`2026-04-12-state-authority-and-mutations.md` and
286+
`2026-04-12-willow-channel-removal.md` were verified during the migration:
287+
each is a genuine spec + plan pair (the plan's header cites the spec). No
288+
misclassifications were found. Future same-date pairs are legitimate and
289+
expected when a target and its migration are designed together.
290+
- **Nine-area catalog.** The nine areas in §3 populated cleanly with no
291+
entries that resisted a home. The area list is stable. Future areas can be
292+
added if a new feature cluster justifies one — the convention does not cap
293+
the count.

0 commit comments

Comments
 (0)