Skip to main content

Operation Guide Template

Operation guides focus on a single action (add, search, update, delete). Show the minimal path to execute it, verify the result, and route readers to references or applied guides.

❌ DO NOT COPY: Guidance & Constraints

  • Frontmatter needs title, description, icon. Title should be a verb phrase (“Add Memories”).
  • Lead with a two-sentence promise (problem → outcome), followed by an <Info> prerequisites block and optional <Warning> for hazards (overwrites, rate limits).
  • Include a “When to pick this” bullet list (≤3 items) so readers confirm they’re in the right doc.
  • Use Tabs with Python and TypeScript examples. If only one SDK exists, add a <Note> stating that explicitly.
  • When migrating legacy guides, keep existing code paths and notes. Slot them into these sections instead of replacing them unless behavior changed.
  • Provide <Info icon="check"> verification after each critical step; call out the most common error with a <Warning> close to where it can occur.
  • End with exactly two CTA cards: left = conceptual depth, right = applied example/cookbook.

✅ COPY THIS: Content Skeleton


✅ Publish Checklist

  • Intro states problem + outcome, and prerequisites are complete.
  • Python and TypeScript snippets stay in sync (or a <Note> clarifies missing parity).
  • Every major step includes an actionable <Info icon="check">.
  • Warnings cover the most likely failure mode near where it occurs.
  • CTA pair is present with valid links (concept left, cookbook right).

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