[docs] Template moulding in docs/platform and index improvement (#3663)

This commit is contained in:
Parth Sharma
2025-10-25 14:05:18 -07:00
committed by GitHub
parent ac9598a67f
commit 61faf71064
15 changed files with 426 additions and 1724 deletions
+1 -1
View File
@@ -124,7 +124,7 @@ const response = await fetch("https://api.mem0.ai/v1/memories", {
- [Build a Customer Support Agent](/cookbooks/customer-support-agent)
<!-- DEBUG: verify CTA targets -->
{/* DEBUG: verify CTA targets */}
<CardGroup cols={2}>
<Card
+4 -4
View File
@@ -45,11 +45,11 @@ icon: "lightbulb"
- **[Term]** – [Short definition]
- **[Term]** – [Short definition]
<!-- Optional: delete if not needed -->
{/* Optional: delete if not needed */}
```mermaid
graph LR
A[Input] --> B[Concept]
B --> C[Outcome]
A[Input] */} B[Concept]
B */} C[Outcome]
```
## How does it work?
@@ -91,7 +91,7 @@ graph LR
- [Cookbook or integration demonstrating the concept]
- [Recording, demo, or sample repo]
<!-- DEBUG: verify CTA targets -->
{/* DEBUG: verify CTA targets */}
<CardGroup cols={2}>
<Card
+3 -3
View File
@@ -62,12 +62,12 @@ Mem0’s advanced retrieval elevates search accuracy when basic keyword matches
Advanced retrieval currently applies to managed Platform projects only. Self-hosted users should rely on the OSS reranker configuration.
</Warning>
<!-- Optional: remove if no diagram is needed -->
{/* Optional: remove if no diagram is needed */}
```mermaid
%% Diagram the moving parts (delete when you fill this out)
graph TD
A[Input] --> B[Feature]
B --> C[Output]
A[Input] */} B[Feature]
B */} C[Output]
```
## Feature anatomy
+4 -4
View File
@@ -45,11 +45,11 @@ Combine Mem0’s memory layer with [Partner] to [describe the joint outcome].
[Use only if access is gated or breaking changes exist. Delete when not needed.]
</Warning>
<!-- Optional architecture diagram -->
{/* Optional architecture diagram */}
```mermaid
graph LR
A[Mem0] --> B[Connector]
B --> C[Partner workflow]
A[Mem0] */} B[Connector]
B */} C[Partner workflow]
```
## Configure credentials
@@ -170,7 +170,7 @@ partner.registerTool("recallPreferences", async (userId: string) => {
- **[Issue]** — `[Fix or link to partner docs]`
- **[Issue]** — `[Fix or link to Mem0 troubleshooting guide]`
<!-- DEBUG: verify CTA targets -->
{/* DEBUG: verify CTA targets */}
<CardGroup cols={2}>
<Card
+4 -4
View File
@@ -55,12 +55,12 @@ releaseDate: "[YYYY-MM-DD]" # Optional
- [Date]: [Milestone]
- [Date]: [Milestone]
<!-- Optional: delete if not needed -->
{/* Optional: delete if not needed */}
```mermaid
graph LR
A[Plan] --> B[Migrate]
B --> C[Validate]
C --> D[Roll back if needed]
A[Plan] */} B[Migrate]
B */} C[Validate]
C */} D[Roll back if needed]
```
## Plan
+1 -1
View File
@@ -141,7 +141,7 @@ const response = await memory.add(payload);
- [Link to complementary operation]
- [Link to troubleshooting playbook section]
<!-- DEBUG: verify CTA targets -->
{/* DEBUG: verify CTA targets */}
<CardGroup cols={2}>
<Card
+1 -1
View File
@@ -129,7 +129,7 @@ These snippets confirm the method returns the new `memory_id` for follow-up oper
- **`400 Missing user_id`** — Provide either `user_id` or `agent_id` in the payload.
- **`422 Metadata too large`** — Reduce metadata size below 2KB (OSS hard limit).
<!-- DEBUG: verify CTA targets -->
{/* DEBUG: verify CTA targets */}
<CardGroup cols={2}>
<Card
+6 -6
View File
@@ -43,13 +43,13 @@ estimatedTime: "[~X minutes]"
[Optional: cross-link to OSS or platform alternative if applicable. Delete if unused.]
</Tip>
<!-- Optional: delete if not needed -->
{/* Optional: delete if not needed */}
```mermaid
graph LR
A[Install] --> B[Configure keys]
B --> C[Add memory]
C --> D[Search]
D --> E[Delete]
A[Install] */} B[Configure keys]
B */} C[Add memory]
C */} D[Search]
D */} E[Delete]
```
## Install dependencies
@@ -212,7 +212,7 @@ await memory.deleteAll({ userId: "alex" });
- `[Error message]` → `[One-line fix or link to troubleshooting guide]`
- `[Second error]` → `[How to resolve]`
<!-- DEBUG: verify CTA targets -->
{/* DEBUG: verify CTA targets */}
<CardGroup cols={2}>
<Card
+1 -1
View File
@@ -89,7 +89,7 @@ tags: ["platform", "oss"] # Optional filters
- [Contributor or team] — `[Short thank-you message].`
<!-- DEBUG: verify CTA targets -->
{/* DEBUG: verify CTA targets */}
<CardGroup cols={2}>
<Card
+5 -5
View File
@@ -36,12 +36,12 @@ icon: "compass"
Start with [Quickstart link] if you’re new, then choose a deeper topic below.
</Info>
<!-- Optional: delete if not needed -->
{/* Optional: delete if not needed */}
```mermaid
graph LR
A[Get set up] --> B[Learn concepts]
B --> C[Build workflows]
C --> D[Support & scale]
A[Get set up] */} B[Learn concepts]
B */} C[Build workflows]
C */} D[Support & scale]
```
## Choose your path
@@ -73,7 +73,7 @@ graph LR
## Keep going
<!-- DEBUG: verify CTA targets -->
{/* DEBUG: verify CTA targets */}
<CardGroup cols={2}>
<Card
+1 -1
View File
@@ -96,7 +96,7 @@ Run this check:
- [Feature or integration doc]
- [Runbook or SLO doc]
<!-- DEBUG: verify CTA targets -->
{/* DEBUG: verify CTA targets */}
<CardGroup cols={2}>
<Card