Commit 1deaa94
Document per-genre readers and register for docs/
Follows-up to #1106
#1106 rewrote `docs/api/validation-codes.md` to its reader's altitude and cut everything that derived, justified,
or narrated mechanism rather than stating the contract. This adds `docs/writing.md`, which codifies that standard
so the next page holds to it by default.
The page states, in under 45 lines: a rule block (fix the reader, their decision, and a length budget before
writing; state contracts, don't narrate mechanism; one home per fact; no history of the text's own production;
improving a page doesn't lengthen it), a genre table assigning each `docs/` area its reader and register, and a
short list of banned phrasings.
Placement: `docs/writing.md` at the docs root, no frontmatter. The site nav is curated, not built from every file
(`planning/` is excluded per `docs/README.md`), and published leaves carry the `title`/`order` frontmatter this
page omits, so it stays out of the product navigation. The docs-deploy workflow only triggers the site build; the
nav lives in the website project.
Genre mapping: there is no `concepts/` or `reference/` directory, so those genres map to the docs-root concept
pages and to `authoring/` + `rdf/` + `examples/`. Every existing `docs/` subdirectory is covered by one row.
Considered, omitted: a standalone row for `examples/` (folded into the reference genre); `title`/`order`
frontmatter (would list it in the nav); a cross-link from `docs/README.md` (this change adds one file only); a
fuller description of the deploy pipeline (out of the page's genre). No repo-root `CLAUDE.md`/`AGENTS.md` exists,
so no AI-context pointer was added.
> <sub>AI-authored — Claude Code, `Opus 4.8 (max)`; executed from a fixed skeleton and genre assignments specified by a Fable 5 session directed by @JeroenDeDauw; not yet human-reviewed; placement verified against the docs-site build config, links checked, docs-only change.</sub>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>1 parent 3ea7a9f commit 1deaa94
1 file changed
Lines changed: 29 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
0 commit comments