I generated interactive diagram to explore the yarl project #1558
Unanswered
ivanmilevtues
asked this question in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hey all I am working on an open-source tool to generate interactive diagram representations of codebases. The diagram starts from the highest level of abstraction and if you click on any of the components, there is a diagram in the same style for that component.
This said I generated a diagram for yarl:
graph LR External_System["External System"] URL_Core["URL Core"] URL_Parsing_Engine["URL Parsing Engine"] Query_String_Management["Query String Management"] Path_Normalization["Path Normalization"] URL_Encoding_Quoting["URL Encoding/Quoting"] External_System -- "provides raw URL string to" --> URL_Parsing_Engine URL_Parsing_Engine -- "delivers parsed components to" --> URL_Core URL_Core -- "delegates query parameter operations to" --> Query_String_Management Query_String_Management -- "returns processed query data to" --> URL_Core URL_Core -- "requests path standardization from" --> Path_Normalization Path_Normalization -- "returns normalized path to" --> URL_Core URL_Core -- "sends components for encoding/decoding to" --> URL_Encoding_Quoting URL_Encoding_Quoting -- "returns processed components to" --> URL_Core click URL_Core href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/yarl/URL_Core.md" "Details" click URL_Parsing_Engine href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/yarl/URL_Parsing_Engine.md" "Details" click URL_Encoding_Quoting href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/yarl/URL_Encoding_Quoting.md" "Details"The generation tool is based on Static Analysis and LLMs and is fully open-source: https://github.com/CodeBoarding/CodeBoarding
You can see the full diagram here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/yarl/on_boarding.md
Any feedback is appreciated! Would love to hear your opinion on diagrams as an exploration tooling and diagram first documentation!
Beta Was this translation helpful? Give feedback.
All reactions