Remove P2P documentation as APIs are not yet released #49
Conversation
Summary of ChangesHello @jayant-dhingra-cb, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on refining the project's documentation by systematically removing or commenting out all content related to Peer-to-Peer synchronization. The primary goal is to align the public-facing documentation with the current release status of the P2P APIs, which are still under development and not yet available. This prevents confusion and ensures that users only see information pertinent to currently released features. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request removes documentation related to the Peer-to-Peer (P2P) sync feature, which is appropriate as the APIs are not yet released. The changes involve deleting the main P2P documentation file and commenting out related sections in other documents. The changes are logical and align with the PR's objective. I have one minor suggestion to improve the source code readability in one of the markdown files.
| Replications to a Server (for example, a Sync Gateway, or passive listener) automatically use delta sync if the property is enabled at database level by the server — see: [databases.$db.delta_sync.enabled](https://docs.couchbase.com/sync-gateway/current/configuration-properties-legacy.html#databases-foo_db-delta_sync). | ||
|
|
||
| Intra-Device replications automatically disable delta sync, whilst Peer-to-Peer replications automatically enable delta sync. | ||
| Intra-Device replications automatically disable delta sync<!-- , whilst Peer-to-Peer replications automatically enable delta sync -->. |
There was a problem hiding this comment.
While commenting out the portion related to Peer-to-Peer sync works, it's generally cleaner to remove text that is not meant to be displayed, rather than commenting it out in documentation files. This improves the readability and maintainability of the source markdown. I suggest removing the commented-out part entirely.
| Intra-Device replications automatically disable delta sync<!-- , whilst Peer-to-Peer replications automatically enable delta sync -->. | |
| Intra-Device replications automatically disable delta sync. |
No description provided.