Add FAQ for why bfcache may not work on Pantheon #10
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 enhances the project's documentation by adding a new FAQ entry. This entry aims to clarify why the back/forward cache (bfcache) might not be working on sites hosted by Pantheon, offering both an explanation of the underlying cause and a practical workaround for users.
Highlights
- Documentation Update: Added a new FAQ section to
README.mdaddressing a common issue where bfcache (back/forward cache) may not work on Pantheon-hosted sites. - bfcache Explanation: The new FAQ entry explains that Pantheon's
must-useplugin currently sends aCache-Control: no-cache, no-store, must-revalidateheader for logged-in users, which prevents bfcache from functioning, and references an open pull request to fix this upstream. - Workaround Provided: A PHP code snippet is included in the FAQ as a temporary workaround, allowing users to prevent the problematic
Cache-Controlheader from being sent.
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 new FAQ section to the README.md file. The new section explains why the back/forward cache (bfcache) may not work on sites hosted by Pantheon and provides a PHP code snippet as a workaround. The explanation is clear and accurate. My review includes a suggestion to add comments to the PHP snippet to improve its maintainability for users who copy it into their projects.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Ref pantheon-systems/pantheon-mu-plugin#94