All-Hands-AI / OpenHands

🙌 OpenHands: Code Less, Make More
https://all-hands.dev
MIT License
37.61k stars 4.25k forks source link

docs: Improve GitHub token setup documentation in UI guide #5162

Open neubig opened 1 week ago

neubig commented 1 week ago

The current documentation about GitHub token setup in the GUI mode guide is minimal and could be improved to help users better understand the process.

Needed improvements:

  1. Add step-by-step instructions for setting up a GitHub token locally:

    • How to access the token settings in the UI
    • Required token scopes and permissions
    • How to enter and save the token
  2. Add information about organizational token policies:

  3. Add troubleshooting section:

    • Common issues with token setup
    • How to verify token is working correctly
    • What to do if token is not being recognized
  4. Clarify OAuth flow for online mode:

    • Explain what permissions are requested
    • How to review and approve access
    • What to do if authentication fails

This will help users better understand how to set up GitHub integration in both local and online modes, and how to handle organizational requirements.

github-actions[bot] commented 1 week ago

OpenHands started fixing the issue! You can monitor the progress here.

github-actions[bot] commented 1 week ago

An attempt was made to automatically fix this issue, but it was unsuccessful. A branch named 'openhands-fix-issue-5162' has been created with the attempted changes. You can view the branch here. Manual intervention may be required.