docs: strip residual Phase/Plan refs from guides
Five spots across three guides referenced the original implementation
phasing (Plan-N / Phase-N nomenclature) from the template's setup era.
Now that the template-reset epic completed and the setup history was
archived, these refs are dead vocabulary for fresh consumers.
guides/scaffolding-a-feature.md:
- "real repo body is a Phase-1 stub" -> "real repo body is a stub"
- "## Phase-1 scope (intentionally limited)" -> "## Scope (intentionally limited)"
- "manually authored as part of Phase-2 wiring" -> "manually authored
as part of the post-scaffold wiring"
guides/adding-a-feature.md:
- "the generator's Phase-1 scope doesn't fit" -> "the generator's
default scope doesn't fit"
guides/tdd-workflow.md:
- "**File naming convention (post-Plan-8):**" -> "**File naming
convention:**"
The Plan-9 refs in docs/architecture/data-flow-explainer.html will be
handled separately along with that file's other staleness in the
next commit.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -9,7 +9,7 @@ by one package under `packages/<feature>/`.
|
||||
> `navigation` reference shape (DI, tRPC router with tests, span + capture
|
||||
> sandwich, dev seed, contract suite). See
|
||||
> [Scaffolding a Feature](./scaffolding-a-feature.md). Use this guide when
|
||||
> the generator's Phase-1 scope doesn't fit — multi-entity layouts, custom
|
||||
> the generator's default scope doesn't fit — multi-entity layouts, custom
|
||||
> shapes, or extending an existing feature — or when you need to understand
|
||||
> what the generator emits and why.
|
||||
|
||||
|
||||
@@ -55,7 +55,7 @@ See `docs/guides/conformance-quickref.md` for the manifest field reference.
|
||||
with the canonical safeParse → presenter shape
|
||||
- Mock + real repository (`src/infrastructure/repositories/<entity>.repository{,.mock}.ts`).
|
||||
Both wrap calls in `tracer.startSpan`; the real repo also calls
|
||||
`logger.captureException` on errors. The real repo body is a Phase-1
|
||||
`logger.captureException` on errors. The real repo body is a
|
||||
stub that returns `null` until you wire a Payload collection.
|
||||
- DI: `symbols.ts`, `module.ts`, `container.ts`, plus
|
||||
`bind-production.ts` and `bind-dev-seed.ts` that compose
|
||||
@@ -67,7 +67,7 @@ See `docs/guides/conformance-quickref.md` for the manifest field reference.
|
||||
- Contract suite (`__contracts__/`), dev seed (`__seeds__/dev.ts`), and
|
||||
empty stubs for `__factories__/` and `ui/`
|
||||
|
||||
## Phase-1 scope (intentionally limited)
|
||||
## Scope (intentionally limited)
|
||||
|
||||
The generator does NOT yet emit:
|
||||
|
||||
@@ -113,7 +113,7 @@ pnpm turbo gen realtime channel # realtime channel descriptor (ADR-016)
|
||||
pnpm turbo gen realtime handler # inbound realtime handler (ADR-016)
|
||||
```
|
||||
|
||||
The event/job generators insert at six fixed `// <gen:*>` anchor comments. Generated features include four of them automatically (the `// <gen:job-tasks>` location is in `integrations/cms/index.ts`, which is manually authored as part of Phase-2 wiring); pre-existing features were retrofitted in ADR-015.
|
||||
The event/job generators insert at six fixed `// <gen:*>` anchor comments. Generated features include four of them automatically (the `// <gen:job-tasks>` location is in `integrations/cms/index.ts`, which is manually authored as part of the post-scaffold wiring); pre-existing features were retrofitted in ADR-015.
|
||||
|
||||
The realtime generators insert at three additional fixed `// <gen:realtime-*>` anchor comments (`// <gen:realtime-channels>` in `src/index.ts`, `// <gen:realtime-handler-symbols>` in `src/di/symbols.ts`, `// <gen:realtime-handlers>` in both `bind-*.ts` files). Generated features include all three automatically; pre-existing features were retrofitted in ADR-016.
|
||||
|
||||
|
||||
@@ -605,7 +605,7 @@ describe("CommentsRepository", () => {
|
||||
|
||||
The `buildSubject` pattern ensures each `run()` call supplies a fresh instance — every contract `it()` starts with a clean repository.
|
||||
|
||||
**File naming convention (post-Plan-8):**
|
||||
**File naming convention:**
|
||||
|
||||
- Mock implementation: `<x>.repository.mock.ts` (not `mock-<x>.repository.ts`)
|
||||
- Mock test: `<x>.repository.mock.test.ts`
|
||||
|
||||
Reference in New Issue
Block a user