my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

my-project-public — gitlawb

#1	---
#2	title: Migration Guide Template
#3	description: "Plan → migrate → validate flow with rollback coverage."
#4	icon: "arrow-right"
#5	---
#6
#7	# Migration Guide Template
#8
#9	Migrations lower blood pressure. They explain what’s changing, why it matters, and how to get through the upgrade with verifications and rollbacks close at hand.
#10
#11	---
#12
#13	## ❌ DO NOT COPY — Guidance & Constraints
#14	- Keep the frontmatter complete (`title`, `description`, `icon`, `versionFrom`, `versionTo`, and optional `releaseDate`). Readers should know at a glance what versions they are moving between.
#15	- Start with context: summary table + “Should you upgrade?” checklist. Highlight deadlines with `<Warning>` and call out optional paths with `<Tip>`.
#16	- Break the body into Plan → Migrate → Validate. Use numbered headings inside Migrate and put rollback instructions directly after any risky step.
#17	- When porting older migration guides, keep existing change tables, screenshots, and warnings—slot them into this format unless the upgrade path has materially changed.
#18	- Document breaking changes with an `Old behavior` vs `New behavior` table. Use `<Info icon="check">` for mandatory verification steps.
#19	- Optional flow diagrams are allowed, but only when a left-to-right Mermaid (`graph LR`) clarifies the upgrade path.
#20	- End with two CTA cards (left = deep dive reference, right = applied example) and keep the comment reminder for reviewers.
#21
#22	---
#23
#24	## ✅ COPY THIS — Content Skeleton
#25	Paste the block below, swap placeholders, and delete optional sections only after you’ve confirmed they aren’t needed.
#26
#27	```mdx
#28	---
#29	title: [Migration title]
#30	description: [Why this upgrade matters]
#31	icon: "arrows-rotate"
#32	versionFrom: "[current version]"
#33	versionTo: "[target version]"
#34	releaseDate: "[YYYY-MM-DD]" # Optional
#35	---
#36
#37	# [Migration headline — state the move]
#38
#39	\| Scope \| Effort \| Downtime \|
#40	\| --- \| --- \| --- \|
#41	\| [Platform/OSS/etc.] \| [Low/Medium/High] ([~time]) \| [Expected downtime impact] \|
#42
#43	<Info>
#44	Should you upgrade?
#45	- [Criteria 1]
#46	- [Criteria 2]
#47	- [Criteria 3]
#48	</Info>
#49
#50	<Warning>
#51	[Breaking deadline or critical change. Remove if not needed.]
#52	</Warning>
#53
#54	## Timeline
#55
#56	- [Date]: [Milestone]
#57	- [Date]: [Milestone]
#58
#59	{/* Optional: delete if not needed */}
#60	```mermaid
#61	graph LR
#62	A[Plan] */} B[Migrate]
#63	B */} C[Validate]
#64	C */} D[Roll back if needed]
#65	```
#66
#67	## Plan
#68
#69	- [Actionable preparatory step]
#70	- [Stakeholder alignment or backup note]
#71
#72	## Migrate
#73
#74	### 1. [Upgrade dependencies]
#75
#76	```bash
#77	pip install mem0ai==[version]
#78	npm install mem0ai@[version]
#79	```
#80
#81	<Tip>
#82	[Optional hint or staging strategy.]
#83	</Tip>
#84
#85	<Info icon="check">
#86	Run `[verification command]` and confirm it reports `[expected output]`.
#87	</Info>
#88
#89	### 2. [Update configuration]
#90
#91	```diff
#92	- memory_filters = true
#93	+ filters = true
#94	```
#95
#96	<Warning>
#97	Breaking change: `[Explain the new behavior and what to update]`.
#98	</Warning>
#99
#100	Rollback: `[Describe how to revert this specific step]`.
#101
#102	### 3. [Run data migrations or API updates]
#103
#104	```python
#105	[Code snippet showing new behavior]
#106	```
#107
#108	<Info icon="check">
#109	`[Describe logs, metrics, or sample response that proves success]`.
#110	</Info>
#111
#112	## Validate
#113
#114	- [ ] `[Smoke test or script]` returns expected result.
#115	- [ ] `[Dashboard or metric]` shows `[desired signal]`.
#116	- [ ] `[End-to-end scenario]` passes with `[new behavior]`.
#117
#118	## Breaking changes
#119
#120	\| Old behavior \| New behavior \| Action \|
#121	\| --- \| --- \| --- \|
#122	\| `[Explain]` \| `[Explain]` \| `[What to change]` \|
#123	\| `[Explain]` \| `[Explain]` \| `[What to change]` \|
#124
#125	## Rollback plan
#126
#127	1. `[Step-by-step rollback instructions]`
#128	2. `[Restore backups or redeploy previous image]`
#129	3. `[Validation after rollback]`
#130
#131	## Known issues
#132
#133	- [Issue name] — `[Status]`. `[Workaround or link]`.
#134	- [Issue name] — `[Status]`. `[Workaround or link]`.
#135
#136	## After you migrate
#137
#138	- `[Link to feature guide showing new capabilities]`
#139	- `[Link to cookbook or integration that benefits from the upgrade]`
#140
#141	{/* DEBUG: verify CTA targets */}
#142
#143	<CardGroup cols={2}>
#144	<Card
#145	title="[Deep dive reference]"
#146	description="[Why this reference matters post-migration]"
#147	icon="book"
#148	href="/[reference-link]"
#149	/>
#150	<Card
#151	title="[Applied example or next step]"
#152	description="[What readers can build now]"
#153	icon="rocket"
#154	href="/[example-link]"
#155	/>
#156	</CardGroup>
#157	```
#158
#159	---
#160
#161	## ✅ Publish Checklist
#162	- [ ] Versions (`versionFrom`, `versionTo`) and timelines are accurate.
#163	- [ ] Every breaking change is highlighted via table or `<Warning>`.
#164	- [ ] Rollback instructions are present and placed immediately after risky steps.
#165	- [ ] Verification steps use `<Info icon="check">` and are actionable.
#166	- [ ] Optional sections (Mermaid, tips) removed if unused.
#167	- [ ] Final `<CardGroup>` contains exactly two cards with valid links.
#168
#169	## Browse Other Templates
#170
#171	<CardGroup cols={3}>
#172	<Card
#173	title="Quickstart"
#174	description="Install → Configure → Add → Search → Delete."
#175	icon="rocket"
#176	href="/templates/quickstart_template"
#177	/>
#178	<Card
#179	title="Operation Guide"
#180	description="Single task walkthrough with verification checkpoints."
#181	icon="circle-check"
#182	href="/templates/operation_guide_template"
#183	/>
#184	<Card
#185	title="Feature Guide"
#186	description="Explain when and why to use a capability, not just the API."
#187	icon="sparkles"
#188	href="/templates/feature_guide_template"
#189	/>
#190	<Card
#191	title="Concept Guide"
#192	description="Define mental models, key terms, and diagrams."
#193	icon="brain"
#194	href="/templates/concept_guide_template"
#195	/>
#196	<Card
#197	title="Integration Guide"
#198	description="Configure Mem0 alongside third-party tools."
#199	icon="plug"
#200	href="/templates/integration_guide_template"
#201	/>
#202	<Card
#203	title="Cookbook"
#204	description="Narrative, end-to-end walkthroughs."
#205	icon="book-open"
#206	href="/templates/cookbook_template"
#207	/>
#208	<Card
#209	title="API Reference"
#210	description="Endpoint specifics with dual-language examples."
#211	icon="code"
#212	href="/templates/api_reference_template"
#213	/>
#214	<Card
#215	title="Parameters Reference"
#216	description="Accepted fields, defaults, and misuse fixes."
#217	icon="list"
#218	href="/templates/parameters_reference_template"
#219	/>
#220	<Card
#221	title="Migration Guide"
#222	description="Plan → migrate → validate with rollback."
#223	icon="arrow-right"
#224	href="/templates/migration_guide_template"
#225	/>
#226	<Card
#227	title="Release Notes"
#228	description="Ship highlights and required CTAs."
#229	icon="megaphone"
#230	href="/templates/release_notes_template"
#231	/>
#232	<Card
#233	title="Troubleshooting Playbook"
#234	description="Symptom → diagnose → fix."
#235	icon="life-buoy"
#236	href="/templates/troubleshooting_playbook_template"
#237	/>
#238	<Card
#239	title="Section Overview"
#240	description="Landing pages with card grids and CTA pair."
#241	icon="grid"
#242	href="/templates/section_overview_template"
#243	/>
#244	</CardGroup>
#245
#246	<CardGroup cols={2}>
#247	<Card
#248	title="Contribution Hub"
#249	description="Review the authoring workflow and linked templates."
#250	icon="clipboard-list"
#251	href="/platform/contribute"
#252	/>
#253	<Card
#254	title="Docs Home"
#255	description="Return to the platform overview once you’re done."
#256	icon="compass"
#257	href="/platform/overview"
#258	/>
#259	</CardGroup>
#260

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public