From b0ba79f515a47faba89da02eac3fc11f075e8906 Mon Sep 17 00:00:00 2001 From: Jaehwa Noh Date: Sun, 18 Jan 2026 22:56:04 +0900 Subject: [PATCH] Update README. Change-Id: Id0b58f086367f7d0e501d61146dab946a12370f2 --- app/README.md | 122 +++++++++++++----------------------- benchmarks/README.md | 122 +++++++++++++----------------------- feature/bookmarks/README.md | 28 +++------ feature/foryou/README.md | 25 ++------ feature/search/README.md | 30 ++------- feature/settings/README.md | 11 ++-- navigation/README.md | 119 +++++++++++++++++++++++++++++++++++ 7 files changed, 225 insertions(+), 232 deletions(-) create mode 100644 navigation/README.md diff --git a/app/README.md b/app/README.md index cbcdc35be..b0cf666db 100644 --- a/app/README.md +++ b/app/README.md @@ -11,42 +11,19 @@ config: nodePlacementStrategy: SIMPLE --- graph TB - subgraph :feature - direction TB - subgraph :feature:settings - direction TB - :feature:settings:impl[impl]:::android-library - end - subgraph :feature:foryou - direction TB - :feature:foryou:api[api]:::android-library - :feature:foryou:impl[impl]:::android-library - end - subgraph :feature:bookmarks - direction TB - :feature:bookmarks:api[api]:::android-library - :feature:bookmarks:impl[impl]:::android-library - end - subgraph :feature:search - direction TB - :feature:search:api[api]:::android-library - :feature:search:impl[impl]:::android-library - end - subgraph :feature:interests - direction TB - :feature:interests:api[api]:::android-library - :feature:interests:impl[impl]:::android-library - end - subgraph :feature:topic - direction TB - :feature:topic:api[api]:::android-library - :feature:topic:impl[impl]:::android-library - end - end subgraph :sync direction TB :sync:work[work]:::android-library end + subgraph :feature + direction TB + :feature:bookmarks[bookmarks]:::android-feature + :feature:foryou[foryou]:::android-feature + :feature:interests[interests]:::android-feature + :feature:search[search]:::android-feature + :feature:settings[settings]:::android-feature + :feature:topic[topic]:::android-feature + end subgraph :core direction TB :core:analytics[analytics]:::android-library @@ -63,6 +40,7 @@ graph TB :core:notifications[notifications]:::android-library :core:ui[ui]:::android-library end + :navigation[navigation]:::android-library :benchmarks[benchmarks]:::android-test :app[app]:::android-application @@ -72,18 +50,10 @@ graph TB :app -.-> :core:data :app -.-> :core:designsystem :app -.-> :core:model + :app -.-> :core:navigation :app -.-> :core:ui - :app -.-> :feature:bookmarks:api - :app -.-> :feature:bookmarks:impl - :app -.-> :feature:foryou:api - :app -.-> :feature:foryou:impl - :app -.-> :feature:interests:api - :app -.-> :feature:interests:impl - :app -.-> :feature:search:api - :app -.-> :feature:search:impl - :app -.-> :feature:settings:impl - :app -.-> :feature:topic:api - :app -.-> :feature:topic:impl + :app -.-> :feature:settings + :app -.-> :navigation :app -.-> :sync:work :benchmarks -.->|testedApks| :app :core:data -.-> :core:analytics @@ -105,43 +75,35 @@ graph TB :core:ui --> :core:analytics :core:ui --> :core:designsystem :core:ui --> :core:model - :feature:bookmarks:api --> :core:navigation - :feature:bookmarks:impl -.-> :core:data - :feature:bookmarks:impl -.-> :core:designsystem - :feature:bookmarks:impl -.-> :core:ui - :feature:bookmarks:impl -.-> :feature:bookmarks:api - :feature:bookmarks:impl -.-> :feature:topic:api - :feature:foryou:api --> :core:navigation - :feature:foryou:impl -.-> :core:designsystem - :feature:foryou:impl -.-> :core:domain - :feature:foryou:impl -.-> :core:notifications - :feature:foryou:impl -.-> :core:ui - :feature:foryou:impl -.-> :feature:foryou:api - :feature:foryou:impl -.-> :feature:topic:api - :feature:interests:api --> :core:navigation - :feature:interests:impl -.-> :core:designsystem - :feature:interests:impl -.-> :core:domain - :feature:interests:impl -.-> :core:ui - :feature:interests:impl -.-> :feature:interests:api - :feature:interests:impl -.-> :feature:topic:api - :feature:search:api -.-> :core:domain - :feature:search:api --> :core:navigation - :feature:search:impl -.-> :core:designsystem - :feature:search:impl -.-> :core:domain - :feature:search:impl -.-> :core:ui - :feature:search:impl -.-> :feature:interests:api - :feature:search:impl -.-> :feature:search:api - :feature:search:impl -.-> :feature:topic:api - :feature:settings:impl -.-> :core:data - :feature:settings:impl -.-> :core:designsystem - :feature:settings:impl -.-> :core:ui - :feature:topic:api -.-> :core:designsystem - :feature:topic:api --> :core:navigation - :feature:topic:api -.-> :core:ui - :feature:topic:impl -.-> :core:data - :feature:topic:impl -.-> :core:designsystem - :feature:topic:impl -.-> :core:ui - :feature:topic:impl -.-> :feature:topic:api + :feature:bookmarks -.-> :core:data + :feature:bookmarks -.-> :core:designsystem + :feature:bookmarks -.-> :core:ui + :feature:bookmarks -.-> :feature:topic + :feature:foryou -.-> :core:designsystem + :feature:foryou -.-> :core:domain + :feature:foryou -.-> :core:notifications + :feature:foryou -.-> :core:ui + :feature:interests -.-> :core:designsystem + :feature:interests -.-> :core:domain + :feature:interests -.-> :core:ui + :feature:search -.-> :core:designsystem + :feature:search -.-> :core:domain + :feature:search -.-> :core:ui + :feature:settings -.-> :core:data + :feature:settings -.-> :core:designsystem + :feature:settings -.-> :core:ui + :feature:topic -.-> :core:data + :feature:topic -.-> :core:designsystem + :feature:topic -.-> :core:ui + :navigation -.-> :core:designsystem + :navigation -.-> :core:model + :navigation -.-> :core:navigation + :navigation -.-> :feature:bookmarks + :navigation -.-> :feature:foryou + :navigation -.-> :feature:interests + :navigation -.-> :feature:search + :navigation -.-> :feature:settings + :navigation -.-> :feature:topic :sync:work -.-> :core:analytics :sync:work -.-> :core:data :sync:work -.-> :core:notifications diff --git a/benchmarks/README.md b/benchmarks/README.md index c2bbf2a2a..40422fc4f 100644 --- a/benchmarks/README.md +++ b/benchmarks/README.md @@ -11,42 +11,19 @@ config: nodePlacementStrategy: SIMPLE --- graph TB - subgraph :feature - direction TB - subgraph :feature:settings - direction TB - :feature:settings:impl[impl]:::android-library - end - subgraph :feature:foryou - direction TB - :feature:foryou:api[api]:::android-library - :feature:foryou:impl[impl]:::android-library - end - subgraph :feature:bookmarks - direction TB - :feature:bookmarks:api[api]:::android-library - :feature:bookmarks:impl[impl]:::android-library - end - subgraph :feature:search - direction TB - :feature:search:api[api]:::android-library - :feature:search:impl[impl]:::android-library - end - subgraph :feature:interests - direction TB - :feature:interests:api[api]:::android-library - :feature:interests:impl[impl]:::android-library - end - subgraph :feature:topic - direction TB - :feature:topic:api[api]:::android-library - :feature:topic:impl[impl]:::android-library - end - end subgraph :sync direction TB :sync:work[work]:::android-library end + subgraph :feature + direction TB + :feature:bookmarks[bookmarks]:::android-feature + :feature:foryou[foryou]:::android-feature + :feature:interests[interests]:::android-feature + :feature:search[search]:::android-feature + :feature:settings[settings]:::android-feature + :feature:topic[topic]:::android-feature + end subgraph :core direction TB :core:analytics[analytics]:::android-library @@ -63,6 +40,7 @@ graph TB :core:notifications[notifications]:::android-library :core:ui[ui]:::android-library end + :navigation[navigation]:::android-library :benchmarks[benchmarks]:::android-test :app[app]:::android-application @@ -72,18 +50,10 @@ graph TB :app -.-> :core:data :app -.-> :core:designsystem :app -.-> :core:model + :app -.-> :core:navigation :app -.-> :core:ui - :app -.-> :feature:bookmarks:api - :app -.-> :feature:bookmarks:impl - :app -.-> :feature:foryou:api - :app -.-> :feature:foryou:impl - :app -.-> :feature:interests:api - :app -.-> :feature:interests:impl - :app -.-> :feature:search:api - :app -.-> :feature:search:impl - :app -.-> :feature:settings:impl - :app -.-> :feature:topic:api - :app -.-> :feature:topic:impl + :app -.-> :feature:settings + :app -.-> :navigation :app -.-> :sync:work :benchmarks -.->|testedApks| :app :core:data -.-> :core:analytics @@ -105,43 +75,35 @@ graph TB :core:ui --> :core:analytics :core:ui --> :core:designsystem :core:ui --> :core:model - :feature:bookmarks:api --> :core:navigation - :feature:bookmarks:impl -.-> :core:data - :feature:bookmarks:impl -.-> :core:designsystem - :feature:bookmarks:impl -.-> :core:ui - :feature:bookmarks:impl -.-> :feature:bookmarks:api - :feature:bookmarks:impl -.-> :feature:topic:api - :feature:foryou:api --> :core:navigation - :feature:foryou:impl -.-> :core:designsystem - :feature:foryou:impl -.-> :core:domain - :feature:foryou:impl -.-> :core:notifications - :feature:foryou:impl -.-> :core:ui - :feature:foryou:impl -.-> :feature:foryou:api - :feature:foryou:impl -.-> :feature:topic:api - :feature:interests:api --> :core:navigation - :feature:interests:impl -.-> :core:designsystem - :feature:interests:impl -.-> :core:domain - :feature:interests:impl -.-> :core:ui - :feature:interests:impl -.-> :feature:interests:api - :feature:interests:impl -.-> :feature:topic:api - :feature:search:api -.-> :core:domain - :feature:search:api --> :core:navigation - :feature:search:impl -.-> :core:designsystem - :feature:search:impl -.-> :core:domain - :feature:search:impl -.-> :core:ui - :feature:search:impl -.-> :feature:interests:api - :feature:search:impl -.-> :feature:search:api - :feature:search:impl -.-> :feature:topic:api - :feature:settings:impl -.-> :core:data - :feature:settings:impl -.-> :core:designsystem - :feature:settings:impl -.-> :core:ui - :feature:topic:api -.-> :core:designsystem - :feature:topic:api --> :core:navigation - :feature:topic:api -.-> :core:ui - :feature:topic:impl -.-> :core:data - :feature:topic:impl -.-> :core:designsystem - :feature:topic:impl -.-> :core:ui - :feature:topic:impl -.-> :feature:topic:api + :feature:bookmarks -.-> :core:data + :feature:bookmarks -.-> :core:designsystem + :feature:bookmarks -.-> :core:ui + :feature:bookmarks -.-> :feature:topic + :feature:foryou -.-> :core:designsystem + :feature:foryou -.-> :core:domain + :feature:foryou -.-> :core:notifications + :feature:foryou -.-> :core:ui + :feature:interests -.-> :core:designsystem + :feature:interests -.-> :core:domain + :feature:interests -.-> :core:ui + :feature:search -.-> :core:designsystem + :feature:search -.-> :core:domain + :feature:search -.-> :core:ui + :feature:settings -.-> :core:data + :feature:settings -.-> :core:designsystem + :feature:settings -.-> :core:ui + :feature:topic -.-> :core:data + :feature:topic -.-> :core:designsystem + :feature:topic -.-> :core:ui + :navigation -.-> :core:designsystem + :navigation -.-> :core:model + :navigation -.-> :core:navigation + :navigation -.-> :feature:bookmarks + :navigation -.-> :feature:foryou + :navigation -.-> :feature:interests + :navigation -.-> :feature:search + :navigation -.-> :feature:settings + :navigation -.-> :feature:topic :sync:work -.-> :core:analytics :sync:work -.-> :core:data :sync:work -.-> :core:notifications diff --git a/feature/bookmarks/README.md b/feature/bookmarks/README.md index 123a842f6..ef84d5978 100644 --- a/feature/bookmarks/README.md +++ b/feature/bookmarks/README.md @@ -13,15 +13,8 @@ config: graph TB subgraph :feature direction TB - subgraph :feature:bookmarks - direction TB - :feature:bookmarks:api[api]:::android-library - :feature:bookmarks:impl[impl]:::android-library - end - subgraph :feature:topic - direction TB - :feature:topic:api[api]:::android-library - end + :feature:bookmarks[bookmarks]:::android-feature + :feature:topic[topic]:::android-feature end subgraph :core direction TB @@ -33,7 +26,6 @@ graph TB :core:datastore-proto[datastore-proto]:::android-library :core:designsystem[designsystem]:::android-library :core:model[model]:::jvm-library - :core:navigation[navigation]:::android-library :core:network[network]:::android-library :core:notifications[notifications]:::android-library :core:ui[ui]:::android-library @@ -56,15 +48,13 @@ graph TB :core:ui --> :core:analytics :core:ui --> :core:designsystem :core:ui --> :core:model - :feature:bookmarks:api --> :core:navigation - :feature:bookmarks:impl -.-> :core:data - :feature:bookmarks:impl -.-> :core:designsystem - :feature:bookmarks:impl -.-> :core:ui - :feature:bookmarks:impl -.-> :feature:bookmarks:api - :feature:bookmarks:impl -.-> :feature:topic:api - :feature:topic:api -.-> :core:designsystem - :feature:topic:api --> :core:navigation - :feature:topic:api -.-> :core:ui + :feature:bookmarks -.-> :core:data + :feature:bookmarks -.-> :core:designsystem + :feature:bookmarks -.-> :core:ui + :feature:bookmarks -.-> :feature:topic + :feature:topic -.-> :core:data + :feature:topic -.-> :core:designsystem + :feature:topic -.-> :core:ui classDef android-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000; classDef android-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000; diff --git a/feature/foryou/README.md b/feature/foryou/README.md index 8c12460f4..5695dd5d1 100644 --- a/feature/foryou/README.md +++ b/feature/foryou/README.md @@ -13,15 +13,7 @@ config: graph TB subgraph :feature direction TB - subgraph :feature:foryou - direction TB - :feature:foryou:api[api]:::android-library - :feature:foryou:impl[impl]:::android-library - end - subgraph :feature:topic - direction TB - :feature:topic:api[api]:::android-library - end + :feature:foryou[foryou]:::android-feature end subgraph :core direction TB @@ -34,7 +26,6 @@ graph TB :core:designsystem[designsystem]:::android-library :core:domain[domain]:::android-library :core:model[model]:::jvm-library - :core:navigation[navigation]:::android-library :core:network[network]:::android-library :core:notifications[notifications]:::android-library :core:ui[ui]:::android-library @@ -59,16 +50,10 @@ graph TB :core:ui --> :core:analytics :core:ui --> :core:designsystem :core:ui --> :core:model - :feature:foryou:api --> :core:navigation - :feature:foryou:impl -.-> :core:designsystem - :feature:foryou:impl -.-> :core:domain - :feature:foryou:impl -.-> :core:notifications - :feature:foryou:impl -.-> :core:ui - :feature:foryou:impl -.-> :feature:foryou:api - :feature:foryou:impl -.-> :feature:topic:api - :feature:topic:api -.-> :core:designsystem - :feature:topic:api --> :core:navigation - :feature:topic:api -.-> :core:ui + :feature:foryou -.-> :core:designsystem + :feature:foryou -.-> :core:domain + :feature:foryou -.-> :core:notifications + :feature:foryou -.-> :core:ui classDef android-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000; classDef android-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000; diff --git a/feature/search/README.md b/feature/search/README.md index 04800005c..5ff6f2429 100644 --- a/feature/search/README.md +++ b/feature/search/README.md @@ -13,19 +13,7 @@ config: graph TB subgraph :feature direction TB - subgraph :feature:search - direction TB - :feature:search:api[api]:::android-library - :feature:search:impl[impl]:::android-library - end - subgraph :feature:interests - direction TB - :feature:interests:api[api]:::android-library - end - subgraph :feature:topic - direction TB - :feature:topic:api[api]:::android-library - end + :feature:search[search]:::android-feature end subgraph :core direction TB @@ -38,7 +26,6 @@ graph TB :core:designsystem[designsystem]:::android-library :core:domain[domain]:::android-library :core:model[model]:::jvm-library - :core:navigation[navigation]:::android-library :core:network[network]:::android-library :core:notifications[notifications]:::android-library :core:ui[ui]:::android-library @@ -63,18 +50,9 @@ graph TB :core:ui --> :core:analytics :core:ui --> :core:designsystem :core:ui --> :core:model - :feature:interests:api --> :core:navigation - :feature:search:api -.-> :core:domain - :feature:search:api --> :core:navigation - :feature:search:impl -.-> :core:designsystem - :feature:search:impl -.-> :core:domain - :feature:search:impl -.-> :core:ui - :feature:search:impl -.-> :feature:interests:api - :feature:search:impl -.-> :feature:search:api - :feature:search:impl -.-> :feature:topic:api - :feature:topic:api -.-> :core:designsystem - :feature:topic:api --> :core:navigation - :feature:topic:api -.-> :core:ui + :feature:search -.-> :core:designsystem + :feature:search -.-> :core:domain + :feature:search -.-> :core:ui classDef android-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000; classDef android-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000; diff --git a/feature/settings/README.md b/feature/settings/README.md index 88aadd960..0efd9d4bf 100644 --- a/feature/settings/README.md +++ b/feature/settings/README.md @@ -13,10 +13,7 @@ config: graph TB subgraph :feature direction TB - subgraph :feature:settings - direction TB - :feature:settings:impl[impl]:::android-library - end + :feature:settings[settings]:::android-feature end subgraph :core direction TB @@ -50,9 +47,9 @@ graph TB :core:ui --> :core:analytics :core:ui --> :core:designsystem :core:ui --> :core:model - :feature:settings:impl -.-> :core:data - :feature:settings:impl -.-> :core:designsystem - :feature:settings:impl -.-> :core:ui + :feature:settings -.-> :core:data + :feature:settings -.-> :core:designsystem + :feature:settings -.-> :core:ui classDef android-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000; classDef android-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000; diff --git a/navigation/README.md b/navigation/README.md new file mode 100644 index 000000000..bf30284f8 --- /dev/null +++ b/navigation/README.md @@ -0,0 +1,119 @@ +# `:navigation` + +## Module dependency graph + + +```mermaid +--- +config: + layout: elk + elk: + nodePlacementStrategy: SIMPLE +--- +graph TB + subgraph :feature + direction TB + :feature:bookmarks[bookmarks]:::android-feature + :feature:foryou[foryou]:::android-feature + :feature:interests[interests]:::android-feature + :feature:search[search]:::android-feature + :feature:settings[settings]:::android-feature + :feature:topic[topic]:::android-feature + end + subgraph :core + direction TB + :core:analytics[analytics]:::android-library + :core:common[common]:::jvm-library + :core:data[data]:::android-library + :core:database[database]:::android-library + :core:datastore[datastore]:::android-library + :core:datastore-proto[datastore-proto]:::android-library + :core:designsystem[designsystem]:::android-library + :core:domain[domain]:::android-library + :core:model[model]:::jvm-library + :core:navigation[navigation]:::android-library + :core:network[network]:::android-library + :core:notifications[notifications]:::android-library + :core:ui[ui]:::android-library + end + :navigation[navigation]:::android-library + + :core:data -.-> :core:analytics + :core:data --> :core:common + :core:data --> :core:database + :core:data --> :core:datastore + :core:data --> :core:network + :core:data -.-> :core:notifications + :core:database --> :core:model + :core:datastore -.-> :core:common + :core:datastore --> :core:datastore-proto + :core:datastore --> :core:model + :core:domain --> :core:data + :core:domain --> :core:model + :core:network --> :core:common + :core:network --> :core:model + :core:notifications -.-> :core:common + :core:notifications --> :core:model + :core:ui --> :core:analytics + :core:ui --> :core:designsystem + :core:ui --> :core:model + :feature:bookmarks -.-> :core:data + :feature:bookmarks -.-> :core:designsystem + :feature:bookmarks -.-> :core:ui + :feature:bookmarks -.-> :feature:topic + :feature:foryou -.-> :core:designsystem + :feature:foryou -.-> :core:domain + :feature:foryou -.-> :core:notifications + :feature:foryou -.-> :core:ui + :feature:interests -.-> :core:designsystem + :feature:interests -.-> :core:domain + :feature:interests -.-> :core:ui + :feature:search -.-> :core:designsystem + :feature:search -.-> :core:domain + :feature:search -.-> :core:ui + :feature:settings -.-> :core:data + :feature:settings -.-> :core:designsystem + :feature:settings -.-> :core:ui + :feature:topic -.-> :core:data + :feature:topic -.-> :core:designsystem + :feature:topic -.-> :core:ui + :navigation -.-> :core:designsystem + :navigation -.-> :core:model + :navigation -.-> :core:navigation + :navigation -.-> :feature:bookmarks + :navigation -.-> :feature:foryou + :navigation -.-> :feature:interests + :navigation -.-> :feature:search + :navigation -.-> :feature:settings + :navigation -.-> :feature:topic + +classDef android-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000; +classDef android-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000; +classDef android-library fill:#9BF6FF,stroke:#000,stroke-width:2px,color:#000; +classDef android-test fill:#A0C4FF,stroke:#000,stroke-width:2px,color:#000; +classDef jvm-library fill:#BDB2FF,stroke:#000,stroke-width:2px,color:#000; +classDef unknown fill:#FFADAD,stroke:#000,stroke-width:2px,color:#000; +``` + +
📋 Graph legend + +```mermaid +graph TB + application[application]:::android-application + feature[feature]:::android-feature + library[library]:::android-library + jvm[jvm]:::jvm-library + + application -.-> feature + library --> jvm + +classDef android-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000; +classDef android-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000; +classDef android-library fill:#9BF6FF,stroke:#000,stroke-width:2px,color:#000; +classDef android-test fill:#A0C4FF,stroke:#000,stroke-width:2px,color:#000; +classDef jvm-library fill:#BDB2FF,stroke:#000,stroke-width:2px,color:#000; +classDef unknown fill:#FFADAD,stroke:#000,stroke-width:2px,color:#000; +``` + +
+