Cookbook Template
Cookbooks are narrative tutorials. They start with a real problem, show the broken path, then layer production-ready fixes. Use this template verbatim so every contributor (human or LLM) ships the same experience.❌ DO NOT COPY: Guidance & Constraints
- Tell a story: problem → broken demo → iterative fixes → production patterns.
- Keep tone conversational; use real names (“Max”, “Sarah”), not
user_123. - Opening must stay tight: ≤2 short paragraphs (no bullet lists) before the first section.
- Inline expected outputs immediately after each code block.
- When modernizing an existing cookbook, keep the narrative beats, screenshots, and sample outputs. Reshape them into this arc instead of rewriting unless the workflow changed.
- Limit callouts to 3–5 per page. Prefer narrative text over stacked boxes.
- Always provide Python and TypeScript tabs when an SDK exists for both.
- Every page must end with exactly two navigation cards (left = related/side quest, right = next cookbook in the journey).
✅ COPY THIS: Content Skeleton
Paste the block below into a new cookbook, then replace all placeholders. Remove any section you don’t need only after the happy path works.✅ Publish Checklist (Keep Handy)
- Replace every
[placeholder]and remove unused sections. - Python & TypeScript code compile (or TypeScript omitted with explicit
<Note>stating language limitation). - Each code block is followed by output +
<Info icon="check">or inline equivalent. - Callouts ≤ 5 total; no emoji, only Mintlify icons.
- Exactly two cards in the final
<CardGroup cols={2}>. - Added verification narrative (what success looks like) in every major step.
- Linked related docs (cookbooks, guides, reference) in Next Steps.