The main page must have the following structure:

Structure


Intro

Start the page with a short introduction (2–3 paragraphs max), explaining what it is, why it exists, and what problem it solves.
Use real context to show relevance.

Why use it?

Highlight the benefits, differentials, and ideal use cases. Feel free to include:
  • Performance gains
  • Security improvements
  • Compliance value
  • Real-world scenarios

Key concepts

Define the most important terms, roles, or components. This section builds shared understanding and avoids ambiguity.

Technical Specs

Document the implementation details developers need to know. Include:
  • Required environment or dependencies
  • Data models or schemas
  • Internal validation rules
  • Configuration variables

Best Practices

Offer practical advice to help users use the product safely and efficiently. Include tips on security, performance, and common pitfalls.