---
title: Section Overview Template
description: "Blueprint for landing pages with headline, card grid, and CTAs."
icon: "grid"
---

# Section Overview Template

Overview pages orient readers for an entire section. Summarize who it’s for, surface the core journeys, and end with a clear “build vs explore” CTA pair.

---

## ❌ DO NOT COPY — Guidance & Constraints
- Frontmatter must include `title`, `description`, `icon`. Keep the hero paragraph under two sentences describing audience + outcome.
- Provide an `<Info>` block pointing to the primary entry point (usually the quickstart). Use `<Warning>` only for major caveats (beta, deprecation).
- Stage journeys in 4–6 cards total. Break into multiple `<CardGroup>` rows when a binary choice (e.g., Python vs Node) or stacked journeys reads better. Keep copy ≤15 words with icons + links.
- When migrating an existing overview, reuse the established journeys, images, and stats—reshape them into this layout rather than cutting content unless it’s outdated.
- Optional accordions (`<AccordionGroup>`) can tuck detailed tables (feature breakdowns, comparisons) beneath the hero when extra context is helpful.
- Optional visuals (comparison table, Mermaid diagram) should be left-to-right and only added when they reduce confusion.
- Finish with exactly two CTA cards: left = adjacent/alternative track, right = next logical step deeper in the section.

---

## ✅ COPY THIS — Content Skeleton

````mdx
---
title: [Section name] Overview
description: [30-second summary of what lives in this section]
icon: "compass"
---

# [Section] Overview

[State who this section is for.] [Explain what they’ll accomplish after browsing these docs.]

<Info>
  Start with [Quickstart link] if you’re new, then choose a deeper topic below.
</Info>

{/* Optional: delete if not needed */}
<AccordionGroup>
  <Accordion title="[Optional value table]" icon="sparkles">
    | Feature | Why it helps |
    | --- | --- |
    | ... | ... |
  </Accordion>
</AccordionGroup>

{/* Optional: delete if not needed */}
```mermaid
graph LR
  A[Get set up] */} B[Learn concepts]
  B */} C[Build workflows]
  C */} D[Support & scale]
```

## Choose your path

{/* Use multiple rows if a 2-up decision helps */}
<CardGroup cols={2}>
  <Card title="[Decision 1]" icon="rocket" href="/[link-1]">
    [One-line outcome]
  </Card>
  <Card title="[Decision 2]" icon="brain" href="/[link-2]">
    [One-line outcome]
  </Card>
</CardGroup>

<CardGroup cols={3}>
  <Card title="[Journey 1]" icon="sparkles" href="/[link-3]">
    [One-line outcome]
  </Card>
  <Card title="[Journey 2]" icon="gear" href="/[link-4]">
    [One-line outcome]
  </Card>
  <Card title="[Journey 3]" icon="book" href="/[link-5]">
    [One-line outcome]
  </Card>
</CardGroup>

{/* Duplicate another CardGroup (2 or 3 columns) if you need more coverage, but keep the total ≤6 cards. */}

<Tip>
  [Optional cross-link, e.g., “Self-hosting? Jump to the OSS overview.”] Delete if unused.
</Tip>

## Keep going

{/* DEBUG: verify CTA targets */}

<CardGroup cols={2}>
  <Card
    title="[Alternative or adjacent track]"
    description="[Why it might be the better next step]"
    icon="arrows-left-right"
    href="/[alternate-link]"
  />
  <Card
    title="[Next deep dive]"
    description="[What they’ll build or learn next]"
    icon="rocket"
    href="/[next-link]"
  />
</CardGroup>
````

---

## ✅ Publish Checklist
- [ ] Hero paragraph states audience + outcome; `<Info>` points to the primary entry point.
- [ ] Card grid lists 4–6 journeys with concise copy and valid icons/links.
- [ ] Optional visuals (tables/Mermaid) are LR and actually clarify the flow.
- [ ] CTA pair present with related alternative on the left and next logical step on the right.
- [ ] All placeholders and unused callouts removed before publishing.

## Browse Other Templates

<CardGroup cols={3}>
  <Card
    title="Quickstart"
    description="Install → Configure → Add → Search → Delete."
    icon="rocket"
    href="/templates/quickstart_template"
  />
  <Card
    title="Operation Guide"
    description="Single task walkthrough with verification checkpoints."
    icon="circle-check"
    href="/templates/operation_guide_template"
  />
  <Card
    title="Feature Guide"
    description="Explain when and why to use a capability, not just the API."
    icon="sparkles"
    href="/templates/feature_guide_template"
  />
  <Card
    title="Concept Guide"
    description="Define mental models, key terms, and diagrams."
    icon="brain"
    href="/templates/concept_guide_template"
  />
  <Card
    title="Integration Guide"
    description="Configure Deja Vu alongside third-party tools."
    icon="plug"
    href="/templates/integration_guide_template"
  />
  <Card
    title="Cookbook"
    description="Narrative, end-to-end walkthroughs."
    icon="book-open"
    href="/templates/cookbook_template"
  />
  <Card
    title="API Reference"
    description="Endpoint specifics with dual-language examples."
    icon="code"
    href="/templates/api_reference_template"
  />
  <Card
    title="Parameters Reference"
    description="Accepted fields, defaults, and misuse fixes."
    icon="list"
    href="/templates/parameters_reference_template"
  />
  <Card
    title="Migration Guide"
    description="Plan → migrate → validate with rollback."
    icon="arrow-right"
    href="/templates/migration_guide_template"
  />
  <Card
    title="Release Notes"
    description="Ship highlights and required CTAs."
    icon="megaphone"
    href="/templates/release_notes_template"
  />
  <Card
    title="Troubleshooting Playbook"
    description="Symptom → diagnose → fix."
    icon="life-buoy"
    href="/templates/troubleshooting_playbook_template"
  />
  <Card
    title="Section Overview"
    description="Landing pages with card grids and CTA pair."
    icon="grid"
    href="/templates/section_overview_template"
  />
</CardGroup>

<CardGroup cols={2}>
  <Card
    title="Contribution Hub"
    description="Review the authoring workflow and linked templates."
    icon="clipboard-list"
    href="/platform/contribute"
  />
  <Card
    title="Docs Home"
    description="Return to the platform overview once you’re done."
    icon="compass"
    href="/platform/overview"
  />
</CardGroup>
