Skip to content

Commit 346969a

Browse files
committed
Improved domains overview in documentation
1 parent 8d9ec32 commit 346969a

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,18 @@ If you think in architecture terms: domains are the vertical slices, report type
5656

5757
### Analysis Domains
5858

59-
- [Overview](./domains/overview/README.md) - High-level project structure, composition, counts, and complexity distributions.
60-
- [External Dependencies](./domains/external-dependencies/README.md) - Usage of external libraries, packages, modules, and namespaces.
61-
- [Internal Dependencies](./domains/internal-dependencies/README.md) - Internal dependency structure, path finding, topological order, OOD metrics, visibility metrics, and word clouds.
62-
- [Cyclic Dependencies](./domains/cyclic-dependencies/README.md) - Dedicated cycle analysis for Java artifacts, Java packages, and TypeScript modules.
63-
- [Java](./domains/java/README.md) - Java code quality, method metrics, annotations, and artifact dependency analysis.
64-
- [Git History](./domains/git-history/README.md) - Change frequency, co-change patterns, authorship, and repository evolution.
65-
- [Graph Algorithms](./domains/graph-algorithms/README.md) - Centrality, communities, similarity, and other Graph Data Science results.
66-
- [Node Embeddings](./domains/node-embeddings/README.md) - Graph embeddings and 2D projections for structural exploration.
67-
- [Anomaly Detection](./domains/anomaly-detection/README.md) - Machine-learning-supported structural anomaly detection.
68-
- [Archetypes](./domains/archetypes/README.md) - Structural roles such as authority, bottleneck, and hub.
59+
| Domain | Description | Java Example | TypeScript Example | Notebooks | Example Chart |
60+
|--------|-------------|--------------|--------------------|-----------|---------------|
61+
| [Anomaly Detection](./domains/anomaly-detection/README.md) | Machine-learning-supported structural anomaly detection | [AxonFramework](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/anomaly-detection/anomaly_detection_report.md) | [react-router](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/react-router/latest/anomaly-detection/anomaly_detection_report.md) | [Explore](./domains/anomaly-detection/explore/AnomalyDetectionExploration.ipynb) | [Anomalies](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/anomaly-detection/Java_Type/Anomalies.svg) |
62+
| [Archetypes](./domains/archetypes/README.md) | Structural roles: authority, bottleneck, and hub | [AxonFramework](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/archetypes/archetypes_report.md) | [react-router](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/react-router/latest/archetypes/archetypes_report.md) || [Treemap](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/archetypes/JavaTreemap1ArchetypesOverviewPerDirectory.svg) |
63+
| [Cyclic Dependencies](./domains/cyclic-dependencies/README.md) | Cycle analysis for Java artifacts, packages, and TypeScript modules | [AxonFramework](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/cyclic-dependencies/cyclic_dependencies_report.md) | [react-router](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/react-router/latest/cyclic-dependencies/cyclic_dependencies_report.md) | [Java](./domains/cyclic-dependencies/explore/CyclicDependenciesJavaExploration.ipynb) , [TypeScript](./domains/cyclic-dependencies/explore/CyclicDependenciesTypescriptExploration.ipynb) | [Cycle Graph](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/cyclic-dependencies/Java_Package/Graph_Visualizations/JavaPackageCyclicDependencies1.svg) |
64+
| [External Dependencies](./domains/external-dependencies/README.md) | Usage of external libraries, packages, modules, and namespaces | [AxonFramework](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/external-dependencies/external_dependencies_report.md) | [react-router](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/react-router/latest/external-dependencies/external_dependencies_report.md) | [Java](./domains/external-dependencies/explore/ExternalDependenciesJava.ipynb) , [TypeScript](./domains/external-dependencies/explore/ExternalDependenciesTypescript.ipynb) | [Most Spread Packages](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/external-dependencies/Java_Most_spread_packages_by_packages_above_threshold.svg) |
65+
| [Git History](./domains/git-history/README.md) | Change frequency, co-change patterns, authorship, and repository evolution | [AxonFramework](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/git-history/git_history_report.md) | [react-router](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/react-router/latest/git-history/git_history_report.md) | [General](./domains/git-history/explore/GitHistoryGeneralExploration.ipynb) , [Correlation](./domains/git-history/explore/GitHistoryCorrelationExploration.ipynb) | [Co-Changing Files](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/git-history/CoChangingFiles.svg) |
66+
| [Graph Algorithms](./domains/graph-algorithms/README.md) | Centrality, communities, similarity, and other Graph Data Science results | [AxonFramework](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/graph-algorithms/graph_algorithms_report.md) | [react-router](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/react-router/latest/graph-algorithms/graph_algorithms_report.md) |||
67+
| [Internal Dependencies](./domains/internal-dependencies/README.md) | Internal structure, path finding, topological order, OOD metrics, visibility metrics, and word clouds | [AxonFramework](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/internal-dependencies/internal_dependencies_report.md) | [react-router](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/react-router/latest/internal-dependencies/internal_dependencies_report.md) | [Java](./domains/internal-dependencies/explore/InternalDependenciesJava.ipynb) , [TypeScript](./domains/internal-dependencies/explore/InternalDependenciesTypescript.ipynb) | [Code Wordcloud](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/internal-dependencies/CodeNamesWordcloud.svg) |
68+
| [Java](./domains/java/README.md) | Java code quality, method metrics, annotations, and artifact dependency analysis | [AxonFramework](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/java/java_report.md) || [Method Metrics](./domains/java/explore/MethodMetricsJavaExploration.ipynb) | [Artifact Dependencies](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/java/ArtifactDependencies_OutgoingTop20_Bar.svg) |
69+
| [Node Embeddings](./domains/node-embeddings/README.md) | Graph embeddings and 2D projections for structural exploration | [AxonFramework](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/node-embeddings/node_embeddings_report.md) | [react-router](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/react-router/latest/node-embeddings/node_embeddings_report.md) | [Java](./domains/node-embeddings/explore/NodeEmbeddingsJavaExploration.ipynb) , [TypeScript](./domains/node-embeddings/explore/NodeEmbeddingsTypescriptExploration.ipynb) | [Package Embeddings 2D](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/node-embeddings/Package_Embeddings_FastRP_UMAP2D_Scatter.svg) |
70+
| [Overview](./domains/overview/README.md) | High-level project structure, composition, counts, and complexity distributions | [AxonFramework](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/overview/overview_report.md) | [react-router](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/react-router/latest/overview/overview_report.md) | [Java](./domains/overview/explore/OverviewJavaExploration.ipynb) , [TypeScript](./domains/overview/explore/OverviewTypescriptExploration.ipynb) | [Packages Per Artifact](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/overview/Overview_Java_Packages_Per_Artifact.svg) |
6971

7072
### Support Domain
7173

0 commit comments

Comments
 (0)