Repository files navigation

Thedocumentation site for theFlutter framework,built withJaspr and hosted onFirebase.

We welcome contributions and feedback on our website.Please file a request in ourissue trackeror create apull request.For simple changes (such as tweaking some text),it's easiest to make changes using the GitHub UI.

If you have an issue with theAPI docs onapi.flutter.dev,please file those issues ontheflutter/flutter repo,not on this (flutter/website) repo.The API docs are embedded in Flutter's source code,so the engineering team handles those.

We love it when the community gets involved in improving our docs!But here are a few notes to keep in mind before you submit a PR:

• When triaging issues,we sometimes label an issue with the tagPRs welcome.But we welcome PRs on other issues as well—it doesn't have to be tagged with that label.
• Please don't run our docs through Grammarly (or similar)and submit those changes as a PR.
• We follow theGoogle Developer Documentation Style Guidelines —for example, don't use "i.e." or "e.g.",avoid writing in first person,and avoid writing in future tense.You can start with thestyle guide highlightsor theword list,or use the search bar at the top of every style guide page.

We truly thank you for your willingness and helpfulnessin keeping the website docs up to date!

To update this site, fork the repo, make your changes,and generate a pull request.For small, contained changes (such as style and typo fixes),you probably don't need to build this site.Often you can make changes using the GitHub UI.If needed, we can stage the changes automatically in your pull request.

If your change involves code samples, adds/removes pages, or affects navigation,do consider building and testing your work before submitting.

If you want or need to build the site, follow the steps below.

For changes beyond simple text and CSS tweaks,we recommend running the site locally toenable an edit-refresh cycle.

To build and develop the site, you'll need toinstall the latest stable release of Flutter, which includes Dart.

If you don't have Flutter or need to update, follow theinstructions atInstall Flutter orUpgrading Flutter.

If you already have Flutter installed, verify it's on your pathand already the latest stable version:

flutter --version

If you're not a member of the Flutter organization,we recommend youcreate a fork of this repo under your own account,and then submit a PR from that fork.

Once you have a fork (or you're a Flutter org member),clone the repository withgit clone:

git clone https://github.com/flutter/website.git

Before you continue setting up the site infrastructure,verify the correct versions of Flutter and Node.js are set up and available byfollowing the instructions inGet the prerequisites.

1. Optional: After cloning the repo,create a branch for your changes:

   git checkout -b <BRANCH_NAME>

2. From the root directory of the repository,fetch the site's Dart dependencies.

   dart pub get

3. From the root directory, run thedash_site tool tovalidate your setup and learn about the available commands.

   dart run dash_site --help

4. From the root directory, serve the site locally.

   dart run dash_site serve

   This command generates and serves the site on alocal port that's printed to your terminal.

5. View your changes in the browser by navigating tohttp://localhost:8080.

   Note the port might be different if8080 is taken.

6. Make your changes to the local repo.

   To view your changes in the browser,you'll need to refresh the page.The site should automatically rebuild on most changes, but ifsomething doesn't update, exit the process and rerun the command.

7. Commit your changes to the branch and submit your PR.

   If your change is large, or you'd like to test it,considervalidating your changes.

If you've made changes to the code inthe/examples,/site, or/tool directories,commit your work, then run the following command toverify it is up to date and matches the site standards.

dart run dash_site check-all

If this script reports any errors or warnings,then address those issues and rerun the command.If you have any issues, leave a comment on your issue or pull request,and we'll try our best to help you.You can also chat with us on the#hackers-devrel channelon theFlutter contributors Discord!

A build that fails with the errorError: Some code excerpts needed to be updated!means that one or more code excerpts in the site Markdown filesaren't identical to the code regions declaredin the corresponding.dart files.

The.dart files are the source of truth for code snippets,and the preceding<?code-excerpt> instructions in Markdown files specifyhow the snippets are copied from the.dart files.

To resolve this error and update the Markdown snippets to match,from the root of thewebsite directory,rundart run dash_site refresh-excerpts.

To learn more about creating, editing, and using code excerpts,check out theexcerpt updater package documentation.