From 79121ba4470374d53484a68504916ef729c0f65e Mon Sep 17 00:00:00 2001 From: Filip Hracek Date: Sat, 24 Feb 2018 10:51:01 -0800 Subject: [PATCH 1/4] Add first version of flutter.io/docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This will be the “index” of our docs (as the homepage will lack sidenav pretty soon). --- _data/docs_cards.yml | 9 +++++ docs.md | 94 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 103 insertions(+) create mode 100644 _data/docs_cards.yml create mode 100644 docs.md diff --git a/_data/docs_cards.yml b/_data/docs_cards.yml new file mode 100644 index 0000000000..6067fede04 --- /dev/null +++ b/_data/docs_cards.yml @@ -0,0 +1,9 @@ +- name: Get Started + description: Learn how to set up your environment and start building. + url: /setup +- name: Widgets Catalog + description: The rich set of Flutter widgets available in the SDK. + url: /widgets +- name: API Docs + description: Generated reference docs for the Flutter framework. + url: https://docs.flutter.io/ diff --git a/docs.md b/docs.md new file mode 100644 index 0000000000..5d4b33b7ab --- /dev/null +++ b/docs.md @@ -0,0 +1,94 @@ +--- +layout: page +title: Flutter Documentation +permalink: /docs/ +--- + + + +  + + +## New to Flutter? + +* [Write Your First Flutter App](/tutorials/get-started/) + A walkthrough on creating a Flutter app that generates names for startup companies. + +* [Flutter for Android Developers](/flutter-for-android/) + Tips for Android developers. + +* [HTML/CSS patterns](/web-analogs/) + Tips for web developers showing how HTML and CSS syntax maps to Flutter widgets. + +* [Building Layouts in Flutter](/tutorials/layout/) + Walkthrough showing how to create layouts in Flutter, where everything is a widget. + +* [Add Interactivity to Your Flutter App](/tutorials/interactivity/) + Walkthrough showing how to add a stateful widget to your app. + +* [A Tour of the Flutter Widget Framework](/widgets-intro/) + A short, conceptual tour through the Flutter framework. + +  + + +## Want to skill up? + +You’ve mastered the basics and want to add to your skills. + +* [Cookbook](/cookbook/) + A (growing) collection of recipes that address common Flutter use cases. + +* [Sample App Catalog](/samples/) + Simple apps that show how to implement features and widgets. + +* [Adding Assets and Images in Flutter](/assets-and-images/) + How to add resources to a Flutter app. + +* [Animations in Flutter](/animations/) + Flutter supports different types of animations. Learn how to create standard, + hero, or staggered animations, to name a few. + +* [Routing and Navigation](/routing-and-navigation/) + How to create and navigate to new pages. + +* [Internationalization](/tutorials/internationalization/) + Go global! How to internationalize your Flutter app. + +* [Effective Dart](https://www.dartlang.org/guides/language/effective-dart) + Guides on how to write better Dart code. + +  + + +## Specialized topics + +* [Custom fonts](/custom-fonts/) + How to add new fonts to your app. + +* [Text input](/text-input/) + How to set up basic text input. + +* [Debugging Flutter Apps](/debugging/) + Tools and tips for debugging your app. + +* [Flutter Widget Inspector](/inspector/) + The Flutter Inspector, a tool available in the Flutter plugin for your IDE. + +  + + +This is not a complete list. Please use the left navigation, or the search +field to find other topics. From 9d13ab470a64298ed73bea3ee15de5f7adacd3db Mon Sep 17 00:00:00 2001 From: Filip Hracek Date: Sat, 24 Feb 2018 14:38:24 -0800 Subject: [PATCH 2/4] Fix links or link to bogus urls --- docs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs.md b/docs.md index 5d4b33b7ab..57f5223c3a 100644 --- a/docs.md +++ b/docs.md @@ -23,7 +23,7 @@ permalink: /docs/ ## New to Flutter? -* [Write Your First Flutter App](/tutorials/get-started/) +* [Write Your First Flutter App](http://example.com) A walkthrough on creating a Flutter app that generates names for startup companies. * [Flutter for Android Developers](/flutter-for-android/) @@ -35,7 +35,7 @@ permalink: /docs/ * [Building Layouts in Flutter](/tutorials/layout/) Walkthrough showing how to create layouts in Flutter, where everything is a widget. -* [Add Interactivity to Your Flutter App](/tutorials/interactivity/) +* [Add Interactivity to Your Flutter App](/tutorials/interactive/) Walkthrough showing how to add a stateful widget to your app. * [A Tour of the Flutter Widget Framework](/widgets-intro/) @@ -51,7 +51,7 @@ You’ve mastered the basics and want to add to your skills. * [Cookbook](/cookbook/) A (growing) collection of recipes that address common Flutter use cases. -* [Sample App Catalog](/samples/) +* [Sample App Catalog](/catalog/samples/) Simple apps that show how to implement features and widgets. * [Adding Assets and Images in Flutter](/assets-and-images/) From f2b51fbf82e851a8ab80482b4554b80130128dde Mon Sep 17 00:00:00 2001 From: Filip Hracek Date: Mon, 26 Feb 2018 15:22:01 -0800 Subject: [PATCH 3/4] Fix link to actual codelab --- docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs.md b/docs.md index 57f5223c3a..a47f384412 100644 --- a/docs.md +++ b/docs.md @@ -23,7 +23,7 @@ permalink: /docs/ ## New to Flutter? -* [Write Your First Flutter App](http://example.com) +* [Write Your First Flutter App](/get-started/codelab/) A walkthrough on creating a Flutter app that generates names for startup companies. * [Flutter for Android Developers](/flutter-for-android/) From e4feac10fff1cd72872e9307d4c5b64d3b4f6b21 Mon Sep 17 00:00:00 2001 From: Filip Hracek Date: Mon, 26 Feb 2018 15:44:21 -0800 Subject: [PATCH 4/4] Update card URLs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The URLs worked, but: * /setup is redirected to /get-started/install/, so let’s use the final destination itself * let’s use URLs with trailing slash, as that seems to be the canonical way on flutter.io --- _data/docs_cards.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_data/docs_cards.yml b/_data/docs_cards.yml index 6067fede04..5c955b3de2 100644 --- a/_data/docs_cards.yml +++ b/_data/docs_cards.yml @@ -1,9 +1,9 @@ - name: Get Started description: Learn how to set up your environment and start building. - url: /setup + url: /get-started/install/ - name: Widgets Catalog description: The rich set of Flutter widgets available in the SDK. - url: /widgets + url: /widgets/ - name: API Docs description: Generated reference docs for the Flutter framework. url: https://docs.flutter.io/