my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

#1	---
#2	title: Feature Guide Template
#3	description: "Structure for explaining when and why to use a Mem0 feature."
#4	icon: "sparkles"
#5	---
#6
#7	# Feature Guide Template
#8
#9	Use this when you introduce or deepen a single Mem0 capability (Graph Memory, Advanced Retrieval, etc.). Aim for crisp problem framing, a walkthrough of how the feature works, and practical configuration guidance with clear exits.
#10
#11	## Reader Promise
#12	- Understand the pain the feature solves and when to reach for it.
#13	- See how to enable, configure, and observe the feature in action.
#14	- Know the next conceptual deep dive and a hands-on example to try.
#15
#16	## Start → Middle → End Pattern
#17
#18	### 1. Start – Why this feature exists
#19	- Frontmatter stays outcome-driven: `title`, `description`, `icon`, optional `badge` (e.g., “Advanced”).
#20	- Opening paragraph = two sentences: problem, then payoff. Keep energy high right from the start.
#21	- Include an `<Info>` block titled “You’ll use this when…” with 3 bullets (user persona, workload, expected benefit).
#22	- When reshaping legacy feature docs, carry over existing diagrams, tables, and gotchas—organize them under these headings rather than replacing them unless the product has changed.
#23	- If there’s a known caveat (pricing, performance), surface it early in a `<Warning>` so readers don’t get surprised later.
#24	- Optional but encouraged: add a Mermaid diagram right after the intro to show how components connect; delete it if the story is obvious without visuals.
#25	- Add a `## Configure access` snippet (even if it’s “Confirm your Mem0 API key is already configured”) so contributors never forget to mention the baseline setup.
#26
#27	### 2. Middle – How it works
#28	- Create three predictable sections:
#29	1. Feature anatomy – Diagram or bullet list of moving parts. Use a table if you need to compare modes (platform vs OSS).
#30	2. Configure it – Step-by-step enabling instructions with `<CodeGroup>` or JSON/YAML snippets. Follow each code block with a short explanation of why it matters.
#31	3. See it in action – End-to-end example (often reusing operation snippets). Pair code with `<Info icon="check">` for expected results and `<Tip>` for optimization hints.
#32	- Insert `<Note>` blocks for cross-links (e.g., “Also available via REST endpoint `/v1/...`”).
#33	- Keep the tone instructive but light—no long manifestos.
#34
#35	### 3. End – Evaluate and go deeper
#36	- Add an `## Verify the feature is working` section with bullets (metrics, logs, dashboards).
#37	- Follow with `## Best practices` or `## Tuning tips` (3–4 bullets max).
#38	- Close with the standard two-card CTA pair: left card = related concept or architecture page, right card = cookbook/application. Keep the comment reminder to double-check links.
#39	- If providers differ meaningfully, summarize them in a final accordion (`<AccordionGroup>` with one `<Accordion>` per provider) so readers can expand what they need without scrolling walls of configuration.
#40
#41	## Markdown Skeleton
#42
#43	```mdx
#44	---
#45	title: Advanced Retrieval
#46	description: Increase relevance with reranking, criteria filters, and context windows.
#47	icon: "sparkles"
#48	badge: "Advanced"
#49	---
#50
#51	# Advanced Retrieval
#52
#53	Mem0’s advanced retrieval elevates search accuracy when basic keyword matches aren’t enough. Turn it on when you need precise context for high-stakes conversations.
#54
#55	<Info>
#56	You’ll use this when…
#57	- You need semantic ranking across long-running agents
#58	- Compliance requires tight control over returned memories
#59	- Personalization hinges on precise filters
#60	</Info>
#61
#62	<Warning>
#63	Advanced retrieval currently applies to managed Platform projects only. Self-hosted users should rely on the OSS reranker configuration.
#64	</Warning>
#65
#66	{/* Optional: remove if no diagram is needed */}
#67	```mermaid
#68	%% Diagram the moving parts (delete when you fill this out)
#69	graph TD
#70	A[Input] */} B[Feature]
#71	B */} C[Output]
#72	```
#73
#74	## Feature anatomy
#75
#76	- Outline the moving parts (retriever, reranker, filters).
#77	- Add a table comparing default vs advanced behavior.
#78
#79	## Configure it
#80
#81	<CodeGroup>
#82	```python Python
#83	client = Client(...)
#84	client.memories.search(criteria={...})
#85	```
#86
#87	```ts TypeScript
#88	const memories = await mem0.memories.search({ criteria: { ... } });
#89	```
#90	</CodeGroup>
#91
#92	Explain which knobs matter (e.g., `rerank_top_k`, `criteria`, `filters`).
#93
#94	<Tip>
#95	OSS users can mirror this by enabling the reranker in `config.yaml`. Link to the integration guide if relevant.
#96	</Tip>
#97
#98	## See it in action
#99
#100	Walk through a real request/response. Include sample payloads and highlight notable fields.
#101
#102	<Info icon="check">
#103	Expect the top memory to match the user persona you set earlier. If not, revisit your filters.
#104	</Info>
#105
#106	## Provider setup {/* Delete if not applicable */}
#107
#108	<AccordionGroup>
#109	<Accordion title="[Provider name]">
#110	Outline configuration or link to provider docs here.
#111	</Accordion>
#112	</AccordionGroup>
#113
#114	## Verify the feature is working
#115
#116	- Watch the dashboard analytics for retrieval latency changes.
#117	- Check logs for `reranker_applied: true`.
#118
#119	## Best practices
#120
#121	- Keep criteria minimal—overfiltering hurts recall.
#122	- Pair with Memory Filters for hybrid scoring.
#123
#124	{/* DEBUG: verify CTA targets */}
#125
#126	<CardGroup cols={2}>
#127	<Card title="Dive Into Memory Scoring" icon="scale-balanced" href="/concepts/memory-scoring">
#128	Understand how Mem0 ranks memories under the hood.
#129	</Card>
#130	<Card title="Build a Research Copilot" icon="book-open" href="/cookbooks/research-copilot">
#131	See advanced retrieval driving a full knowledge assistant.
#132	</Card>
#133	</CardGroup>
#134	```
#135
#136	Stick to this outline. Keep the “why” up front, the “how” in the middle, and the “where to go next” crystal clear at the end.
#137
#138	## Browse Other Templates
#139
#140	<CardGroup cols={3}>
#141	<Card
#142	title="Quickstart"
#143	description="Install → Configure → Add → Search → Delete."
#144	icon="rocket"
#145	href="/templates/quickstart_template"
#146	/>
#147	<Card
#148	title="Operation Guide"
#149	description="Single task walkthrough with verification checkpoints."
#150	icon="circle-check"
#151	href="/templates/operation_guide_template"
#152	/>
#153	<Card
#154	title="Feature Guide"
#155	description="Explain when and why to use a capability, not just the API."
#156	icon="sparkles"
#157	href="/templates/feature_guide_template"
#158	/>
#159	<Card
#160	title="Concept Guide"
#161	description="Define mental models, key terms, and diagrams."
#162	icon="brain"
#163	href="/templates/concept_guide_template"
#164	/>
#165	<Card
#166	title="Integration Guide"
#167	description="Configure Mem0 alongside third-party tools."
#168	icon="plug"
#169	href="/templates/integration_guide_template"
#170	/>
#171	<Card
#172	title="Cookbook"
#173	description="Narrative, end-to-end walkthroughs."
#174	icon="book-open"
#175	href="/templates/cookbook_template"
#176	/>
#177	<Card
#178	title="API Reference"
#179	description="Endpoint specifics with dual-language examples."
#180	icon="code"
#181	href="/templates/api_reference_template"
#182	/>
#183	<Card
#184	title="Parameters Reference"
#185	description="Accepted fields, defaults, and misuse fixes."
#186	icon="list"
#187	href="/templates/parameters_reference_template"
#188	/>
#189	<Card
#190	title="Migration Guide"
#191	description="Plan → migrate → validate with rollback."
#192	icon="arrow-right"
#193	href="/templates/migration_guide_template"
#194	/>
#195	<Card
#196	title="Release Notes"
#197	description="Ship highlights and required CTAs."
#198	icon="megaphone"
#199	href="/templates/release_notes_template"
#200	/>
#201	<Card
#202	title="Troubleshooting Playbook"
#203	description="Symptom → diagnose → fix."
#204	icon="life-buoy"
#205	href="/templates/troubleshooting_playbook_template"
#206	/>
#207	<Card
#208	title="Section Overview"
#209	description="Landing pages with card grids and CTA pair."
#210	icon="grid"
#211	href="/templates/section_overview_template"
#212	/>
#213	</CardGroup>
#214
#215	<CardGroup cols={2}>
#216	<Card
#217	title="Contribution Hub"
#218	description="Review the authoring workflow and linked templates."
#219	icon="clipboard-list"
#220	href="/platform/contribute"
#221	/>
#222	<Card
#223	title="Docs Home"
#224	description="Return to the platform overview once you’re done."
#225	icon="compass"
#226	href="/platform/overview"
#227	/>
#228	</CardGroup>
#229

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public