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:
@@ -19,6 +19,6 @@ go test ./modules/demo
|
||||
```
|
||||
|
||||
```go src=modules/demo/example_test.go#ExampleHello
|
||||
fmt.Println(demo.Hello("blog"))
|
||||
// Output: Hello, blog
|
||||
fmt.Println(demo.Hello("world"))
|
||||
// Output: Hello, world
|
||||
```
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
rule: snippet
|
||||
file: modules/demo/README.md
|
||||
message: modules/demo/example_test.go#ExampleHello: module README code blocks are rendered as written
|
||||
message: body differs from modules/demo/example_test.go#ExampleHello (run: summer docs:sync)
|
||||
|
||||
Reference in New Issue
Block a user