Skip to content

Commit ffe0ced

Browse files
lesnik512claude
andcommitted
docs(planning): retire "bundle" wording across planning prose
Sweep the pre-2.0.0 word "bundle" to "change"/"change file"/"folder" in 6 historical change files and the CI step name. Accuracy-preserving: "folder" where it names the retired directory mechanism, "change" otherwise. Keep 3 coherence-required uses in the upgrade spec (the before/after definition, "rejects folder bundles", and a verbatim quote of the old CLAUDE.md text). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 7836ee1 commit ffe0ced

7 files changed

Lines changed: 70 additions & 15 deletions

‎.github/workflows/planning.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ jobs:
1414
uses: astral-sh/setup-uv@v7
1515
with:
1616
python-version: "3.11"
17-
- name: Validate planning bundles
17+
- name: Validate planning changes
1818
run: uv run python planning/index.py --check

‎planning/changes/2026-06-28.02-adopt-planning-convention.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
summary: Adopt lesnik512/planning-convention v1.1.1 at the repo root and migrate docs/superpowers/ into planning/ change bundles plus a lazy architecture/ truth home.
2+
summary: Adopt lesnik512/planning-convention v1.1.1 at the repo root and migrate docs/superpowers/ into planning/ change folders plus a lazy architecture/ truth home.
33
---
44

55
# Design: Adopt the planning convention and migrate docs/superpowers/
@@ -10,7 +10,7 @@ Apply the portable two-axis planning convention from
1010
[`lesnik512/planning-convention`](https://github.com/lesnik512/planning-convention)
1111
(v1.1.1) to this repo via its `APPLY.md` flow, as a **fresh adoption**, and
1212
migrate the existing planning material under `docs/superpowers/` into the
13-
convention's `planning/changes/` bundles. The convention's `architecture/` and
13+
convention's `planning/changes/` folders. The convention's `architecture/` and
1414
`planning/` trees live at the **repo root**, where the convention's prose,
1515
`index.py` path resolution, and `APPLY.md` §5 all assume they live.
1616

@@ -35,10 +35,10 @@ validator, a generated index, a Quick-path lane decision, and a living
3535
delete `docs/superpowers/`. Matches the convention verbatim with no prose
3636
rewrites. Nothing lands under `docs/`, so MkDocs never publishes it and the
3737
`exclude_docs: superpowers/` rule is retired.
38-
2. **community-health bundle: `change.md`.** The `org-community-health-defaults`
39-
plan (06-24) has no design doc; the bundle is given a condensed `change.md` as
38+
2. **community-health change: `change.md`.** The `org-community-health-defaults`
39+
plan (06-24) has no design doc; the change is given a condensed `change.md` as
4040
its spec. The substantial shipped `plan.md` is **kept alongside** it (the
41-
validator allows `change.md` + `plan.md` in one bundle) so the detailed
41+
validator allows `change.md` + `plan.md` in one folder) so the detailed
4242
shipped record is preserved in-repo rather than only in git history.
4343
*(Open for confirmation at the review gate: keep both, or fold the plan into
4444
change.md and drop plan.md.)*
@@ -83,7 +83,7 @@ frontmatter. Migration is **structural only**: each document's existing body and
8383
headings are preserved (the templates are starting points, not mandatory section
8484
names; the validator enforces only `summary:` on specs).
8585

86-
| Bundle | Lane | Source | Frontmatter change |
86+
| Change | Lane | Source | Frontmatter change |
8787
|---|---|---|---|
8888
| `2026-06-24.01-promotion-strategy` | design-only (pending) | `specs/2026-06-24-promotion-strategy-design.md` → `design.md` | add `summary:`; drop the `**Date/Status/Owner/Scope**` block (date derived from dir; `status`/`owner` are not convention fields); keep Scope as a prose line |
8989
| `2026-06-24.02-org-community-health-defaults` | `change.md` + `plan.md` | `plans/2026-06-24-org-community-health-defaults.md` → `plan.md`; new `change.md` from the plan intro | plan.md: none; change.md: `summary:` |
@@ -94,7 +94,7 @@ The `.NN` counter on 06-24 places the strategic umbrella (`promotion-strategy`)
9494
at `.01` and its implementation (`community-health-defaults`) at `.02`.
9595

9696
`launch-playbook.md` moves to `planning/launch-playbook.md` as a loose
97-
operational asset — it cannot live inside a bundle (the validator rejects any
97+
operational asset — it cannot live inside a change folder (the validator rejects any
9898
file other than `design.md`/`plan.md`/`change.md` there). Its "excluded via
9999
`exclude_docs`" note is updated, since it now sits at the repo root and is never
100100
published. After migration, `docs/superpowers/` is deleted.
@@ -144,7 +144,7 @@ Local edits to these are intentionally not made — they are owned upstream.
144144

145145
## Risk
146146

147-
- **Plan-without-design bundle fails validation** (community-health). Mitigated by
147+
- **Plan-without-design change fails validation** (community-health). Mitigated by
148148
decision 2 (write a `change.md`).
149149
- **Stale references** to `docs/superpowers/` elsewhere in the repo (e.g.
150150
`mkdocs.yml`, CLAUDE.md, launch-playbook prose). Mitigated by the `git grep`

‎planning/changes/2026-06-30.02-docs-ogimage-rollout.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ GitHub/Slack/X/etc. show the branded card instead of nothing. Each docs repo
1212
self-hosts its card (`docs/assets/social-card.png`, copied from this repo's
1313
`brand/projects/<repo>/social-card.png`) and gains a small MkDocs Material
1414
template override that emits the Open Graph + Twitter meta. Shipped as **seven
15-
PRs**, one per docs repo. This planning bundle lives in `.github` (the org/brand
15+
PRs**, one per docs repo. This planning change lives in `.github` (the org/brand
1616
home where the cards are generated); no code changes land in `.github`.
1717

1818
## Motivation

‎planning/changes/2026-06-30.05-profile-badge-tables.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ maintainer wants the org landing page to read as metrics-forward, matching the
2323
badge strips already present in every repo README (`modern-di`'s README even
2424
carries a project table already, so the pattern has internal precedent).
2525

26-
Two research sweeps (saved findings in this bundle's history) established the
26+
Two research sweeps (saved findings in this change's history) established the
2727
guardrails:
2828
- No surveyed org (astral-sh, pydantic, encode, prisma, grafana, langchain,
2929
vercel, supabase, …) puts a per-repo badge **table** in its org profile; the

‎planning/changes/2026-07-02.04-aiohttp-surfaces.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ PyPI. Progress so far:
2727
placement — `modern-di-aiohttp` now lands in its alphabetical slot. Future
2828
integrations slot in alphabetically, no insertion-point decision needed.
2929

30-
The brand mark and assets are already done and merged (bundle
30+
The brand mark and assets are already done and merged (change
3131
`2026-07-02.02-aiohttp-brand`, PR #31) — `brand/projects/modern-di-aiohttp/`
3232
exists on `main`.
3333

@@ -103,6 +103,6 @@ gh repo edit modern-python/modern-di-aiohttp \
103103

104104
## Notes
105105

106-
Ship as one PR (this bundle finalized + the two file edits) once unblocked; the
106+
Ship as one PR (this change finalized + the two file edits) once unblocked; the
107107
GitHub-settings step is out-of-repo and applied alongside. Independent of any
108108
other pending work.

‎planning/changes/2026-07-05.01-docs-lockup-hero.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Add a short "docs home page hero" note to `architecture/brand-marks.md` (beside
147147
the existing README-banner note), recording that docs sites vendor the lockup as
148148
a centered `.mp-hero` — contrasted with the README `<picture>` hotlink approach —
149149
and add a one-line pointer in `brand/README.md`'s per-project marks section. This
150-
promotion rides in the same PR as the planning bundle (this `.github` repo's
150+
promotion rides in the same PR as the planning change (this `.github` repo's
151151
slice of the rollout).
152152

153153
## Rollout
@@ -161,7 +161,7 @@ Full lane, executed **pilot then replicate**:
161161
3. **`modern-di`** last, once its branch is free.
162162

163163
Each target repo is a separate PR in its own repo. This `.github` repo carries
164-
its own PR for the planning bundle + architecture/brand-README docs (step 4).
164+
its own PR for the planning change + architecture/brand-README docs (step 4).
165165

166166
## Testing
167167

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
summary: Retire the pre-2.0.0 word "bundle" from planning prose — sweep it to "change"/"change file"/"folder" across 6 historical change files and the CI step name, keeping only the 3 coherence-required uses in the upgrade spec.
3+
---
4+
5+
# Change: Retire "bundle" wording across planning prose
6+
7+
## What & why
8+
9+
Convention 2.0.0 renamed change *bundles* (folders) to flat change *files*.
10+
The merged upgrade (#39) fixed the living-truth surfaces (`CLAUDE.md`,
11+
`architecture/README.md`, `planning/README.md`), but the word "bundle" lingered
12+
in six historical change files and one CI step name. This sweep retires it
13+
everywhere it still reads as the change artifact, so the docs speak the 2.0.0
14+
vocabulary consistently.
15+
16+
Accuracy-preserving (maintainer's ruling): use "folder" where the text names the
17+
retired directory mechanism (a folder that held `change.md` + `plan.md`), and
18+
"change"/"change file" where it just means the change. Three uses are
19+
deliberately **kept** — they would otherwise become incoherent or falsify a
20+
quote.
21+
22+
## Scope
23+
24+
Swept to "change"/"change file"/"folder":
25+
26+
- `.github/workflows/planning.yml` — CI step `Validate planning bundles` → `Validate planning changes`.
27+
- `planning/changes/2026-06-28.02-adopt-planning-convention.md` — 8 uses; "folder" where it names the v1.1.1 directory (e.g. "in one folder"), else "change".
28+
- `planning/changes/2026-06-30.02-docs-ogimage-rollout.md` — 1.
29+
- `planning/changes/2026-06-30.05-profile-badge-tables.md` — 1.
30+
- `planning/changes/2026-07-02.04-aiohttp-surfaces.md` — 2.
31+
- `planning/changes/2026-07-05.01-docs-lockup-hero.md` — 2.
32+
33+
**Kept (intentional):**
34+
35+
- `planning/changes/2026-07-07.02-upgrade-planning-convention-2.0.md` — 3 uses:
36+
the before→after definition ("change *bundles* become flat *files*"), "rejects
37+
folder bundles", and a verbatim quote of the pre-change `CLAUDE.md` text
38+
("create a bundle under …"). That file's subject is retiring bundles, so it
39+
necessarily names the old thing.
40+
- `architecture/site-branding.md` — "bundled Jost TTF" is a font reference, not
41+
planning vocabulary.
42+
43+
## Verification
44+
45+
- `just check-planning` prints `planning: OK`.
46+
- After the sweep, `grep -rni 'bundle' --include='*.md' --include='*.yml'` over
47+
the repo (excluding `site/`) returns only: the 3 kept uses in the upgrade
48+
spec, the Jost-font line, and this change file's own descriptive mentions.
49+
- No folder diagrams or `change.md`+`plan.md` references were altered — only the
50+
word "bundle" changed.
51+
52+
## Notes
53+
54+
Pure documentation vocabulary; no code, no tests, no assets. Multi-file only
55+
because "bundle" was scattered; each edit is a one-word substitution.

0 commit comments

Comments
 (0)