Repository navigation
v4.1.7
"Docs for a Studio": the plan's sixth release, the last before 4.2; the documentation a studio reads
first, after the code it describes. What this release does not do is in the LOG and the passes sheet.
Changes
- Docs for a studio (4.1.7, the plan's sixth release). The READMEs rewritten in both languages: one pitch,
three commands, what each role gets, the screenshots taken again from the current build, one table of numbers,
the current release in one paragraph (the release-by-release stack is the CHANGELOG's), a non-affiliation note
(also in CREDITS.md).docs/en/TUTORIAL.mdand its French twin: a first room in fifteen minutes.API.mdcarries
the public API's signatures, generated from the sources (tools/api-doc.ts, held bytests/api-doc.test.ts).
SUPPORT.md says the 4.1.x policy once and has a support matrix (what CI checks, what only people check). STUDIO.md
in French has the three sections it summarised (Assets, Demo, Assistant); a test keeps every French page within a
third of its English twin, section by section; another checks every relative link in the docs. AGENTS.md loses
the rules of the pair work that ended with v3; CLAUDE.md points at the right pages. The release notes drop the
work log's entry and decision numbers.CODE_OF_CONDUCT.md, a pull request template and a feature issue template;
the wiki is off. Fixed: a warm-up of the assets in progress ended withApp.destroy()neither its idle waits
nor its fetches (CI's node-24 sawwindow is not definedfrom a test's torn-down page); the bank now carries the
player's abort signal and stops at it. The first visit's JavaScript goes from 122 to 123 KB gzipped for it (the
baseline moved on purpose; the budget,initialJsKB140, is untouched).
Manual passes (D12: reported, not blocking)
10 of 14 done.
| Pass | Status | Who, when | Device, OS, browser, versions | What failed |
|---|---|---|---|---|
| 1 | the README opens on forty lines of release history | one pitch, three commands, what each role gets, screenshots from the current build, one table of numbers, the release in one paragraph (tests/readme-release.test.ts, tests/docs-links.test.ts) |
||
| 2 | a newcomer has no page that ends with a room they can play | docs/en/TUTORIAL.md and docs/fr/TUTORIAL.md |
||
| 3 | API.md is a table of names without a signature |
the signatures generated from the sources (tools/api-doc.ts, tests/api-doc.test.ts) |
||
| 4 | SUPPORT.md has one "exception" per release and no matrix | the 4.1.x policy said once; a support matrix of what CI checks and what only people check | ||
| 5 | a French page summarises what the English one explains | STUDIO.md complete; every French page within a third of its English twin, section by section (tests/docs-truth.test.ts) |
||
| 6 | an npm script has no line anywhere | all 83 in TOOLS.md (tests/scripts-documented.test.ts) |
||
| 7 | AGENTS.md describes a pair that ended with v3 | gone, with the stale pointers of CLAUDE.md | ||
| 8 | the release notes cite the work log | (LOG #n) and (Dn) stripped by scripts/release-notes.mjs (tested) |
||
| 9 | the repository has no code of conduct, PR template or feature template | all three; the wiki off | ||
| Pass | Status | Who, when | Device, OS, browser, versions | What failed |
The seven field passes (docs/en/FIELD.md) |
not done | |||
| A newcomer follows TUTORIAL.md to the end without help | not done | |||
| The 88 surviving mutants of the reality set, the 216 unused exports knip lists | not done | |||
Signed tag (git tag -s) |
not done |