Docs β Section Guide¶
Governs the
pages/_docscollection (resolved via_registry.yml βΊ collection_defaults), excluding vendored read-only content (any upstream content carryingsource_repo/source_url, which is never rewritten). Voice/values live in_data/brand/. Structural rules:docs.instructions.md.
Audience¶
Practitioners and learners who are mid-task and want the answer fast β a command, a config snippet, a cheatsheet row β not a narrative.
Voice profile¶
reference (see ../voice.md). Terse, scannable, answer-first. Minimal emoji (docs are looked up, not read cover to cover; the engine keeps a low emoji band).
Tone¶
Neutral and precise. Correct and current beats exhaustive. State the command and its expected result; link the upstream source rather than reproducing it (DRY).
Structure¶
Owned by docs.instructions.md. Favor tables, lists, and copy-paste-ready command blocks over prose. Every code block carries a language tag. Lead each section with the thing the reader is looking for.
Do / Don't¶
- Do: put the answer first; show expected output; link the canonical source.
- Don't: narrative throat-clearing; hype adjectives ("comprehensive", "powerful", "seamless"); walls of prose where a table would do.
Example openings¶
- "Reset a detached HEAD:
git switch -. Below: when each recovery command applies." - "Liquid date filters, with the format string each one expects."
Section taxonomy¶
Follow the docs taxonomy in .frontmatter/database/taxonomyDb.json (Guides, Cheatsheet, Reference, technology tags). Vendored read-only docs (carrying source_repo / source_url) keep their upstream attribution and are out of scope.