Documentation Rules

All documentation in English. Root README concise, detailed docs in `/docs`.

Stars 10

Forks 1

Install this agent skill to your Project

npx add-skill https://github.com/hivellm/rulebook/tree/main/templates/skills/core/documentation-rules

SKILL.md

Documentation Standards

CRITICAL: All documentation in English. Root README concise, detailed docs in /docs.

Structure

Root-Level (ONLY):

All Other Docs in /docs:

Type	Update
`feat`	README features, API docs, CHANGELOG "Added"
`fix`	Troubleshooting, CHANGELOG "Fixed"
`breaking`	CHANGELOG + migration guide, version docs
`perf`	Benchmarks, CHANGELOG "Performance"
`security`	SECURITY.md, CHANGELOG "Security"
`docs`	Verify spelling/links only
`refactor`	Update if behavior changed

bash

markdownlint **/*.md         # Lint markdown
markdown-link-check **/*.md  # Check links
codespell **/*.md            # Spell check

MUST pass before commit (see AGENT_AUTOMATION).