my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

#1	---
#2	title: Contribution Hub
#3	description: "Follow the shared playbook for writing and updating Mem0 documentation."
#4	icon: "clipboard-list"
#5	---
#6
#7	# Build Mem0 Docs the Right Way
#8
#9	<Info>
#10	Who this is for
#11	- Contributors and LLM assistants updating the docs
#12	- Reviewers vetting new pages before publication
#13	- Maintainers syncing live docs with the template library
#14	</Info>
#15
#16	<Steps>
#17	<Step title="Review the standards">
#18	Check your team’s latest checklist or guidance so the update keeps the right navigation flow, CTA pattern, and language coverage.
#19	</Step>
#20	<Step title="Pick the right template">
#21	Select the doc type you are writing (quickstart, feature guide, migration, etc.) and copy the skeleton from the template library below.
#22	</Step>
#23	<Step title="Draft, verify, and note follow-ups">
#24	Fill the skeleton completely, include inline verification callouts, and jot down any open questions for maintainers before opening a PR.
#25	</Step>
#26	</Steps>
#27
#28	<Info icon="check">
#29	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).
#30	</Info>
#31
#32	## Template Library
#33
#34	Choose the document type you need. Each card links directly to the canonical template inside this repo.
#35
#36	<CardGroup cols={3}>
#37	<Card
#38	title="Quickstart"
#39	description="Install → Configure → Add → Search → Delete with Tabs + Steps."
#40	icon="rocket"
#41	href="/templates/quickstart_template"
#42	/>
#43	<Card
#44	title="Operation Guide"
#45	description="Single task walkthrough with verification checkpoints."
#46	icon="circle-check"
#47	href="/templates/operation_guide_template"
#48	/>
#49	<Card
#50	title="Feature Guide"
#51	description="Explain when and why to use a capability, not just the API."
#52	icon="sparkles"
#53	href="/templates/feature_guide_template"
#54	/>
#55	<Card
#56	title="Concept Guide"
#57	description="Define mental models, key terms, and diagrams."
#58	icon="brain"
#59	href="/templates/concept_guide_template"
#60	/>
#61	<Card
#62	title="Integration Guide"
#63	description="Configure Mem0 with third-party tools using shared Tabs + Steps."
#64	icon="plug"
#65	href="/templates/integration_guide_template"
#66	/>
#67	<Card
#68	title="Cookbook"
#69	description="Narrative end-to-end workflow with reusable snippets."
#70	icon="book-open"
#71	href="/templates/cookbook_template"
#72	/>
#73	<Card
#74	title="API Reference"
#75	description="Document endpoints with quick facts and dual-language examples."
#76	icon="code"
#77	href="/templates/api_reference_template"
#78	/>
#79	<Card
#80	title="Parameters Reference"
#81	description="Call out accepted fields, defaults, and misuse troubleshooting."
#82	icon="list"
#83	href="/templates/parameters_reference_template"
#84	/>
#85	<Card
#86	title="Migration Guide"
#87	description="Plan → Migrate → Validate with rollback steps."
#88	icon="arrow-right"
#89	href="/templates/migration_guide_template"
#90	/>
#91	<Card
#92	title="Release Notes"
#93	description="Ship highlights, stats, and mandatory CTA pair."
#94	icon="megaphone"
#95	href="/templates/release_notes_template"
#96	/>
#97	<Card
#98	title="Troubleshooting Playbook"
#99	description="Symptom → Diagnose → Fix with escalation tips."
#100	icon="life-buoy"
#101	href="/templates/troubleshooting_playbook_template"
#102	/>
#103	<Card
#104	title="Section Overview"
#105	description="Headline, card grid, and CTA pair for section landing pages."
#106	icon="grid"
#107	href="/templates/section_overview_template"
#108	/>
#109	</CardGroup>
#110
#111	## Contribution Checklist
#112
#113	<AccordionGroup>
#114	<Accordion title="Prep your draft">
#115	Confirm you copied the exact skeleton (`✅ COPY THIS` block) and removed every placeholder. Keep the DO-NOT-COPY guidance out of the published doc.
#116	</Accordion>
#117	<Accordion title="Mind the standards">
#118	Use Mintlify icons, include `<Info icon="check">` after runnable steps, and ensure Tabs show both Python and TypeScript (or justify the absence with `<Note>`).
#119	</Accordion>
#120	<Accordion title="Surface open questions early">
#121	Flag blockers or follow-up work in your PR description so reviewers know what to look for and can update project trackers as needed.
#122	</Accordion>
#123	</AccordionGroup>
#124
#125	<CardGroup cols={2}>
#126	<Card
#127	title="Browse Templates"
#128	description="Jump straight into the quickstart skeleton and switch tabs for other types."
#129	icon="clipboard-check"
#130	href="/templates/quickstart_template"
#131	/>
#132	<Card
#133	title="Return to Platform Overview"
#134	description="Jump back into the managed journey once you’re done editing."
#135	icon="compass"
#136	href="/platform/overview"
#137	/>
#138	</CardGroup>
#139

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public