698 B
698 B
id, title, description, sidebar_position
| id | title | description | sidebar_position |
|---|---|---|---|
| documentation-style-guide | Documentation Style Guide | Standards for writing user-facing docs in this repository. | 2 |
Use this structure for feature pages:
- What it is
- Why it exists
- How to use it
- Common problems
- Related pages
Frontmatter requirements
Every doc should include:
idtitledescriptionsidebar_position
Writing rules
- Prefer concrete steps over abstract prose.
- Provide copy-pasteable examples.
- State defaults and constraints explicitly.
- Link related docs using
/docs/...URLs.
PR expectations
Any user-visible behavior change should include matching docs updates.