Skip to content

Commit 4e162bd

Browse files
authored
Add and fix more tooling redirects (#10767)
Contributes to #10363
1 parent 962872d commit 4e162bd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+160
-153
lines changed

firebase.json

+10-2
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,9 @@
158158
{ "source": "/testing/best-practices", "destination": "/perf/best-practices", "type": 301 },
159159
{ "source": "/testing/integration-tests/migration", "destination": "/release/breaking-changes/flutter-driver-migration", "type": 301 },
160160
{ "source": "/testing/ui-performance", "destination": "/perf/ui-performance", "type": 301 },
161-
{ "source": "/tools/devtools", "destination": "/tools/devtools/overview", "type": 301 },
162161
{ "source": "/tools/devtools/code-size", "destination": "/tools/devtools/app-size", "type": 301 },
163162
{ "source": "/tools/devtools/codeSize", "destination": "/tools/devtools/app-size", "type": 301 },
163+
{ "source": "/tools/devtools/overview", "destination": "/tools/devtools", "type": 301 },
164164
{ "source": "/tools/devtools/timeline", "destination": "/tools/devtools/performance", "type": 301 },
165165
{ "source": "/tools/ide", "destination": "/tools/android-studio", "type": 301 },
166166
{ "source": "/tools/ide/android-studio", "destination": "/tools/android-studio", "type": 301 },
@@ -647,16 +647,20 @@
647647
{ "source": "/to/build-modes", "destination": "/testing/build-modes", "type": 301 },
648648
{ "source": "/to/china-setup", "destination": "/community/china", "type": 301 },
649649
{ "source": "/to/crash-reporting", "destination": "/reference/crash-reporting", "type": 301 },
650+
{ "source": "/to/debug-mode", "destination": "/testing/build-modes#debug", "type": 301 },
650651
{ "source": "/to/debug-render-layer", "destination": "/testing/code-debugging#print-the-render-tree", "type": 301 },
652+
{ "source": "/to/deep-link-tool", "destination": "/ui/navigation/deep-linking", "type": 301 },
651653
{ "source": "/to/deep-linking", "destination": "/ui/navigation/deep-linking", "type": 301 },
652654
{ "source": "/to/develop-packages", "destination": "/packages-and-plugins/developing-packages", "type": 301 },
655+
{ "source": "/to/develop-plugins", "destination": "/packages-and-plugins/developing-packages#plugin", "type": 301 },
653656
{ "source": "/to/editor-setup", "destination": "/get-started/editor", "type": 301 },
654657
{ "source": "/to/federated-plugins", "destination": "/packages-and-plugins/developing-packages#federated-plugins", "type": 301 },
655658
{ "source": "/to/flutter-fix", "destination": "/tools/flutter-fix", "type": 301 },
656659
{ "source": "/to/flutter-test-docs", "destination": "https://api.flutter.dev/flutter/flutter_test/flutter_test-library.html", "type": 301 },
657660
{ "source": "/to/font-from-package", "destination": "/cookbook/design/package-fonts#use", "type": 301 },
658661
{ "source": "/to/gesture-disambiguation", "destination": "/ui/interactivity/gestures#gesture-disambiguation", "type": 301 },
659662
{ "source": "/to/gestures", "destination": "/ui/interactivity/gestures", "type": 301 },
663+
{ "source": "/to/handle-errors", "destination": "/testing/errors", "type": 301 },
660664
{ "source": "/to/hot-reload", "destination": "/tools/hot-reload", "type": 301 },
661665
{ "source": "/to/impeller", "destination": "/perf/impeller", "type": 301 },
662666
{ "source": "/to/install", "destination": "/get-started/install", "type": 301 },
@@ -678,18 +682,21 @@
678682
{ "source": "/to/macos-ffi", "destination": "/platform-integration/macos/c-interop", "type": 301 },
679683
{ "source": "/to/macos-ios-setup", "destination": "/get-started/install/macos/mobile-ios", "type": 301 },
680684
{ "source": "/to/macos-minimum-target", "destination": "/deployment/ios#review-xcode-project-settings", "type": 301 },
685+
{ "source": "/to/minimize-layout-passes", "destination": "/perf/best-practices#minimize-layout-passes-caused-by-intrinsic-operations", "type": 301 },
681686
{ "source": "/to/performance-overlay", "destination": "/perf/ui-performance#performance-overlay", "type": 301 },
682687
{ "source": "/to/platform-channels", "destination": "/platform-integration/platform-channels", "type": 301 },
683688
{ "source": "/to/platform-plugins", "destination": "/packages-and-plugins/using-packages", "type": 301 },
684689
{ "source": "/to/previous-releases", "destination": "/release/archive", "type": 301 },
685-
{ "source": "/to/profile-mode", "destination": "/perf/ui-performance#run-in-profile-mode", "type": 301 },
690+
{ "source": "/to/profile-mode", "destination": "/testing/build-modes#profile", "type": 301 },
686691
{ "source": "/to/pub-system-cache", "destination": "https://dart.dev/tools/pub/glossary#system-cache", "type": 301 },
687692
{ "source": "/to/pubspec-plugin-platforms", "destination": "/packages-and-plugins/developing-packages#plugin-platforms", "type": 301 },
688693
{ "source": "/to/recommend-const", "destination": "/perf/best-practices#control-build-cost", "type": 301 },
689694
{ "source": "/to/reference-keystore", "destination": "/deployment/android#reference-the-keystore-from-the-app", "type": 301 },
695+
{ "source": "/to/release-mode", "destination": "/testing/build-modes#release", "type": 301 },
690696
{ "source": "/to/report-bugs", "destination": "/resources/bug-reports", "type": 301 },
691697
{ "source": "/to/resolution-aware-images", "destination": "/ui/assets/assets-and-images#resolution-aware", "type": 301 },
692698
{ "source": "/to/review-gradle-config", "destination": "/deployment/android#review-the-gradle-build-configuration", "type": 301 },
699+
{ "source": "/to/save-layer-perf", "destination": "/perf/best-practices#use-savelayer-thoughtfully", "type": 301 },
693700
{ "source": "/to/state-management-sample", "destination": "/data-and-backend/state-mgmt/simple", "type": 301 },
694701
{ "source": "/to/track-widget-creation", "destination": "/tools/devtools/inspector#track-widget-creation", "type": 301 },
695702
{ "source": "/to/troubleshoot-devices", "destination": "/get-started/install", "type": 301 },
@@ -699,6 +706,7 @@
699706
{ "source": "/to/update-macos-path", "destination": "/get-started/install/macos/mobile-ios?tab=download#add-flutter-to-your-path", "type": 301 },
700707
{ "source": "/to/update-windows-path", "destination": "/get-started/install/windows/mobile?tab=download#update-your-windows-path-variable", "type": 301 },
701708
{ "source": "/to/use-mirror-site", "destination": "/community/china#configure-your-machine-to-use-a-mirror-site", "type": 301 },
709+
{ "source": "/to/use-profile-mode", "destination": "/perf/ui-performance#run-in-profile-mode", "type": 301 },
702710
{ "source": "/to/wasm", "destination": "/platform-integration/web/wasm", "type": 301 },
703711
{ "source": "/to/web-bootstrapping", "destination": "/platform-integration/web/initialization", "type": 301 },
704712
{ "source": "/to/web-images", "destination": "/platform-integration/web/web-images", "type": 301 },

src/_data/sidenav.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -664,7 +664,7 @@
664664
permalink: /tools/devtools
665665
children:
666666
- title: Overview
667-
permalink: /tools/devtools/overview
667+
permalink: /tools/devtools
668668
- title: Run from Android Studio & IntelliJ
669669
permalink: /tools/devtools/android-studio
670670
- title: Run from VS Code

src/_includes/header.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@
104104
<a class="dropdown-item {% if route contains '/get-started/install' %} active{% endif %}"
105105
href="/get-started/install">Install Flutter</a>
106106
<a class="dropdown-item {% if route contains '/tools/devtools' %} active{% endif %}"
107-
href="/tools/devtools/overview">DevTools</a>
107+
href="/tools/devtools">DevTools</a>
108108
<a class="dropdown-item {% if route contains '/cookbook' %} active{% endif %}"
109109
href="/cookbook">Cookbook</a>
110110
<a class="dropdown-item {% if route contains '/codelabs' %} active{% endif %}"

src/content/get-started/codelab-web.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1119,11 +1119,11 @@ Dart DevTools, or Flutter animations, see the following:
11191119
[Building a form with validation]: /cookbook/forms/validation
11201120
[Chrome browser]: https://www.google.com/chrome/?brand=CHBD&gclid=CjwKCAiAws7uBRAkEiwAMlbZjlVMZCxJDGAHjoSpoI_3z_HczSbgbMka5c9Z521R89cDoBM3zAluJRoCdCEQAvD_BwE&gclsrc=aw.ds
11211121
[create a new Flutter project]: /get-started/test-drive
1122-
[Dart DevTools]: /tools/devtools/overview
1122+
[Dart DevTools]: /tools/devtools
11231123
[DartPad]: {{site.dartpad}}
11241124
[DevTools command line]: /tools/devtools/cli
11251125
[DevTools documentation]: /tools/devtools
1126-
[DevTools installed]: /tools/devtools/overview#start
1126+
[DevTools installed]: /tools/devtools#start
11271127
[DartPad troubleshooting page]: {{site.dart-site}}/tools/dartpad/troubleshoot
11281128
[`didUpdateWidget`]: {{site.api}}/flutter/widgets/State/didUpdateWidget.html
11291129
[editor]: /get-started/editor

src/content/get-started/flutter-for/xamarin-forms-devs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2555,7 +2555,7 @@ For more information on using the Firebase Cloud Messaging API, see the
25552555
[Cupertino widgets]: /ui/widgets/cupertino
25562556
[`devicePixelRatio`]: {{site.api}}/flutter/dart-ui/FlutterView/devicePixelRatio.html
25572557
[developing packages and plugins]: /packages-and-plugins/developing-packages
2558-
[DevTools]: /tools/devtools/overview
2558+
[DevTools]: /tools/devtools
25592559
[existing plugin]: {{site.pub}}/flutter
25602560
[`google_mobile_ads`]: {{site.pub}}/packages/google_mobile_ads
25612561
[`firebase_analytics`]: {{site.pub}}/packages/firebase_analytics

src/content/platform-integration/web/faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Not currently.
153153
[Creating responsive apps]: /ui/adaptive-responsive
154154
[Debugging]: /tools/devtools/debugger
155155
[file an issue]: {{site.repo.flutter}}/issues/new?title=[web]:+%3Cdescribe+issue+here%3E&labels=%E2%98%B8+platform-web&body=Describe+your+issue+and+include+the+command+you%27re+running,+flutter_web%20version,+browser+version
156-
[Flutter DevTools]: /tools/devtools/overview
156+
[Flutter DevTools]: /tools/devtools
157157
[Generating event timeline]: {{site.developers}}/web/tools/chrome-devtools/evaluate-performance/performance-reference
158158
[`http`]: {{site.pub}}/packages/http
159159
[`iframe`]: https://html.com/tags/iframe/

src/content/release/archive-whats-new.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ You might also check out [Introducing Dart 3][].
249249
[Material Widget Catalog]: /ui/widgets/material
250250
[canvasKitVariant runtime configuration]: /platform-integration/web/initialization
251251
[Android Java Gradle migration]: /release/breaking-changes/android-java-gradle-migration-guide
252-
[DevTools]: /tools/devtools/overview
252+
[DevTools]: /tools/devtools
253253
[WebAssembly support]: /platform-integration/web/wasm
254254
[adding iOS app extensions]: /platform-integration/ios/app-extensions
255255
[testing Flutter plugins]: /testing/testing-plugins

src/content/resources/faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ called Dart DevTools). For more information, see
219219
[Debugging with Flutter][] and the [Flutter DevTools][] docs.
220220

221221
[Debugging with Flutter]: /testing/debugging
222-
[Flutter DevTools]: /tools/devtools/overview
222+
[Flutter DevTools]: /tools/devtools
223223

224224
### Does Flutter come with a dependency injection framework?
225225

src/content/tools/devtools/app-size.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,6 @@ to reduce an app's size are also discussed.
271271
[Generating size files]: #generating-size-files
272272
[Analysis tab]: #analysis-tab
273273
[Diff tab]: #diff-tab
274-
[launch instructions]: /tools/devtools/overview#install-devtools
274+
[launch instructions]: /tools/devtools#start
275275
[App Size Documentation]: /perf/app-size#breaking-down-the-size
276276
[app-size-tutorial]: {{site.medium}}/@fluttergems/mastering-dart-flutter-devtools-app-size-tool-part-3-of-8-9be6e9ec42a2

src/content/tools/devtools/index.md

+100-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,102 @@
11
---
2-
layout: toc
3-
title: DevTools
4-
description: Content covering the Dart and Flutter DevTools.
2+
title: Flutter and Dart DevTools
3+
description: How to use Flutter DevTools with Flutter.
54
---
5+
6+
## What is DevTools?
7+
8+
DevTools is a suite of performance and debugging tools
9+
for Dart and Flutter.
10+
_Flutter DevTools_ and _Dart DevTools_ refer to the
11+
same set of tools.
12+
13+
![Dart DevTools Screens](/assets/images/docs/tools/devtools/dart-devtools.gif){:width="100%"}
14+
15+
For a video introduction to DevTools, check out
16+
the following deep dive and use-case walkthrough:
17+
18+
<iframe width="560" height="315" src="{{site.yt.embed}}/_EYk-E29edo" title="Dive in to Flutter DevTools" {{site.yt.set}}></iframe>
19+
20+
[Dive in to DevTools]({{site.yt.watch}}?v=_EYk-E29edo)
21+
22+
## What can I do with DevTools?
23+
24+
Here are some of the things you can do with DevTools:
25+
26+
* Inspect the UI layout and state of a Flutter app.
27+
* Diagnose UI jank performance issues in a Flutter app.
28+
* CPU profiling for a Flutter or Dart app.
29+
* Network profiling for a Flutter app.
30+
* Source-level debugging of a Flutter or Dart app.
31+
* Debug memory issues in a Flutter or Dart
32+
command-line app.
33+
* View general log and diagnostics information
34+
about a running Flutter or Dart
35+
command-line app.
36+
* Analyze code and app size.
37+
* Validate deep links in your Android app.
38+
39+
We expect you to use DevTools in conjunction with
40+
your existing IDE or command-line based development workflow.
41+
42+
<a id="how-do-i-install-devtools"></a>
43+
<a id="install-devtools"></a>
44+
45+
## How to launch DevTools {:#start}
46+
47+
See the [VS Code][], [Android Studio/IntelliJ][], or
48+
[command line][] pages for instructions on how to launch DevTools.
49+
50+
## Troubleshooting some standard issues
51+
52+
**Question**: My app looks janky or stutters.
53+
How do I fix it?
54+
55+
**Answer**: Performance issues can cause [UI frames][]
56+
to be janky and/or slow down some operations.
57+
58+
1. To detect which code impacts concrete late frames,
59+
start at [Performance > Timeline][].
60+
2. To learn which code takes the most CPU time in
61+
the background, use the [CPU profiler][].
62+
63+
For more information, check out the
64+
[Performance][] page.
65+
66+
**Question**: I see a lot of garbage collection (GC) events occurring.
67+
Is this a problem?
68+
69+
**Answer**: Frequent GC events might display on
70+
the DevTools > Memory > Memory chart. In most cases,
71+
it's not a problem.
72+
73+
If your app has frequent background activity with some idle time,
74+
Flutter might use that opportunity to collect the created objects
75+
without performance impact.
76+
77+
[CPU profiler]: /tools/devtools/cpu-profiler
78+
[Performance]: /perf
79+
[Performance > Timeline]: /tools/devtools/performance#timeline-events-tab
80+
[UI frames]: /perf/ui-performance
81+
82+
## Providing feedback
83+
84+
Please give DevTools a try, provide feedback, and file issues
85+
in the [DevTools issue tracker][]. Thanks!
86+
87+
## Other resources
88+
89+
For more information on debugging and profiling
90+
Flutter apps, see the [Debugging][] page and,
91+
in particular, its list of [other resources][].
92+
93+
For more information on using DevTools with
94+
Dart command-line apps, see the
95+
[DevTools documentation on dart.dev]({{site.dart-site}}/tools/dart-devtools).
96+
97+
[Android Studio/IntelliJ]: /tools/devtools/android-studio
98+
[VS Code]: /tools/devtools/vscode
99+
[command line]: /tools/devtools/cli
100+
[DevTools issue tracker]: {{site.github}}/flutter/devtools/issues
101+
[Debugging]: /testing/debugging
102+
[Other resources]: /testing/debugging#other-resources

src/content/tools/devtools/memory.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This page is up to date for DevTools 2.23.0.
1212
:::
1313

1414
For information on how to locate DevTools screens in different IDEs,
15-
check out the [DevTools overview](/tools/devtools/overview).
15+
check out the [DevTools overview](/tools/devtools).
1616

1717
To better understand the insights found on this page,
1818
the first section explains how Dart manages memory.
@@ -383,6 +383,8 @@ The quantities plotted on the y-axis are as follows:
383383
[frog]: https://dartfrog.vgv.dev/
384384
[heroku]: {{site.yt.watch}}?v=nkTUMVNelXA
385385

386+
<a id="profile-tab" aria-hidden="true"></a>
387+
386388
### Profile Memory tab
387389

388390
Use the **Profile Memory** tab to see current memory
@@ -410,6 +412,8 @@ to narrow the data:
410412
For a deeper analysis in Google Sheets
411413
or other tools, download the data in CSV format.
412414

415+
<a id="trace-tab" aria-hidden="true"></a>
416+
413417
### Trace Instances tab
414418

415419
Use the **Trace Instances** tab to investigate what methods

src/content/tools/devtools/overview.md

-102
This file was deleted.

src/content/tools/devtools/release-notes/release-notes-2.10.0-src.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The 2.10.0 release of the Dart and Flutter DevTools
44
includes the following changes among other general improvements.
55
To learn more about DevTools, check out the
6-
[DevTools overview](https://docs.flutter.dev/tools/devtools/overview).
6+
[DevTools overview](https://docs.flutter.dev/tools/devtools).
77

88
## Flutter inspector updates
99

src/content/tools/devtools/release-notes/release-notes-2.11.2-src.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The 2.11.2 release of the Dart and Flutter DevTools
44
includes the following changes among other general improvements.
55
To learn more about DevTools, check out the
6-
[DevTools overview](https://docs.flutter.dev/tools/devtools/overview).
6+
[DevTools overview](https://docs.flutter.dev/tools/devtools).
77

88
## General updates
99

0 commit comments

Comments
 (0)