Skip to content

Visualization of the typeshed codebase #14248

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

Closed
wants to merge 1 commit into from

Conversation

ivanmilevtues
Copy link

Added high-level diagrams representing the typeshed codebase.

You can see how they render in GitHub here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/typeshed/on_boarding.md

The idea of these diagrams is to help new contributors get up-to-speed with the existing codebase. We think here visuals are crucial as they give you enough context to concentrate on the interesting to you component. We also believe that such documents require a lot of effort from the maintainers so we are looking into creating github action which generates them, the generation is using both static analysis and LLMs.

Any feedback is more than welcome! I usually open discussions, but it seems like they are not enabled for this repo so I decide to open directly a PR.

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.

@hauntsaninja
Copy link
Collaborator

Same feedback as I had on other repos

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