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
+13 -13
View File
@@ -6,21 +6,21 @@ icon: "megaphone"
# Release Notes Template
Release notes are heartbeat updates. They tell readers what shipped, what needs attention, and where to go for the deep dive—fast.
Release notes are heartbeat updates. They tell readers what shipped, what needs attention, and where to go for the deep dive fast.
---
## ❌ DO NOT COPY — Guidance & Constraints
## ❌ DO NOT COPY: Guidance & Constraints
- Frontmatter must include `title`, `description`, `icon`, `releaseDate`, and `version`. Add `tags` if you need filters (e.g., `["platform", "oss"]`).
- 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.
- Organize the body into Highlights, Improvements & fixes (grouped by product), and Known issues. Each bullet links to docs where appropriate.
- When reshaping older release notes, retain the shipped items and shout-outs—map them to these sections instead of rewriting history.
- When reshaping older release notes, retain the shipped items and shout-outs. Map them to these sections instead of rewriting history.
- Include an Upgrade checklist with concrete next steps. Optional “Community shout-outs” should remain short.
- Two-card CTA at the end, as always: left = deeper reference, right = applied next step.
---
## ✅ COPY THIS — Content Skeleton
## ✅ COPY THIS: Content Skeleton
Paste the snippet below, swap placeholders, and trim optional sections only once you know they’re unnecessary.
```mdx
@@ -54,9 +54,9 @@ tags: ["platform", "oss"] # Optional filters
## Highlights
- **[Feature name]** — [One-sentence benefit]. [Link to doc]
- **[Feature name]** — [One-sentence benefit]. [Link to doc]
- **[Feature name]** — [One-sentence benefit]. [Link to doc]
- **[Feature name]:** [One-sentence benefit]. [Link to doc]
- **[Feature name]:** [One-sentence benefit]. [Link to doc]
- **[Feature name]:** [One-sentence benefit]. [Link to doc]
## Improvements & fixes
@@ -77,18 +77,18 @@ tags: ["platform", "oss"] # Optional filters
## 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].`
## Upgrade checklist
- [ ] `[Step 1 — update package or config]`
- [ ] `[Step 2 — run migration or toggle setting]`
- [ ] `[Step 3 — verify workflow or metric]`
- [ ] `[Step 1: update package or config]`
- [ ] `[Step 2: run migration or toggle setting]`
- [ ] `[Step 3: verify workflow or metric]`
## Community shout-outs
- [Contributor or team] — `[Short thank-you message].`
- [Contributor or team]: `[Short thank-you message].`
{/* DEBUG: verify CTA targets */}