Please note, for the time being there will be a lot of force pushes onto the main branch. We will stop using force pushes as soon as the documentation was completely migrated.
We try to stick to British English.
- Use unabigous language.
- Be enjoyable to read.
- Vvoid personal speech.
- A confused reader is bad documentation.
- Don't take readers for fools.
- Strive to be as accessible as possible while retaining expressiveness.
- Start with a quick abstract what the page is going to teach.
- Use tips, notes, warnings, and dangers as required. They catch readers attention.
- Document all quirks and name them as such.