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
  • Clarified Kobo integration: reading progress remains bidirectional and library delivery continues.
  • Added that personal star ratings set on Kobo (1–5) are synced to Grimmory and converted to the 0–10 personal rating scale; existing Grimmory ratings are not pushed back to Kobo.

[coderabbitai]

Warning

Rate limit exceeded

@Milhound has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 56 minutes and 3 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1343a263-d812-4e1e-89ee-5861e1119bde

📥 Commits

Reviewing files that changed from the base of the PR and between cda853c and 5d430cd.

📒 Files selected for processing (1)

• docs/integration/kobo.md

📝 Walkthrough

Walkthrough

This PR updates Kobo docs to state that Kobo-set star ratings (1–5) are converted to Grimmory's 0–10 personal rating scale and synced one-way to Grimmory; reading progress remains bidirectional.

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 clarify Kobo 1–5 → Grimmory 0–10 conversion and that Grimmory ratings are not pushed back.
Integration Documentation docs/integration/kobo.md	Intro reworded to frame Kobo sync as syncing reading activity between systems. New "Personal Ratings" section documents Kobo→Grimmory rating sync and scale conversion.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• grimmory-tools/grimmory-docs#18: Related wording updates to Kobo/Grimmory sync documentation.

Suggested reviewers

• zachyale
• obviouslyallie

Poem

🐰 I nibble on docs with careful delight,
From Kobo's five to Grimmory's ten in flight,
One-way the stars hop across the stream,
Progress still dances both ways in dream,
Hooray — your ratings travel safe and bright! 🌟

---

Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 error)

Check name	Status	Explanation	Resolution
Description check	❌ Error	The PR description contains all required sections: Description, Linked Issue, Changes, and AI Disclosure. Manual Testing Steps section is missing.	Add a 'Manual Testing Steps' section with specific steps used to verify the documentation changes and check for regressions.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The PR title follows the conventional commit format with 'Docs:' prefix, describing the main change clearly.
Linked Issues check	✅ Passed	The PR fully implements the requirements from issue #28: documents Kobo personal ratings sync flow, specifies 1-5 to 0-10 rating scale conversion, clarifies one-way sync direction, and updates both integration and Devices pages.
Out of Scope Changes check	✅ Passed	All changes are directly aligned with issue #28 objectives: documentation updates to Kobo integration guide and Devices page regarding personal ratings sync.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ 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.

[obviouslyallie]

Again, this is nitpicking and it wouldn't hurt my feelings if we resolved as is.

[obviouslyallie]

The previous line wasn't great, but this feels a bit wordy and almost a run-on.

[Milhound]

Reworded to be shorter and break up the sentence.

[obviouslyallie]

Ln 181: This is saying the same thing twice.

[Milhound]

Converted it all to a note.

[Milhound]

No worries, let's get it the way you want it.