search

dart-lang / pub-dev

The pub.dev website
https://pub.dev
BSD 3-Clause "New" or "Revised" License
789 stars 146 forks source link

Offer help/steps for all Suggestions in scoring #1354

Closed mit-mit closed 5 years ago

mit-mit commented 6 years ago

Some of the suggestions listed on the score page are not easy for a developer to reproduce. As an example, consider this one:

Running dartdoc failed.

How does a Flutter developer actually do that? They have no Dart SDK in path.

We should create a page with documentation for all possible failures with steps listed for how to do them.

mit-mit commented 6 years ago

cc @isoos WDYT?

isoos commented 6 years ago

Yeah, agreed. I'd add a helpCode to the suggestion, and the pub site could decide how to link to the more detailed help page.

isoos commented 6 years ago

We have ~25 different kind of suggestions in pana, and I think we'll need to provide help articles to less than 10 of them.

mit-mit commented 6 years ago

Cool. If you go ahead with the helpCode part I an help with documentation!

isoos commented 6 years ago

Another angle: Is there a Flutter-specific command that generates the docs for the app? I can't find one, but if there is, we can also output the Flutter-specific command within the suggestion's text (similarly what we do for dartfmt and dartanalyzer if the package uses Flutter).

mit-mit commented 6 years ago

Remaining work: Write up documentation for each of the possible error codes.

isoos commented 5 years ago

Suggestions with updated wording had been updated in both pana and pub site, will be part of the next prod release.