feat(docsite): require src= on Go code blocks of module READMEs (quick-261118-qsd)

This commit is contained in:
Jakub Zych
2026-11-18 20:18:38 +01:00
parent 1e56d750ef
commit 8c03cc3621
11 changed files with 43 additions and 40 deletions

View File

@@ -58,6 +58,7 @@ Framework code never names a consuming application (READMEs, docs, examples use
- A change to a module's exported API, config keys, CLI commands or dependencies updates that module's `README.md` and the affected `docs/` pages in the same commit.
- Module README structure: H1 name, one-sentence summary, import line, `**Name:**` mnemonic, then Overview, Features, Usage, API reference, optional Configuration and CLI commands, Dependencies, Testing. The root table's purpose text reuses the summary sentence.
- Every identifier in a README or docs page must exist in the package (the docs checker enforces it). Config keys are not checked automatically; review them by hand.
- Go code blocks in `docs/` pages and module READMEs are `src=` references into compiled test code (usually the module's `example_test.go`): an Example with `// Output:`, a `docs:start`/`docs:end` region, or a declaration a test runs. `summer docs:build --check` compares them with their source, and `summer docs:sync` refreshes them after the source changes.
## MSD workflow