This repository was archived by the owner on Jul 29, 2026. It is now read-only.
Announce end of maintenance and add a DataStore migration guide - #263
Merged
Conversation
Document the Kotpref-specific parts of moving to DataStore: the delegate mapping table, the preference key rule (key ?: property.name), which name to pass to SharedPreferencesMigration given that kotprefName defaults to the model class name, and what replaces each optional module. Generic DataStore usage links to the official documentation instead of being restated here. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Ga7khpnpwB5JRMWPD2mX7d
Add a deprecation notice pointing to Jetpack DataStore and the migration guide, and note that published artifacts remain on Maven Central so existing builds are unaffected. The Install and How to use sections are kept as a reference for current users. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Ga7khpnpwB5JRMWPD2mX7d
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Prepares the repository for archiving.
README
Adds a deprecation notice at the top, using a GitHub alert, that states maintenance
has ended and points to Jetpack DataStore and the migration guide. Below it, plain
prose notes that published artifacts stay on Maven Central so existing builds are
unaffected, and sketches the choice between Preferences DataStore and Proto
DataStore.
The Install and How to use sections are left untouched, as a reference for current
users.
Note: GitHub alerts render on github.com but not through the Jekyll-based GitHub
Pages site, where
[!IMPORTANT]will appear as literal text in a blockquote. Thealert is kept short so the degraded rendering stays readable.
docs/MIGRATION.md
A new guide focused on what is specific to Kotpref, linking to the official
documentation for generic DataStore usage:
Preferences.Keymapping, with Kotpref's default valueskey ?: property.name)vartosuspend/FlowSharedPreferencesMigration, given thatkotprefNamedefaults to the model's simple class name — getting this wrong fails silently
preference-screen-dslhasno equivalent
stringSetPrefsets, noMODE_MULTI_PROCESS,one instance per file
The guide carries a note that it was written at archive time and has not been
verified against a real migration.
Follow-ups (not in this PR)
🤖 Generated with Claude Code
https://claude.ai/code/session_01Ga7khpnpwB5JRMWPD2mX7d