[docs] Visualization of the open-interpreter codebase #1632
+1,050
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe the changes you have made:
This PR adds diagram representation of the open-interpreter codebase. You can see how it renders here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/open-interpreter/on_boarding.md
The idea is to help new contributors have an overview of the main components within the project and how they interact with eachother. I saw that in your docs you have all the documentation in .md. If you like the diagrams I'd be more than happy to integrate our free github action to keep the diagrams up-to-date in your docs.
I am curious to hear what do you think of diagram first documentation (static analysis + LLMs).
Any feedback is more than welcome!
I'd usually start with a discussion but they are not enabled for this repo so I decided to do a PR instead!
Full disclosure: we're trying to turn this into a startup, but we're still in a very early stage and figuring out what will actually be useful for people.
Reference any relevant issues (e.g. "Fixes #000"):
Pre-Submission Checklist (optional but appreciated):
docs/CONTRIBUTING.md
docs/ROADMAP.md