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 com 8000 munity. Whether you're fixing a typo, or adding a new topic, your contributions help everyone.
Below you'll find guidelines on how you can contribute to different parts of the documentation.
- Most of our documentation is written in
Markdown, making it super easy to edit files. - You can choose to edit Markdown directly in GitHub or open up the entire repository in StackBlitz.
Either way, you'll need to open up a pull request and get approval from at least one code owner.
Before you start contributing, please take a moment to review our Contribution Guidelines. This document outlines the process and expectations for contributions to ensure a smooth collaboration.
-
Editing Existing Pages: To make edits to an existing page in 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.
-
Adding a New Docs Page: To add a new docs page, simply create a new Markdown page in an existing subdirectory within the
/docsdirectory. -
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.
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:
- Install Dependencies: Run
npm installin your terminal to install the necessary dependencies. - 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.
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!
If you have any questions or need further guidance, don't hesitate to reach out to the documentation team. Happy documenting!