Proto datastore tutorial is barely usable in its current state and would deserve some update / cleaning

Open
#74 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
android, kotlin

Research direction

Start by reading the Proto datastore tutorial alongside the GitHub repository, checking each replacement instruction and code snippet. Pay particular attention to task 7, the shared-preferences-to-data-store migration, and dependency versions; done means the steps, code, repository, and build dependencies agree, with the migration complexity addressed separately.

Written by the indexing model from the issue text.

Description

I'm afraid the tutorial is barely usable in its current state.

  • Many instances of "replace code X with Y" but no mention of where to replace the code.
  • Many mismatches between some instructions and provided code snippet.
  • Many mismatches between instructions and github repo.
  • Missing instructions / steps in the task 7. Shared preferences to data store.
  • Outdated or erroneous dependencies leading to build errors.

Also, the topic of "migration from sharedPreferences to proto data" would deserve its own tutorial rather than clutter the "proto datastore" tutorial with unnecessary complexity.

Thank you very much.

Dominant language
Kotlin
Stars
240
Forks
113
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from android/codelab-android-datastore

All issues in android/codelab-android-datastore

Similar issues

More Kotlin issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.