From a5025390af98011df60c8ce0c252827f694ce8ac Mon Sep 17 00:00:00 2001 From: Don Turner Date: Thu, 14 Mar 2024 13:36:17 +0000 Subject: [PATCH] Add title to READMEs to describe the dependency graph Change-Id: Ifb4b44e67df53ddd8ed048122c6c12a904e61528 --- app-nia-catalog/README.md | 4 ++-- app/README.md | 4 ++-- core/analytics/README.md | 2 +- core/common/README.md | 2 +- core/data-test/README.md | 2 +- core/data/README.md | 2 +- core/database/README.md | 2 +- core/datastore-proto/README.md | 2 +- core/datastore-test/README.md | 2 +- core/datastore/README.md | 2 +- core/designsystem/README.md | 2 +- core/domain/README.md | 2 +- core/model/README.md | 2 +- core/network/README.md | 2 +- core/notifications/README.md | 2 +- core/screenshot-testing/README.md | 2 +- core/testing/README.md | 2 +- core/ui/README.md | 2 +- feature/bookmarks/README.md | 2 +- feature/foryou/README.md | 2 +- feature/interests/README.md | 2 +- feature/search/README.md | 2 +- feature/settings/README.md | 2 +- feature/topic/README.md | 2 +- generateModuleGraphs.sh | 2 +- sync/sync-test/README.md | 2 +- sync/work/README.md | 2 +- 27 files changed, 29 insertions(+), 29 deletions(-) diff --git a/app-nia-catalog/README.md b/app-nia-catalog/README.md index 724f1effe..99503ba84 100644 --- a/app-nia-catalog/README.md +++ b/app-nia-catalog/README.md @@ -1,3 +1,3 @@ # :app-nia-catalog module - -![Dependency graph](../docs/images/graphs/dep_graph_app_nia_catalog.svg) +## Dependency graph +![Dependency graph](../../docs/images/graphs/dep_graph_app_nia_catalog.svg) diff --git a/app/README.md b/app/README.md index bbadc7330..f80083494 100644 --- a/app/README.md +++ b/app/README.md @@ -1,3 +1,3 @@ # :app module - -![Dependency graph](../docs/images/graphs/dep_graph_app.svg) +## Dependency graph +![Dependency graph](../../docs/images/graphs/dep_graph_app.svg) diff --git a/core/analytics/README.md b/core/analytics/README.md index c451cc838..d2bcd1ea7 100644 --- a/core/analytics/README.md +++ b/core/analytics/README.md @@ -1,3 +1,3 @@ # :core:analytics module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_analytics.svg) diff --git a/core/common/README.md b/core/common/README.md index 2fbc5a329..96558bcc6 100644 --- a/core/common/README.md +++ b/core/common/README.md @@ -1,3 +1,3 @@ # :core:common module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_common.svg) diff --git a/core/data-test/README.md b/core/data-test/README.md index 43804eeec..977ee10e4 100644 --- a/core/data-test/README.md +++ b/core/data-test/README.md @@ -1,3 +1,3 @@ # :core:data-test module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_data_test.svg) diff --git a/core/data/README.md b/core/data/README.md index a5a05870c..5d30f1638 100644 --- a/core/data/README.md +++ b/core/data/README.md @@ -1,3 +1,3 @@ # :core:data module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_data.svg) diff --git a/core/database/README.md b/core/database/README.md index 524cb5c48..855eab53e 100644 --- a/core/database/README.md +++ b/core/database/README.md @@ -1,3 +1,3 @@ # :core:database module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_database.svg) diff --git a/core/datastore-proto/README.md b/core/datastore-proto/README.md index 0b115b981..19ed58239 100644 --- a/core/datastore-proto/README.md +++ b/core/datastore-proto/README.md @@ -1,3 +1,3 @@ # :core:datastore-proto module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_datastore_proto.svg) diff --git a/core/datastore-test/README.md b/core/datastore-test/README.md index f59e9353d..99cf13f1f 100644 --- a/core/datastore-test/README.md +++ b/core/datastore-test/README.md @@ -1,3 +1,3 @@ # :core:datastore-test module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_datastore_test.svg) diff --git a/core/datastore/README.md b/core/datastore/README.md index e05e2ff72..4785c5885 100644 --- a/core/datastore/README.md +++ b/core/datastore/README.md @@ -1,3 +1,3 @@ # :core:datastore module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_datastore.svg) diff --git a/core/designsystem/README.md b/core/designsystem/README.md index 59f8cf803..d1778cb14 100644 --- a/core/designsystem/README.md +++ b/core/designsystem/README.md @@ -1,3 +1,3 @@ # :core:designsystem module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_designsystem.svg) diff --git a/core/domain/README.md b/core/domain/README.md index f86422435..cc6905846 100644 --- a/core/domain/README.md +++ b/core/domain/README.md @@ -1,3 +1,3 @@ # :core:domain module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_domain.svg) diff --git a/core/model/README.md b/core/model/README.md index c740370ac..efd0eec76 100644 --- a/core/model/README.md +++ b/core/model/README.md @@ -1,3 +1,3 @@ # :core:model module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_model.svg) diff --git a/core/network/README.md b/core/network/README.md index 4106f0dde..516aa2d38 100644 --- a/core/network/README.md +++ b/core/network/README.md @@ -1,3 +1,3 @@ # :core:network module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_network.svg) diff --git a/core/notifications/README.md b/core/notifications/README.md index 7d509913f..8f5607bdf 100644 --- a/core/notifications/README.md +++ b/core/notifications/README.md @@ -1,3 +1,3 @@ # :core:notifications module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_notifications.svg) diff --git a/core/screenshot-testing/README.md b/core/screenshot-testing/README.md index bab2e1a10..9bd4f1f9c 100644 --- a/core/screenshot-testing/README.md +++ b/core/screenshot-testing/README.md @@ -1,3 +1,3 @@ # :core:screenshot-testing module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_screenshot_testing.svg) diff --git a/core/testing/README.md b/core/testing/README.md index a7d40abcd..5a35d379b 100644 --- a/core/testing/README.md +++ b/core/testing/README.md @@ -1,3 +1,3 @@ # :core:testing module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_testing.svg) diff --git a/core/ui/README.md b/core/ui/README.md index e41b50bd5..38e514d01 100644 --- a/core/ui/README.md +++ b/core/ui/README.md @@ -1,3 +1,3 @@ # :core:ui module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_core_ui.svg) diff --git a/feature/bookmarks/README.md b/feature/bookmarks/README.md index 1af65fd92..54cbf91d0 100644 --- a/feature/bookmarks/README.md +++ b/feature/bookmarks/README.md @@ -1,3 +1,3 @@ # :feature:bookmarks module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_feature_bookmarks.svg) diff --git a/feature/foryou/README.md b/feature/foryou/README.md index fd864fbfa..0f08cb827 100644 --- a/feature/foryou/README.md +++ b/feature/foryou/README.md @@ -1,3 +1,3 @@ # :feature:foryou module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_feature_foryou.svg) diff --git a/feature/interests/README.md b/feature/interests/README.md index be94111d8..90a4fbc9c 100644 --- a/feature/interests/README.md +++ b/feature/interests/README.md @@ -1,3 +1,3 @@ # :feature:interests module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_feature_interests.svg) diff --git a/feature/search/README.md b/feature/search/README.md index c793d1543..e205970f0 100644 --- a/feature/search/README.md +++ b/feature/search/README.md @@ -1,3 +1,3 @@ # :feature:search module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_feature_search.svg) diff --git a/feature/settings/README.md b/feature/settings/README.md index 8620a2dcd..7a4df04fe 100644 --- a/feature/settings/README.md +++ b/feature/settings/README.md @@ -1,3 +1,3 @@ # :feature:settings module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_feature_settings.svg) diff --git a/feature/topic/README.md b/feature/topic/README.md index 199a9cb55..84588929c 100644 --- a/feature/topic/README.md +++ b/feature/topic/README.md @@ -1,3 +1,3 @@ # :feature:topic module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_feature_topic.svg) diff --git a/generateModuleGraphs.sh b/generateModuleGraphs.sh index fc4b190c8..27dea22da 100755 --- a/generateModuleGraphs.sh +++ b/generateModuleGraphs.sh @@ -65,7 +65,7 @@ check_and_create_readme() { # Calculate the correct relative path to the image local relative_image_path="../../docs/images/graphs/${file_name}.svg" echo "# ${module_path} module" > "$readme_path" - echo "" >> "$readme_path" + echo "## Dependency graph" >> "$readme_path" echo "![Dependency graph](${relative_image_path})" >> "$readme_path" fi } diff --git a/sync/sync-test/README.md b/sync/sync-test/README.md index 34ce5066a..78876290f 100644 --- a/sync/sync-test/README.md +++ b/sync/sync-test/README.md @@ -1,3 +1,3 @@ # :sync:sync-test module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_sync_sync_test.svg) diff --git a/sync/work/README.md b/sync/work/README.md index f31359e9f..2fe66d616 100644 --- a/sync/work/README.md +++ b/sync/work/README.md @@ -1,3 +1,3 @@ # :sync:work module - +## Dependency graph ![Dependency graph](../../docs/images/graphs/dep_graph_sync_work.svg)