my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

my-project-public — gitlawb

#1	---
#2	title: Cookbook Template
#3	description: "Narrative recipe structure for end-to-end Mem0 workflows."
#4	icon: "book-open"
#5	---
#6
#7	# Cookbook Template
#8
#9	Cookbooks are narrative tutorials. They start with a real problem, show the broken path, then layer production-ready fixes. Use this template verbatim so every contributor (human or LLM) ships the same experience.
#10
#11	---
#12
#13	## ❌ DO NOT COPY — Guidance & Constraints
#14	- Tell a story: problem → broken demo → iterative fixes → production patterns.
#15	- Keep tone conversational; use real names ("Max", "Sarah"), not `user_123`.
#16	- Opening must stay tight: ≤2 short paragraphs (no bullet lists) before the first section.
#17	- Inline expected outputs immediately after each code block.
#18	- When modernizing an existing cookbook, keep the narrative beats, screenshots, and sample outputs—reshape them into this arc instead of rewriting unless the workflow changed.
#19	- Limit callouts to 3–5 per page. Prefer narrative text over stacked boxes.
#20	- Always provide Python and TypeScript tabs when an SDK exists for both.
#21	- Every page must end with exactly two navigation cards (left = related/side quest, right = next cookbook in the journey).
#22
#23	---
#24
#25	## ✅ COPY THIS — Content Skeleton
#26	Paste the block below into a new cookbook, then replace all placeholders. Remove any section you don't need only after the happy path works.
#27
#28	```mdx
#29	---
#30	title: [Cookbook title — action oriented]
#31	description: [1 sentence outcome]
#32	---
#33
#34	# [Hero headline]
#35
#36	[Two sentences max: state the user's pain and what this cookbook will fix.]
#37
#38	<Tip>
#39	[Only include if you truly have launch news. Delete otherwise to keep the intro crisp.]
#40	</Tip>
#41
#42	<Info icon="clock">
#43	Time to complete: [~X minutes] · Languages: Python, TypeScript
#44	</Info>
#45
#46	## Setup
#47
#48	```python
#49	default_language = "python" # replace with real imports
#50	```
#51	```typescript
#52	// Equivalent TypeScript setup goes here
#53	```
#54
#55	<Note>
#56	Mention any prerequisites (API keys, environment variables) right here if the reader must do something before running code.
#57	</Note>
#58
#59	## Make It Work Once
#60
#61	[Set context with characters + goal.]
#62
#63	```python
#64	# Happy-path example
#65	```
#66	```typescript
#67	// Happy-path example (TypeScript)
#68	```
#69
#70	<Info icon="check">
#71	Expected output (Python): `[describe inline]` · Expected output (TypeScript): `[describe inline]`
#72	</Info>
#73
#74	## The Problem
#75
#76	[Explain what breaks without tuning.]
#77
#78	```python
#79	# Broken behaviour
#80	```
#81	```typescript
#82	// Broken behaviour
#83	```
#84
#85	Output:
#86	```
#87	[Paste noisy output]
#88	```
#89
#90	[One sentence on why the result is unacceptable.]
#91
#92	## Fix It – [Solution Name]
#93
#94	[Explain the fix and why it helps.]
#95
#96	```python
#97	# Improved implementation
#98	```
#99	```typescript
#100	// Improved implementation
#101	```
#102
#103	Retest:
#104	```python
#105	# Same test as before
#106	```
#107	```typescript
#108	// Same test as before
#109	```
#110
#111	Output:
#112	```
#113	[Cleaner result]
#114	```
#115
#116	[Highlight the improvement + remaining gap if any.]
#117
#118	## Build On It – [Second Layer]
#119
#120	[Add another enhancement, e.g., metadata filters, rerankers, batching.]
#121
#122	```python
#123	# Additional refinement
#124	```
#125	```typescript
#126	// Additional refinement
#127	```
#128
#129	<Warning>
#130	Call out the most common mistake or edge case for this layer.
#131	</Warning>
#132
#133	## Production Patterns
#134
#135	- [Pattern 1] — `[When to use it]`
#136	```python
#137	# Example snippet
#138	```
#139	```typescript
#140	// Example snippet
#141	```
#142	- [Pattern 2] — `[When to use it]`
#143	```python
#144	# Example snippet
#145	```
#146	```typescript
#147	// Example snippet
#148	```
#149
#150	## What You Built
#151
#152	- [Capability 1] — [How the cookbook delivers it]
#153	- [Capability 2] — [How the cookbook delivers it]
#154	- [Capability 3] — [How the cookbook delivers it]
#155
#156	## Production Checklist
#157
#158	- [Actionable step #1]
#159	- [Actionable step #2]
#160	- [Actionable step #3]
#161
#162	## Next Steps
#163
#164	<CardGroup cols={2}>
#165	<Card
#166	title="[Related cookbook / deep dive]"
#167	description="[Why this pairs well with the current guide]"
#168	icon="arrow-right"
#169	href="/[related-link]"
#170	/>
#171	<Card
#172	title="[Next cookbook in journey]"
#173	description="[Set expectation for the next step]"
#174	icon="rocket"
#175	href="/[next-link]"
#176	/>
#177	</CardGroup>
#178	```
#179
#180	---
#181
#182	## ✅ Publish Checklist (Keep Handy)
#183	- [ ] Replace every `[placeholder]` and remove unused sections.
#184	- [ ] Python & TypeScript code compile (or TypeScript omitted with explicit `<Note>` stating language limitation).
#185	- [ ] Each code block is followed by output + `<Info icon="check">` or inline equivalent.
#186	- [ ] Callouts ≤ 5 total; no emoji, only Mintlify icons.
#187	- [ ] Exactly two cards in the final `<CardGroup cols={2}>`.
#188	- [ ] Added verification narrative (what success looks like) in every major step.
#189	- [ ] Linked related docs (cookbooks, guides, reference) in Next Steps.
#190
#191	Stick to the skeleton above. If you need to deviate, document the rationale in the PR so we can update the template for everyone else.
#192	```
#193
#194	## Browse Other Templates
#195
#196	<CardGroup cols={3}>
#197	<Card
#198	title="Quickstart"
#199	description="Install → Configure → Add → Search → Delete."
#200	icon="rocket"
#201	href="/templates/quickstart_template"
#202	/>
#203	<Card
#204	title="Operation Guide"
#205	description="Single task walkthrough with verification checkpoints."
#206	icon="circle-check"
#207	href="/templates/operation_guide_template"
#208	/>
#209	<Card
#210	title="Feature Guide"
#211	description="Explain when and why to use a capability, not just the API."
#212	icon="sparkles"
#213	href="/templates/feature_guide_template"
#214	/>
#215	<Card
#216	title="Concept Guide"
#217	description="Define mental models, key terms, and diagrams."
#218	icon="brain"
#219	href="/templates/concept_guide_template"
#220	/>
#221	<Card
#222	title="Integration Guide"
#223	description="Configure Mem0 alongside third-party tools."
#224	icon="plug"
#225	href="/templates/integration_guide_template"
#226	/>
#227	<Card
#228	title="Cookbook"
#229	description="Narrative, end-to-end walkthroughs."
#230	icon="book-open"
#231	href="/templates/cookbook_template"
#232	/>
#233	<Card
#234	title="API Reference"
#235	description="Endpoint specifics with dual-language examples."
#236	icon="code"
#237	href="/templates/api_reference_template"
#238	/>
#239	<Card
#240	title="Parameters Reference"
#241	description="Accepted fields, defaults, and misuse fixes."
#242	icon="list"
#243	href="/templates/parameters_reference_template"
#244	/>
#245	<Card
#246	title="Migration Guide"
#247	description="Plan → migrate → validate with rollback."
#248	icon="arrow-right"
#249	href="/templates/migration_guide_template"
#250	/>
#251	<Card
#252	title="Release Notes"
#253	description="Ship highlights and required CTAs."
#254	icon="megaphone"
#255	href="/templates/release_notes_template"
#256	/>
#257	<Card
#258	title="Troubleshooting Playbook"
#259	description="Symptom → diagnose → fix."
#260	icon="life-buoy"
#261	href="/templates/troubleshooting_playbook_template"
#262	/>
#263	<Card
#264	title="Section Overview"
#265	description="Landing pages with card grids and CTA pair."
#266	icon="grid"
#267	href="/templates/section_overview_template"
#268	/>
#269	</CardGroup>
#270
#271	<CardGroup cols={2}>
#272	<Card
#273	title="Contribution Hub"
#274	description="Review the authoring workflow and linked templates."
#275	icon="clipboard-list"
#276	href="/platform/contribute"
#277	/>
#278	<Card
#279	title="Docs Home"
#280	description="Return to the platform overview once you’re done."
#281	icon="compass"
#282	href="/platform/overview"
#283	/>
#284	</CardGroup>
#285

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public