my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

#1	---
#2	title: Quickstart Template
#3	description: "Guidance and skeleton for Mem0 quickstart documentation."
#4	icon: "rocket"
#5	---
#6
#7	# Quickstart Template
#8
#9	Quickstarts are the fastest path to first success. Each page should configure the minimum viable setup for its section, execute one complete add/search/delete loop, and hand readers off to deeper docs once the core flow succeeds.
#10
#11	---
#12
#13	## ❌ DO NOT COPY — Guidance & Constraints
#14	- Keep the intro tight: one-sentence promise + `<Info>` prerequisites. Add `<Warning>` only for blocking requirements (e.g., “requires paid tier”).
#15	- Default to Python + TypeScript examples inside `<Tabs>` with `<Steps>` per language. If a second language truly doesn’t exist, add a `<Note>` explaining why.
#16	- Every journey must follow Install → Configure → Add → Search → Delete (or closest equivalents). Drop verification `<Info icon="check">` immediately after the critical operation.
#17	- When migrating an existing quickstart, reuse canonical snippets and screenshots—reshape them into this flow rather than rewriting content unless the product changed.
#18	- If you include a Mermaid diagram, keep it optional and render left-to-right (`graph LR`) so it doesn’t flood the page.
#19	- End with exactly two CTA cards: left = related/alternative path, right = next step in the journey. No link farms.
#20
#21	---
#22
#23	## ✅ COPY THIS — Content Skeleton
#24	Paste the block below into a new quickstart, then replace every placeholder. Remove optional sections only after the happy path is working.
#25
#26	````mdx
#27	---
#28	title: [Quickstart title — action focused]
#29	description: [1 sentence outcome]
#30	icon: "rocket"
#31	estimatedTime: "[~X minutes]"
#32	---
#33
#34	# [Hero headline — promise the win]
#35
#36	<Info>
#37	Prerequisites
#38	- [SDK/Runtime requirement]
#39	- [API key or account requirement]
#40	- [Any optional tooling the reader might want]
#41	</Info>
#42
#43	<Tip>
#44	[Optional: cross-link to OSS or platform alternative if applicable. Delete if unused.]
#45	</Tip>
#46
#47	{/* Optional: delete if not needed */}
#48	```mermaid
#49	graph LR
#50	A[Install] */} B[Configure keys]
#51	B */} C[Add memory]
#52	C */} D[Search]
#53	D */} E[Delete]
#54	```
#55
#56	## Install dependencies
#57
#58	<Tabs>
#59	<Tab title="Python">
#60	<Steps>
#61	<Step title="Install the SDK">
#62	```bash
#63	pip install [package-name]
#64	```
#65	</Step>
#66	</Steps>
#67	</Tab>
#68	<Tab title="TypeScript">
#69	<Steps>
#70	<Step title="Install the SDK">
#71	```bash
#72	npm install [package-name]
#73	```
#74	</Step>
#75	</Steps>
#76	</Tab>
#77	</Tabs>
#78
#79	[Explain why the install matters in one sentence.]
#80
#81	## Configure access
#82
#83	<Tabs>
#84	<Tab title="Python">
#85	<Steps>
#86	<Step title="Set environment variables">
#87	```bash
#88	export MEM0_API_KEY="sk-..."
#89	```
#90	</Step>
#91	<Step title="Initialize the client">
#92	```python
#93	from mem0 import Memory
#94
#95	memory = Memory(api_key="sk-...")
#96	```
#97	</Step>
#98	</Steps>
#99	</Tab>
#100	<Tab title="TypeScript">
#101	<Steps>
#102	<Step title="Set environment variables">
#103	```bash
#104	export MEM0_API_KEY="sk-..."
#105	```
#106	</Step>
#107	<Step title="Initialize the client">
#108	```typescript
#109	import { Memory } from "mem0ai";
#110
#111	const memory = new Memory({ apiKey: process.env.MEM0_API_KEY! });
#112	```
#113	</Step>
#114	</Steps>
#115	</Tab>
#116	</Tabs>
#117
#118	<Warning>
#119	[Optional: call out the most common setup failure and how to fix it.]
#120	</Warning>
#121
#122	## Add your first memory
#123
#124	<Tabs>
#125	<Tab title="Python">
#126	<Steps>
#127	<Step title="Send a conversation">
#128	```python
#129	messages = [
#130	{"role": "user", "content": "Hi, I'm Alex and I love basketball."},
#131	{"role": "assistant", "content": "Noted! I'll remember that."},
#132	]
#133
#134	memory.add(messages, user_id="alex")
#135	```
#136	</Step>
#137	</Steps>
#138	</Tab>
#139	<Tab title="TypeScript">
#140	<Steps>
#141	<Step title="Send a conversation">
#142	```typescript
#143	const messages = [
#144	{ role: "user", content: "Hi, I'm Alex and I love basketball." },
#145	{ role: "assistant", content: "Noted! I'll remember that." },
#146	];
#147
#148	await memory.add(messages, { userId: "alex" });
#149	```
#150	</Step>
#151	</Steps>
#152	</Tab>
#153	</Tabs>
#154
#155	<Info icon="check">
#156	Expected output: `[Describe the success log or console output]`. If you see `[common error]`, jump to the troubleshooting section.
#157	</Info>
#158
#159	## Search the memory
#160
#161	<Tabs>
#162	<Tab title="Python">
#163	<Steps>
#164	<Step title="Query the memory">
#165	```python
#166	result = memory.search("What does Alex like?", filters={"user_id": "alex"})
#167	print(result)
#168	```
#169	</Step>
#170	</Steps>
#171	</Tab>
#172	<Tab title="TypeScript">
#173	<Steps>
#174	<Step title="Query the memory">
#175	```typescript
#176	const result = await memory.search("What does Alex like?", { userId: "alex" });
#177	console.log(result);
#178	```
#179	</Step>
#180	</Steps>
#181	</Tab>
#182	</Tabs>
#183
#184	<Info icon="check">
#185	You should see `[show the key fields]`. Screenshot or paste real output when possible.
#186	</Info>
#187
#188	## Delete the memory
#189
#190	<Tabs>
#191	<Tab title="Python">
#192	<Steps>
#193	<Step title="Clean up">
#194	```python
#195	memory.delete_all(user_id="alex")
#196	```
#197	</Step>
#198	</Steps>
#199	</Tab>
#200	<Tab title="TypeScript">
#201	<Steps>
#202	<Step title="Clean up">
#203	```typescript
#204	await memory.deleteAll({ userId: "alex" });
#205	```
#206	</Step>
#207	</Steps>
#208	</Tab>
#209	</Tabs>
#210
#211	## Quick recovery
#212
#213	- `[Error message]` → `[One-line fix or link to troubleshooting guide]`
#214	- `[Second error]` → `[How to resolve]`
#215
#216	{/* DEBUG: verify CTA targets */}
#217
#218	<CardGroup cols={2}>
#219	<Card
#220	title="[Related/alternate path]"
#221	description="[Why it’s worth exploring next]"
#222	icon="sparkles"
#223	href="/[related-link]"
#224	/>
#225	<Card
#226	title="[Next step in the journey]"
#227	description="[Set expectation for what they’ll learn]"
#228	icon="rocket"
#229	href="/[next-link]"
#230	/>
#231	</CardGroup>
#232	````
#233
#234	---
#235
#236	## ✅ Publish Checklist
#237	- [ ] Replace every placeholder and delete unused sections (`<Tip>`, Mermaid diagram, etc.).
#238	- [ ] Python and TypeScript tabs render correctly (or you added a `<Note>` explaining a missing language).
#239	- [ ] Each major step includes an inline verification `<Info icon="check">`.
#240	- [ ] Quick recovery section lists at least two common issues.
#241	- [ ] Final `<CardGroup>` has exactly two cards (related on the left, next step on the right).
#242	- [ ] Links, commands, and code snippets were tested or clearly marked if hypothetical.
#243
#244	## Browse Other Templates
#245
#246	<CardGroup cols={3}>
#247	<Card
#248	title="Quickstart"
#249	description="Install → Configure → Add → Search → Delete."
#250	icon="rocket"
#251	href="/templates/quickstart_template"
#252	/>
#253	<Card
#254	title="Operation Guide"
#255	description="Single task walkthrough with verification checkpoints."
#256	icon="circle-check"
#257	href="/templates/operation_guide_template"
#258	/>
#259	<Card
#260	title="Feature Guide"
#261	description="Explain when and why to use a capability, not just the API."
#262	icon="sparkles"
#263	href="/templates/feature_guide_template"
#264	/>
#265	<Card
#266	title="Concept Guide"
#267	description="Define mental models, key terms, and diagrams."
#268	icon="brain"
#269	href="/templates/concept_guide_template"
#270	/>
#271	<Card
#272	title="Integration Guide"
#273	description="Configure Mem0 alongside third-party tools."
#274	icon="plug"
#275	href="/templates/integration_guide_template"
#276	/>
#277	<Card
#278	title="Cookbook"
#279	description="Narrative, end-to-end walkthroughs."
#280	icon="book-open"
#281	href="/templates/cookbook_template"
#282	/>
#283	<Card
#284	title="API Reference"
#285	description="Endpoint specifics with dual-language examples."
#286	icon="code"
#287	href="/templates/api_reference_template"
#288	/>
#289	<Card
#290	title="Parameters Reference"
#291	description="Accepted fields, defaults, and misuse fixes."
#292	icon="list"
#293	href="/templates/parameters_reference_template"
#294	/>
#295	<Card
#296	title="Migration Guide"
#297	description="Plan → migrate → validate with rollback."
#298	icon="arrow-right"
#299	href="/templates/migration_guide_template"
#300	/>
#301	<Card
#302	title="Release Notes"
#303	description="Ship highlights and required CTAs."
#304	icon="megaphone"
#305	href="/templates/release_notes_template"
#306	/>
#307	<Card
#308	title="Troubleshooting Playbook"
#309	description="Symptom → diagnose → fix."
#310	icon="life-buoy"
#311	href="/templates/troubleshooting_playbook_template"
#312	/>
#313	<Card
#314	title="Section Overview"
#315	description="Landing pages with card grids and CTA pair."
#316	icon="grid"
#317	href="/templates/section_overview_template"
#318	/>
#319	</CardGroup>
#320
#321	<CardGroup cols={2}>
#322	<Card
#323	title="Contribution Hub"
#324	description="Review the authoring workflow and linked templates."
#325	icon="clipboard-list"
#326	href="/platform/contribute"
#327	/>
#328	<Card
#329	title="Docs Home"
#330	description="Return to the platform overview once you’re done."
#331	icon="compass"
#332	href="/platform/overview"
#333	/>
#334	</CardGroup>
#335

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public