The site configuration and navigation layout are defined in ./mkdocs.yml. The navigation sections follow the Diátaxis framework, with four main areas:
- Concepts (known as 'Explanation' in Diátaxis)
- APIs & Reference
- Tutorials
- Guides
When adding new documentation, take a moment to consider which area the document belongs to. You can use the Diátaxis compass to help answer that question. If you are unsure, raise an issue, create a PR anyways to invite discussion, or reach out on the #kuadrant slack channel.
When writing content, refer to the ./style_guide.md for writing style guidelines, tips and examples.