DOCS: Document our documentation standards
Open
docs
- Dominant language
- Python
- Stars
- 917
- Forks
- 98
- PR merge metrics
- No merged PRs in 30d
Description
There are some unwritten rules on how we document that should be added somewhere, written better than I do here:
- All code examples need to work with copy/paste. That means all objects need to be imported or created
- Title case for section headers
- Concise text with plain English over long explanations with fancy words
- Names used in examples should be Aang, Katara, Sokka, etc
Contributor guide
Assessment
This issue has not been assessed yet.