1f929dfc7f
* don't run for generated docusaurus * format * workflow to autoupdate docs version * fix versioning * add link back to app * remove old docs * html link??? * don't track .docusaurus * documantation build
35 lines
698 B
Markdown
35 lines
698 B
Markdown
---
|
|
id: documentation-style-guide
|
|
title: Documentation Style Guide
|
|
description: Standards for writing user-facing docs in this repository.
|
|
sidebar_position: 2
|
|
---
|
|
|
|
Use this structure for feature pages:
|
|
|
|
1. **What it is**
|
|
2. **Why it exists**
|
|
3. **How to use it**
|
|
4. **Common problems**
|
|
5. **Related pages**
|
|
|
|
## Frontmatter requirements
|
|
|
|
Every doc should include:
|
|
|
|
- `id`
|
|
- `title`
|
|
- `description`
|
|
- `sidebar_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.
|