android / android/nowinandroid

[Documentation]: Differences between some dependency graph images and actual dependencies

Open
#957 2 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Kotlin
Stars
21.8k
Forks
4.6k
Avg merge
19h 20m
Merged PRs (30d)
2

Description

### Is there an existing issue for this?

- [X] I have searched the existing issues

### Page URL (type "NEW" for a new page suggestion)

https://github.com/android/nowinandroid/blob/main/docs/images/graphs/dep_graph_core_data.png

### What's the documentation problem or suggestion?

The dependency graph images have been very helpful in understanding the module dependencies.
However, there are differences between the images and the actual implementation.

For instance, the `core:data` module depends on the `core:database` module, but this is not reflected in the diagram.
https://github.com/android/nowinandroid/blob/main/docs/images/graphs/dep_graph_core_data.png
https://github.com/android/nowinandroid/blob/main/core/data/build.gradle.kts

There are also some other modules where the diagram is not accurate.

### Code of Conduct

- [X] I agree to follow this project's Code of Conduct

Contributor guide

Open the contributing guide

Research direction

Start by comparing docs/images/graphs/dep_graph_core_data.png with core/data/build.gradle.kts, then inspect the other dependency graph images and corresponding module build files for mismatches. Done means every affected graph accurately reflects the actual module dependencies, including core:data depending on core:database.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.