Skip to content

Commit 483dd09

Browse files
committed
Merge branch 'refs/heads/main' into pooja/style-guide
2 parents 4caa18b + 7be2e94 commit 483dd09

File tree

406 files changed

+8546
-2825
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

406 files changed

+8546
-2825
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Check Build Errors
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main # Run on PRs targeting the main branch
7+
8+
jobs:
9+
build-check:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout Repository
13+
uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
17+
- name: Install Dependencies
18+
run: npm install
19+
20+
- name: Build
21+
run: npm run build
22+
23+
24+
25+
26+

README.md

Lines changed: 36 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,52 @@
1-
21
# Welcome to the FlutterFlow Documentation Repository!
3-
We're thrilled to have you here! Our documentation is a crucial resource for both new and existing users of FlutterFlow, and it grows and improves with contributions from our community. Whether you're fixing a typo, discussing a new topic, adding a troubleshooting guide, or sharing your experiences in a blog post, your contributions help everyone.
2+
We're thrilled to have you here! Our documentation is a crucial resource for both new and existing users of FlutterFlow, and it grows and improves with contributions from our community. Whether you're fixing a typo, or adding a new topic, your contributions help everyone.
43

54
Below you'll find guidelines on how you can contribute to different parts of the documentation.
65

7-
### A little note on tooling
8-
Most of our documentation is written in markdown, which means it's super easy edit files.
9-
You can choose to edit markdown directly in GitHub, or you can open up the entire reposiitory in StackBlitz.
10-
11-
Either way, you'll need to open up a pull request, and get an approval from at least one-code owner.
6+
## A Little Note on Tooling
7+
- Most of our documentation is written in `Markdown`, making it super easy to edit files.
8+
- You can choose to edit Markdown directly in GitHub or open up the entire repository in StackBlitz.
129

13-
TO DO: add more details
10+
Either way, you'll need to open up a pull request and get approval from at least one code owner.
1411

15-
## 1. Editing Existing Pages
16-
To make edits to an existing page, you can use the "Edit this page" button that appears at the bottom of each page.
17-
That brings you straight to the source of the page in GitHub.
12+
## Contribution Guidelines
13+
Before you start contributing, please take a moment to review our [Contribution Guidelines](https://flutterflow.notion.site/Docs-Contribution-Guidelines-42829c305df441f6b061b4095abac8a8). This document outlines the process and expectations for contributions to ensure a smooth collaboration.
1814

19-
## 2. Adding a New Docs Page
20-
To add a new docs page, simply create a new markdown page in a subdirectory within the docs directory.
15+
## How to Contribute
16+
1. **Editing Existing Pages**:
17+
To make edits to an existing page in [docs.flutterflow.io](https://docs.flutterflow.io), you can use the "Edit this page" button that appears at the bottom of each page. This button will bring you straight to the source of the page in GitHub.
2118

22-
To ensure that page shows up on the sidebar, add its path to the docsSidebar object inside the sidebars.ts file.
19+
2. **Adding a New Docs Page**:
20+
To add a new docs page, simply create a new Markdown page in an existing subdirectory within the `/docs` directory.
2321

24-
## 3. Adding a Troubleshooting Guide
25-
To add a new troubleshooting guide, simply create a new mardkown page in the docs/troubleshooting directory.
22+
3. **Create a PR to `main`**:
23+
After making these changes, commit them to a new branch, and then create a pull request (PR) for review from FlutterFlow team.
2624

27-
## 4. Adding a Blog
28-
To add a new blog, simply create a new mardkown page in the blogs directory.
25+
## Running the Docs Site Locally
26+
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:
2927

30-
## 5. Generating the Changelog
31-
TO DO: auto-generating changelog
28+
1. **Install Dependencies:** Run **`npm install`** in your terminal to install the necessary dependencies.
29+
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`**.
3230

33-
### Ready to Contribute?
31+
## Ready to Contribute?
3432
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!
3533

36-
### Top Contributors
34+
[//]: # (Top Contributors)
35+
36+
[//]: # (We value the hard work and dedication of our contributors. Here’s a list of our top contributors, automatically generated:)
37+
38+
[//]: # ()
39+
[//]: # (shell)
40+
41+
[//]: # (Copy code)
42+
43+
[//]: # (# Script to add top contributors)
44+
45+
[//]: # (npx @octokit/rest.js --run "repos.listContributors({)
46+
47+
[//]: # (owner: 'flutterflow',)
3748

38-
TO DO: *Perhaps we have some top contributors tabe that's autogenerated*?
49+
[//]: # (repo: 'documentation')
3950

40-
If you have any questions or need further guidance, don't hesitate to reach out to the documentation team. Happy documenting!
51+
[//]: # (})")
52+
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

Lines changed: 36 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,85 +9,77 @@ sidebar_position: 1
99
# Account Management
1010
This section contains information on changing your password, verifying your email, and deleting your account.
1111

12-
## Password
1312
### I can't log in to my account / I forgot my login info.
14-
1513
To reset your account password:
1614

17-
- From `flutterflow.io` select Login in the top right corner.
18-
19-
- At the bottom of the page, select Reset Password.
20-
21-
- You will receive an email with a link to reset your password.
22-
23-
- Click the reset link and enter your new password.
24-
25-
If you can’t remember your username or are experiencing any other issues, please reach out to us at [email protected]
26-
27-
15+
1. From `flutterflow.io` select Login in the top right corner.
16+
2. At the bottom of the page, select **Reset Password**.
17+
3. You will receive an email with a link to reset your password.
18+
4. Click the reset link and enter your new password.
2819

29-
30-
### How Do I Change My Password?
20+
If you can’t remember your username or are experiencing any other issues, please reach out to us at `[email protected]`
3121

3222

23+
### How do I change my password?
3324
To change your password, please use the following steps:
3425

35-
- Log in to your FlutterFlow account and select Account from the top right.
36-
37-
- Under Personal Info, select Reset Password.
26+
1. Navigate to your [account page in FlutterFlow](https://app.flutterflow.io/account).
27+
2. Under Personal Info, select Reset Password.
28+
3. You will receive an email with a link to reset your password.
29+
4. Click the reset link and enter your new password.
3830

39-
- You will receive an email with a link to reset your password.
4031

41-
- Click the reset link and enter your new password.
42-
43-
## Verify Account
44-
### How Do I Check If My Account Is Verified?
32+
### How do I check if my account is verified?
4533
To check if you have verified your account:
4634

47-
1. Log in to your FlutterFlow account and select Account from the top right.
48-
2. Navigate to the Profile Information section.
49-
3. If you have a green checkmark next to your email, your account is verified.
35+
1. Navigate to your [account page in FlutterFlow](https://app.flutterflow.io/account).
36+
2. If you have a green checkmark next to your email, your account is verified.
5037

51-
![img_1.png](imgs/img_1.png)
38+
![check-account-verification.png](imgs/check-account-verification.png)
5239

53-
### I Didn't Get The Email To Verify My Account / How Do I Resend The Verification Email?
40+
### I didn't get the email to verify my account, how do I resend the verification email?
5441
If you did not receive a verification email, please follow these steps:
5542

56-
1. Log in to your FlutterFlow account and select Account from the top right.
57-
2. Navigate to the Profile Information section and check that your email address is correct.
58-
3. If your email is incorrect, please reach out to [email protected] to correct this.
59-
4. From the Profile Information section, select Verify Email.
43+
1. Navigate to your [account page in FlutterFlow](https://app.flutterflow.io/account).
44+
2. Check that your email address is correct. If your email is incorrect, please reach out to `[email protected]` to correct this.
45+
3. From the **Profile Information** section, select **Verify Email**.
6046

6147
You should receive a new confirmation email. If you do not receive the verification email, please contact us at [email protected].
6248

63-
![img.png](imgs/img.png)
49+
![email-verification.png](imgs/email-verification.png)
6450

65-
## Delete Account
66-
### How Do I Delete My Account
51+
### How do I delete my account?
6752
To delete your FlutterFlow account, please follow these steps:
6853

69-
1. Log in to your FlutterFlow account and select Account from the top right.
70-
71-
2. Scroll down to the My Plan section and select Delete Account (bottom right corner)
54+
1. Log in to your FlutterFlow account and select **Account** from the top right.
55+
2. Scroll down to the **My Plan** section and select **Delete Account** (bottom right corner)
7256

7357
:::danger
7458
This step can not be undone. We will not be able to recover your projects.
7559
:::
7660

7761

78-
## Change/Update Email Address
79-
### Q: How do I change or update my login email address?
62+
### How do I change or update my email address?
8063
To change your login email in FlutterFlow:
8164

8265
1. Log into your FlutterFlow account.
8366
2. Go to the dashboard and select your account tile (showing your name and email).
84-
3. Click on Update Email.
67+
3. Click on **Update Email**.
8568
4. Enter your current email and password.
86-
5. Input your new email and click Confirm & Log Out.
69+
5. Input your new email and click **Confirm & Log Out**.
8770
6. Verify the new email via the link sent to it.
88-
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.
71+
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.
8972
8. You'll receive the password reset link at your new email address. Click the link and reset the password.
9073

9174
Now, you are ready to log in with your new email address and password.
9275

93-
![img_2.png](imgs/img_2.png)
76+
![update-email.png](imgs/update-email.png)
77+
78+
### How do I generate an API Token?
79+
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)
80+
.
81+
82+
To create an API token tied to your account:
83+
84+
1. Navigate to your [account page in FlutterFlow](https://app.flutterflow.io/account).
85+
2. Near the bottom of the page, click **Create Token**
126 KB
Loading
25.2 KB
Binary file not shown.
18.8 KB
Binary file not shown.

docs/accounts-billing/plan-pricing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ sidebar_position: 2
88

99
# Plans & Pricing
1010
:::note
11-
For our most upto date information, please visit **[FlutterFlow pricing](https://flutterflow.io/pricing.html)**.
11+
For our most up-to-date information, please visit **[FlutterFlow pricing](https://flutterflow.io/pricing)**.
1212
:::
1313

1414
:::note
1515
Regional discounts are available, please **[log in to FlutterFlow](https://app.flutterflow.io/)** to see the pricing for your region.
16-
:::
16+
:::

0 commit comments

Comments
 (0)