Skip to main content

Quickstart Template

Quickstarts are the fastest path to first success. Each page should configure the minimum viable setup for its section, execute one complete add/search/delete loop, and hand readers off to deeper docs once the core flow succeeds.

❌ DO NOT COPY: Guidance & Constraints

  • Keep the intro tight: one-sentence promise + <Info> prerequisites. Add <Warning> only for blocking requirements (e.g., “requires paid tier”).
  • Default to Python + TypeScript examples inside <Tabs> with <Steps> per language. If a second language truly doesn’t exist, add a <Note> explaining why.
  • Every journey must follow Install → Configure → Add → Search → Delete (or closest equivalents). Drop verification <Info icon="check"> immediately after the critical operation.
  • When migrating an existing quickstart, reuse canonical snippets and screenshots. Reshape them into this flow rather than rewriting content unless the product changed.
  • If you include a Mermaid diagram, keep it optional and render left-to-right (graph LR) so it doesn’t flood the page.
  • End with exactly two CTA cards: left = related/alternative path, right = next step in the journey. No link farms.

✅ COPY THIS: Content Skeleton

Paste the block below into a new quickstart, then replace every placeholder. Remove optional sections only after the happy path is working.

✅ Publish Checklist

  • Replace every placeholder and delete unused sections (<Tip>, Mermaid diagram, etc.).
  • Python and TypeScript tabs render correctly (or you added a <Note> explaining a missing language).
  • Each major step includes an inline verification <Info icon="check">.
  • Quick recovery section lists at least two common issues.
  • Final <CardGroup> has exactly two cards (related on the left, next step on the right).
  • Links, commands, and code snippets were tested or clearly marked if hypothetical.

Browse Other Templates

Quickstart

Operation Guide

Feature Guide

Concept Guide

Integration Guide

Cookbook

API Reference

Parameters Reference

Migration Guide

Release Notes

Troubleshooting Playbook

Section Overview

Contribution Hub

Docs Home