docs: sync framework docs from internal repo #8861
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 @kevinthecheung, 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 updating and refining the framework documentation. The key intent is to guide users towards Firebase App Hosting for full-stack applications while also cleaning up outdated information and correcting minor errors to improve overall clarity and accuracy.
Highlights
- Documentation Updates for Firebase App Hosting: Added prominent 'Caution' notes to both Angular and Next.js framework documentation, strongly recommending Firebase App Hosting for full-stack applications and encouraging users of the experimental Firebase CLI frameworks feature to 'graduate' to App Hosting for a unified solution.
- Removal of Outdated Information: Removed the note regarding experimental support for Flask and Django from the frameworks overview documentation, along with the associated trusted tester signup link.
- Typographical and Formatting Corrections: Implemented several minor corrections across the documentation, including updating an Angular prerendering guide link, fixing spacing issues in Next.js and Flutter Web links, and correcting grammatical errors and spacing in the Next.js documentation.
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 syncs documentation for frameworks from an internal repository. The main changes include adding a recommendation for Firebase App Hosting to the Angular and Next.js guides, removing an outdated note about Flask/Django support, and fixing some minor formatting and typos. My review focuses on improving the clarity and presentation of the newly added content.
| Caution: For developers creating a full-stack Angular app, we strongly | ||
| recommend [Firebase App Hosting](/docs/app-hosting/). | ||
| If you're already using the frameworks experiment in the Firebase CLI, we | ||
| recommend "graduating" to | ||
| {{app_hosting}}. With {{app_hosting}}, you'll have a unified solution to manage | ||
| everything from CDN to server-side rendering, along with improved GitHub | ||
| integration. |
There was a problem hiding this comment.
The new caution message could be improved for better clarity and presentation.
- Using a blockquote (
>) will make the caution message stand out more visually. - The term
"graduating"is a bit colloquial for technical documentation. "Migrating" or "moving" would be a more standard term.
| Caution: For developers creating a full-stack Angular app, we strongly | |
| recommend [Firebase App Hosting](/docs/app-hosting/). | |
| If you're already using the frameworks experiment in the Firebase CLI, we | |
| recommend "graduating" to | |
| {{app_hosting}}. With {{app_hosting}}, you'll have a unified solution to manage | |
| everything from CDN to server-side rendering, along with improved GitHub | |
| integration. | |
| > **Caution:** For developers creating a full-stack Angular app, we strongly | |
| > recommend [Firebase App Hosting](/docs/app-hosting/). | |
| > | |
| > If you're already using the frameworks experiment in the Firebase CLI, we | |
| > recommend migrating to {{app_hosting}}. With {{app_hosting}}, you'll have a | |
| > unified solution for everything from CDN to server-side rendering, along | |
| > with improved GitHub integration. |
| for more information. | ||
|
|
||
| ### Optional: add a server module |
There was a problem hiding this comment.
The new heading ### Optional: add a server module is currently empty and is immediately followed by a subheading #### Deploy. Headings should typically be followed by content. Please either add content under this heading or remove it.
| Caution: For developers creating a full-stack Next.js app, we strongly | ||
| recommend [Firebase App Hosting](/docs/app-hosting/). | ||
| If you're already using the frameworks experiment in the Firebase CLI, we | ||
| recommend "graduating" to | ||
| {{app_hosting}}. With {{app_hosting}}, you'll have a unified solution to manage | ||
| everything from CDN to server-side rendering, along with improved GitHub | ||
| integration. |
There was a problem hiding this comment.
The new caution message could be improved for better clarity and presentation.
- Using a blockquote (
>) will make the caution message stand out more visually. - The term
"graduating"is a bit colloquial for technical documentation. "Migrating" or "moving" would be a more standard term.
| Caution: For developers creating a full-stack Next.js app, we strongly | |
| recommend [Firebase App Hosting](/docs/app-hosting/). | |
| If you're already using the frameworks experiment in the Firebase CLI, we | |
| recommend "graduating" to | |
| {{app_hosting}}. With {{app_hosting}}, you'll have a unified solution to manage | |
| everything from CDN to server-side rendering, along with improved GitHub | |
| integration. | |
| > **Caution:** For developers creating a full-stack Next.js app, we strongly | |
| > recommend [Firebase App Hosting](/docs/app-hosting/). | |
| > | |
| > If you're already using the frameworks experiment in the Firebase CLI, we | |
| > recommend migrating to {{app_hosting}}. With {{app_hosting}}, you'll have a | |
| > unified solution for everything from CDN to server-side rendering, along | |
| > with improved GitHub integration. |
Description
Scenarios Tested
Sample Commands