feat(docsite): check, caption and sync src= blocks in module READMEs (quick-261118-qsd)
- checkSnippets compares top-level src= fences of module READMEs like docs/ pages; the README src= refusal is gone - Sync also rewrites drifted src= fences in modules/<name>/README.md, still all-or-nothing across pages and READMEs - fenceAnnotator captions top-level src= fences on every page - the snippet-readme-src planted violation now plants a drifted README fence instead of the old refusal - utilities.md, README.md and CLAUDE.md describe src= in module READMEs
This commit is contained in:
@@ -165,7 +165,7 @@ npm --prefix admin run gen:api # regenerate TypeScript types from admin/open
|
||||
|
||||
`summer dev` watches an application's sources and rebuilds its binary on change.
|
||||
|
||||
`summer docs:build` renders `docs/` and every module README into a static site under `site/` (use `--out` for another directory, `--check` to validate without writing). Code blocks with a `src=` reference are copies of real source, and `src=` works on top-level code blocks of `docs/` pages only; after changing that source, run `summer docs:sync` to refresh the copies.
|
||||
`summer docs:build` renders `docs/` and every module README into a static site under `site/` (use `--out` for another directory, `--check` to validate without writing). Code blocks with a `src=` reference are copies of real source, and `src=` works on top-level code blocks of `docs/` pages and module READMEs; after changing that source, run `summer docs:sync` to refresh the copies.
|
||||
|
||||
`summer docs:serve` builds the same site into a temporary directory and previews it at `http://127.0.0.1:8088` (`--addr` to change it), rebuilding when the docs, a module or a `src=` source changes; a failed rebuild prints its problems and keeps serving the last good build. It listens only on a loopback address unless you pass `--allow-remote`. Search needs this server: browsers block the search index over `file://`.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user