Merge branch 'main' into patch-1

Author: PoojaB26

.github/workflows/build-errors-check.yml

@@ -0,0 +1,26 @@
+name: Check Build Errors
+
+on:
+  pull_request:
+    branches:
+      - main  # Run on PRs targeting the main branch
+
+jobs:
+  build-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
+
+
+
+

README.md

@@ -22,6 +22,12 @@ Before you start contributing, please take a moment to review our [Contribution
 3. **Create a PR to `main`**:
    After making these changes, commit them to a new branch, and then create a pull request (PR) for review from FlutterFlow team.
 
+## Running the Docs Site Locally
+You may want to run the docs site locally to test and visualize changes you are proposing to the documentation. To run the docs site locally, please enter the following commands in the terminal of the downloaded repository:
+
+1. **Install Dependencies:** Run **`npm install`** in your terminal to install the necessary dependencies.
+2. **Preview Changes:** To see your changes in real-time as you edit the files, you can run a local development server. This server will host your website and reflect the latest changes. Use the command **`npm run start`**.
+
 ## Ready to Contribute?
 Your contributions are vital to keeping FlutterFlow's documentation clear, up-to-date, and helpful. We look forward to seeing your pull requests and are excited to welcome you into our community of contributors!
 
@@ -43,4 +49,4 @@ Your contributions are vital to keeping FlutterFlow's documentation clear, up-to
 [//]: # (repo: 'documentation')
 
 [//]: # (})")
-If you have any questions or need further guidance, don't hesitate to reach out to the documentation team. Happy documenting!
+If you have any questions or need further guidance, don't hesitate to reach out to the documentation team. Happy documenting!

docs/accounts-billing/account-management.md

@@ -9,85 +9,77 @@ sidebar_position: 1
 # Account Management
 This section contains information on changing your password, verifying your email, and deleting your account.
 
-## Password
 ### I can't log in to my account / I forgot my login info.
-
 To reset your account password:
 
-- From `flutterflow.io` select Login in the top right corner.
-
-- At the bottom of the page, select Reset Password.
-
-- You will receive an email with a link to reset your password.
-
-- Click the reset link and enter your new password.
-
-If you can’t remember your username or are experiencing any other issues, please reach out to us at [email protected]
-
-
+1. From `flutterflow.io` select Login in the top right corner.
+2. At the bottom of the page, select **Reset Password**.
+3. You will receive an email with a link to reset your password.
+4. Click the reset link and enter your new password.
 
-
-### How Do I Change My Password?
+If you can’t remember your username or are experiencing any other issues, please reach out to us at `[email protected]`
 
 
+### How do I change my password?
 To change your password, please use the following steps:
 
-- Log in to your FlutterFlow account and select Account from the top right.
-
-- Under Personal Info, select Reset Password.
+1. Navigate to your [account page in FlutterFlow](https://app.flutterflow.io/account).
+2. Under Personal Info, select Reset Password.
+3. You will receive an email with a link to reset your password.
+4. Click the reset link and enter your new password.
 
-- You will receive an email with a link to reset your password.
 
-- Click the reset link and enter your new password.
-
-## Verify Account
-### How Do I Check If My Account Is Verified?
+### How do I check if my account is verified?
 To check if you have verified your account:
 
-1. Log in to your FlutterFlow account and select Account from the top right. 
-2. Navigate to the Profile Information section. 
-3. If you have a green checkmark next to your email, your account is verified.
+1. Navigate to your [account page in FlutterFlow](https://app.flutterflow.io/account).
+2. If you have a green checkmark next to your email, your account is verified.
 
-![img_1.png](imgs/img_1.png)
+![check-account-verification.png](imgs/check-account-verification.png)
 
-### I Didn't Get The Email To Verify My Account / How Do I Resend The Verification Email?
+### I didn't get the email to verify my account, how do I resend the verification email?
 If you did not receive a verification email, please follow these steps:
 
-1. Log in to your FlutterFlow account and select Account from the top right. 
-2. Navigate to the Profile Information section and check that your email address is correct. 
-3. If your email is incorrect, please reach out to [email protected] to correct this. 
-4. From the Profile Information section, select Verify Email.
+1. Navigate to your [account page in FlutterFlow](https://app.flutterflow.io/account).
+2. Check that your email address is correct. If your email is incorrect, please reach out to `[email protected]` to correct this. 
+3. From the **Profile Information** section, select **Verify Email**.
 
 You should receive a new confirmation email. If you do not receive the verification email, please contact us at [email protected].
 
-![img.png](imgs/img.png)
+![email-verification.png](imgs/email-verification.png)
 
-## Delete Account
-### How Do I Delete My Account
+### How do I delete my account?
 To delete your FlutterFlow account, please follow these steps:
 
-1. Log in to your FlutterFlow account and select Account from the top right.
-
-2. Scroll down to the My Plan section and select Delete Account (bottom right corner)
+1. Log in to your FlutterFlow account and select **Account** from the top right.
+2. Scroll down to the **My Plan** section and select **Delete Account** (bottom right corner)
 
 :::danger
 This step can not be undone. We will not be able to recover your projects.
 :::
 
 
-## Change/Update Email Address
-### Q: How do I change or update my login email address?
+### How do I change or update my email address?
 To change your login email in FlutterFlow:
 
 1. Log into your FlutterFlow account. 
 2. Go to the dashboard and select your account tile (showing your name and email). 
-3. Click on Update Email. 
+3. Click on **Update Email**. 
 4. Enter your current email and password. 
-5. Input your new email and click Confirm & Log Out. 
+5. Input your new email and click **Confirm & Log Out**. 
 6. Verify the new email via the link sent to it. 
-7. Now, you need to create a new password for your new email address. To do so, click on the Forgot Password on the login page and enter your new email address. 
+7. Now, you need to create a new password for your new email address. To do so, click on the **Forgot Password** on the login page and enter your new email address. 
 8. You'll receive the password reset link at your new email address. Click the link and reset the password.
 
 Now, you are ready to log in with your new email address and password.
 
-![img_2.png](imgs/img_2.png)
+![update-email.png](imgs/update-email.png)
+
+### How do I generate an API Token?
+An API token is required to use the [CLI](../testing-deployment-publishing/exporting-code/ff-cli.md) and the [Visual Studio Code Extension](../ff-concepts/adding-customization/vscode-extension.md)
+.
+
+To create an API token tied to your account:
+
+1. Navigate to your [account page in FlutterFlow](https://app.flutterflow.io/account).
+2. Near the bottom of the page, click **Create Token**

docs/accounts-billing/imgs/img_1.png renamed to docs/accounts-billing/imgs/check-account-verification.png

@@ -8,9 +8,9 @@ sidebar_position: 2
 
 # Plans & Pricing
 :::note
-For our most upto date information, please visit **[FlutterFlow pricing](https://flutterflow.io/pricing.html)**.
+For our most up-to-date information, please visit **[FlutterFlow pricing](https://flutterflow.io/pricing)**.
 :::
 
 :::note
 Regional discounts are available, please **[log in to FlutterFlow](https://app.flutterflow.io/)** to see the pricing for your region.
-:::
+:::

docs/accounts-billing/imgs/img.png renamed to docs/accounts-billing/imgs/email-verification.png

@@ -249,6 +249,27 @@ com/embed/0c4306c1951a4d9099aa96324c7561af?sid=69709110-ad60-4e98-bf53-36a50a99e
 
 ## FAQs
 
+<details>
+<summary>Why do cloud function deployments fail on newly created projects?</summary>
+
+This issue occurs because the newly created Google Cloud Platform (GCP) project hasn't been fully configured with the necessary APIs and permissions. Follow the steps below to enable the required APIs and set proper permissions.
+
+1. Open your browser and navigate to the following URL:
+`https://console.cloud.google.com/functions/list?referrer=search&hl=en&project=<projectID>`
+Replace `<projectID>` with your GCP or Firebase project ID.
+2. Click on the **Create Function** button. GCP will prompt you to enable the necessary APIs: **Cloud Build** and **Cloud Functions**.
+3. After clicking **Next**, you will be prompted to enable the **Cloud Run Admin API**.
+![cloud-run-admin-api](imgs/cloud-run-admin-api.png)
+4. Now, you need to grant the default compute service account the appropriate permissions. In the next page, you will see the option to deploy an example cloud function like `helloHttp`. Deploy this function. You will be prompted to grant permissions to the default compute service account. The message will look like:
+`You need to grant the following roles to the build service account to deploy a function:
+roles/cloudbuild.builds.builder to <projectID>[email protected].`
+5. Click **Grant** to provide the required permissions and deploy the example cloud function. Once deployed, you can delete this function if you wish.
+
+With the required permissions granted, you should now be able to deploy cloud functions from FlutterFlow without any further issues.
+
+</details>
+
+
 <details>
 <summary>I am getting Cloud Function Deployment Errors</summary>
 

docs/accounts-billing/imgs/img_2.png renamed to docs/accounts-billing/imgs/update-email.png

@@ -3,7 +3,7 @@ slug: /concepts/custom-code/custom-actions
 title: Custom Actions
 description: Learn how to create and use custom actions in your FlutterFlow app to enhance functionality.
 tags: [Custom Actions, Custom Code]
-sidebar_position: 3
+sidebar_position: 4
 keywords: [FlutterFlow, Custom Actions, Customizations, Flutter, Dart, Pub.dev]
 ---
 

docs/accounts-billing/plan-pricing.md

@@ -11,19 +11,15 @@ toc_max_heading_level: 4
 # Custom Code
 
 While FlutterFlow provides a wide range of pre-built components and functionalities, there may be
-times when you need to extend your app with custom logic or features that are not readily available.
-This
-is where writing custom code comes into play. We provide the following features to accommodate
-these needs:
-
-* **[Custom Functions](custom-functions.md):** Write custom Dart functions to perform specific tasks or 
-  calculations.
-* **[Custom Actions](custom-actions.md):** Implement custom actions that can be triggered by user 
-  interactions or
-  other action triggers.
-* **[Custom Widgets](custom-widgets.md):** Create custom Flutter widgets to achieve unique UI designs or 
-  behaviors.
-* **[Custom Files:](custom-files.md)** Ability to edit some parts of the `main.dart` file.
+times when you need to extend your app with custom logic or UI components that are not available out of the box.
+This is where writing custom code comes into play. 
+
+There are a few different ways to make custom code accessible in FlutterFLow:
+
+* **[Custom Functions](custom-functions.md):** Custom Dart functions that can be used to set Widget or Action properties. 
+* **[Custom Actions](custom-actions.md):** Custom Dart functions that can be triggered by [Action Triggers](https://docs.flutterflow.io/resources/functions/action-triggers/) or used as nodes in an [Action Flow](https://docs.flutterflow.io/resources/functions/action-flow-editor#action-flow-editor). These are usually `async` functions and are able to import custom package dependencies.
+* **[Custom Widgets](custom-widgets.md):** Custom Flutter widgets, which can be used in the same way [Components](https://docs.flutterflow.io/resources/ui/components) are used throughout your project. 
+
 
 :::tip[Why Write Custom Code?]
 
@@ -35,14 +31,29 @@ these needs:
   interactions.
   :::
 
-## Common Properties
+# Writing Custom Code
+There are two main ways to write custom code in FlutterFlow:
+
+1. Using the [**In-App Code Editor**](#using-the-in-app-code-editor)
+2. Using the [**Visual Studio Code Extension**](vscode-extension.md)
 
-There are several properties and settings that are common to each type of custom code in
-FlutterFlow. Most of these common properties are highlighted in the diagram below. For more
-information about some of these properties, see the details provided below.
+
+### Using the In-App Code Editor
+You can use the In-App Code Editor to view and edit custom code directly in the FlutterFlow application. 
 
 ![custom-code-common.png](imgs/custom-code-common.png)
 
+:::warning[Using the In-App Code Editor on Desktop]
+Note that the desktop version of the In-App Code Editor is limited. We recommend using the Web editor
+or the **[VSCode Extension](vscode-extension.md)**.
+  :::
+
+
+Beyond the custom code resoureces outlined above, you'll also see an additional section in the left 
+hand sidebar of the Custom Code page - [Custom Files:](custom-files.md). 
+
+Within Custom Files you'll have the ability to edit some parts of the `main.dart` file.
+
 ### Code Copilot
 
 Code Copilot is an AI-assisted feature that helps you generate code snippets,
@@ -85,35 +96,43 @@ knowledge, making it especially useful for custom functions and actions.
 ### Compile Code
 
 When you are done adding your code snippets, you can compile it to ensure there are no
-compilation errors. To do so, click the **Compile Code** button.
+compilation errors and that your code can be transformed into something that can execute when your app is running.
 
+To do so, click the **Compile Code** button.
 
 <figure>
     ![compile-errors.png](imgs/compile-errors.png)
   <figcaption class="centered-caption">How to recognize compile time errors</figcaption>
 </figure>
 
+To run your app, you must make sure **Custom Functions** are compiled. 
+
+Custom Widgets and Actions don't need to be compiled to export code or test your app. However, you won't be able to preview Custom Widgets in the builder until they are compiled.  You'll see a project warning if you don't compile Custom Widgets or Actions.
+
+Compiling Custom Functions should be pretty fast, but sometimes, compiling Custom Actions and Widgets takes a while. 
+
 ### Code Analyzer
 
 The code analyzer is available in all your custom code snippets and ensures the quality and
 correctness of your custom code. It automatically checks your Dart code for errors and warnings,
 providing real-time feedback as you write.
 ![code-analyzer.png](imgs/code-analyzer.png)
+
 When there is a compilation error, the code analyzer will stop running and display the errors caught
 by the compiler. Once fixed, save the code and rerun using the Compile Code button. The code analyzer
 should then be reconnected. You can also manually reconnect it if needed.
 
 ### Custom Code Automatic Imports
 
-When creating a new custom code snippet (actions, widgets, or functions) in FlutterFlow, some fundamental imports will be automatically added for you. These imports cannot be modified by the developer. Custom Functions do not allow adding any custom imports, but you can add custom imports in Custom Actions and Widgets after the line **"Do not remove or modify the code above"**.
+When creating a new custom code snippet (Actions, Widgets, or Functions) in FlutterFlow, some fundamental imports will be automatically added for you. These imports cannot be modified by the developer. Custom Functions do not allow adding any custom imports, but you can add custom imports in Custom Actions and Widgets after the line **"Do not remove or modify the code above"**.
 
 ![automatic-imports.png](imgs/automatic-imports.png)
 
 ### Custom Code Settings
 
 When you edit a custom code snippet in FlutterFlow, the Settings block will open on the right. This
-block may vary slightly depending on the type of custom code (actions, functions, widgets), but here
-we will discuss the common settings.
+block may vary slightly depending on the type of custom code (Actions, Functions, Widgets), but here
+we'll discuss the common settings.
 
 #### Exclude From Compilation
 
@@ -261,7 +280,7 @@ one.
 
 ![Dependency-score.png](imgs/Dependency-score.png)
 
-When adding a pubspec dependency to your custom code in FlutterFlow, you’ll need two pieces of information: the [package name with its version number](#copy-package-name--version-) and the [import statement](#copying-import-statement).
+When adding a pubspec dependency to your custom code in FlutterFlow, you’ll need two pieces of information: the [package name with its version number](#copy-package-name--version) and the [import statement](#copying-import-statement).
 
 #### Copy Package Name & Version