Is there an existing issue for this?
Page URL (type "NEW" for a new page suggestion)
https://github.com/android/nowinandroid/blob/main/docs/ArchitectureLearningJourney.md
What's the documentation problem or suggestion?
Problem
docs/ArchitectureLearningJourney.md appears to describe an older For You feed flow.
The document references GetUserNewsResourcesUseCase, but that class no longer exists in the current codebase. The current implementation uses:
ForYouViewModel.feedState
UserNewsResourceRepository.observeAllForFollowedTopics
CompositeUserNewsResourceRepository, which combines NewsRepository data with UserDataRepository data
The domain-layer example also uses GetUserNewsResourcesUseCase, so readers following the architecture learning journey may search for a class that is no longer present.
Suggested solution
Update docs/ArchitectureLearningJourney.md so it matches the current implementation:
- Replace the stale
GetUserNewsResourcesUseCase references with UserNewsResourceRepository / CompositeUserNewsResourceRepository
- Point readers to
ForYouViewModel.feedState for the For You feed flow
- Use
GetFollowableTopicsUseCase as the current domain-layer example
I have opened a small documentation PR for this change.
Code of Conduct
Is there an existing issue for this?
Page URL (type "NEW" for a new page suggestion)
https://github.com/android/nowinandroid/blob/main/docs/ArchitectureLearningJourney.md
What's the documentation problem or suggestion?
Problem
docs/ArchitectureLearningJourney.mdappears to describe an older For You feed flow.The document references
GetUserNewsResourcesUseCase, but that class no longer exists in the current codebase. The current implementation uses:ForYouViewModel.feedStateUserNewsResourceRepository.observeAllForFollowedTopicsCompositeUserNewsResourceRepository, which combinesNewsRepositorydata withUserDataRepositorydataThe domain-layer example also uses
GetUserNewsResourcesUseCase, so readers following the architecture learning journey may search for a class that is no longer present.Suggested solution
Update
docs/ArchitectureLearningJourney.mdso it matches the current implementation:GetUserNewsResourcesUseCasereferences withUserNewsResourceRepository/CompositeUserNewsResourceRepositoryForYouViewModel.feedStatefor the For You feed flowGetFollowableTopicsUseCaseas the current domain-layer exampleI have opened a small documentation PR for this change.
Code of Conduct