Build Mem0 Docs the Right Way
Who this is for
- Contributors and LLM assistants updating the docs
- Reviewers vetting new pages before publication
- Maintainers syncing live docs with the template library
1
Review the standards
Check your teamβs latest checklist or guidance so the update keeps the right navigation flow, CTA pattern, and language coverage.
2
Pick the right template
Select the doc type you are writing (quickstart, feature guide, migration, etc.) and copy the skeleton from the template library below.
3
Draft, verify, and note follow-ups
Fill the skeleton completely, include inline verification callouts, and jot down any open questions for maintainers before opening a PR.
When previewing locally, confirm the page ends with exactly two CTA cards, includes both Python and TypeScript examples when they exist, and keeps all Mintlify icons (no emojis).
Template Library
Choose the document type you need. Each card links directly to the canonical template inside this repo.Quickstart
Operation Guide
Feature Guide
Concept Guide
Integration Guide
Cookbook
API Reference
Parameters Reference
Migration Guide
Release Notes
Troubleshooting Playbook
Section Overview
Contribution Checklist
Prep your draft
Prep your draft
Confirm you copied the exact skeleton (
β
COPY THIS block) and removed every placeholder. Keep the DO-NOT-COPY guidance out of the published doc.Mind the standards
Mind the standards
Use Mintlify icons, include
<Info icon="check"> after runnable steps, and ensure Tabs show both Python and TypeScript (or justify the absence with <Note>).Surface open questions early
Surface open questions early
Flag blockers or follow-up work in your PR description so reviewers know what to look for and can update project trackers as needed.