my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

#1	---
#2	title: Release Notes Template
#3	description: "Format for concise launch summaries with clear CTAs."
#4	icon: "megaphone"
#5	---
#6
#7	# Release Notes Template
#8
#9	Release notes are heartbeat updates. They tell readers what shipped, what needs attention, and where to go for the deep dive—fast.
#10
#11	---
#12
#13	## ❌ DO NOT COPY — Guidance & Constraints
#14	- Frontmatter must include `title`, `description`, `icon`, `releaseDate`, and `version`. Add `tags` if you need filters (e.g., `["platform", "oss"]`).
#15	- Lead with a one-sentence headline plus a quick stats table (New features, Fixes, Required action). Keep the TL;DR in an `<Info>` block; use `<Warning>` only for breaking changes or deadlines.
#16	- Organize the body into Highlights, Improvements & fixes (grouped by product), and Known issues. Each bullet links to docs where appropriate.
#17	- When reshaping older release notes, retain the shipped items and shout-outs—map them to these sections instead of rewriting history.
#18	- Include an Upgrade checklist with concrete next steps. Optional “Community shout-outs” should remain short.
#19	- Two-card CTA at the end, as always: left = deeper reference, right = applied next step.
#20
#21	---
#22
#23	## ✅ COPY THIS — Content Skeleton
#24	Paste the snippet below, swap placeholders, and trim optional sections only once you know they’re unnecessary.
#25
#26	```mdx
#27	---
#28	title: [Release title]
#29	description: [1 sentence summary of the release]
#30	icon: "sparkles"
#31	releaseDate: "[YYYY-MM-DD]"
#32	version: "[X.Y]"
#33	tags: ["platform", "oss"] # Optional filters
#34	---
#35
#36	# [Release at a glance]
#37
#38	[Hero sentence that states the biggest win.]
#39
#40	\| New features \| Fixes \| Required action \|
#41	\| --- \| --- \| --- \|
#42	\| [#] \| [#] \| [Required/Optional + short note] \|
#43
#44	<Info>
#45	TL;DR
#46	- [Highlight #1]
#47	- [Highlight #2]
#48	- [Highlight #3]
#49	</Info>
#50
#51	<Warning>
#52	[Breaking change or deadline reminder. Remove if not needed.]
#53	</Warning>
#54
#55	## Highlights
#56
#57	- [Feature name] — [One-sentence benefit]. [Link to doc]
#58	- [Feature name] — [One-sentence benefit]. [Link to doc]
#59	- [Feature name] — [One-sentence benefit]. [Link to doc]
#60
#61	## Improvements & fixes
#62
#63	Platform
#64	- [Improvement sentence with link if relevant.]
#65	- [Fix sentence.]
#66
#67	Open Source
#68	- [Improvement sentence.]
#69
#70	SDKs
#71	- Python: `[Change summary]`.
#72	- TypeScript: `[Change summary]`.
#73
#74	<Tip>
#75	[Optional activation hint, e.g., “Enable the feature in Settings → Labs.”]
#76	</Tip>
#77
#78	## Known issues
#79
#80	- [Issue name] — `[Status]`. `[Workaround or link].`
#81	- [Issue name] — `[Status]`. `[Workaround or link].`
#82
#83	## Upgrade checklist
#84
#85	- [ ] `[Step 1 — update package or config]`
#86	- [ ] `[Step 2 — run migration or toggle setting]`
#87	- [ ] `[Step 3 — verify workflow or metric]`
#88
#89	## Community shout-outs
#90
#91	- [Contributor or team] — `[Short thank-you message].`
#92
#93	{/* DEBUG: verify CTA targets */}
#94
#95	<CardGroup cols={2}>
#96	<Card
#97	title="[Deep dive reference]"
#98	description="[Why readers should open it]"
#99	icon="book-open"
#100	href="/[reference-link]"
#101	/>
#102	<Card
#103	title="[Apply it next]"
#104	description="[Set expectation for the follow-up guide or cookbook]"
#105	icon="rocket"
#106	href="/[next-link]"
#107	/>
#108	</CardGroup>
#109	```
#110
#111	---
#112
#113	## ✅ Publish Checklist
#114	- [ ] Headline sentence and stats table reflect the release accurately.
#115	- [ ] Every highlight, improvement, and issue links to supporting docs when available.
#116	- [ ] `<Warning>` only appears when a deadline or breaking change exists.
#117	- [ ] Upgrade checklist lists concrete steps (not vague reminders).
#118	- [ ] Exactly two CTA cards at the end with valid links.
#119
#120	## Browse Other Templates
#121
#122	<CardGroup cols={3}>
#123	<Card
#124	title="Quickstart"
#125	description="Install → Configure → Add → Search → Delete."
#126	icon="rocket"
#127	href="/templates/quickstart_template"
#128	/>
#129	<Card
#130	title="Operation Guide"
#131	description="Single task walkthrough with verification checkpoints."
#132	icon="circle-check"
#133	href="/templates/operation_guide_template"
#134	/>
#135	<Card
#136	title="Feature Guide"
#137	description="Explain when and why to use a capability, not just the API."
#138	icon="sparkles"
#139	href="/templates/feature_guide_template"
#140	/>
#141	<Card
#142	title="Concept Guide"
#143	description="Define mental models, key terms, and diagrams."
#144	icon="brain"
#145	href="/templates/concept_guide_template"
#146	/>
#147	<Card
#148	title="Integration Guide"
#149	description="Configure Mem0 alongside third-party tools."
#150	icon="plug"
#151	href="/templates/integration_guide_template"
#152	/>
#153	<Card
#154	title="Cookbook"
#155	description="Narrative, end-to-end walkthroughs."
#156	icon="book-open"
#157	href="/templates/cookbook_template"
#158	/>
#159	<Card
#160	title="API Reference"
#161	description="Endpoint specifics with dual-language examples."
#162	icon="code"
#163	href="/templates/api_reference_template"
#164	/>
#165	<Card
#166	title="Parameters Reference"
#167	description="Accepted fields, defaults, and misuse fixes."
#168	icon="list"
#169	href="/templates/parameters_reference_template"
#170	/>
#171	<Card
#172	title="Migration Guide"
#173	description="Plan → migrate → validate with rollback."
#174	icon="arrow-right"
#175	href="/templates/migration_guide_template"
#176	/>
#177	<Card
#178	title="Release Notes"
#179	description="Ship highlights and required CTAs."
#180	icon="megaphone"
#181	href="/templates/release_notes_template"
#182	/>
#183	<Card
#184	title="Troubleshooting Playbook"
#185	description="Symptom → diagnose → fix."
#186	icon="life-buoy"
#187	href="/templates/troubleshooting_playbook_template"
#188	/>
#189	<Card
#190	title="Section Overview"
#191	description="Landing pages with card grids and CTA pair."
#192	icon="grid"
#193	href="/templates/section_overview_template"
#194	/>
#195	</CardGroup>
#196
#197	<CardGroup cols={2}>
#198	<Card
#199	title="Contribution Hub"
#200	description="Review the authoring workflow and linked templates."
#201	icon="clipboard-list"
#202	href="/platform/contribute"
#203	/>
#204	<Card
#205	title="Docs Home"
#206	description="Return to the platform overview once you’re done."
#207	icon="compass"
#208	href="/platform/overview"
#209	/>
#210	</CardGroup>
#211

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public