OpenHands icon indicating copy to clipboard operation
OpenHands copied to clipboard
verified publisher icon All-Hands-AI

Docs for OpenHands Cloud are Not Clear

Open neubig opened this issue 8 months ago • 3 comments

What problem or use case are you trying to solve?

The documentation for the Open Hands cloud does not clearly demonstrate the usage flow.

Describe the UX or technical implementation you have in mind

Within the front page of the OpenHands cloud, it should demonstrate how to step through each process of getting started. Each step of this process could be assigned its own page within the documentation.

  1. Getting Started a. Github Installation b. Gitlab Installation
  2. OpenHands Cloud UI
  3. OpenHands Cloud Resolver
  4. OpenHands Cloud API

Currently github installation and gitlab installation do not have their own separate pages, and using the online interface does not have a page. Each installation page could also include links at the end for next steps, pointing to the UI, resolver, cloud API pages.

For the "OpenHands Cloud UI" page, the content will be new. It should mostly just state that the cloud interface can be accessed at app.all-hands.dev and link to the main getting started page for more usage details. If there is an existing screenshot of the web interface, this can be reused here.

Make sure that the sidebar is also structured appropriately.

Thanks @jjmachan for the feedback on this.

If you find this feature request or enhancement useful, make sure to add a 👍 to the issue

neubig avatar May 17 '25 17:05 neubig

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

openhands-ai[bot] avatar May 17 '25 17:05 openhands-ai[bot]

I've successfully addressed issue #8557 by improving the OpenHands Cloud documentation structure. Here's a summary of the changes made:

  1. Created separate documentation pages:

    • Main "Getting Started" page for OpenHands Cloud
    • GitHub installation page with detailed setup instructions
    • GitLab installation page with detailed setup instructions
    • OpenHands Cloud UI page with information about the web interface

  2. Updated the sidebar structure in sidebars.ts to organize the documentation in a logical flow:

    • Created a nested "Installation" category with GitHub and GitLab options
    • Added the new Cloud UI page
    • Maintained existing Cloud API and GitHub Resolver pages

  3. Fixed links between pages to ensure proper navigation flow, including updating references in the GitHub Resolver page.

  4. Added "Next Steps" sections at the end of each page to guide users through the documentation.

  5. Created a placeholder for the UI screenshot.

All changes have been committed and pushed to the fix-cloud-docs branch, and I've created pull request #8558 that references and fixes issue #8557. The PR includes the required mention of @neubig and the continuation link.

The documentation now has a clear structure that guides users through the process of getting started with OpenHands Cloud, from installation to using the UI and advanced features.

PR Link: https://github.com/All-Hands-AI/OpenHands/pull/8558

openhands-ai[bot] avatar May 17 '25 17:05 openhands-ai[bot]

I have updated the PR with additional improvements:

  1. Fixed the broken image in Cloud UI page by adding a placeholder for future update
  2. Removed duplicated UI Features section from Cloud UI page and added link to Key Features
  3. Consolidated GitHub and GitLab resolver usage information into a single unified format

The PR has been updated with these changes: https://github.com/All-Hands-AI/OpenHands/pull/8558

neubig avatar May 17 '25 19:05 neubig