@@ -25,6 +25,20 @@ Make a coverage map before writing pages. Write it to
2525` almanac/coverage-map.md ` , then treat it as the contract for the rest of the
2626run.
2727
28+ Write ` coverage-map.md ` with valid page frontmatter:
29+
30+ ``` yaml
31+ ---
32+ title : Coverage Map
33+ summary : Frozen page inventory for this first wiki build.
34+ topics : [build, wiki, reference]
35+ sources : []
36+ ---
37+ ```
38+
39+ Even though ` coverage-map.md ` is working state, it lives under ` almanac/ ` and
40+ must pass normal page validation.
41+
2842Write ` coverage-map.md ` with one main section:
2943
3044## Page Inventory
@@ -138,9 +152,29 @@ For each writing sub-agent, provide:
138152- the evidence files listed for those pages
139153- the planned links to nearby pages
140154
155+ Do not summarize, paraphrase, or compress the manual guidance when prompting
156+ writing sub-agents. Include the relevant manual text directly in the sub-agent
157+ prompt, including ` how-to-write.md ` , ` evidence.md ` , ` links.md ` , and every
158+ folder-specific manual needed for that batch.
159+
160+ Every writing sub-agent prompt must include the exact source frontmatter shape:
161+
162+ ``` yaml
163+ sources :
164+ - id : source-id
165+ type : file
166+ path : path/to/file.py
167+ ` ` `
168+
169+ Use ` type`, not `kind`. Directory evidence is still `type: file`; mark it with a
170+ trailing slash in `path`.
171+
141172When a batch contains pages from different folders, include every relevant
142173folder-specific manual in the sub-agent prompt.
143174
175+ A writing batch is not fully assigned until its sub-agent prompt includes the
176+ full manual packet and the exact source schema example.
177+
144178The sub-agent's task is to write encyclopedia-quality articles about this
145179codebase. Each page should feel like a focused Wikipedia article for one
146180codebase subject : it should define the subject, explain why it exists here, show
@@ -175,9 +209,10 @@ Use simple, direct prose. Avoid jargon when plain language works. Structure
175209sections so each page has a clear through line and later sections build on
176210earlier sections without simply repeating them.
177211
178- Use inline citations for non-obvious claims. Use Markdown links for related
179- wiki pages. Put relevant files and folders in ` sources: ` frontmatter entries
180- with ` type: file ` .
212+ Use inline citations for non-obvious claims. Put only cited evidence in
213+ ` sources:` frontmatter entries. Do not use `sources:` as a context list or
214+ bibliography. Every `sources:` entry must be cited in the page body with
215+ ` [@source-id]` , or removed. Directory source paths must end with `/`.
181216
182217Assign `almanac/getting-started.md` to a writing sub-agent as the front door to
183218the finished wiki. If it is drafted early, send it back to a writing or repair
@@ -202,6 +237,10 @@ missing citations, missing links between related pages, duplicate or overlapping
202237explanations, terminology drift, or wrong folder placement, dispatch repair
203238sub-agents with the exact pages and changes needed.
204239
240+ Run `codealmanac validate` before committing. If validation fails, do not commit.
241+ Fix validation issues first, rerun validation, and commit only after validation
242+ passes.
243+
205244Before stopping, make sure every missing planned page has an exact
206245repo-evidence removal reason in `coverage-map.md`, or write the missing page.
207246
0 commit comments