From 4e1162bf0a1868cdc7bbe68c53ee26a2bde8ef37 Mon Sep 17 00:00:00 2001 From: Shams Zakhour Date: Wed, 10 Oct 2018 17:50:32 -0700 Subject: [PATCH 1/4] stashing --- src/docs.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/docs.md b/src/docs.md index 025f58d5b4f..23292959160 100644 --- a/src/docs.md +++ b/src/docs.md @@ -47,6 +47,24 @@ Some of the new content includes: If you have questions or comments about the revamped site, [file an issue]({{site.repo.this}}/issues). +# TODO (Not for publication) + +* Finish reviewing all pages and fixing issues +* Add a TOC back to pages containing tabs +* Run site through accessibility testing/review +* UX testing of new site +* Custom search +* Deprecated/watermark format option +* Add descriptions to each page +* Sitemap +* Redirects +* Finalize landing page +* Finalize showcase page +* A new 404 page +* Complete styling for widget catalog +* More new content (by Flutter Live) + + ## New to Flutter? Once you've gone through [Get Started](/get-started/install), From f3805664763a5a93bcc84e37983256d5ec2ea585 Mon Sep 17 00:00:00 2001 From: Shams Zakhour Date: Mon, 15 Oct 2018 00:11:21 -0700 Subject: [PATCH 2/4] Fixed a slew of bugs filed against master. --- src/_data/sidenav.yml | 11 +- src/deployment/android-release.md | 4 +- src/docs.md | 2 + src/get-started/install/_get-sdk-win.md | 2 +- src/get-started/install/_get-sdk.md | 4 +- src/get-started/install/_path-mac-linux.md | 2 +- .../whatisflutter/diagram-layercake.svg | 141 ++++++++++-------- src/resources/technical-overview.md | 44 +++--- 8 files changed, 116 insertions(+), 94 deletions(-) diff --git a/src/_data/sidenav.yml b/src/_data/sidenav.yml index 6c93f5c3d7f..b54f5d548bc 100644 --- a/src/_data/sidenav.yml +++ b/src/_data/sidenav.yml @@ -165,14 +165,13 @@ permalink: /resources/bootstrap-into-dart - title: Inside Flutter permalink: /resources/inside-flutter - # - title: Flutter best practices - # TODO: We don't have this page yet. + - title: Technical overview + permalink: /resources/technical-overview + # - title: Flutter best practices # TODO - title: Technical videos for learning Flutter permalink: /resources/videos - # - title: Flutter developer communities - # TODO: We don't have this page yet. - # - title: Flutter learning resources - # TODO: We don't have this page yet. + # - title: Flutter developer communities # TODO + # - title: Flutter learning resources # TODO - title: FAQ permalink: /resources/faq diff --git a/src/deployment/android-release.md b/src/deployment/android-release.md index 2e38966fba9..ffe25da291a 100644 --- a/src/deployment/android-release.md +++ b/src/deployment/android-release.md @@ -16,8 +16,8 @@ Review the default [App Manifest][manifest] file `AndroidManifest.xml` located in `/android/app/src/main` and verify the values are correct, especially: -* `application`: Edit the [`application`][applicationtag] tag to reflect the - final name of the app. +* `application`: Edit the `android:label` in the + [`application`][applicationtag] tag to reflect the final name of the app. * `uses-permission`: Remove the `android.permission.INTERNET` [permission][permissiontag] if your application code does not need Internet diff --git a/src/docs.md b/src/docs.md index 23292959160..ea5c3d10fb3 100644 --- a/src/docs.md +++ b/src/docs.md @@ -47,6 +47,7 @@ Some of the new content includes: If you have questions or comments about the revamped site, [file an issue]({{site.repo.this}}/issues). +{% comment %} # TODO (Not for publication) * Finish reviewing all pages and fixing issues @@ -63,6 +64,7 @@ issue]({{site.repo.this}}/issues). * A new 404 page * Complete styling for widget catalog * More new content (by Flutter Live) +{% endcomment %} ## New to Flutter? diff --git a/src/get-started/install/_get-sdk-win.md b/src/get-started/install/_get-sdk-win.md index b8d31a92c11..212de5d7d51 100644 --- a/src/get-started/install/_get-sdk-win.md +++ b/src/get-started/install/_get-sdk-win.md @@ -39,7 +39,7 @@ In the Flutter Console, run the following command to see if there are any dependencies you need to install to complete the setup: ```terminal -$ flutter doctor +$ flutter doctor [-v] ``` This command checks your environment and displays a report to the terminal diff --git a/src/get-started/install/_get-sdk.md b/src/get-started/install/_get-sdk.md index 0a2cdf2c18f..ce3cfa1f48f 100644 --- a/src/get-started/install/_get-sdk.md +++ b/src/get-started/install/_get-sdk.md @@ -34,7 +34,7 @@ 1. Add the `flutter` tool to your path: ```terminal - $ export PATH=`pwd`/flutter/bin:$PATH + $ export PATH=$PATH:`pwd`/flutter/bin ``` The above command sets your `PATH` variable temporarily, for the current terminal @@ -51,7 +51,7 @@ Run the following command to see if there are any dependencies you need to install to complete the setup: ```terminal -$ flutter doctor +$ flutter doctor [-v] ``` This command checks your environment and displays a report to the terminal diff --git a/src/get-started/install/_path-mac-linux.md b/src/get-started/install/_path-mac-linux.md index 53bcadfc59b..667f5c68de9 100644 --- a/src/get-started/install/_path-mac-linux.md +++ b/src/get-started/install/_path-mac-linux.md @@ -16,7 +16,7 @@ a new window. For example: the path where you cloned Flutter's git repo: ```terminal - $ export PATH=PATH_TO_FLUTTER_GIT_DIRECTORY/flutter/bin:$PATH + $ export PATH=$PATH:[PATH_TO_FLUTTER_GIT_DIRECTORY]/flutter/bin ``` 4. Run `source $HOME/.bash_profile` to refresh the current window. 5. Verify that the `flutter/bin` directory is now in your PATH by running: diff --git a/src/images/whatisflutter/diagram-layercake.svg b/src/images/whatisflutter/diagram-layercake.svg index 78f906f5b24..3d3630f629a 100644 --- a/src/images/whatisflutter/diagram-layercake.svg +++ b/src/images/whatisflutter/diagram-layercake.svg @@ -1,65 +1,78 @@ - - - - - layer-cake - - Framework(Dart) - - Material - - Cupertino - - Widgets - - Rendering - - - - Painting - Animation - Gestures - - - - - Dart - Skia - Text - - Foundation - Engine (C++) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/resources/technical-overview.md b/src/resources/technical-overview.md index 814d767cce8..fb9c469c091 100644 --- a/src/resources/technical-overview.md +++ b/src/resources/technical-overview.md @@ -7,19 +7,20 @@ title: Technical Overview Flutter is a mobile app SDK for building high-performance, high-fidelity, apps for iOS and Android, from a single codebase. -The goal is to enable developers to deliver high-performance apps that feel natural -on different platforms. We embrace differences in scrolling behaviors, +The goal is to enable developers to deliver high-performance apps that feel +natural on different platforms. We embrace differences in scrolling behaviors, typography, icons, and more. This is a demo app from the [Gallery](https://github.com/flutter/flutter/tree/master/examples/flutter_gallery/lib/demo), -a collection of Flutter sample apps you can run after installing Flutter and setting -up your environment. Shrine has high-quality scrolling images, interactive cards, -buttons, dropdown lists, and a shopping cart page. To look at the single codebase -for this and more examples, -[visit our GitHub repository](https://github.com/flutter/flutter/tree/master/examples). +a collection of Flutter sample apps you can run after installing Flutter +and setting up your environment. Shrine has high-quality scrolling images, +interactive cards, buttons, dropdown lists, and a shopping cart page. +To look at the single codebase for this and more examples, +[visit our GitHub +repository](https://github.com/flutter/flutter/tree/master/examples). No mobile development experience is required to get started. Apps are written in [Dart](https://www.dartlang.org), which looks familiar if you've used a @@ -107,9 +108,10 @@ building upon the previous layer. -The diagram shows the upper layers of the framework, which are used more -frequently than the lower layers. For the complete set of libraries that make up -the Flutter's layered framework, see our [API documentation](https://docs.flutter.io). +The upper layers of the framework are used more frequently than the lower +layers. For the complete set of libraries that make up +the Flutter's layered framework, see our +[API documentation](https://docs.flutter.io). The goal of this design is to help you do more with less code. For example, the Material layer is built by composing basic widgets from the widgets layer, @@ -130,14 +132,16 @@ wish into the lower layers. You define the unique characteristics of a widget by implementing a [build](https://docs.flutter.io/flutter/widgets/StatelessWidget/build.html) -function that returns a tree (or hierarchy) of widgets. This tree represents the widget's part -of the user interface in more concrete terms. For example, a toolbar widget might -have a build function that returns a [horizontal layout](https://docs.flutter.io/flutter/widgets/Row-class.html) +function that returns a tree (or hierarchy) of widgets. This tree represents +the widget's part of the user interface in more concrete terms. +For example, a toolbar widget might have a build function that returns +a [horizontal layout](https://docs.flutter.io/flutter/widgets/Row-class.html) of some [text](https://docs.flutter.io/flutter/widgets/Text-class.html) and [various](https://docs.flutter.io/flutter/material/IconButton-class.html) [buttons](https://docs.flutter.io/flutter/material/PopupMenuButton-class.html). The framework then recursively asks each of these widgets to build until the -process bottoms out in [fully concrete widgets](https://docs.flutter.io/flutter/widgets/RenderObjectWidget-class.html), +process bottoms out in [fully concrete +widgets](https://docs.flutter.io/flutter/widgets/RenderObjectWidget-class.html), which the framework then stitches together into a tree. A widget's build function should be free of side effects. Whenever it is asked @@ -159,9 +163,12 @@ widget has a counter that increments whenever the user taps a button, the value of the counter is the state for that widget. When that value changes, the widget needs to be rebuilt to update the UI. -These widgets subclass [StatefulWidget](https://docs.flutter.io/flutter/widgets/StatefulWidget-class.html) -(rather than [StatelessWidget](https://docs.flutter.io/flutter/widgets/StatelessWidget-class.html)) -and store their mutable state in a subclass of [State](https://docs.flutter.io/flutter/widgets/State-class.html). +These widgets subclass +[StatefulWidget](https://docs.flutter.io/flutter/widgets/StatefulWidget-class.html) +(rather than +[StatelessWidget](https://docs.flutter.io/flutter/widgets/StatelessWidget-class.html)) +and store their mutable state in a subclass of +[State](https://docs.flutter.io/flutter/widgets/State-class.html). @@ -190,7 +197,8 @@ Next steps: 1. [Follow the Flutter Getting Started guide](/get-started). 1. Try [Building Layouts in Flutter](/development/ui/layout) and [Adding Interactivity to Your Flutter App](/development/ui/interactive). -1. Follow a detailed example in [Tour of the Widget Framework](/development/ui/widgets-intro). +1. Follow a detailed example in [Tour of the Widget + Framework](/development/ui/widgets-intro). ## Get support From 86cf46ea717f9c2ecd5195af2ab4f86bd9224a88 Mon Sep 17 00:00:00 2001 From: Shams Zakhour Date: Mon, 15 Oct 2018 00:40:25 -0700 Subject: [PATCH 3/4] Fixing an issue in Test Drive. --- src/get-started/test-drive/_androidstudio.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/get-started/test-drive/_androidstudio.md b/src/get-started/test-drive/_androidstudio.md index ad8ccbf9fde..832663df777 100644 --- a/src/get-started/test-drive/_androidstudio.md +++ b/src/get-started/test-drive/_androidstudio.md @@ -3,10 +3,12 @@ ## Create the app {#create-app} 1. Select **File > New Flutter Project**. - 1. Select **Flutter application** as the project type, and press **Next**. - 1. Enter a project name, such as `myapp`, and press **Next**. + 1. Select **Flutter application** as the project type, and press Next. + 1. Make sure that the **Flutter SDK Path** text field specifies the + location of the SDK. Install the SDK if you haven't yet done so. + 1. Enter a project name (for example, `myapp`), and press Next. 1. Click **Finish**. - 1. Wait for Android Studio to install the SDK and create the project. + 1. Wait for Android Studio to install the SDK, and create the project. The above commands create a Flutter project directory called `myapp` that contains a simple demo app that uses [Material Components][]. From b97262b2bf883b0580f8ca1786590987ed5d0a82 Mon Sep 17 00:00:00 2001 From: Shams Zakhour Date: Tue, 16 Oct 2018 11:31:37 -0700 Subject: [PATCH 4/4] Fixing little bugs. --- .../accessibility-and-localization/internationalization.md | 4 ++-- src/docs.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/development/accessibility-and-localization/internationalization.md b/src/development/accessibility-and-localization/internationalization.md index 080973e6e4a..f975c6a55ac 100644 --- a/src/development/accessibility-and-localization/internationalization.md +++ b/src/development/accessibility-and-localization/internationalization.md @@ -130,8 +130,8 @@ on the inherited widget is created. When an inherited widget changes contexts are rebuilt. Localized values are loaded by the Localizations widget's list of -[LocalizationsDelegate](https://docs.flutter.io/flutter/widgets/LocalizationsDelegate-class.html)s. -Each delegate must define an async +[LocalizationsDelegate]({{site.api}}/flutter/widgets/LocalizationsDelegate-class.html)s. +Each delegate must define an asynchronous [`load()`](https://docs.flutter.io/flutter/widgets/LocalizationsDelegate/load.html) method that produces an object which encapsulates a collection of localized values. Typically these objects define one method per localized value. diff --git a/src/docs.md b/src/docs.md index ea5c3d10fb3..5031c969d67 100644 --- a/src/docs.md +++ b/src/docs.md @@ -54,7 +54,7 @@ issue]({{site.repo.this}}/issues). * Add a TOC back to pages containing tabs * Run site through accessibility testing/review * UX testing of new site -* Custom search +* Custom search - open issue * Deprecated/watermark format option * Add descriptions to each page * Sitemap