2
2
3
3
[ Flutter logo ] : https://github.com/dart-lang/site-shared/blob/main/src/_assets/image/flutter/icon/64.png?raw=1
4
4
5
- # [ Flutter] [ ] documentation website
5
+ # [ Flutter] [ ] documentation website
6
6
7
7
The [ documentation site] [ Flutter ] for the [ Flutter framework] [ ] ,
8
8
built with [ Eleventy] [ ] and hosted on [ Firebase] [ ] .
@@ -32,41 +32,41 @@ built with [Eleventy][] and hosted on [Firebase][].
32
32
33
33
## Issues, bugs, and requests
34
34
35
- We welcome contributions and feedback on our website.
35
+ We welcome contributions and feedback on our website.
36
36
Please file a request in our
37
- [ issue tracker] ( https://github.com/flutter/website/issues/new/choose )
38
- or create a [ pull request] ( https://github.com/flutter/website/pulls ) .
39
- For simple changes (such as tweaking some text),
37
+ [ issue tracker] ( https://github.com/flutter/website/issues/new/choose )
38
+ or create a [ pull request] ( https://github.com/flutter/website/pulls ) .
39
+ For simple changes (such as tweaking some text),
40
40
it's easiest to make changes using the GitHub UI.
41
41
42
- If you have an issue with the
43
- API docs on [ api.flutter.dev] ( https://api.flutter.dev ) ,
44
- please file those issues on
45
- the [ ` flutter/flutter ` ] ( https://github.com/flutter/flutter/issues ) repo,
46
- not on this (` flutter/website ` ) repo.
47
- The API docs are embedded in Flutter's source code,
42
+ If you have an issue with the
43
+ API docs on [ api.flutter.dev] ( https://api.flutter.dev ) ,
44
+ please file those issues on
45
+ the [ ` flutter/flutter ` ] ( https://github.com/flutter/flutter/issues ) repo,
46
+ not on this (` flutter/website ` ) repo.
47
+ The API docs are embedded in Flutter's source code,
48
48
so the engineering team handles those.
49
49
50
50
51
51
## Before you submit a PR
52
52
53
- We love it when the community gets involved in improving our docs!
53
+ We love it when the community gets involved in improving our docs!
54
54
But here are a few notes to keep in mind before you submit a PR:
55
55
56
- - When triaging issues,
57
- we sometimes label an issue with the tag ** PRs welcome** .
56
+ - When triaging issues,
57
+ we sometimes label an issue with the tag ** PRs welcome** .
58
58
But we welcome PRs on other issues as well&mdash ;
59
59
it doesn't have to be tagged with that label.
60
- - Please don't run our docs through Grammarly (or similar)
60
+ - Please don't run our docs through Grammarly (or similar)
61
61
and submit those changes as a PR.
62
62
- We follow the [ Google Developer Documentation Style Guidelines] [ ] —
63
- for example, don't use "i.e." or "e.g.",
63
+ for example, don't use "i.e." or "e.g.",
64
64
avoid writing in first person,
65
65
and avoid writing in future tense.
66
66
You can start with the
67
- [ style guide highlights] ( https://developers.google.com/style/highlights )
68
- or the [ word list] ( https://developers.google.com/style/word-list ) ,
69
- or use the search bar that's at the top of every style guide page.
67
+ [ style guide highlights] ( https://developers.google.com/style/highlights )
68
+ or the [ word list] ( https://developers.google.com/style/word-list ) ,
69
+ or use the search bar at the top of every style guide page.
70
70
71
71
> We truly thank you for your willingness and helpfulness
72
72
> in keeping the website docs up to date!
@@ -83,12 +83,12 @@ you probably don't need to build this site.
83
83
Often you can make changes using the GitHub UI.
84
84
If needed, we can stage the changes automatically in your pull request.
85
85
86
- > [ !IMPORTANT]
86
+ > [ !IMPORTANT]
87
87
> If you are cloning this repository locally,
88
88
> follow the below instruction on cloning with its submodule.
89
89
90
90
If your change involves code samples, adds/removes pages, or affects navigation,
91
- do consider building and test your work before submitting.
91
+ do consider building and testing your work before submitting.
92
92
93
93
If you want or need to build the site, follow the steps below.
94
94
@@ -239,7 +239,7 @@ following the instructions in [Get the prerequisites](#get-the-prerequisites).
239
239
``` console
240
240
pnpm install
241
241
```
242
-
242
+
243
243
Rerun ` pnpm install ` whenever you incorporate the
244
244
latest changes to the ` main ` branch or if you
245
245
experience dependency or import errors when building the site.
@@ -318,7 +318,7 @@ in the corresponding `.dart` files.
318
318
319
319
The ` .dart ` files are the source of truth for code snippets,
320
320
and the preceding ` <?code-excerpt> ` instructions in Markdown files specify
321
- how the snippets are copied from the ` .dart ` files.
321
+ how the snippets are copied from the ` .dart ` files.
322
322
323
323
To resolve this error and update the Markdown snippets to match,
324
324
from the root of the ` website ` directory,
@@ -341,7 +341,7 @@ you can build a full version and upload it to Firebase.
341
341
- Navigate to the [ Firebase Console] ( https://console.firebase.google.com )
342
342
and create your own Firebase project (for example, ` flutter-dev-staging ` ).
343
343
344
- - Head back to your local terminal and verify that you are logged in.
344
+ - Head back to your local terminal and verify that you're logged in.
345
345
346
346
``` console
347
347
firebase login
0 commit comments