These Markdown corpora are what codeaf looks up when explaining itself. This README is developer guidance outside both corpora; it is not a product page. The repository documentation map covers developer design, contributor rules and history.
| Corpus | Surface | Useful starting pages |
|---|---|---|
| chat/ | Chat in internal/tui3 over internal/session |
Getting started, capabilities, commands, keys |
| pages/ | Resident surface in internal/head and internal/resident |
What codeaf is, surfaces |
A mechanism shared by both surfaces needs an explanation in each corpus's own vocabulary. Do not merge the corpora or insert repository contribution rules into product answers. Runtime knowledge learned from saved chats is a separate system; its behavior is explained in Memory and knowledge from saved chats.
Use one # title per page and self-contained ## sections under about 2,000
characters. Put the words people ask in headings: headings are the retrieval
index. Each section should answer a concrete question without requiring the
previous section to be retrieved.
Document capabilities, commands, tools, keys, defaults, limits, refusals and recovery in the same change that alters them. Quote visible strings accurately. Remove obsolete denials when a feature becomes available. Explain user-visible behavior here; implementation ownership and design rationale belong in developer docs.
Keep existing page names stable unless retrieval evidence justifies a change. Long pages can be split by user intent, but preserve search coverage and validate both source and packed lookup. Do not perform an alphabetical reorganization of these folders merely to match the developer documentation categories.
make test-packed-manual manual-gatesUse the relevant existing retrieval tests as well. If a question reaches the
wrong page, improve its headings and content rather than weakening the test.
make build generates the ignored chat.pack.gz and pages.pack.gz archives;
commit source Markdown, not generated packs. See manual.go for the
corpus loading and packing entry points.