Clean up release highlights copy and removing emdash from the docs (#5984)

This commit is contained in:
Kartik
2026-06-29 21:27:53 +05:30
committed by GitHub
parent 754034abbc
commit b2ff3aeda5
73 changed files with 572 additions and 557 deletions
+3 -3
View File
@@ -19,7 +19,7 @@ Use this when you introduce or deepen a single Mem0 capability (Graph Memory, Ad
- Frontmatter stays outcome-driven: `title`, `description`, `icon`, optional `badge` (e.g., “Advanced”).
- Opening paragraph = two sentences: problem, then payoff. Keep energy high right from the start.
- Include an `<Info>` block titled “You’ll use this when…” with 3 bullets (user persona, workload, expected benefit).
- 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.
- 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.
- If there’s a known caveat (pricing, performance), surface it early in a `<Warning>` so readers don’t get surprised later.
- 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.
- 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.
@@ -30,7 +30,7 @@ Use this when you introduce or deepen a single Mem0 capability (Graph Memory, Ad
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.
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.
- Insert `<Note>` blocks for cross-links (e.g., “Also available via REST endpoint `/v1/...`”).
- Keep the tone instructive but light—no long manifestos.
- Keep the tone instructive but light. No long manifestos.
### 3. **End – Evaluate and go deeper**
- Add an `## Verify the feature is working` section with bullets (metrics, logs, dashboards).
@@ -118,7 +118,7 @@ Walk through a real request/response. Include sample payloads and highlight nota
## Best practices
- Keep criteria minimal—overfiltering hurts recall.
- Keep criteria minimal. Overfiltering hurts recall.
- Pair with Memory Filters for hybrid scoring.
{/* DEBUG: verify CTA targets */}