Skip to content
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

Merged
merged 2 commits into from
Feb 10, 2025
Merged

Conversation

antfitch
Copy link
Contributor

@antfitch antfitch commented Feb 6, 2025

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:

  • Created an overview and moved the various notes and conceptual details into this overview.
  • The overview now has a list of performance analysis tools that the developer can browse with links to the documentation elsewhere.
  • Tried to make it more clear that this page is specifically about the Performance Overlay tool, but more might be needed.
  • A few sections in the doc weren't about the Performance Overlay tool, so I moved them into the bulleted list in the overview with links to their documentation (the sections were very small, so this was pretty easy).
  • Changed some headings, and moved some sections around.
  • Moved all of the links to the bottom of the topic and alphabetically sorted them (to match the pattern i've seen elsewhere the most often.)

Issues fixed by this PR (if any):

PRs or commits this PR depends on (if any):

Presubmit checklist

  • This PR is marked as draft with an explanation if not meant to land until a future stable release.
  • This PR doesn’t contain automatically generated corrections (Grammarly or similar).
  • This PR follows the Google Developer Documentation Style Guidelines — for example, it doesn’t use i.e. or e.g., and it avoids I and we (first person).
  • This PR uses semantic line breaks of 80 characters or fewer.

@antfitch antfitch requested review from sfshaza2, parlough and a team as code owners February 6, 2025 21:32
@flutter-website-bot
Copy link
Collaborator

flutter-website-bot commented Feb 6, 2025

Visit the preview URL for this PR (updated for commit 82a0523):

https://flutter-docs-prod--pr11688-ios-code-formatting-keu2vqmi.web.app

Copy link
Contributor

@sfshaza2 sfshaza2 left a 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
Copy link
Contributor

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. :)

Copy link
Contributor Author

@antfitch antfitch Feb 6, 2025

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.

## 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][].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
more, see the [Use the Performance View][].
more, see [Use the Performance View][].

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed!


You can toggle display of the performance overlay as follows:

* **Flutter inspector**: The easiest way to enable the PerformanceOverlay widget
Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Contributor Author

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?

Copy link
Member

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated!

@antfitch antfitch requested a review from elliette February 6, 2025 22:30
@antfitch antfitch self-assigned this Feb 6, 2025
@sfshaza2 sfshaza2 merged commit 4f089c1 into flutter:main Feb 10, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants