ce5dcec7e4
- validation map rows 11.1-07-T1 through T5 with the commands that passed - the README src= todo names the refusal, caption and Sync work left
11 lines
890 B
Markdown
11 lines
890 B
Markdown
---
|
|
title: Convert module README Go code blocks to compiled src= references
|
|
date: 2026-09-30
|
|
priority: medium
|
|
area: summercms.go/modules/*/README.md, internal/docsite
|
|
---
|
|
|
|
Phase 11.1 (D-18) publishes every module README as an `api/<name>` docs page, but its Go code blocks (about 41 across 22 READMEs) are only identifier-checked, not compiled. Move each to an `Example*` or region in the module's `example_test.go` and reference it with `src=`, then drop the README exemption in `internal/docsite` `check_policy.go` so ROADMAP 11.1 SC4 can be widened back to "every Go example in the docs".
|
|
|
|
Since 11.1-07, checkSnippets refuses `src=` in module READMEs (`readmeSrcMessage`) and fenceAnnotator captions only docs/ pages. Converting README fences means replacing that refusal with checkFences over README pages, captioning their top-level `src=` fences, and extending Sync to README files.
|