Skip to content

Conversation

@xingyaoww
Copy link
Collaborator

@xingyaoww xingyaoww commented Sep 5, 2025

Overview

This PR integrates OpenHands documentation with the new unified docs repository (All-Hands-AI/docs) that aggregates documentation from multiple All-Hands-AI repositories using Git submodules and Mintlify.

Changes

✅ Added

  • GitHub Action (dispatch-to-docs.yml): Automatically notifies the docs repository when documentation changes are pushed to main
  • Updated README: Comprehensive documentation explaining the new synchronization workflow

❌ Removed

  • docs.json: Moved to the root of the docs repository for unified configuration across all repositories

How It Works

  1. Developer makes changes to docs/ in this repository
  2. Changes are pushed/merged to the main branch
  3. GitHub Action triggers and dispatches an event to the docs repository
  4. Docs repository updates its submodule reference to include the latest changes
  5. Mintlify automatically rebuilds and deploys the unified documentation site

Benefits

  • Unified Documentation: All All-Hands-AI documentation in one place
  • Automatic Synchronization: No manual intervention required
  • Version Control: Exact commit tracking for documentation versions
  • Scalable: Easy to add documentation from other repositories
  • Developer Friendly: No changes to existing documentation workflow

Implementation Details

This follows the pattern from this blog post for clean submodule auto-updates using repository dispatch events.

The docs repository is already set up and ready to receive updates from this repository.

Testing

After this PR is merged, any changes to the docs/ directory will automatically trigger updates to the unified documentation site.


Related: Sets up the OpenHands side of the unified documentation system established in All-Hands-AI/docs

@xingyaoww can click here to continue refining the PR


To run this PR locally, use the following command:

GUI with Docker:

docker run -it --rm   -p 3000:3000   -v /var/run/docker.sock:/var/run/docker.sock   --add-host host.docker.internal:host-gateway   -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:65c7486-nikolaik   --name openhands-app-65c7486   docker.all-hands.dev/all-hands-ai/openhands:65c7486

CLI with uvx:

uvx --python 3.12 --from git+https://github.com/All-Hands-AI/OpenHands@docs-repo-integration openhands

- Add GitHub Action to dispatch docs updates to All-Hands-AI/docs
- Remove docs.json (now managed in docs repo for unified configuration)
- Update docs README with new synchronization workflow
- Enable automatic documentation synchronization via submodules

This integrates OpenHands documentation with the new unified docs repository
that aggregates documentation from multiple All-Hands-AI repositories.

Co-authored-by: openhands <[email protected]>
@xingyaoww xingyaoww requested a review from mamoodi as a code owner September 5, 2025 02:15
@openhands-ai
Copy link

openhands-ai bot commented Sep 5, 2025

Looks like there are a few issues preventing this PR from being merged!

  • GitHub Actions are failing:
    • Lint

If you'd like me to help, just leave a comment, like

@OpenHands please fix the failing actions on PR #10830 at branch `docs-repo-integration`

Feel free to include any additional details that might help me get this PR into a better state.

You can manage your notification settings

Updated the token and module name in the workflow.
Copy link
Collaborator

@enyst enyst left a comment

Choose a reason for hiding this comment

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

LGTM

@xingyaoww xingyaoww merged commit 989a4e6 into main Sep 6, 2025
22 checks passed
@xingyaoww xingyaoww deleted the docs-repo-integration branch September 6, 2025 14:10
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.

4 participants