Commit 5dc1bdd
authored
Correct 20-contract §19's list of /authoring exports (#366)
Carried over from
[#316](#316),
which was closed as superseded. This was the one part of that branch
that had not landed independently.
## What was wrong
`20-contract.md` §19 described `@the-running-dev/game-engine/authoring`
as exporting:
> generic content-registry builder, the story-graph source builder, the
shared adventure builder and its migration helper …
Two things are inaccurate against `src/engine/src/authoring.ts`:
- The subpath exports `buildCampaign` — a **campaign** builder, from
`core/registry/build.ts`. `buildContentRegistry` is not exported from
`/authoring` at all, so a reader following §19 would go looking for a
surface that is not there.
- The adventure exports are three, not two: `buildAdventureCampaign`,
`createAdventureSource`, `migrateV1AdventureState`. The sentence named
the builder and the migration helper and dropped the source factory.
`docs/docs/guide.md` carried the same drift in its own words ("the
content-registry builder, the story-graph and adventure source builders
and their migration helpers") and is corrected to match.
## What changed
- `design/20-contract.md` §19 — the canonical edit, two lines.
- `docs/docs/engine/04-core.md` — regenerated by
`./build/ConvertTo-HumanDocumentation.ps1`, not hand-edited.
- `docs/docs/guide.md` — the affected paragraph corrected and the design
digest re-stamped with `-StampGuide`.
Wording only. No type, signature, or export changes — the code was
already right; the contract was describing it wrongly.
## Note on how the guide was regenerated
`/make-human-docs` overwrites `guide.md` in full with no partial
regeneration. For a two-noun correction in one paragraph of an 841-line
file, a full rewrite would have produced a large unrelated diff on a
branch scoped to one sentence, so the affected paragraph was corrected
in place and the digest re-stamped. The gate that matters —
`Test-Documentation.ps1`'s guide-digest check — passes either way, but
the choice is recorded here rather than left to be inferred from the
diff.
## Gates
| Gate | Result |
|---|---|
| `./build/Test-Documentation.ps1` | pass — drift check across 18
generated engine pages, compatibility pointers and the guide; 125
Markdown files |
| `npm run typecheck` | pass |
| `npm run lint` | pass |
| `npm test` | pass — 79 files, 1173 tests |
| `git diff --check` | clean |
**Did not run:** `./docs.ps1 -BuildOnly`, the production Docusaurus
build. `docs.ps1` is not installed in this checkout, so it could not be
run locally — the *Verify Documentation Build* check on this PR is the
gate that covers it, and it should be read there rather than assumed
from the above.3 files changed
Lines changed: 13 additions & 13 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1539 | 1539 | | |
1540 | 1540 | | |
1541 | 1541 | | |
1542 | | - | |
1543 | | - | |
| 1542 | + | |
| 1543 | + | |
1544 | 1544 | | |
1545 | 1545 | | |
1546 | 1546 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1511 | 1511 | | |
1512 | 1512 | | |
1513 | 1513 | | |
1514 | | - | |
1515 | | - | |
| 1514 | + | |
| 1515 | + | |
1516 | 1516 | | |
1517 | 1517 | | |
1518 | 1518 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| |||
130 | 130 | | |
131 | 131 | | |
132 | 132 | | |
133 | | - | |
134 | | - | |
135 | | - | |
136 | | - | |
137 | | - | |
138 | | - | |
139 | | - | |
140 | | - | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
141 | 141 | | |
142 | 142 | | |
143 | 143 | | |
| |||
0 commit comments