search

dart-lang / site-www

The source for the Dart website.
https://dart.dev
Other
970 stars 702 forks source link

Document DevTools functionality and usage #4352

Open parlough opened 2 years ago

parlough commented 2 years ago

What information is missing?

We currently document what DevTools is and how to start using it, but don't document how to use it to debug, profile, or analyze code. The Flutter docs have documentation on using many of its views but that's a different site and also contains a lot of Flutter specific mentions.

How would you like us to fix this problem?

We should have more extensive documentation on the various DevTools views that is applicable to all types of Dart applications.

johnpryan commented 2 years ago

We might want to make sure we don't duplicate docs between dart.dev and flutter.dev cc: @kenzieschmoll

kenzieschmoll commented 2 years ago

There are some DevTools tools that apply to both standalone dart apps and to flutter apps, though a lot of the content on flutter.dev assumes a flutter app is connected. On many pages (like the performance page for example) there will be a smaller subset of features that are enabled for Dart CLI apps, so it may be worth documenting those workflows on dart.dev. Can we share code between the two websites? for the pages that are the same for standalone Dart and Flutter, it could be useful to share the code and display the page on both sites.

johnpryan commented 2 years ago

I don't think we have a way to share docs between the two sites. We might be able to use site-shared, but this isn't something we are doing right now as far as I know.

atsansone commented 1 year ago

@johnpryan : That's exactly what we could use site-shared for. I'd need to take a look at the structure to better understand any issues with doing so.