Skip to content

Conversation

@jamiechicago312
Copy link
Collaborator

@jamiechicago312 jamiechicago312 commented Oct 16, 2025

  • 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 adds both a dismissible banner and troubleshooting documentation for the GitHub organization rename from All-Hands-AI to OpenHands.

Changes Made

Banner

  • Added a banner configuration to docs.json with the following features:

Troubleshooting Documentation

  • Added new troubleshooting section "GitHub Organization Rename Issues" to the troubleshooting documentation
  • Includes step-by-step instructions for updating git remotes (both SSH and HTTPS)
  • Covers Docker image reference updates from ghcr.io/all-hands-ai/ to ghcr.io/openhands/
  • Provides commands to find and update hardcoded references
  • Follows the existing format, tone, and length of other troubleshooting items

Testing

  • Tested locally using mintlify dev to confirm the banner renders correctly
  • Verified the banner appears at the top of all pages
  • Confirmed the link works and the banner is dismissible
  • Banner styling matches the OpenHands branding
  • Verified the troubleshooting section follows the same format as existing entries
  • Content is concise and to the point as requested
  • Instructions are clear and actionable

Related Issues

Fixes #2
Fixes #3

References

@jamiechicago312 can click here to continue refining the PR

- Added dismissible banner announcing All-Hands-AI to OpenHands org rename
- Banner displays at top of all documentation pages
- Includes migration date (Monday Oct 20th at 18:00 UTC) and link to details
- Fixes #2
jamiechicago312 and others added 3 commits October 16, 2025 15:35
- Updated banner style to use black background (#000000)
- Kept white text color (#ffffff) for contrast
- Removed invalid style property from banner configuration
- Attempted custom CSS approach but Mintlify banner styles are protected
- Current yellow background with white text is ADA compliant
- Banner functionality works correctly with dismissible feature
Fixes #3

- Added concise troubleshooting section for GitHub org rename issues
- Includes git remote update instructions
- Covers Docker image reference updates
- Provides commands to find hardcoded references

Co-authored-by: openhands <openhands@all-hands.dev>
@jamiechicago312 jamiechicago312 marked this pull request as draft October 16, 2025 19:57
@jamiechicago312 jamiechicago312 changed the title Add GitHub org rename banner to documentation Add GitHub organization rename banner and troubleshooting section Oct 16, 2025
@jamiechicago312 jamiechicago312 marked this pull request as ready for review October 16, 2025 20:03
Copy link
Contributor

@raymyers raymyers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine if we can get it not to be white text on yellow. I can try and help with CSS

@raymyers raymyers merged commit 0dafe2d into OpenHands:main Oct 16, 2025
enyst pushed a commit that referenced this pull request Nov 8, 2025
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