Skip to content

docs: sync framework docs from internal repo #8861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 25, 2025
+26 −12
Merged

docs: sync framework docs from internal repo #8861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15eff13
docs: sync framework docs from internal repo
kevinthecheung Jul 17, 2025
ae4fad4
Merge branch 'master' of github.com:firebase/firebase-tools into kc-w…
kevinthecheung Jul 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion src/frameworks/docs/angular.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ to Firebase and serve dynamic content to your users.

<<_includes/_preview-disclaimer.md>>

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.
Comment on lines +18 to +24
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.
Suggested change
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.


<<_includes/_before-you-begin.md>>

- Optional: AngularFire
Expand Down Expand Up @@ -55,9 +63,11 @@ To prerender dynamic content in Angular, you need to set up Angular SSR.
ng add @angular/ssr
```

See the [Angular Prerendering (SSG) guide](https://angular.dev/guide/prerendering)
See the [Angular Prerendering (SSG) guide](https://angular.dev/guide/ssr)
for more information.

### Optional: add a server module
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.


#### Deploy

When you deploy with `firebase deploy`, Firebase builds your browser bundle,
Expand Down
8 changes: 2 additions & 6 deletions src/frameworks/docs/frameworks-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@ and Next.js. Using {{firebase_hosting}} and {{cloud_functions_full}} with these
frameworks, you can develop apps and microservices in your preferred framework
environment, and then deploy them in a managed, secure server environment.

Note: Experimental support for Flask and Django is under development, and will be
available soon. To stay up to date on the latest releases, sign up as a
trusted tester at [https://goo.gle/41enW5X](//goo.gle/41enW5X).

Support during this early preview includes the following functionality:

* Deploy Web apps comprised of static web content
Expand Down Expand Up @@ -67,6 +63,6 @@ See the [Cloud Functions documentation](https://firebase.google.com/docs/functio
See the detailed guide for your preferred framework:

* [Angular](/docs/hosting/frameworks/angular)
* [Next.js] (/docs/hosting/frameworks/nextjs)
* [Flutter Web] (/docs/hosting/frameworks/flutter)
* [Next.js](/docs/hosting/frameworks/nextjs)
* [Flutter Web](/docs/hosting/frameworks/flutter)
* [Frameworks with Express.js](/docs/hosting/frameworks/express)
18 changes: 13 additions & 5 deletions src/frameworks/docs/nextjs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ logic to {{cloud_functions_full}}.

<<_includes/_preview-disclaimer.md>>

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.
Comment on lines +21 to +27
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.
Suggested change
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.


<<_includes/_before-you-begin.md>>

- Optional: use the experimental ReactFire library to benefit from its
Expand All @@ -26,7 +34,7 @@ logic to {{cloud_functions_full}}.
<<_includes/_initialize-firebase.md>>

1. Answer yes to "Do you want to use a web framework? (experimental)"
1. Choose your hosting source directory. If this an existing Next.js app,
1. Choose your hosting source directory. If this is an existing Next.js app,
the {{cli}} process completes, and you can proceed to the next section.
1. If prompted, choose Next.js.

Expand All @@ -45,14 +53,14 @@ on its live site.
## Pre-render dynamic content

The {{firebase_cli}} will detect usage of
[getStaticProps](https://nextjs.org/docs/pages/building-your-application/data-fetching/get-static-props)
[getStaticProps](https://nextjs.org/docs/pages/building-your-application/data-fetching/get-static-props)
and [getStaticPaths](https://nextjs.org/docs/pages/building-your-application/data-fetching/get-static-paths).

### Optional: integrate with the Firebase JS SDK

When including Firebase JS SDK methods in both server and client bundles, guard
against runtime errors by checking `isSupported()` before using the product.
Not all products are
Not all products are
[supported in all environments](/docs/web/environments-js-sdk#other_environments).

Tip: consider using
Expand All @@ -69,7 +77,7 @@ and [getStaticPaths](https://nextjs.org/docs/basic-features/data-fetching/get-st

The {{firebase_cli}} will detect usage of
[getServerSideProps](https://nextjs.org/docs/basic-features/data-fetching/get-server-side-props).
In such cases, the {{cli}} will deploy functions to {{cloud_functions_full}} to run dynamic
In such cases, the {{cli}} will deploy functions to {{cloud_functions_full}} to run dynamic
server code. You can view information about these functions, such as their domain and runtime
configuration, in the [Firebase console](https://console.firebase.google.com/project/_/functions).

Expand All @@ -87,7 +95,7 @@ interoperate well together.

### Redirects, Rewrites, and Headers

The {{firebase_cli}} respects
The {{firebase_cli}} respects
[redirects](https://nextjs.org/docs/api-reference/next.config.js/redirects),
[rewrites](https://nextjs.org/docs/api-reference/next.config.js/rewrites), and
[headers](https://nextjs.org/docs/api-reference/next.config.js/headers) in
Expand Down
Loading