Skip to content

Conversation

@ivanmilevtues
Copy link

This PR contains high-level diagrams representing the codebase of the python-asana repository.
You can see how it renders here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-asana/on_boarding.md

The goal of these diagrams is to give high-level understanding of the full project at a glance. And then one can get into details much easier about different components of the project. The way I generate these is based on Static Analysis and LLMs.
I would love to hear what your process for on-boarding in Asana is, what is your opinion on diagram first documentation?

In order to keep these docs update we are working on a github action at the moment. Let me know if this sounds like something interesting.

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.

@ivanmilevtues
Copy link
Author

A quick update https://github.com/CodeBoarding/CodeBoarding is open source now, so you can see exactly how we are generating these diagrams!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant