Add documentation for DevTools extensions #10061
Conversation
kenzieschmoll
requested review from
sfshaza2,
atsansone,
parlough,
domesticmouse and
MaryaBelanger
as code owners
|
Visit the preview URL for this PR (updated for commit 3505713): |
src/tools/devtools/extensions.md
Outdated
|
|
||
|  | ||
|
|
||
| ### devtools_options.yaml |
There was a problem hiding this comment.
| ### devtools_options.yaml | |
| ## Configure extensions file |
There was a problem hiding this comment.
What about "Extension enablement states"? This may not always be an extensions only file and the user shouldn't need to manually configure this. This doc is supposed to be an explanation of why a devtools_options.yaml file is showing up in the user's project and what they should do with it.
There was a problem hiding this comment.
Is "Configure extension enablement states" ok? I'm trying to keep the headers parallel, in the sense that we try to start each header with a (non-gerund) verb. But if it's really not working for you, I can be flexible.
There was a problem hiding this comment.
I used "Configure extension enablement states" and moved the screenshot and explanation of how to enable the extension from devtools to this section. I think this makes it more clear that you should be enabling and disabling extensions from DevTools, and that the file is just to persist this data.
Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>
Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>
Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>
Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>
parlough
added
review.await-update
There was a problem hiding this comment.
Thanks @kenzieschmoll! Let's ship it so you can land your DevTools PR. I imagine we can expand this further in the future (including incorporating the relevant content from the blog post), as we better understand how users are using and building extensions.
These docs will be linked to from the `devtools_options.yaml` file that DevTools creates for storing extension enablement states: flutter/devtools#7052 --------- Co-authored-by: Brett Morgan <[email protected]> Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>
These docs will be linked to from the `devtools_options.yaml` file that DevTools creates for storing extension enablement states: flutter/devtools#7052 --------- Co-authored-by: Brett Morgan <[email protected]> Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>
These docs will be linked to from the
devtools_options.yamlfile that DevTools creates for storing extension enablement states: flutter/devtools#7052