[docs] platform core concept revamp and overview update (#3664)
This commit is contained in:
+1
@@ -14,6 +14,7 @@ Release notes are heartbeat updates. They tell readers what shipped, what needs
|
||||
- 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.
|
||||
- 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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user