Skip to content

Commit e63dba6

Browse files
authored
Update learning index YAML files for consistency (#12505)
- Fix a few keys that had a null/missing value causing issues for some YAML parsers. - Keep descriptions <= 80 characters by consistently breaking them across lines. - A few minor capitalization fixes.
1 parent 3717536 commit e63dba6

File tree

3 files changed

+95
-38
lines changed

3 files changed

+95
-38
lines changed

src/_data/learning-resources-index/demos.yml

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
- name: Add-to-app
2-
description: Recommended approaches for adding Flutter to existing apps.
2+
description: >-
3+
Recommended approaches for adding Flutter to existing apps.
34
tags:
45
- platforms
56
- iOS
@@ -10,7 +11,9 @@
1011
label: Flutter Github
1112

1213
- name: Android splash screen
13-
description:
14+
description: >-
15+
A Flutter sample app that exemplifies how to implement an
16+
animated splash screen for Android devices.
1417
tags:
1518
- Android
1619
type: demo
@@ -19,16 +22,19 @@
1922
label: Flutter Github
2023

2124
- name: iOS app clip
22-
description:
25+
description: >-
26+
A sample project demonstrating integration with iOS App Clip.
2327
tags:
2428
- iOS
2529
type: demo
2630
link:
2731
url: https://github.com/flutter/samples/tree/main/ios_app_clip
2832
label: Flutter Github
2933

30-
- name: Swift Platform view
31-
description: A Flutter sample app that combines a native iOS UIViewController with a full-screen Flutter view.
34+
- name: Swift platform view
35+
description: >-
36+
A Flutter sample app that combines a native iOS UIViewController with
37+
a full-screen Flutter view.
3238
tags:
3339
- swift
3440
- ios
@@ -37,9 +43,12 @@
3743
url: https://github.com/flutter/samples/tree/main/platform_view_swift
3844
label: Flutter Github
3945

40-
- name: Simplistic Editor
41-
description: This sample text editor showcases the use of TextEditingDeltas and a DeltaTextInputClient to expand and contract styled ranges of text.
46+
- name: Simplistic editor
47+
description: >-
48+
This sample text editor showcases the use of TextEditingDeltas and
49+
a DeltaTextInputClient to expand and contract styled ranges of text.
4250
tags:
51+
- text
4352
type: quickstart
4453
link:
4554
url: https://github.com/flutter/samples/tree/main/simplistic_editor

src/_data/learning-resources-index/quickstarts_dart.yml

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
- name: Command line app
2-
description: A command line app that parses command-line options and fetches from GitHub.
1+
- name: Command-line app
2+
description: >-
3+
A command line app that parses command-line options and fetches from GitHub.
34
tags:
45
- cli
56
- Dart
@@ -9,7 +10,8 @@
910
label: Dart Github
1011

1112
- name: Extension methods
12-
description: Demonstrates Dart's extensions method syntax.
13+
description: >-
14+
Demonstrates Dart's extensions method syntax.
1315
tags:
1416
- syntax
1517
- Dart
@@ -19,7 +21,8 @@
1921
label: Dart Github
2022

2123
- name: FFI
22-
description: A series of simple examples demonstrating how to call C libraries from Dart.
24+
description: >-
25+
A series of simple examples demonstrating how to call C libraries from Dart.
2326
tags:
2427
- platforms
2528
- Dart
@@ -29,7 +32,9 @@
2932
label: Dart Github
3033

3134
- name: Isolates (in a CLI)
32-
description: Command line applications that demonstrate how to work with Concurrency in Dart using isolates.
35+
description: >-
36+
Command line applications that demonstrate how to
37+
work with Concurrency in Dart using isolates.
3338
tags:
3439
- cli
3540
- Dart
@@ -39,7 +44,9 @@
3944
label: Dart Github
4045

4146
- name: Native Dart app
42-
description: A command line application that can be compiled to native code using `dart compile exe`.
47+
description: >-
48+
A command line application that can be compiled to
49+
native code using `dart compile exe`.
4350
tags:
4451
- cli
4552
- Dart
@@ -49,7 +56,8 @@
4956
label: Dart Github
5057

5158
- name: Server side Dart
52-
description: Examples of running Dart on the server.
59+
description: >-
60+
Examples of running Dart on the server.
5361
tags:
5462
- cli
5563
- Dart
@@ -59,7 +67,8 @@
5967
label: Dart Github
6068

6169
- name: Package constraint solver
62-
description: Demonstrates best-practices for publishing packages on pub.dev.
70+
description: >-
71+
Demonstrates best-practices for publishing packages on pub.dev.
6372
tags:
6473
- pub
6574
- Dart

src/_data/learning-resources-index/quickstarts_flutter.yml

Lines changed: 62 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
- name: Asset transformation
2-
description: Demonstrates how to transform images' color scales and formats.
2+
description: >-
3+
Demonstrates how to transform images' color scales and formats.
34
tags:
45
- images
56
- UI
@@ -9,7 +10,8 @@
910
label: Flutter Github
1011

1112
- name: Background isolate channels
12-
description: Demonstrates how to use long-lived isolates.
13+
description: >-
14+
Demonstrates how to use long-lived isolates.
1315
tags:
1416
- performance
1517
type: quickstart
@@ -18,15 +20,21 @@
1820
label: Flutter Github
1921

2022
- name: Code sharing
21-
description: Demonstrates how to share business logic between Flutter client and Dart server using `package:shelf`.
23+
description: >-
24+
Demonstrates how to share business logic between a
25+
Flutter client and Dart server using `package:shelf`.
2226
tags:
27+
- Dart
2328
type: quickstart
2429
link:
2530
url: https://github.com/flutter/samples/tree/main/code_sharing
2631
label: Flutter Github
27-
32+
2833
- name: Context menus
29-
description: This sample shows how to create and customize cross-platform context menus, such as the text selection toolbar on mobile or the right click menu on desktop.
34+
description: >-
35+
This sample shows how to create and customize cross-platform context menus,
36+
such as the text selection toolbar on mobile or
37+
the right click menu on desktop.
3038
tags:
3139
- macos
3240
- windows
@@ -36,7 +44,8 @@
3644
label: Flutter Github
3745

3846
- name: Desktop UI
39-
description: Demonstrates desktop features in both Material and FluentUI design systems.
47+
description: >-
48+
Demonstrates desktop features in both Material and FluentUI design systems.
4049
tags:
4150
- material
4251
- macos
@@ -47,7 +56,9 @@
4756
label: Flutter Github
4857

4958
- name: AI generated dynamic theme
50-
description: Demonstrates how to call on-device Flutter APIs based on output from the Gemini API.
59+
description: >-
60+
Demonstrates how to call on-device Flutter APIs based on
61+
output from the Gemini API.
5162
tags:
5263
- AI
5364
- google
@@ -57,7 +68,8 @@
5768
label: Flutter Github
5869

5970
- name: Form app
60-
description: A sample demonstrating different types of forms and best practices.
71+
description: >-
72+
A sample demonstrating different types of forms and best practices.
6173
tags:
6274
- input
6375
- layout
@@ -67,7 +79,9 @@
6779
label: Flutter Github
6880

6981
- name: AI todo list
70-
description: A developer sample written in Flutter demonstrating how to interact with a to-do list in natural language using the Gemini API.
82+
description: >-
83+
A developer sample written in Flutter demonstrating how to
84+
interact with a to-do list in natural language using the Gemini API.
7185
tags:
7286
- AI
7387
- google
@@ -77,7 +91,8 @@
7791
label: Flutter Github
7892

7993
- name: Google Maps plugin
80-
description: Demonstrates the Google Maps for Flutter plugin.
94+
description: >-
95+
Demonstrates the Google Maps for Flutter plugin.
8196
tags:
8297
- google
8398
- maps
@@ -87,7 +102,9 @@
87102
label: Flutter Github
88103

89104
- name: Infinite list
90-
description: A Flutter sample app that shows an implementation of the 'infinite list' UX pattern.
105+
description: >-
106+
A Flutter sample app that shows an implementation of
107+
the 'infinite list' UX pattern.
91108
tags:
92109
- lists
93110
- layout
@@ -98,7 +115,9 @@
98115
label: Flutter Github
99116

100117
- name: Isolates
101-
description: A sample application that demonstrate best practices when using isolates.
118+
description: >-
119+
A sample application that
120+
demonstrate best practices when using isolates.
102121
tags:
103122
- isolates
104123
- perf
@@ -109,7 +128,9 @@
109128
label: Flutter Github
110129

111130
- name: Navigation and routing
112-
description: A sample that shows how to use `go_router` API to handle common navigation scenarios.
131+
description: >-
132+
A sample that shows how to use `go_router` API to
133+
handle common navigation scenarios.
113134
tags:
114135
- navigation
115136
- routing
@@ -119,7 +140,8 @@
119140
label: Flutter Github
120141

121142
- name: Google Maps Flutter plugin
122-
description: A sample place tracking app that uses the google_apps_flutter plugin.
143+
description: >-
144+
A sample place tracking app that uses the google_apps_flutter plugin.
123145
tags:
124146
- maps
125147
- google
@@ -130,7 +152,10 @@
130152
label: Flutter Github
131153

132154
- name: Platform adaptive design
133-
description: This sample project shows a Flutter app that maximizes application code reuse while adhering to different design patterns on Android and iOS.
155+
description: >-
156+
This sample project shows a Flutter app that
157+
maximizes application code reuse while adhering to
158+
different design patterns on Android and iOS.
134159
tags:
135160
- adaptive
136161
- design
@@ -140,7 +165,9 @@
140165
label: Flutter Github
141166

142167
- name: Counter app with Provider
143-
description: The starter Flutter application, but using the Provider package to manage state.
168+
description: >-
169+
The starter Flutter application, but
170+
using the Provider package to manage state.
144171
tags:
145172
- state management
146173
- architecture
@@ -150,7 +177,9 @@
150177
label: Flutter Github
151178

152179
- name: Shopping app with Provider
153-
description: A Flutter sample app that shows a state management approach using the Provider package.
180+
description: >-
181+
A Flutter sample app that shows a
182+
state management approach using the Provider package.
154183
tags:
155184
- state management
156185
- architecture
@@ -160,7 +189,8 @@
160189
label: Flutter Github
161190

162191
- name: Simple shaders
163-
description: A simple Flutter fragment shaders project.
192+
description: >-
193+
A simple Flutter fragment shaders project.
164194
tags:
165195
- shaders
166196
- gpu
@@ -170,7 +200,8 @@
170200
label: Flutter Github
171201

172202
- name: Desktop calculator
173-
description: A calculator sample to demonstrate a simple start for a desktop Flutter app.
203+
description: >-
204+
A calculator sample to demonstrate a simple start for a desktop Flutter app.
174205
tags:
175206
- desktop
176207
type: quickstart
@@ -179,7 +210,8 @@
179210
label: Flutter Github
180211

181212
- name: Testing app
182-
description: A sample app that shows different types of testing in Flutter.
213+
description: >-
214+
A sample app that shows different types of testing in Flutter.
183215
tags:
184216
- testing
185217
type: quickstart
@@ -188,7 +220,10 @@
188220
label: Flutter Github
189221

190222
- name: Web element embedding
191-
description: Modifies the index.html of a flutter app so it is launched in a custom hostElement. This is the most basic embedding example.
223+
description: >-
224+
Modifies the index.html of a flutter app so it
225+
is launched in a custom hostElement.
226+
This is the most basic embedding example.
192227
tags:
193228
- web
194229
type: quickstart
@@ -197,7 +232,9 @@
197232
label: Flutter Github
198233

199234
- name: ng-flutter
200-
description: A simple Angular app (and component) that replicates the above example, but in an Angular style.
235+
description: >-
236+
A simple Angular app (and component) that
237+
replicates the element embedding example, but in an Angular app.
201238
tags:
202239
- web
203240
- google
@@ -207,7 +244,9 @@
207244
label: Flutter Github
208245

209246
- name: Platform channels
210-
description: A sample Flutter app which demonstrates how to use `MethodChannel`, `EventChannel`, `BasicMessageChannel` and `MessageCodec`.
247+
description: >-
248+
A sample Flutter app which demonstrates how to use
249+
`MethodChannel`, `EventChannel`, `BasicMessageChannel` and `MessageCodec`.
211250
tags:
212251
- platforms
213252
- android

0 commit comments

Comments
 (0)