Publishing Checklist
This page tracks tasks to publish and maintain the mdBook.
-
Create
book/book.tomlandbook/srcwith chapter structure. - Write chapters for grammar, components, artifacts, limits, validation, authoring, contract, schemas, testing.
- CI job: build mdBook on PRs and main.
- Optional: Deploy to GitHub Pages from main.
Local build (requires mdbook):
cargo install mdbook
mdbook build book
open book/book/index.html
CI recommendations:
- Add a job that runs
cargo install mdbookandmdbook build bookand uploads thebook/book/as an artifact. - Protect against external network fetches; fonts should be local.