Restructure documentation

Author: JohT

README.md

@@ -10,7 +10,32 @@ The process involves three steps:
 
 1. **Use**: Download the analysis results with [actions/download-artifact](https://github.com/actions/download-artifact) and utilize them as needed.
 
-## Example for TypeScript Code
+## Table of Contents
+<!-- TOC -->
+
+- [Table of Contents](#table-of-contents)
+- [:arrow_forward: Pipeline for TypeScript Code](#arrow_forward-pipeline-for-typescript-code)
+- [:arrow_forward: Pipeline for Java Artifacts](#arrow_forward-pipeline-for-java-artifacts)
+- [:page_with_curl: CSV Cypher Query Report Reference](#page_with_curl-csv-cypher-query-report-reference)
+- [:page_with_curl: Jupyter Notebook Report Reference](#page_with_curl-jupyter-notebook-report-reference)
+- [:camera: Image Reference](#camera-image-reference)
+- [:arrows_counterclockwise: Keeping the Analysis Workflow Updated with Renovate](#arrows_counterclockwise-keeping-the-analysis-workflow-updated-with-renovate)
+- [:page_facing_up: License](#page_facing_up-license)
+- [:chart: Analysis Results](#chart-analysis-results)
+    - [External Dependencies of Java Packages](#external-dependencies-of-java-packages)
+    - [Dependencies Graph of Java Artifacts](#dependencies-graph-of-java-artifacts)
+    - [Longest Paths of Java Artifacts](#longest-paths-of-java-artifacts)
+    - [All Pairs Shortest Paths of Java Packages per Artifact](#all-pairs-shortest-paths-of-java-packages-per-artifact)
+    - [Object-Oriented Design Metrics for Java Packages](#object-oriented-design-metrics-for-java-packages)
+    - [Effective Line Count of Java Methods](#effective-line-count-of-java-methods)
+    - [Cyclomatic Complexity Distribution for Java Methods](#cyclomatic-complexity-distribution-for-java-methods)
+    - [Visibility of Java Types](#visibility-of-java-types)
+    - [Communities and Node Embeddings of Java Packages](#communities-and-node-embeddings-of-java-packages)
+    - [Word Cloud of Git Authors](#word-cloud-of-git-authors)
+
+<!-- /TOC -->
+
+## :arrow_forward: Pipeline for TypeScript Code
 
 This example demonstrates how to analyze TypeScript code in a GitHub Workflows pipeline.
 
@@ -29,7 +54,7 @@ This example demonstrates how to analyze TypeScript code in a GitHub Workflows p
 
 3. The third job, [analyze-code-graph](https://github.com/JohT/code-graph-analysis-examples/blob/23143b34d8fc6e0ab7d80102d8de0b6e6a4ec98e/.github/workflows/typescript-code-analysis.yml#L99), demonstrates how to download the analysis results and commit them back to the repository.
 
-## Example for Java Artifacts
+## :arrow_forward: Pipeline for Java Artifacts
 
 Java artifacts are analyzed similarly to TypeScript code. The main difference is that Java artifacts are downloaded from a Maven repository instead of being part of the repository.
 
@@ -39,7 +64,35 @@ The first job, [prepare-code-to-analyze](https://github.com/JohT/code-graph-anal
 
 The second and third jobs are the same as for the TypeScript example.
 
-## Analysis Results
+## :page_with_curl: CSV Cypher Query Report Reference
+
+[CSV_REPORTS.md](./analysis-results/CSV_REPORTS.md) lists all CSV Cypher query result reports inside the [results](./results) directory. It can be generated as described in [Generate CSV Report Reference](./COMMANDS.md#generate-csv-cypher-query-report-reference).
+
+## :page_with_curl: Jupyter Notebook Report Reference
+
+[JUPYTER_REPORTS.md](./analysis-results/JUPYTER_REPORTS.md) lists all Jupyter Notebook reports inside the [results](./results) directory. It can be generated as described in [Generate Jupyter Notebook Report Reference](./COMMANDS.md#generate-jupyter-notebook-report-reference).
+
+## :camera: Image Reference
+
+[IMAGES.md](./analysis-results/IMAGES.md) lists all PNG images inside the [results](./results) directory. It can be generated as described in [Generate Image Reference](./COMMANDS.md#generate-image-reference).
+
+## :arrows_counterclockwise: Keeping the Analysis Workflow Updated with Renovate
+
+This repository uses [Renovate](https://docs.renovatebot.com) to automatically update the analysis workflow to the latest version. To enable this, add the following extension to your Renovate configuration:
+
+```json
+"extends": [
+  "github>JohT/code-graph-analysis-pipeline//renovate-presets/code-graph-analysis-workflow-latest-digest.json5"
+]
+```
+
+You can find the complete configuration in the [renovate.json](./renovate.json) file.
+
+## :page_facing_up: License
+
+This repository is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text.
+
+## :chart: Analysis Results
 
 Here are ten examples from over a hundred reports generated by the analysis. These examples illustrate the results of analyzing [AxonFramework](https://github.com/AxonFramework/AxonFramework), a Java framework for Evolutionary Message-Driven Microservices on the JVM. For the complete set of reports, visit the [analysis-results](./analysis-results) directory.
 
@@ -82,31 +135,3 @@ Here are ten examples from over a hundred reports generated by the analysis. The
 ### Word Cloud of Git Authors
 
 <img src="./analysis-results/AxonFramework/latest/wordcloud/Wordcloud_files/Wordcloud_17_0.png" width="600" alt="Word cloud of git authors">
-
-## :page_with_curl: CSV Cypher Query Report Reference
-
-[CSV_REPORTS.md](./analysis-results/CSV_REPORTS.md) lists all CSV Cypher query result reports inside the [results](./results) directory. It can be generated as described in [Generate CSV Report Reference](./COMMANDS.md#generate-csv-cypher-query-report-reference).
-
-## :page_with_curl: Jupyter Notebook Report Reference
-
-[JUPYTER_REPORTS.md](./analysis-results/JUPYTER_REPORTS.md) lists all Jupyter Notebook reports inside the [results](./results) directory. It can be generated as described in [Generate Jupyter Notebook Report Reference](./COMMANDS.md#generate-jupyter-notebook-report-reference).
-
-## :camera: Image Reference
-
-[IMAGES.md](./analysis-results/IMAGES.md) lists all PNG images inside the [results](./results) directory. It can be generated as described in [Generate Image Reference](./COMMANDS.md#generate-image-reference).
-
-## Keeping the Analysis Workflow Updated with Renovate
-
-This repository uses [Renovate](https://docs.renovatebot.com) to automatically update the analysis workflow to the latest version. To enable this, add the following extension to your Renovate configuration:
-
-```json
-"extends": [
-  "github>JohT/code-graph-analysis-pipeline//renovate-presets/code-graph-analysis-workflow-latest-digest.json5"
-]
-```
-
-You can find the complete configuration in the [renovate.json](./renovate.json) file.
-
-## License
-
-This repository is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text.