Skip to content

docs: review reminders documentation - #21829

Open
ericli3690 wants to merge 1 commit into
ankidroid:mainfrom
ericli3690:ericli3690-review-reminders-docs
Open

ericli3690 wants to merge 1 commit into
ankidroid:mainfrom
ericli3690:ericli3690-review-reminders-docs

Conversation

@ericli3690

Copy link
Copy Markdown
Member

Purpose / Description

Initial creation of the documentation file for the review reminders system of AnkiDroid.

Fixes

Learning

No AI used.

Checklist

  • You have a descriptive commit message with a short title (first line, max 50 chars).
  • You have commented your code, particularly in hard-to-understand areas
  • You have performed a self-review of your own code

@ericli3690 ericli3690 self-assigned this Sep 12, 2026

@david-allison david-allison left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only nitpicks, awesome work!

Comment thread docs/review_reminders/README.md Outdated
Comment thread docs/review_reminders/README.md
Comment thread docs/review_reminders/README.md Outdated
Comment thread docs/review_reminders/README.md
Comment thread docs/review_reminders/README.md
Comment thread docs/review_reminders/README.md
Comment thread docs/review_reminders/README.md
Comment thread docs/review_reminders/README.md
Comment thread docs/review_reminders/README.md Outdated
@david-allison david-allison added Needs Second Approval Has one approval, one more approval to merge and removed Needs Review labels Sep 13, 2026
@ericli3690
ericli3690 force-pushed the ericli3690-review-reminders-docs branch 2 times, most recently from ead5254 to 51a7f72 Compare September 14, 2026 05:32
Comment thread docs/review_reminders/README.md Outdated
Comment thread docs/review_reminders/README.md Outdated
Initial creation of the documentation file for the review reminders system of AnkiDroid.
@ericli3690
ericli3690 force-pushed the ericli3690-review-reminders-docs branch from 51a7f72 to 1f1846b Compare September 15, 2026 21:56
@ericli3690

Copy link
Copy Markdown
Member Author

Changes:

  • Addressed David's feedback on the JSON. I've decided to make it more clearly JSON-format, even though some of the JSON parts are actually serialized strings. This makes the doc easier to read and prevents my IDE from exploding with JSON formatting errors.
  • Added another sentence to the limitations section to explain a possible RevewReminderId invariant instability I just thought of.

Ready for review!

@david-allison david-allison left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM on my side

must be handled manually to ensure that outdated review reminders do not crash the app when deserialized.
New fields cannot be added without a schema change because `ignoreUnknownKeys` is not enabled for deserialization.

For an example of a schema migration, see the following commit: `9b13c6426c31c39eb5f69a58509cdda014e40093`.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For an example of a schema migration, see the following commit: `9b13c6426c31c39eb5f69a58509cdda014e40093`.
For an example of a schema migration, see [9b13c6426c31c39eb5f69a58509cdda014e40093](https://github.com/ankidroid/Anki-Android/commit/9b13c6426c31c39eb5f69a58509cdda014e40093).

Note: see https://github.com/ankidroid/Anki-Android/wiki/Development-guide#custom-search-engines for how I link commits in Chrome

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs Second Approval Has one approval, one more approval to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Review reminders: create documentation file

2 participants