feat: Add auto-generated UML diagram to docs#110
Open
igopalakrishna wants to merge 2 commits intogoogle:copybara_pushfrom
Open
feat: Add auto-generated UML diagram to docs#110igopalakrishna wants to merge 2 commits intogoogle:copybara_pushfrom
igopalakrishna wants to merge 2 commits intogoogle:copybara_pushfrom
Conversation
Collaborator
|
As discussed, it would be nice to simplify the diagram (removing some of the details about parameters of each class), and orient it vertically (so we can perhaps include it in the documentation site). Also, the pre-commit hook is nice, but depending on how long it takes to run, we might prefer a more manual or occasional update process, to streamline the developer experience. Manual process might be fine, otherwise perhaps a GitHub action that runs once a month and creates a PR if there are any updates to the diagram. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #52
This pull request adds a UML class diagram to the main documentation page to help developers understand the project's code architecture.
Key Changes:
.pre-commit-config.yamlto automatically generate the diagram usingpyreverseandgraphviz.make umlcommand in theMakefile.docs/index.mdpage.docs/setup.mdguide was updated to includegraphvizas a required development dependency.