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/migration_guide_template.mdx
Vendored
+6 -6
View File
@@ -10,18 +10,18 @@ Migrations lower blood pressure. They explain what’s changing, why it matters,
---
## ❌ DO NOT COPY — Guidance & Constraints
## ❌ DO NOT COPY: Guidance & Constraints
- Keep the frontmatter complete (`title`, `description`, `icon`, `versionFrom`, `versionTo`, and optional `releaseDate`). Readers should know at a glance what versions they are moving between.
- Start with context: summary table + “Should you upgrade?” checklist. Highlight deadlines with `<Warning>` and call out optional paths with `<Tip>`.
- Break the body into **Plan → Migrate → Validate**. Use numbered headings inside **Migrate** and put rollback instructions directly after any risky step.
- When porting older migration guides, keep existing change tables, screenshots, and warnings—slot them into this format unless the upgrade path has materially changed.
- When porting older migration guides, keep existing change tables, screenshots, and warnings. Slot them into this format unless the upgrade path has materially changed.
- Document breaking changes with an `Old behavior` vs `New behavior` table. Use `<Info icon="check">` for mandatory verification steps.
- Optional flow diagrams are allowed, but only when a left-to-right Mermaid (`graph LR`) clarifies the upgrade path.
- End with two CTA cards (left = deep dive reference, right = applied example) and keep the comment reminder for reviewers.
---
## ✅ COPY THIS — Content Skeleton
## ✅ COPY THIS: Content Skeleton
Paste the block below, swap placeholders, and delete optional sections only after you’ve confirmed they aren’t needed.
```mdx
@@ -34,7 +34,7 @@ versionTo: "[target version]"
releaseDate: "[YYYY-MM-DD]" # Optional
---
# [Migration headline — state the move]
# [Migration headline: state the move]
| Scope | Effort | Downtime |
| --- | --- | --- |
@@ -130,8 +130,8 @@ npm install mem0ai@[version]
## Known issues
- **[Issue name]** — `[Status]`. `[Workaround or link]`.
- **[Issue name]** — `[Status]`. `[Workaround or link]`.
- **[Issue name]**: `[Status]`. `[Workaround or link]`.
- **[Issue name]**: `[Status]`. `[Workaround or link]`.
## After you migrate