Improve docs with info about Jetpack and add FAQ #9
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 @westonruter, 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 focuses on enhancing the plugin's documentation to provide clearer guidance and troubleshooting information regarding Back/Forward Cache (bfcache). I've introduced a new FAQ section in the README.md to address common user queries and interactions with other popular plugins like Jetpack and Akismet, aiming to improve user understanding and experience. A minor code comment update also reflects this expanded context.
Highlights
- Documentation Enhancement: I've added a comprehensive 'FAQ' section to the
README.mdto address common questions and provide detailed guidance on Back/Forward Cache (bfcache) behavior, including common blocking reasons. - Jetpack Compatibility Information: The
README.mdnow includes specific instructions and context for users experiencing bfcache issues with Jetpack active, detailing how to disable the Notifications module and referencing an ongoing Jetpack pull request for further improvements. - Akismet Interaction Note: I've added a note in the FAQ about Akismet's use of
unloadevent listeners potentially blocking bfcache, suggesting a more appropriate event should be used. - Educational Resources: I've integrated direct links to web.dev articles and a YouTube video within the
README.mdto help users better understand bfcache and debugging techniques. - Code Comment Clarity: I've updated a code comment in
includes/bfcache-opt-in.phpto explicitly mention Jetpack'sadd_no_store_header()function and its priority, alongside the existing WooCommerce reference, for better context.
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. ↩
westonruter
changed the title
No description provided.