Keeping users informed about updates, bug fixes, and new features is essential. The Documentation theme makes it easy to create structured, professional release notes.
📦 How to Create Release Notes:
- Create a New Page
- Go to Pages > Add New.
- Title it clearly (e.g.,
Version 2.1.0 – April 2025).
- Apply the Release Notes Template
- In the Page settings (right sidebar), select the Release Notes template.
- Organize Content
Use headings (H3) for each category:- 🚀 New Features
- 🛠 Improvements
- 🐞 Bug Fixes
- ⚙ Technical Changes
✍️ Example Release Note Layout:
Version 2.1.0 – April 2025
🚀 New Features
- Added advanced sidebar filters.
- Introduced role-based content visibility.
🛠 Improvements
- Optimized mobile sidebar performance.
- Updated documentation card layouts.
🐞 Bug Fixes
- Fixed dark mode toggle flicker on Safari.
- Resolved breadcrumb SEO markup issues.
⚙ Technical Changes
- Updated dependencies for better performance.
📄 Additional Tips:
- Version Naming: Follow semantic versioning (
major.minor.patch). - Link Related Docs: When possible, link to guides for new features.
- Date the Release: Always include the release date.
💡 Tip: Group your release notes by year or product version in the sidebar for easy access.