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

Update documentation - Queued for next release #6716

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

mamoodi
Copy link
Collaborator

@mamoodi mamoodi commented Feb 13, 2025

End-user friendly description of the problem this fixes or functionality that this introduces

  • Include this change in the Release Notes. If checked, you must provide an end-user friendly description for your change below

Update documentation.


Give a summary of what the PR does, explaining any non-trivial design decisions

  • Update doc style guide with referencing UI elements
  • Add Most Popular Links to Home Page
  • Updated docs to reflect new settings page
  • Small change to Installation version section and add an extra link for better flow
  • In the GUI mode page, make the github token sections collapsible so the page does not seem too long. Remove unnecessary sections.

Link of any specific issues this addresses


To run this PR locally, use the following command:

docker run -it --rm   -p 3000:3000   -v /var/run/docker.sock:/var/run/docker.sock   --add-host host.docker.internal:host-gateway   -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:d2162c1-nikolaik   --name openhands-app-d2162c1   docker.all-hands.dev/all-hands-ai/openhands:d2162c1

@mamoodi
Copy link
Collaborator Author

mamoodi commented Feb 14, 2025

I'm going to update this PR with the new settings and queue it for release.

@mamoodi mamoodi changed the title Update documentation (Home page, GUI mode, Installation) Update documentation Feb 14, 2025
1. **Generate a Personal Access Token (PAT)**:
- Go to GitHub Settings > Developer Settings > Personal Access Tokens > Tokens (classic).
- Click "Generate new token (classic)".
- **Local (OSS)**: The user directly inputs their GitHub token.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- **Local (OSS)**: The user directly inputs their GitHub token.
- **Local Installation**: The user directly inputs their GitHub token.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If we have the other one named "OpenHands Cloud", would it make sense to call this "OpenHands Local"?
Local Installation here is fine too just wondering in general for when a user runs OpenHands locally, we call it that? :D

Copy link
Collaborator Author

@mamoodi mamoodi Feb 14, 2025

Choose a reason for hiding this comment

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

Actually this may be moot soon (we will likely be adding a separate Cloud section somewhere in the docs) so will go with your suggestion for now.

Copy link
Collaborator

Choose a reason for hiding this comment

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

just wondering in general for when a user runs OpenHands locally, we call it that? :D

We call it OpenHands. ✅

Hey, last we renamed this project, the name we settled on was OpenHands.

It wasn't "the OSS" nor "local OpenHands". Of course, I can see that for the sake of understanding each other in communication, we use these expressions at times. Idk, I also feel they are overused sometimes.

I look at it this way:

  • OpenHands is an open source project, MIT license
  • which means anyone, not just AH, can build and maintain a fork to run in the cloud
  • indeed, there seem to be other cloud installations of OpenHands (for example Daytona)
  • (or they could make a mobile app instead 🤷‍♂️)
  • Daytona or Joe Shmuck have the same right as All Hands AI to do the work of running OpenHands multi-user if they want to, and that's okay.
  • the Open Source OpenHands project enables that.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sounds great! Simple! 🚀

@mamoodi mamoodi changed the title Update documentation Update documentation - Queued for next release Feb 14, 2025
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.

2 participants