Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
neubig opened this issue Nov 21, 2024 · 2 comments
Open

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

neubig opened this issue Nov 21, 2024 · 2 comments
Labels
documentation Related to documentation fix-me Attempt to fix this issue with OpenHands

Comments

@neubig
Copy link
Contributor

neubig commented Nov 21, 2024

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.

@neubig neubig added the fix-me Attempt to fix this issue with OpenHands label Nov 21, 2024
Copy link
Contributor

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

Copy link
Contributor

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.

@mamoodi mamoodi added the documentation Related to documentation label Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to documentation fix-me Attempt to fix this issue with OpenHands
Projects
None yet
Development

No branches or pull requests

2 participants