docs(README): mark dexie-observable and dexie-syncable as legacy/unmaintained - #2298
Merged
Conversation
…intained; recommend dexie-cloud-addon for sync
📝 WalkthroughWalkthroughA new README section was added documenting legacy addons (dexie-observable, dexie-syncable) as deprecated and incompatible with Dexie Cloud, recommending users migrate to dexie-cloud-addon for real-time sync solutions. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
254-254: Consider more concise wording.The phrase "not compatible" could be shortened to "incompatible" for better readability.
✍️ Suggested wording improvement
-If you find references to `dexie-observable` or `dexie-syncable` in tutorials, blog posts, or old code, be aware that these are **deprecated** sync solutions. They are not compatible with Dexie Cloud and should not be used in new projects. +If you find references to `dexie-observable` or `dexie-syncable` in tutorials, blog posts, or old code, be aware that these are **deprecated** sync solutions. They are incompatible with Dexie Cloud and should not be used in new projects.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 254, Replace the phrase "not compatible with Dexie Cloud" with the more concise "incompatible with Dexie Cloud" in the README sentence that mentions `dexie-observable` and `dexie-syncable`; locate the sentence containing those symbols and update the wording to read: "...they are **deprecated** sync solutions. They are incompatible with Dexie Cloud and should not be used in new projects." to improve readability.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@README.md`:
- Line 254: Replace the phrase "not compatible with Dexie Cloud" with the more
concise "incompatible with Dexie Cloud" in the README sentence that mentions
`dexie-observable` and `dexie-syncable`; locate the sentence containing those
symbols and update the wording to read: "...they are **deprecated** sync
solutions. They are incompatible with Dexie Cloud and should not be used in new
projects." to improve readability.
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add a clear section after the Dexie Cloud section explaining that
dexie-observableanddexie-syncableare legacy/unmaintained packages. Direct users todexie-cloud-addonas the modern replacement for local-first sync.Summary by CodeRabbit