Skip to content

Restructure Enterprise release notes into individual pages - #832

Merged
jpelletier1 merged 5 commits into
mainfrom
restructure-enterprise-release-notes
Sep 23, 2026
Merged

jpelletier1 merged 5 commits into
mainfrom
restructure-enterprise-release-notes

Conversation

@jpelletier1

Copy link
Copy Markdown
Contributor
  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

This PR restructures the Enterprise release notes from a single long page into individual pages for better navigation and organization.

Changes Made

1. Created Individual Release Pages

  • Created enterprise/releases/ directory
  • Split 9 releases into separate pages (0.70.0 through 0.24.0)
  • Each page includes:
    • Proper frontmatter (title, description)
    • Complete release content (features, bug fixes, maintenance)
    • Organized by component (Enterprise Server, SDK, Runtime API, Canvas, Helm Chart)

2. Updated Release Notes Overview

  • Converted enterprise/release-notes.mdx to an overview/landing page
  • Added introduction explaining the release notes structure
  • Included highlights from the latest 3 releases
  • Added "All Releases" section with links to individual pages
  • Reduced file from 1,084 lines to 49 lines

3. Updated Navigation Structure

  • Modified docs.json to show "Release Notes" as an expandable group
  • Positioned under "Feature Guides" in the Enterprise tab
  • Overview page appears first, followed by all release pages
  • Maintains chronological order (newest to oldest)

User Experience Impact

In the Enterprise tab sidebar, users will now see:

Feature Guides
  └─ Release Notes ▼          (expandable group)
      ├─ Release Notes        (overview/landing page)
      ├─ Release 0.70.0       (individual release pages)
      ├─ Release 0.64.0
      ├─ Release 0.55.0
      ├─ Release 0.45.0
      ├─ Release 0.41.0
      ├─ Release 0.36.1
      ├─ Release 0.36.0
      ├─ Release 0.28.0
      └─ Release 0.24.0

Benefits

  • Better Navigation: Users can quickly jump to a specific release
  • Improved Discoverability: Each release has its own URL and can be directly linked
  • Cleaner Organization: Overview page provides context and highlights
  • Scalability: Easy to add new releases without making the main page unwieldy
  • Consistent Structure: Each release follows the same format and organization

@jpelletier1 can click here to continue refining the PR

- Split single release-notes.mdx into 9 individual release pages
- Created enterprise/releases/ directory with dedicated page per version
- Updated release-notes.mdx to be an overview page with highlights
- Modified docs.json to show Release Notes as expandable group
- Each release page has proper frontmatter and complete content
- Organized releases chronologically from 0.70.0 to 0.24.0
@mintlify

mintlify Bot commented Sep 23, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
all-hands-ai 🟢 Ready View Preview Sep 23, 2026, 8:16 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

- Deleted enterprise/release-notes.mdx (no longer needed)
- Updated docs.json to show only individual release pages
- Release Notes group now directly contains the 9 release pages
Applied steps 4, 6, and 7 from the ohe-release-notes skill:

Step 4: Reorganized structure
- Changed from component-first to category-first organization
- Top-level sections: Features, Bug Fixes, Maintenance
- Component subsections (h4) under each category
- Component order: Enterprise Server, SDK, Runtime API, Automation, Cloud

Step 6: Updated page format
- Added h1 title: '# OpenHands Enterprise X.Y.Z'
- Added release date
- Added Highlights section at top (always included)
- Added Full Changelog section at bottom with links to all repos
- Proper frontmatter with title and description

Step 7: Updated navigation
- Moved from enterprise/releases/ to enterprise/release-notes/
- Updated all paths in docs.json
- Maintained chronological order (newest first)

All 9 release pages now follow the canonical OHE release notes format.
Reformatted Highlights sections in all releases except 0.70.0:
- Converted paragraph-style highlights to focused bullet points
- Used consistent format: **Title** — Description
- Improved scannability and readability
- Each bullet covers a distinct feature or improvement

Affected releases:
- 0.64.0: 4 focused bullets (LLM connections, GPG signing, org tools, permissions)
- 0.55.0: 6 bullets (quotas, scheduling, issue trackers, SDK, runtime, identity)
- 0.45.0: 4 bullets (Canvas Extensions, SDK, automation, stability)
- 0.41.0: 4 bullets (Canvas rollout, GLM 5.2, auth, stability)
- 0.36.1: 3 bullets (session preservation, email config, stability)
- 0.36.0: 3 bullets (Canvas availability, Bitbucket DC, performance)
- 0.28.0: 3 bullets (Canvas embedded, Helm improvements, stability)
- 0.24.0: 4 bullets (monitoring, budgets, third-party agents, Jira)

0.70.0 retained as-is with existing bullet format.
Added 'rocket' icon to the Release Notes group in the Enterprise tab
navigation for better visual identification and consistency with other
menu items that have icons.
@jpelletier1
jpelletier1 merged commit e854bcf into main Sep 23, 2026
5 checks passed
@jpelletier1
jpelletier1 deleted the restructure-enterprise-release-notes branch September 23, 2026 20:18

This branch was successfully deployed

1 active deployment
staging — 105a2215 Deployed Sep 23, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants