docs: retire plans/perfect-shape.md — roadmap complete#1003
Conversation
Size Report
Startup median (7 runs, lower is better):
Top changed chunks: no changes in the largest emitted chunks. |
|
Review finding: The PR removes plans/perfect-shape.md, but a few comments still cite bare roadmap section numbers with no surviving target:
Because the plan file is deleted, those section references are now dangling. Please repoint them to ADR-0008/ADR-0009/CONTEXT.md wording, or inline the rationale without section numbers, before retiring the roadmap. |
The perfect-shape roadmap (two-registry thesis: CommandDescriptor + PlatformPlugin, typed-result spine, folder DAG + layering lint, agent-cost, and the Apple apple+appleOs platform model with a non-breaking leaf wire) is substantively complete and merged. Per its own §5 retirement note, the durable decisions now live in ADR-0008 (command descriptor) and ADR-0009 (Apple/AppleOS), and current-state terms in CONTEXT.md; this removes the last plan file. - Delete plans/perfect-shape.md (plans/ is now empty and gone). - CONTEXT.md: add "Architecture (perfect-shape refactor, completed 2026-07)" end-state summary plus a "Deferred / next-minor" note (Phase 2c client-types narrowing, b.3 recording/providers facets, strict DAG back-edge inversion, legacy alias drops) so nothing is lost. - Repoint every remaining perfect-shape.md/§ reference (ADRs 0003/0008/0009, ci.yml, scripts/layering/check.ts, and the platform-plugin/apple comments) to ADR-0008/0009 or CONTEXT.md. No dangling references remain. Docs/comment-only; tsc, oxlint, oxfmt, and the layering DAG check all pass.
… roadmap Removing plans/perfect-shape.md left three comments citing bare section numbers with no surviving target. The rationales are already inlined, so drop the numbers (and point the do-not-flatten note at the durable ADR): - src/platforms/apple/plugin.ts: `(§7)` -> "do-not-flatten; see docs/adr/0009". - src/core/interactors/register-builtins.ts: "the §5.1 ... sketch" -> "an ... sketch". - scripts/layering/check.ts: drop `(§5.5 ...)`, keep the inline "re-export barrels only".
|
Addressed + rebased onto main (now includes #1004). Removed the three dangling section-number citations now that plans/perfect-shape.md is gone — the rationale was already inlined at each site, so:
Grep confirms no surviving |
51a9247 to
2d77c2d
Compare
|
Review follow-up: the dangling roadmap section references are fixed in head 2d77c2d. I verified git grep for plans/perfect-shape.md, perfect-shape.md, and § now returns no hits, while the surviving perfect-shape narrative is anchored in CONTEXT.md/ADR references. Checks are green (21/21). This docs/comment-only retirement looks ready for human maintainer judgment. |
|
What
Retires the last plan file,
plans/perfect-shape.md. Theplans/directory is now empty and removed.The perfect-shape roadmap — the two-registry thesis (CommandDescriptor + PlatformPlugin), the typed-result spine, the folder DAG + import-direction layering lint, agent-cost, and the Apple
apple+appleOsplatform model with a non-breakingios/macosleaf wire — is substantively complete and merged to main.plans/phase3-platform-plugin-progress.mdwas already retired (#982); this removes the final plan file, per the roadmap's own §5 retirement note ("plans/ deleted incrementally, perfect-shape.md last").Delivered (all merged)
src/core/command-descriptor/registry.ts(dispatchswitch→ total map).TypedError.PLATFORMS = ['apple', …]with anappleOsdiscriminant,PUBLIC_PLATFORMS = ['ios', 'macos', …]non-breaking leaf output, shared engine undersrc/platforms/apple/core/, per-OS leaves undersrc/platforms/apple/os/<os>/.outputSchema, leveledResponseView).scripts/layering/check.ts.Durable decision records
The ADRs are the durable records and the retirement targets:
Current-state terms now live in
CONTEXT.md, which gains an "Architecture (perfect-shape refactor, completed 2026-07)" section describing the delivered end-state (two registries, typed spine, Appleapple/appleOsmodel + non-breaking wire, folder DAG + layering lint, agent-cost) with pointers to ADR-0008/0009.Deferred / next-minor (now recorded in CONTEXT.md so they aren't lost)
Record-typed client methods insrc/client/client-types.tsto their existing typed contracts (semver-relevant public-API narrowing; not yet done).providers,recording) stay on their daemon branch as source of truth (Phase 3 b.3: platform-neutral daemon facets (providers/recording/appLog/perf) on PlatformPlugin #974 closed).commands→cli/client) is not done.References repointed
Every remaining
perfect-shape.md/§reference was repointed to ADR-0008/0009 or CONTEXT.md — ADRs 0003/0008/0009,.github/workflows/ci.yml,scripts/layering/check.ts, and the platform-plugin/Apple source comments (src/core/capabilities.ts,src/core/platform-plugin/{plugin,apple-os-capabilities}.ts,src/platforms/apple/plugin.ts,src/platforms/apple/os/tvos/remote.ts,src/core/__tests__/capability-plugin-routing-parity.test.ts). No dangling references remain (git grep perfect-shape.mdis clean).Verification
Docs/comment-only.
tsc -p tsconfig.json --noEmit,oxlint --deny-warnings,oxfmt --check, and the layering DAG check (scripts/layering/check.ts) all pass.The perfect-shape roadmap is complete; this retires the last plan file.