Docs: Add details on syncing kobo rating

[Milhound]

Description

Document how personal ratings sync from Kobo to Grimmory, including the user-facing flow, rating conversion, and sync direction.

Linked Issue

Fixes #28

Changes

• Updated the Kobo integration guide to explain how personal ratings move from Kobo to Grimmory.
• Added a step-by-step flow for rating sync after a user sets a rating on the Kobo device.
• Documented the rating scale conversion from Kobo’s 1-5 stars to Grimmory’s 0-10 personal rating scale.
• Clarified that rating sync is one-way for now: Kobo to Grimmory.
• Updated the opening Kobo integration description to mention personal rating sync.
• Updated the Devices page Kobo section to mention ratings syncing back to Grimmory.

Summary by CodeRabbit

• Documentation
  • Updated Kobo integration documentation to clarify that personal ratings set on Kobo devices are synced to Grimmory with automatic scale conversion (1–5 to 0–10). Sync currently operates one-way from Kobo to Grimmory.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 98edcc08-d63c-403f-a08b-5ca4c46089fb

📥 Commits

Reviewing files that changed from the base of the PR and between 953485d and d13434b.

📒 Files selected for processing (2)

• docs/integration/kobo.md
• docs/tools/devices.md

📜 Recent review details

🧰 Additional context used

🪛 LanguageTool

docs/integration/kobo.md

[grammar] ~178-~178: Ensure spelling is correct
Context: ...ating. - Kobo uses a 1-5 star scale. - Grimmory stores personal ratings on a 0-10 scale...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (3)

docs/integration/kobo.md (2)

3-3: Clear integration overview update.

Good update at Line 3: it now accurately summarizes library sync, bidirectional progress behavior, and Kobo→Grimmory personal rating sync in one place.

---

167-182: Personal rating sync behavior is documented well.

The new section is clear and actionable: user flow, 1–5 → 0–10 conversion example, and one-way limitation are all explicitly documented.

docs/tools/devices.md (1)

63-63: Docs are consistent across Devices and Integration pages.

Nice alignment here: Line 63 introduces rating sync in the overview, and Line 127 clearly captures conversion and one-way sync constraints.

Also applies to: 127-127

---

📝 Walkthrough

Walkthrough

This PR documents Kobo personal ratings synchronization between Kobo devices and Grimmory. The changes describe how star ratings set on Kobo devices are converted to Grimmory's 0–10 scale and synced one-way to Grimmory, with clarification that existing Grimmory ratings are not synced back to Kobo devices.

Changes

Kobo Personal Ratings Feature Documentation

Layer / File(s)	Summary
Feature Overview docs/tools/devices.md	Kobo Integration description now includes personal ratings syncing. Notes section clarifies Kobo 1–5 rating conversion to Grimmory 0–10 scale and one-way sync direction.
Integration Documentation docs/integration/kobo.md	Introductory description updated to frame Kobo sync as "reading activity between both systems." New Personal Ratings section details how Kobo device ratings are sent to Grimmory on sync, rating value conversion, and one-way sync behavior.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

enhancement

Suggested reviewers

• obviouslyallie
• zachyale

Poem

🐰 A reader's heart rates both ways true,
From Kobo's five to Grimmory's ten so new,
One-way the journey, a path clearly bright,
Your ratings are synced with algorithmic delight! ⭐

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title follows the conventional commit format with 'Docs:' prefix and clearly describes the main change (adding documentation about Kobo rating syncing).
Linked Issues check	✅ Passed	The changes comprehensively fulfill issue #28 requirements: documentation added to /docs/integration/kobo explaining how personal ratings sync from Kobo to Grimmory, including the 1–5 to 0–10 scale conversion and one-way sync behavior.
Out of Scope Changes check	✅ Passed	All changes are directly related to documenting Kobo personal rating sync behavior, with updates to both the Kobo integration guide and Devices page consistently addressing the linked issue requirements.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

✨ Simplify code

• Create PR with simplified code

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

Documents how personal ratings sync from Kobo devices into Grimmory, clarifying the user-facing flow, rating conversion, and current one-way sync direction.

Changes:

• Expanded Kobo integration documentation to include personal rating sync behavior and limitations.
• Added a step-by-step “Personal Ratings” flow and documented the 1–5 (Kobo) → 0–10 (Grimmory) conversion.
• Updated the Devices page Kobo section to mention ratings syncing into Grimmory.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
docs/tools/devices.md	Updates the Kobo integration summary and notes to mention personal rating sync and conversion/one-way behavior.
docs/integration/kobo.md	Adds a “Personal Ratings” section describing the Kobo → Grimmory rating sync flow and rating scale conversion.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.