Skip to content

[docs] Visualization of the open-interpreter codebase #1632

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ivanmilevtues
Copy link

@ivanmilevtues ivanmilevtues commented Jun 28, 2025

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):

  • I have included relevant documentation updates (stored in /docs)
  • I have read docs/CONTRIBUTING.md
  • I have read docs/ROADMAP.md

@ivanmilevtues ivanmilevtues changed the title Added high-level diagrams [docs] Visualization of the open-interpreter codebase Jun 28, 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.

1 participant