Files
LithosAnanke/docs/v4.0.0/plans/2026-11-10-alpha4-documents.md
T
Claude 1a9b142d80 docs: The Dictionary of v4 -- every live word, alphabetical, its stack notation and description; built and published with every release (#157) [skip ci]
make dictionary -> build/docs/Dictionary.pdf (20 pages): mkdictionary.py checks docs/reference/v4-dictionary.tsv against the booted system's words first, so a stale dictionary fails the build; then Markdown, pandoc, docs/book/dictionary.tex (the books' preamble, its own title page: version and commit). Quoted FORTH tokens set as code, so their quotes print straight. The nightly's docs stage builds it; publish sends classifier dictionary; the Gitea release attaches it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GE3SDvQn5EoxdGufk84zz2
2026-11-10 11:31:07 +00:00

27 lines
2.0 KiB
Markdown

# alpha.4's documents and pages -- progress (kept current, one line per increment)
Captain Bob, 2026-11-10: "Do it" -- the rest of alpha.4 that lives in the tree, after #92 (merged,
#160). #133 and #134 are the server's (Captain Bob's).
## #138 -- The Book of Fabric
- [x] `docs/book/fabric.tex`: the FABRIC record as one book -- Part I the living record (FABRIC-3),
Part II the closed ones in order, Part III the forward-looking notes; title page with the
version (`git describe --tags`) and the commit. The book's preamble moved into
`docs/book/preamble.tex`, shared by both books (the book itself builds unchanged, 821 pages).
- [x] `make fabric` -> `build/docs/BookOfFabric.pdf` (722 pages, 42 s).
- [x] `scripts/nightly.sh docs` builds it (`$DOCS/fabric.pdf`); `publish` sends it as
`org.starship:documentation:<version>`, classifier `fabric`; `gitea-release` attaches every
PDF in `$DOCS`, so the release carries it.
## #157 -- the dictionary of v4, and the .com's Documents page
- [x] the live word list of the built system (318 words): `v4/tools/mkdictionary.py words` -- the hosted v4's `WORDS` (317) plus the kernel's `sk_v4_words[]` (`MINT-ZUSE`)
- [x] the table in the tree, `docs/reference/v4-dictionary.tsv`: all 318 entries, written in three alphabetical batches against v4's own definitions (the source gave 54 stacks and 105 descriptions to start from); `check` passes
- [x] the check: `mkdictionary.py check` -- every live word has a finished entry, every entry a live word; run by `make dictionary`, so a stale table fails the build and the nightly
- [x] the PDF, alphabetical: `make dictionary` -> `build/docs/Dictionary.pdf` (20 pages; `docs/book/dictionary.tex`); the nightly's docs stage builds it, `publish` sends classifier `dictionary`, the release attaches it
- [ ] the Documents page: canvas artboard, then `site/com`
## #126 -- the Downloads page live
- [ ] `site/com` builds Downloads (and Documents) from the release: its tag, `SHA256SUMS`, the
Root CA's fingerprint
- [ ] the nav links on Home, Try it, Inquiries