Skip to content
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

Docs/graphs - GraphViz Visualizations Generator for the codebase and crates/modules. #23

Merged
merged 7 commits into from
May 13, 2024

Conversation

andrcmdr
Copy link
Contributor

GraphViz's Visualizations Generator

GraphViz Visualizations Generator for the codebase and crates/modules.

In this branch:

This tool (the bash script) generates graph diagrams for the whole codebase or separate exact crates/modules.

It can generate graphs of dependencies for modules in a crate, and graphs for code internals inside modules of a crate (package), visualizing interrelations of types, traits (abstract types, interfaces), and functions/methods to them.

It can be used for documentation, onboarding new team-mates, and for analyzing the points of future architectural improvements.

andrcmdr added 7 commits May 6, 2024 17:37
…des in a graphs, for improvements of visualizations readability; structuring directories for every crate/package and module in `cargo` workspace, and for various layout algorithms.
… codebase, for every crate/package and modules in `cargo` workspace, including visualizations using all available `GraphViz` layout algorithms (for the sake of variety and diversity).
…base, for every crate/package and modules in `cargo` workspace, including visualizations using all available `GraphViz` layout algorithms (for the sake of variety and diversity).
… for `fdi` and `infusion` based branches of codebase, for the sake of simplicity.
@andrcmdr andrcmdr added the documentation Improvements or additions to documentation label May 13, 2024
@andrcmdr
Copy link
Contributor Author

No conflicts. Checks passed. Ready to merge.

@andrcmdr andrcmdr merged commit 9a06043 into main May 13, 2024
6 checks passed
@andrcmdr andrcmdr deleted the docs/graphs branch May 13, 2024 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants