From 9a06043d48a684f29c8aeb1595102446fb1e9fae Mon Sep 17 00:00:00 2001 From: Andrew Bednoff Date: Mon, 13 May 2024 22:15:37 +0600 Subject: [PATCH] Made corrections to README.md description. --- docs/code_internals_visualizing/README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/code_internals_visualizing/README.md b/docs/code_internals_visualizing/README.md index c22d71d14..451dd1860 100644 --- a/docs/code_internals_visualizing/README.md +++ b/docs/code_internals_visualizing/README.md @@ -1,8 +1,12 @@ -# **Graphs Visualizations Generator** +# **GraphViz's Visualizations Generator** + +#### **GraphViz Visualizations Generator for the codebase and crates/modules.** This tool 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. + ## **Requirements:** - [Cargo-modules](https://github.com/regexident/cargo-modules) @@ -62,3 +66,8 @@ Graph of dependencies for modules in `lightning-service-executor` crate: Graph for code internals inside modules of `lightning-service-executor` crate (package), picturing interrelations of types, traits (abstract types, interfaces), and functions/methods to them: ![`lightning-service-executor` crate types/traits/functions interrelations](graphs_examples/crates_modules/lightning-service-executor/lightning-service-executor.types_traits_fns.svg) + +*Note:* + +The whole set of visualizations (exhaustive full set of code visualizations for `fdi` and `infusion` based branches of codebase, including visualizations for every crate/package and modules in `cargo` workspace, and visualizations using all +available `GraphViz` layout algorithms) will remain in [`docs/graphs` branch in git history](https://github.com/fleek-network/lightning/tree/9c4c9cb1a2a99001e18b34fe989500ab33cb2198/docs/code_internals_visualizing) for any reference.