my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

#1	---
#2	title: Operation Guide Template
#3	description: "Checklist and skeleton for documenting a single Mem0 operation."
#4	icon: "circle-check"
#5	---
#6
#7	# Operation Guide Template
#8
#9	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.
#10
#11	---
#12
#13	## ❌ DO NOT COPY — Guidance & Constraints
#14	- Frontmatter needs `title`, `description`, `icon`. Title should be a verb phrase (“Add Memories”).
#15	- Lead with a two-sentence promise (problem → outcome), followed by an `<Info>` prerequisites block and optional `<Warning>` for hazards (overwrites, rate limits).
#16	- Include a “When to pick this” bullet list (≤3 items) so readers confirm they’re in the right doc.
#17	- Use Tabs with Python and TypeScript examples. If only one SDK exists, add a `<Note>` stating that explicitly.
#18	- When migrating legacy guides, keep existing code paths and notes—slot them into these sections instead of replacing them unless behavior changed.
#19	- Provide `<Info icon="check">` verification after each critical step; call out the most common error with a `<Warning>` close to where it can occur.
#20	- End with exactly two CTA cards: left = conceptual depth, right = applied example/cookbook.
#21
#22	---
#23
#24	## ✅ COPY THIS — Content Skeleton
#25
#26	````mdx
#27	---
#28	title: [Operation title]
#29	description: [Outcome in one sentence]
#30	icon: "bolt"
#31	---
#32
#33	# [Operation headline — say what it does]
#34
#35	[State the problem this solves.] [Explain the outcome after running it.]
#36
#37	<Info>
#38	Prerequisites
#39	- [API key, project, runtime requirements]
#40	- [Identifiers the reader needs ready]
#41	</Info>
#42
#43	<Warning>
#44	[Optional: describe the main risk, e.g., duplicates or destructive behavior.]
#45	</Warning>
#46
#47	## When to pick this
#48
#49	- [Scenario 1]
#50	- [Scenario 2]
#51	- [Scenario 3]
#52
#53	## Configure access
#54
#55	```bash
#56	export MEM0_API_KEY="sk-..."
#57	```
#58
#59	<Tip>
#60	Already configured Mem0? Skip this and move to the next section.
#61	</Tip>
#62
#63	## Prepare inputs
#64
#65	[Brief sentence describing payload requirements.]
#66
#67	<Tabs>
#68	<Tab title="Python">
#69	<CodeGroup>
#70	```python Python
#71	payload = {
#72	"user_id": "alex",
#73	"memory": "I am training for a marathon.",
#74	}
#75	```
#76	</CodeGroup>
#77	</Tab>
#78	<Tab title="TypeScript">
#79	<CodeGroup>
#80	```typescript TypeScript
#81	const payload = {
#82	userId: "alex",
#83	memory: "I am training for a marathon.",
#84	};
#85	```
#86	</CodeGroup>
#87	</Tab>
#88	</Tabs>
#89
#90	## Call the operation
#91
#92	<Tabs>
#93	<Tab title="Python">
#94	<CodeGroup>
#95	```python Python
#96	from mem0 import Memory
#97
#98	memory = Memory(api_key=os.environ["MEM0_API_KEY"])
#99	response = memory.add(payload)
#100	```
#101	</CodeGroup>
#102	</Tab>
#103	<Tab title="TypeScript">
#104	<CodeGroup>
#105	```typescript TypeScript
#106	import { Memory } from "mem0ai/oss";
#107
#108	const memory = new Memory({ apiKey: process.env.MEM0_API_KEY! });
#109	const response = await memory.add(payload);
#110	```
#111	</CodeGroup>
#112	</Tab>
#113	</Tabs>
#114
#115	<Info icon="check">
#116	Expect `{"memory_id": "mem_123"}` (or similar). Keep this ID for updates or deletes.
#117	</Info>
#118
#119	<Warning>
#120	`401 Unauthorized` usually means the API key is missing or scoped incorrectly.
#121	</Warning>
#122
#123	## Interpret the response
#124
#125	\| Field \| Description \|
#126	\| --- \| --- \|
#127	\| `memory_id` \| Use to update or delete later. \|
#128	\| `created_at` \| ISO 8601 timestamp for auditing. \|
#129
#130	<Tip>
#131	Need to upsert instead? Switch to the update operation and supply the `memory_id`.
#132	</Tip>
#133
#134	## Verify it worked
#135
#136	- Check the Mem0 dashboard for the new memory entry.
#137	- Run the search operation with the same `user_id` and confirm it appears in results.
#138
#139	## Common follow-ups
#140
#141	- [Link to parameter reference]
#142	- [Link to complementary operation]
#143	- [Link to troubleshooting playbook section]
#144
#145	{/* DEBUG: verify CTA targets */}
#146
#147	<CardGroup cols={2}>
#148	<Card
#149	title="[Concept guide]"
#150	description="[Deepen understanding of the operation’s model]"
#151	icon="layers"
#152	href="/[concept-link]"
#153	/>
#154	<Card
#155	title="[Applied cookbook]"
#156	description="[How to apply this operation in a workflow]"
#157	icon="rocket"
#158	href="/[cookbook-link]"
#159	/>
#160	</CardGroup>
#161	````
#162
#163	---
#164
#165	## ✅ Publish Checklist
#166	- [ ] Intro states problem + outcome, and prerequisites are complete.
#167	- [ ] Python and TypeScript snippets stay in sync (or a `<Note>` clarifies missing parity).
#168	- [ ] Every major step includes an actionable `<Info icon="check">`.
#169	- [ ] Warnings cover the most likely failure mode near where it occurs.
#170	- [ ] CTA pair is present with valid links (concept left, cookbook right).
#171
#172	## Browse Other Templates
#173
#174	<CardGroup cols={3}>
#175	<Card
#176	title="Quickstart"
#177	description="Install → Configure → Add → Search → Delete."
#178	icon="rocket"
#179	href="/templates/quickstart_template"
#180	/>
#181	<Card
#182	title="Operation Guide"
#183	description="Single task walkthrough with verification checkpoints."
#184	icon="circle-check"
#185	href="/templates/operation_guide_template"
#186	/>
#187	<Card
#188	title="Feature Guide"
#189	description="Explain when and why to use a capability, not just the API."
#190	icon="sparkles"
#191	href="/templates/feature_guide_template"
#192	/>
#193	<Card
#194	title="Concept Guide"
#195	description="Define mental models, key terms, and diagrams."
#196	icon="brain"
#197	href="/templates/concept_guide_template"
#198	/>
#199	<Card
#200	title="Integration Guide"
#201	description="Configure Mem0 alongside third-party tools."
#202	icon="plug"
#203	href="/templates/integration_guide_template"
#204	/>
#205	<Card
#206	title="Cookbook"
#207	description="Narrative, end-to-end walkthroughs."
#208	icon="book-open"
#209	href="/templates/cookbook_template"
#210	/>
#211	<Card
#212	title="API Reference"
#213	description="Endpoint specifics with dual-language examples."
#214	icon="code"
#215	href="/templates/api_reference_template"
#216	/>
#217	<Card
#218	title="Parameters Reference"
#219	description="Accepted fields, defaults, and misuse fixes."
#220	icon="list"
#221	href="/templates/parameters_reference_template"
#222	/>
#223	<Card
#224	title="Migration Guide"
#225	description="Plan → migrate → validate with rollback."
#226	icon="arrow-right"
#227	href="/templates/migration_guide_template"
#228	/>
#229	<Card
#230	title="Release Notes"
#231	description="Ship highlights and required CTAs."
#232	icon="megaphone"
#233	href="/templates/release_notes_template"
#234	/>
#235	<Card
#236	title="Troubleshooting Playbook"
#237	description="Symptom → diagnose → fix."
#238	icon="life-buoy"
#239	href="/templates/troubleshooting_playbook_template"
#240	/>
#241	<Card
#242	title="Section Overview"
#243	description="Landing pages with card grids and CTA pair."
#244	icon="grid"
#245	href="/templates/section_overview_template"
#246	/>
#247	</CardGroup>
#248
#249	<CardGroup cols={2}>
#250	<Card
#251	title="Contribution Hub"
#252	description="Review the authoring workflow and linked templates."
#253	icon="clipboard-list"
#254	href="/platform/contribute"
#255	/>
#256	<Card
#257	title="Docs Home"
#258	description="Return to the platform overview once you’re done."
#259	icon="compass"
#260	href="/platform/overview"
#261	/>
#262	</CardGroup>
#263

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public