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: add learning notes for a developer who are completely new fresh to OpenHands #6585

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

Conversation

georgesheth
Copy link

share learning note to understand how OpenHands works

  • [add learning notes on how OpenHands backend works by studying on its initialisation, interaction and knowledge management]
  • [add these notes as a new category into Sidebar to be shown on OpenHands Docs]

As a new developer who want to contribute to the development of OpenHands, he/she needs to understand how exactly OpenHands works in the background.
I take this initiative to study OpenHands with zero knowledge and make notes during my study, and now decide to share.
It could also take some other new developers to spend much efforts to familiar with OpenHands in order to do some code contribution. So why not share them ?
During my study of OpenHands Doc, it did not provide much information on how Backends works exactly, these information are embedded in the codebase, so I summary my learning notes to others and hopefully they will be useful to other new developers.
It did not touch on any other existing code, but only add new docs pages. The resulted changes are looks like as this attached images.

screenshot-20250203-021326


not link to any issues yet.

@georgesheth
Copy link
Author

@enyst or @mamoodi @openhands-agent you wanna a review ? I saw you have contributed lots to the docs.

@mamoodi
Copy link
Collaborator

mamoodi commented Feb 4, 2025

@enyst or @mamoodi @openhands-agent you wanna a review ? I saw you have contributed lots to the docs.

Thanks for your contribution! I'm not as familiar with the inner workings of OpenHands so I won't do a good job of reviewing.

I am wondering how this will be kept up to date as the project is moving and changing really fast. Have you thought about that as well?

@openhands-agent
Copy link
Contributor

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

@enyst
Copy link
Collaborator

enyst commented Feb 4, 2025

Thank you for this! I do think we have more improvements to make, to get openhands more friendly to new contributors.

I love the diagram in your screenshot! In the same time, Mamoodi makes a good point, and perhaps we don't shouldn't duplicate actual source code in the documentation. Instead, we actually have it automated in this Python API section: https://docs.all-hands.dev/modules/python/openhands/events/stream

How about we just link to some of those classes/files, for the most important types you uncovered?

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.

4 participants