-
Notifications
You must be signed in to change notification settings - Fork 3.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update performance profiling docs. #11688
Conversation
Visit the preview URL for this PR (updated for commit 82a0523): https://flutter-docs-prod--pr11688-ios-code-formatting-keu2vqmi.web.app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OMG, looks so good! I have a couple little grammatical nits but otherwise LGTM
how do you fix it? Where do you begin? | ||
This guide shows you where to start, | ||
steps to take, and tools that can help. | ||
App performance encompasses various aspects, from raw speed and I/O throughput |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oooh, I like this. I wrote that OG paragraph years ago and when I re-reviewed it yesterday, I cringed. :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sfshaza2, I actually loved how this read! There were many additions to this guide with different voices over the years. I ended up going with a more generic writing style to try and meet in the middle with them. But honestly, this writing style of yours is more approachable, imo.
src/content/perf/ui-performance.md
Outdated
## Diagnosing performance problems | ||
* **The Performance View**: A web-based interface that connects to your app and | ||
displays detailed performance metrics. Part of the DevTools utility. To learn | ||
more, see the [Use the Performance View][]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
more, see the [Use the Performance View][]. | |
more, see [Use the Performance View][]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed!
src/content/perf/ui-performance.md
Outdated
|
||
You can toggle display of the performance overlay as follows: | ||
|
||
* **Flutter inspector**: The easiest way to enable the PerformanceOverlay widget |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just checking. Is this the new inspector or the old one? Maybe it makes no difference.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure. I think this might be the old one. I'll look into it right now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@elliette can you take a look at this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi! This has actually been moved in both the new and old inspector. The Performance Overlay button is in the Performance panel of DevTools, not the Inspector.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated!
Description of what this PR is changing or adding, and why:
This is part of one of our goals to make it easier for iOS developers to work with our docs. iOS devs are having a particularly difficult time with debugging and performance. This guide is full of great information, but it's been added to over the years by many contributors and looks like it has started to lose its original form.
I've taken a shot at condensing all of the materials that have been added over the years and making this doc easier to parse in a linear fashion. I worked on it a bit more than intended, so if the changes are too much in one PR, no worries at all. I can always split this up.
Changes:
Issues fixed by this PR (if any):
PRs or commits this PR depends on (if any):
Presubmit checklist