Review use of "devtools" in Getting Started #10389
Assignees
Labels
a.get-started
Relates to the Getting Started section of docs.flutter.dev
e2-days
Effort: < 5 days
from.page-issue
Reported in a reader-filed concern
p2-medium
Necessary but not urgent concern. Resolve when possible.
t.dev-tools
Relates to DevTools and CLI
Comments
sfshaza2
added
p1-high
atsansone
added
a.get-started
atsansone
changed the title
sfshaza2
pushed a commit
that referenced
this issue
Apr 10, 2024
Fixes #10389 --------- Co-authored-by: Brett Morgan <brettmorgan@google.com>
|
There's still cases of this on the site. I opened #10402 to address the most apparent cases. |
sfshaza2
pushed a commit
that referenced
this issue
Apr 12, 2024
- "devtools" is a term that generally refers to the Dart/Flutter DevTools app, we shouldn't conflate it with the various apps/software/tools developers using when building for/developing on/debugging against a platform. This PR continues and expand on changes began in 8c0003e to move away from these usages of "devtools". - The [web](https://docs.flutter.dev/platform-integration/web/install-web) and [android](https://docs.flutter.dev/platform-integration/android/install-android) pages had some rendering issues due to whitespace causing rendering differences. This PR addresses those. - This PR also standardize styles and Liquid usage between the equivalent pages for different platforms. Feel free to push any changes you'd like to this branch. I haven't had a chance to understand what content is covered or to put too much thought into the names. I put the page names as "Add X as a target platform ..." for now to be consistent with 8c0003e, but it seems the content might actually be "Set up your development environment for targeting X platform with Flutter"? Closes #10389 @atsansone @sfshaza2 I've having trouble wrapping my head around these pages, or perhaps just their structure. It's also not clear to me what developers who didn't or don't follow the current version of the getting started instructions should do. I think it might be beneficial if us three could chat through this whole flow together. For now though, I kept this individual PR focused on fixing the rendering issues and replacing the "devtools" mentions.
sfshaza2
pushed a commit
that referenced
this issue
Apr 23, 2024
Fixes #10389 --------- Co-authored-by: Brett Morgan <brettmorgan@google.com>
sfshaza2
pushed a commit
that referenced
this issue
Apr 23, 2024
- "devtools" is a term that generally refers to the Dart/Flutter DevTools app, we shouldn't conflate it with the various apps/software/tools developers using when building for/developing on/debugging against a platform. This PR continues and expand on changes began in 8c0003e to move away from these usages of "devtools". - The [web](https://docs.flutter.dev/platform-integration/web/install-web) and [android](https://docs.flutter.dev/platform-integration/android/install-android) pages had some rendering issues due to whitespace causing rendering differences. This PR addresses those. - This PR also standardize styles and Liquid usage between the equivalent pages for different platforms. Feel free to push any changes you'd like to this branch. I haven't had a chance to understand what content is covered or to put too much thought into the names. I put the page names as "Add X as a target platform ..." for now to be consistent with 8c0003e, but it seems the content might actually be "Set up your development environment for targeting X platform with Flutter"? Closes #10389 @atsansone @sfshaza2 I've having trouble wrapping my head around these pages, or perhaps just their structure. It's also not clear to me what developers who didn't or don't follow the current version of the getting started instructions should do. I think it might be beneficial if us three could chat through this whole flow together. For now though, I kept this individual PR focused on fixing the rendering issues and replacing the "devtools" mentions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Page URL
https://docs.flutter.dev/platform-integration/android/install-android/install-android-from-linux?tab=virtual
Page source
/src/content/platform-integration/android/install-android/install-android-from-linux.md
Describe the problem
This issue applies to this page and many other pages. Recently some pages were updated/added that don't use the terms "DevTools" or "web" correctly.
First, it's either Flutter DevTools, Dart DevTools (both refer to the same suite of tools), or Chrome DevTools. So far as I know, none of these DevTools run on any other browsers besides Chrome, so "web DevTools" is incorrect.
Also, check the Google word list. Unless it's the start of a sentence, it's "web", not "Web".
Finally, "devtools" is not a word. We are talking about two specific sets of tooling. We don't want to weaken the meaning of that term by devolving into a generic short word that could apply to any tooling that is developer related.
Also, regarding the pages that are titled as follows: "Add Android devtools for Flutter from Linux start". I don't even know what this title means (nor any of those pages titled similarly). You don't install DevTools, you get it when you download Flutter/Dart. So you launch it or open it. You do install the Flutter/Dart plugins in your IDE, and maybe you meant that but what is "from a Linux start"? (Another experienced Flutter user told me that they don't understand these titles either).
Also, what are "Android devtools"?
cc @kenzieschmoll
Expected fix
No response
Additional context
No response
I would like to fix this problem.
The text was updated successfully, but these errors were encountered: