Add Organizations documentation for OpenHands Cloud#479
Conversation
Add documentation for the Organizations feature, which is a commercial feature available with OpenHands Cloud subscription or OpenHands Enterprise. New documentation pages: - organizations/overview.mdx - Feature overview and key capabilities - organizations/managing-members.mdx - How to invite and manage users - organizations/roles-permissions.mdx - Permissions table and role descriptions - organizations/settings.mdx - LLM config, credits, and Git org claiming Updated docs.json to add Organizations section to the Cloud tab. Co-authored-by: openhands <openhands@all-hands.dev>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
@OpenHands move the "Organizations" section under "Cloud" tab to just above the "Automations" section |
|
I'm on it! jpelletier1 can track my progress at all-hands.dev |
Co-authored-by: openhands <openhands@all-hands.dev>
Summary of WorkI successfully completed the requested navigation change for PR #479. Request Completion Checklist:
Changes Made:The "Organizations" group in Previous order:
New order:
Conciseness:The change was minimal and precise - only the navigation group order was modified in The update has been pushed to PR #479 and is now live on the branch. |
all-hands-bot
left a comment
There was a problem hiding this comment.
The documentation structure is solid, but there are critical consistency issues with UI navigation instructions that will confuse users. The terminology switches between "Org Members" tab/link, "Members" tab, and "Organization" link across different pages without clear distinction.
Review SummaryTaste Rating: 🟡 Acceptable - Good structure and comprehensive coverage, but navigation instructions need consistency work [CRITICAL ISSUES] (Must fix before merge)
[IMPROVEMENT OPPORTUNITIES] (Should fix)
[TESTING GAPS]
[RISK ASSESSMENT]
This is documentation-only, so there's no risk of breaking functionality. However:
Recommendation: Fix the terminology inconsistencies by verifying the actual UI labels and using them consistently across all four organization documentation pages. Run VERDICT: KEY INSIGHT:
|
|
I'm on it! all-hands-bot can track my progress at all-hands.dev |
…d settings docs
- managing-members.mdx:
- Inviting: use 'Hover over profile icon' with direct 'Invite Organization Members' button (actual UI label)
- Changing roles: consistent navigation using 'Org Members' nav label
- Removing: fix incorrect nav flow ('organization settings page' + 'Members tab') to use 'Org Members'
- settings.mdx:
- Credits: clarify nav flow and use actual button label '+ Add'
- Git routing: remove inaccurate steps (provider selection, org name entry, verification); orgs are listed automatically from connected identities
- Monitoring: use bold for 'Organization' nav label for consistency
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Review Feedback AddressedAll critical issues from the code review have been fixed in commits 312ab9c and 3dd9e26. Changes Made
Note on 'Organization' vs 'Org Members'The reviewer flagged these as inconsistent, but they are actually two distinct nav items in the OpenHands UI (verified against settings-nav.tsx):
Both labels are correct for their respective sections. This comment was created by an AI agent (OpenHands) on behalf of the user. |
Summary of Work DoneAll review feedback on PR #479 has been addressed. Here's a checklist of what was requested vs. what was completed: Critical Issues (Must fix before merge)
Improvement Opportunities (Should fix)
Bonus Fix (from review suggestion)
ConcisenessAll changes are minimal and directly address the flagged issues. No extraneous changes were made. Process
|
|
@mamoodi any chance I can get your 👁️ on this? Hoping to publish some initial docs on Orgs. |
all-hands-bot
left a comment
There was a problem hiding this comment.
The documentation is well-structured and mostly clear. I've identified a few areas where navigation instructions are inconsistent or claims need verification. See inline comments for details.
Co-authored-by: OpenHands Bot <contact@all-hands.dev>
Co-authored-by: OpenHands Bot <contact@all-hands.dev>
|
@OpenHands under the organization/settings page under "Monitoring Usage" remove "Credit usage over time" and "Usage breakdown by member". instead, reference the API "/api/organizations/{org_id}/members/financial" |
|
I'm on it! jpelletier1 can track my progress at all-hands.dev |
Removed 'Credit usage over time' and 'Usage breakdown by member' from the
Monitoring Usage section. Added reference to the API endpoint
/api/organizations/{org_id}/members/financial for detailed user-level
usage reporting.
Co-authored-by: openhands <openhands@all-hands.dev>
Summary of Work DoneI've successfully addressed the PR comment from @jpelletier1 on PR #479. Request Completion Checklist:
Changes Made:File: The Monitoring Usage section was updated from a bullet list showing three items to a concise paragraph mentioning only the current credit balance, followed by API documentation for detailed user-level reporting. Conciseness Check:✅ The changes are minimal and focused — only the specific content requested was modified. No extraneous changes were made. Commit: |
Summary of changes
This PR adds documentation for the Organizations feature, which is a commercial feature available with an OpenHands Cloud subscription or OpenHands Enterprise.
New Documentation Pages
1.
openhands/usage/cloud/organizations/overview.mdx2.
openhands/usage/cloud/organizations/managing-members.mdx3.
openhands/usage/cloud/organizations/roles-permissions.mdx4.
openhands/usage/cloud/organizations/settings.mdxNavigation Update
Updated
docs.jsonto add a new "Organizations" group in the Cloud tab with a building icon, positioned after "OpenHands Cloud" and before "Settings".This PR was created by an AI agent (OpenHands) on behalf of the user.
@jpelletier1 can click here to continue refining the PR