Overview

Best Practices for Overview Pages

Keep it high-level and conceptual - explain WHAT and WHY, not HOW. NO code examples - save those for quickstart and guides. Use CoolCards to visually organize key concepts. Focus on benefits, use cases, and core concepts. Keep language accessible to non-technical readers. Reference: See agent-quickstart.md for quickstart examples.

What is Feature Name

[Start with a clear, concise explanation of what this feature is. Use 2-3 sentences to establish the core concept. Avoid technical jargon - focus on the value and purpose.]

Key Concepts

Use CoolCards to break down the main concepts. Each card should represent a distinct aspect of the feature. schemas and plots are better than text

Concept 1

[Brief explanation of the first key concept. Focus on what it is and why it matters, not how to implement it.]

Concept 2

[Brief explanation of the second key concept. Keep it conceptual and high-level.]

Concept 3

[Brief explanation of the third key concept. Explain the benefit or use case.]

How It Works

[Provide a high-level explanation of how the feature works, but without code. Use diagrams, flow descriptions, or conceptual explanations. Focus on the flow and relationships between components.]

Use Cases

[Describe 2-3 common use cases or scenarios where this feature would be valuable. Keep descriptions brief and focused on the business value or user benefit.]

Quickstart link

[Guide readers to the next documentation page - typically the quickstart. Keep this brief and action-oriented.]

Ready to get started? Follow the Quickstart guide to use this feature in 3 minutes.

FAQ

[Answer to the first common question. Provide a clear, actionable answer. Include examples if helpful, but keep it concise.]

[If needed, add code examples or additional context:]

// Example if relevant

[Answer explaining behavior, edge cases, or common scenarios.]

[Answer about capabilities, limitations, or alternatives.]

[Answer explaining reasoning, best practices, or troubleshooting tips.]