diff --git a/.claude/skills/write-docs/SKILL.md b/.claude/skills/write-docs/SKILL.md index 6ff4d736d5..ac593ad3e1 100644 --- a/.claude/skills/write-docs/SKILL.md +++ b/.claude/skills/write-docs/SKILL.md @@ -57,6 +57,8 @@ AI Transport is the testbed for the new principles. Other Ably products will ali Pick the template that matches the page you are writing. +**Templates describe structure, not headings.** The numbered items below are the *section shape* — what each section covers and roughly in what order. They are not the literal H2 text for the page. A concept-page template item like "Problem statement" becomes a descriptive imperative on the page itself: `## Why Runs exist`, `## Why sessions exist`. "Model" becomes `## Understand the Run lifecycle`, `## Understand sessions and channels`. "Code proof" becomes `## Trigger a Run`, `## Attach to a session`. Adapt the heading to the specific concept; never copy the template label verbatim. Use imperative or descriptive verb phrases per the writing-style guide. + ### Feature page A feature page maps to one developer JTBD. The section order below distils the structural pattern feature pages follow. @@ -380,6 +382,13 @@ grep -rn -E "key\s*:\s*['\"][^'\"]+['\"]" "$P" | grep -v authUrl # No "docs under construction" / WIP markers grep -rni "under construction\|coming soon\|todo:\|wip\b" "$P" +# Every H2 carries an inline anchor (CLAUDE.md convention: `## Heading `) +for f in "$P"/*.mdx; do + total=$(grep -c "^## " "$f") + anchored=$(grep -cE '^## .* ` used sparingly and load-bearing. No decorative asides. -17. Internal links resolve. No references to URLs that only exist in `redirect_from` frontmatter. +15. Every H2 carries an inline anchor — `## Heading `, per the CLAUDE.md convention. Use the H2-anchor grep above. +16. Section headings are descriptive imperatives or noun phrases tied to the specific content, not template labels copied verbatim (no `## The model`, `## The problem X solves`, `## Code proof`). +17. New page added to the relevant nav file under `src/data/nav/`. +18. `