Added section about push pull replication filters #6
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 @Wojtach, 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 enhances the documentation for remote Sync Gateway by introducing a comprehensive section on replication filters. It aims to provide users with clear guidance and examples on how to implement and utilize both push and pull replication filters for fine-grained control over document synchronization, improving the overall clarity and completeness of the documentation.
Highlights
- New Documentation Section: Added a dedicated section titled "Replication filters" to the
docs/DataSync/remote-sync-gateway.mdfile. - Push Filter Documentation: Included a detailed explanation of push filters, their use cases, and a TypeScript code example demonstrating how to implement them for selective document pushing.
- Pull Filter Documentation: Provided a comprehensive overview of pull filters, their security implications, a TypeScript code example, and important considerations such as their distinction from channels, current limitations (e.g., 100-document processing limit), and behavior when document access is lost via the Sync Function.
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
This pull request adds a section about push and pull replication filters to the remote-sync-gateway.md documentation file. The new section includes explanations, code examples, and notes/cautions/info regarding the use of replication filters. There are some formatting issues with the note/caution/info directives that should be addressed.
No description provided.