JDSS/mem0
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
docs/templates/operation_guide_template.mdx
Vendored
+4 -4
View File
@@ -10,18 +10,18 @@ Operation guides focus on a single action (add, search, update, delete). Show th
---
## ❌ DO NOT COPY — Guidance & Constraints
## ❌ DO NOT COPY: Guidance & Constraints
- Frontmatter needs `title`, `description`, `icon`. Title should be a verb phrase (“Add Memories”).
- Lead with a two-sentence promise (problem → outcome), followed by an `<Info>` prerequisites block and optional `<Warning>` for hazards (overwrites, rate limits).
- Include a “When to pick this” bullet list (≤3 items) so readers confirm they’re in the right doc.
- Use Tabs with Python and TypeScript examples. If only one SDK exists, add a `<Note>` stating that explicitly.
- When migrating legacy guides, keep existing code paths and notes—slot them into these sections instead of replacing them unless behavior changed.
- When migrating legacy guides, keep existing code paths and notes. Slot them into these sections instead of replacing them unless behavior changed.
- Provide `<Info icon="check">` verification after each critical step; call out the most common error with a `<Warning>` close to where it can occur.
- End with exactly two CTA cards: left = conceptual depth, right = applied example/cookbook.
---
## ✅ COPY THIS — Content Skeleton
## ✅ COPY THIS: Content Skeleton
````mdx
---
@@ -30,7 +30,7 @@ description: [Outcome in one sentence]
icon: "bolt"
---
# [Operation headline — say what it does]
# [Operation headline: say what it does]
[State the problem this solves.] [Explain the outcome after running it.]