I generated a diagram representation of fastapi-pagination's codebase #1575
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.
-
I generated an interactive diagram representation to explore the kotaemon project. The diagram starts from high/abstract level components and how they interact with each other:
graph LR FastAPI_Integration_Module["FastAPI Integration Module"] Core_Pagination_Logic["Core Pagination Logic"] Database_ORM_Adapters["Database/ORM Adapters"] Pagination_Model_Customization["Pagination Model & Customization"] Pagination_Link_Generation["Pagination Link Generation"] FastAPI_Integration_Module -- "Initiates pagination flow and passes parameters" --> Core_Pagination_Logic FastAPI_Integration_Module -- "Uses models for OpenAPI schema generation" --> Pagination_Model_Customization Core_Pagination_Logic -- "Delegates data retrieval and pagination execution" --> Database_ORM_Adapters Core_Pagination_Logic -- "Constructs response objects based on defined models" --> Pagination_Model_Customization Core_Pagination_Logic -- "Requests and incorporates navigation links into the response" --> Pagination_Link_Generation Database_ORM_Adapters -- "Returns paginated data" --> Core_Pagination_Logic Pagination_Model_Customization -- "Provides model definitions for response structuring" --> Core_Pagination_Logic Pagination_Link_Generation -- "Supplies generated links" --> Core_Pagination_Logic Core_Pagination_Logic -- "Returns the final paginated response" --> FastAPI_Integration_Module click FastAPI_Integration_Module href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/fastapi-pagination/FastAPI_Integration_Module.md" "Details" click Core_Pagination_Logic href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/fastapi-pagination/Core_Pagination_Logic.md" "Details" click Database_ORM_Adapters href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/fastapi-pagination/Database_ORM_Adapters.md" "Details" click Pagination_Model_Customization href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/fastapi-pagination/Pagination_Model_Customization.md" "Details" click Pagination_Link_Generation href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/fastapi-pagination/Pagination_Link_Generation.md" "Details"Then if you click on each of the component you will get the same style of diagram on how that components works.
The full diagram is here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/kotaemon/on_boarding.md
The diagram is generated by the tool I built: https://github.com/CodeBoarding/CodeBoarding
Would love to hear what you think of the diagram and in general the idea, if interested I will be more than happy to open a PR (also working on a github action to keep the diagrams up-to-date)
Beta Was this translation helpful? Give feedback.
All reactions