Skip to content

Update OHE release notes skill to match Agent Canvas format - #826

Merged
jpelletier1 merged 1 commit into
mainfrom
update-ohe-release-notes-format
Sep 23, 2026
Merged

jpelletier1 merged 1 commit into
mainfrom
update-ohe-release-notes-format

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

Updated the .agents/skills/ohe-release-notes.md skill to generate release notes matching the Agent Canvas format.

Key Changes

Modified Steps 4, 6, and 7

Step 4: Categorization structure

  • Changed from component-first (Enterprise Server → Features/Bug Fixes) to category-first (Features → Enterprise Server/SDK/etc.)
  • Top-level sections are now Features, Bug Fixes, and Maintenance with h4 component subsections under each

Step 6: Page format

  • Creates individual files enterprise/release-notes/X.Y.Z.mdx instead of updating a single file
  • Each release gets its own dedicated page
  • New format includes:
    • ## Highlights section with 2-5 customer-facing highlights at the top
    • ## Features, ## Bug Fixes, ## Maintenance sections with #### Component Name subsections
    • ## Full Changelog section with links to all component GitHub releases
  • Removed horizontal rules between component sections

Step 7: Navigation updates

  • Detailed instructions for creating/updating a "Release Notes" group in docs.json
  • New releases are prepended to the pages array (most recent first)

Step 8: Commit path

  • Updated to reference new file path: enterprise/release-notes/X.Y.Z.mdx

New Format Structure

---
title: OpenHands Enterprise X.Y.Z
description: Release notes for OpenHands Enterprise version X.Y.Z
---

# OpenHands Enterprise X.Y.Z

Released <Month Day, Year>.

## Highlights
- **Feature name** — Description

## Features
#### Enterprise Server
* feat: ...

## Bug Fixes
#### Enterprise Server
* fix: ...

## Maintenance
#### Runtime API
* ci: ...

## Full Changelog
- [Enterprise Server releases](link)
- [Software Agent SDK releases](link)

This brings consistency with the Agent Canvas release notes format where:

  • One page per release published as a child under release-notes
  • Categories are top-level sections with component subsections
  • Highlights section surfaces important changes first
  • Full changelog links provide easy access to detailed component releases

@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, 12:07 PM

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

@jpelletier1
jpelletier1 marked this pull request as draft September 23, 2026 12:10
@jpelletier1
jpelletier1 marked this pull request as ready for review September 23, 2026 20:08
@jpelletier1
jpelletier1 requested a review from mamoodi September 23, 2026 20:09
@jpelletier1
jpelletier1 merged commit 747e08b into main Sep 23, 2026
5 checks passed
@jpelletier1
jpelletier1 deleted the update-ohe-release-notes-format branch September 23, 2026 20:16

This branch was successfully deployed

1 active deployment
staging — 847d649e 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