Skip to content

Move Cloud tab docs under enterprise#451

Open
enyst wants to merge 6 commits into
mainfrom
openhands-workspace-1926lVVI1FpsfBA2u2GZFh
Open

Move Cloud tab docs under enterprise#451
enyst wants to merge 6 commits into
mainfrom
openhands-workspace-1926lVVI1FpsfBA2u2GZFh

Conversation

@enyst
Copy link
Copy Markdown
Collaborator

@enyst enyst commented Apr 11, 2026

  • 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

  • move Cloud-tab-owned docs from openhands/usage/... to enterprise/usage/...
  • update the Cloud tab in docs.json to use the new enterprise/... paths
  • add redirects from the legacy openhands/usage/... routes so the visible docs URLs continue to work
  • update AGENTS.md to reflect the new Cloud docs location convention

This PR was created by an AI assistant (OpenHands) on behalf of the user.

Co-authored-by: openhands <openhands@all-hands.dev>
@enyst enyst requested a review from mamoodi as a code owner April 11, 2026 22:01
@mintlify
Copy link
Copy Markdown

mintlify Bot commented Apr 11, 2026

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

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview Apr 11, 2026, 10:02 PM

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

Copy link
Copy Markdown
Contributor

@all-hands-bot all-hands-bot left a comment

Choose a reason for hiding this comment

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

🔴 Needs rework - The file reorganization structure is sound, but you've moved the files without updating their internal cross-references.

[CRITICAL ISSUES]

  • Internal Links (52 broken): All moved files still reference /openhands/usage/ paths internally. Examples:

    • enterprise/usage/settings/api-keys-settings.mdx line 7: /openhands/usage/cloud/openhands-cloud
    • enterprise/usage/settings/integrations-settings.mdx line 10: /openhands/usage/cloud/openhands-cloud
    • Total: 34 refs to /openhands/usage/cloud/, 18 to other moved paths
  • Duplicate Navigation: integrations-settings appears in both Settings and Integrations groups (docs.json lines 390 and 397)

[FIX]

Run this search-and-replace across all moved files:

find enterprise/usage -name '*.mdx' -type f -exec sed -i \
  's|/openhands/usage/cloud/|/enterprise/usage/cloud/|g; \
   s|/openhands/usage/settings/|/enterprise/usage/settings/|g; \
   s|/openhands/usage/automations/|/enterprise/usage/automations/|g; \
   s|/openhands/usage/api/|/enterprise/usage/api/|g' {} +

Remove the duplicate integrations-settings entry from the Integrations group in docs.json.

VERDICT:Needs rework - Must fix broken internal links

KEY INSIGHT: When moving documentation, internal cross-references matter as much as the file paths.

Comment thread docs.json Outdated
Co-authored-by: openhands <openhands@all-hands.dev>
Copy link
Copy Markdown
Collaborator Author

enyst commented Apr 11, 2026

Addressed the review feedback in 8332c17:

  • updated internal links inside the moved enterprise/usage/... pages so links to other moved pages now point at their new enterprise/... locations
  • left links to unmoved pages (for example application-settings, llm-settings, mcp-settings, and secrets-settings) unchanged
  • removed the duplicate integrations-settings entry from the Cloud tab
  • re-verified that there are no remaining references from enterprise/usage/... docs to the old moved paths, and that the Cloud tab no longer has duplicate page entries

This comment was created by an AI assistant (OpenHands) on behalf of the user.

Copy link
Copy Markdown
Contributor

@all-hands-bot all-hands-bot left a comment

Choose a reason for hiding this comment

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

🟡 Acceptable - The file reorganization is technically sound, but lacks build verification.

KEY INSIGHT: This is a straightforward directory restructure with proper link updates and backward-compatible redirects. The execution is pragmatic and clean, but you didn't prove it works.

Comment thread docs.json
Comment thread docs.json
Copy link
Copy Markdown
Contributor

@all-hands-bot all-hands-bot left a comment

Choose a reason for hiding this comment

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

🟡 Acceptable - Files moved correctly with proper internal updates, but external references weren't updated.

KEY INSIGHT: The reorganization is half-complete—moved files are clean, but 12 other docs still use old paths, creating redirect hops and inconsistency.

Comment thread AGENTS.md Outdated
Co-authored-by: openhands <openhands@all-hands.dev>
Copy link
Copy Markdown
Contributor

@all-hands-bot all-hands-bot left a comment

Choose a reason for hiding this comment

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

🟡 Acceptable - Clean directory reorganization with proper redirects and comprehensive link updates.

KEY INSIGHT: This is a well-executed mechanical refactor. You mentioned running mint broken-links in a review comment, but the PR description checkbox for local verification is unchecked—consider documenting the verification in an Evidence section for future reference.

Copy link
Copy Markdown
Contributor

@xingyaoww xingyaoww left a comment

Choose a reason for hiding this comment

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

I'm not 100% sure if "Cloud" counts as enterprise here?
Enterprise probably refers to self-hosted deployment if i understand correctly

cc @jpelletier1 @jpshackelford

@jpelletier1
Copy link
Copy Markdown
Contributor

@xingyaoww In general, I am OK with this change. I think having the Cloud tab=Commercial Functionality, and the Enterprise tab=Self-hosted is fine for now. Ultimately, Enterprise has the same functionality as Cloud (with some more customization given it's self-hosted).

We also have a known product naming problem that I am working with Olivia on. Once resolved, I think this will provide some better organization of commercial functionality from both a docs and marketing perspective.

@enyst
Copy link
Copy Markdown
Collaborator Author

enyst commented Apr 13, 2026

Yes, Cloud and Enterprise are the same codebase and functionality, basically, I think?

  • Enterprise deployed on AH infra = "Cloud"
  • Enterprise deployed externally = "Enterprise"

If that is accurate, it makes some sense to me to have them in the same location or at least under the same big category ("enterprise").

I'm happy to make its own category too, if you wish?

I do think it's more "alike" enterprise than it is to OpenHands the open source project, that is the reason I propose this PR.

@enyst
Copy link
Copy Markdown
Collaborator Author

enyst commented Apr 14, 2026

@OpenHands Read and understand this PR, then merge main into it, solving the conflicts carefully. Document what you did.

@openhands-ai
Copy link
Copy Markdown

openhands-ai Bot commented Apr 14, 2026

I'm on it! enyst can track my progress at all-hands.dev

Bring the latest main changes into the Cloud-docs move branch, preserving the enterprise path migration while carrying over the new Jira integration overview content and contributing guide updates.

Co-authored-by: openhands <openhands@all-hands.dev>

This comment was marked as duplicate.

@openhands-ai

This comment was marked as duplicate.

@enyst
Copy link
Copy Markdown
Collaborator Author

enyst commented Apr 17, 2026

We also have a known product naming problem that I am working with Olivia on. Once resolved, I think this will provide some better organization of commercial functionality from both a docs and marketing perspective.

Sorry I ask, where the work on this, is there anything in the open from it? I would be happy to study it, so that I don’t take your time with questions that would be easily answered by just reading. Also, is Olivia on Slack? 🙏

You’re right, we have a naming problem, and not only on the Cloud/Enterprise side, it’s also in the Open Source project. And it has consequences.

OpenHands is Open Source software, under the MIT license. The Cloud / Enterprise docs should be separate from it, otherwise it’s very confusing what’s where and what functionality do people really get.

I think maybe the best structure of docs is like:

  • docs.openhands.dev/ = OpenHands, which is the SDK and Open Source sub-projects
  • enterprise.openhands.dev/ = Cloud and Enterprise tabs, maybe Use Cases if those are enterprise-oriented.

This PR is only fixing the underlying links, though, under the hybrid docs subdomain of today.

@jpelletier1
Copy link
Copy Markdown
Contributor

@enyst We aren't going to solve all the problems in this PR :-) Can we please keep the focus on fixing the underlying links, as the original scope of this PR?

Preserve the Cloud-tab docs move under enterprise paths while carrying over main's automation overview/examples consolidation and related documentation updates.

Co-authored-by: openhands <openhands@all-hands.dev>
@enyst enyst reopened this May 13, 2026
@enyst
Copy link
Copy Markdown
Collaborator Author

enyst commented May 13, 2026

@OpenHands understand this PR very well, and its description. Then merge main and fix the conflicts. Re-verify that the goal is achieved for the new pages and changed pages too.

@openhands-ai
Copy link
Copy Markdown

openhands-ai Bot commented May 13, 2026

I'm on it! enyst can track my progress at all-hands.dev

Preserve enterprise-owned Cloud docs paths and move new Cloud pages under enterprise.

Co-authored-by: openhands <openhands@all-hands.dev>
Copy link
Copy Markdown
Collaborator Author

enyst commented May 13, 2026

Merged main into this PR branch again and resolved the new conflicts in commit d947f9d.

What I changed:

  • kept the PR's Cloud-docs move under enterprise/
  • preserved the AGENTS.md guidance added on main while keeping the updated Cloud-docs location guidance
  • updated docs.json so the Cloud tab still uses enterprise-owned canonical paths after the merge
  • moved newly introduced Cloud-owned pages from main under enterprise/ as part of this PR's scope:
    • enterprise/usage/automations/event-automations.mdx
    • enterprise/usage/cloud/organizations/overview.mdx
    • enterprise/usage/cloud/organizations/managing-members.mdx
    • enterprise/usage/cloud/organizations/roles-permissions.mdx
    • enterprise/usage/cloud/organizations/settings.mdx
  • updated internal links in the moved/new enterprise pages so they point at the enterprise canonical locations
  • updated enterprise/enterprise-vs-oss.mdx to link to the enterprise automations canonical path

Re-verification:

  • python3 -m json.tool docs.json
  • ✅ Verified the Cloud tab now contains no legacy openhands/usage/... page paths
  • ✅ Verified the newly added event-automation and organization pages are present in the Cloud tab and exist on disk under enterprise/
  • ✅ Verified enterprise-owned docs no longer link back to the legacy moved paths
  • ⚠️ uv run --with pytest --with requests --with pyyaml pytest -q tests/ gets 34 passed, 2 errors; the remaining failures appear unrelated to this PR and come from tests/test_pricing_documentation.py fetching https://raw.githubusercontent.com/OpenHands/OpenHands/main/openhands/utils/llm.py, which currently returns 404 upstream

This comment was created by an AI agent (OpenHands) on behalf of the user.

@openhands-ai
Copy link
Copy Markdown

openhands-ai Bot commented May 13, 2026

Final summary of new work since the last summary:

  • Merged main into the PR branch again and resolved the newly introduced conflicts
  • Preserved the PR’s intended structure: Cloud-tab-owned docs remain under enterprise/
  • Carried forward new main additions into the same enterprise-owned structure:
    • enterprise/usage/automations/event-automations.mdx
    • enterprise/usage/cloud/organizations/{overview,managing-members,roles-permissions,settings}.mdx
  • Updated docs.json so the Cloud tab continues to point only to enterprise canonical paths, including the newly added pages
  • Preserved main’s new AGENTS.md guidance while keeping the updated Cloud docs location guidance
  • Fixed internal links in the newly moved/merged enterprise pages
  • Updated enterprise/enterprise-vs-oss.mdx to use the enterprise automations canonical path
  • Committed and pushed the merge resolution as d947f9d
  • Documented the work on PR Move Cloud tab docs under enterprise #451 in a GitHub comment

Verification completed:

  • docs.json parses successfully
  • Re-verified the Cloud tab contains no legacy openhands/usage/... page entries
  • Re-verified the new event-automation and organization pages exist under enterprise/ and are wired into the Cloud tab
  • Re-verified enterprise-owned docs no longer link back to the legacy moved paths

Test status:

  • Ran uv run --with pytest --with requests --with pyyaml pytest -q tests/
  • Full test pass was not achieved, but the remaining 2 failures appear unrelated to this PR: tests/test_pricing_documentation.py fetches an upstream file that currently returns 404

Conciseness:

  • The new changes were limited to the merge conflict resolution, path preservation, and verification required by the comment.
  • I did not add unrelated edits beyond what was needed to keep the PR goal intact after merging main.

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.

5 participants