Page structure

The page structure is up to you, but for consistency, usability, and accessibility, we recommend the following guidelines.

Content order

Pages should be structured roughly as follows:

1. Brief 1-2 sentence introduction. Similar to a dictionary definition.
2. Links to required reading for understanding this page (if absolutely necessary.)
3. Example based on a real-life software scenario. (For example a video player or login, not a dog or foo and bar.)
4. Further explanation of any details or nuances. (If necessary.)
5. How-tos, step-by-step instructions, or code examples with accompanying explanations. (If necessary.)
6. Any further information required for specific or unusual use cases. (If necessary.)
7. Related resources (If useful.)
8. General further resources (If useful.)