I generated a diagram for contextgem's codebase #64
Closed
ivanmilevtues
started this conversation 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.
-
Hey, 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:
graph LR Document_Ingestion_Preprocessing["Document Ingestion & Preprocessing"] Schema_Definition_Validation["Schema Definition & Validation"] LLM_Interaction_Prompt_Engineering["LLM Interaction & Prompt Engineering"] Extraction_Orchestration["Extraction Orchestration"] Extracted_Data_Management["Extracted Data Management"] Output_Serialization["Output & Serialization"] Document_Ingestion_Preprocessing -- "Provides cleaned and segmented document text for prompt context." --> LLM_Interaction_Prompt_Engineering Schema_Definition_Validation -- "Supplies structured schemas and validation rules for prompt generation." --> LLM_Interaction_Prompt_Engineering LLM_Interaction_Prompt_Engineering -- "Sends raw LLM responses for further processing and validation." --> Extraction_Orchestration Extraction_Orchestration -- "Sends extracted items for validation against defined schemas." --> Schema_Definition_Validation Schema_Definition_Validation -- "Stores validated `Aspects` and `Concepts`." --> Extracted_Data_Management Extracted_Data_Management -- "Provides the stored `Aspects` and `Concepts` for conversion into external formats." --> Output_Serialization click Document_Ingestion_Preprocessing href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/contextgem/Document_Ingestion_Preprocessing.md" "Details" click Schema_Definition_Validation href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/contextgem/Schema_Definition_Validation.md" "Details" click Extraction_Orchestration href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/contextgem/Extraction_Orchestration.md" "Details" click Extracted_Data_Management href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/contextgem/Extracted_Data_Management.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/contextgem/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