feat: Add docs for P2P#48
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @DominikZajac, 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 primarily introduces new documentation for Peer-to-Peer (P2P) synchronization in Couchbase Lite for Ionic, detailing its setup, authentication, and TLS configurations. Additionally, it clarifies existing documentation regarding limitations for live queries and document change listeners on specific platforms.
Highlights
- New P2P Sync Documentation: Added a comprehensive new documentation page (
docs/DataSync/peer-to-peer.md) detailing how to implement Peer-to-Peer synchronization using Couchbase Lite for Ionic. This includes basic setup (listener creation, client connection), authentication options (basic, certificate-based), TLS configuration (disabling for dev, self-signed, imported certificates, identity management), and security best practices. - Live Query Limitation Clarification: Updated
docs/Queries/live-queries.mdto include a note clarifying that live queries using parameter expressions are not compatible with change listeners. - Document/Collection Listener Limitation: Updated
docs/documents.mdto add a note specifying that Document and Collection Change Listeners are currently not supported on iOS.
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and 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 to provide feedback.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request adds documentation for peer-to-peer synchronization, live queries, and document changes in Couchbase Lite for Ionic. The documentation covers basic setup, authentication options, TLS configuration, and best practices for security. It also includes notes on platform-specific limitations and deprecated APIs.
| :::note | ||
| On iOS, the expiration date can be in the past without triggering an error. However, on Android, if the expiration date is in the past, an error will be thrown. | ||
| ::: |
There was a problem hiding this comment.
It's good to provide platform-specific notes, but consider rephrasing this to be more proactive. Instead of stating that iOS doesn't throw an error, perhaps suggest a best practice of always ensuring the expiration date is valid regardless of the platform.
| // On Android this is not supported and will throw an error | ||
| } |
There was a problem hiding this comment.
It would be helpful to provide a link to the documentation or a resource that explains why deleteIdentity is not supported on Android.
| - Never hardcode credentials in your application | ||
| - Use strong passwords for certificates |
There was a problem hiding this comment.
It's good to recommend not hardcoding credentials. Consider adding a link to a resource that explains how to securely store credentials in a mobile application (e.g., using platform-specific keychains or secure storage).
| Document and Collection Change Listeners are currently not supported on iOS | ||
| ::: |
There was a problem hiding this comment.
Consider adding a link to the relevant documentation or issue tracker that explains why Document and Collection Change Listeners are not supported on iOS.
2 participants
No description provided.