website icon indicating copy to clipboard operation
website copied to clipboard

☂️ Scrutinize (and update) cookbook entries to verify up to standards

Open parlough opened this issue 2 years ago • 5 comments
trafficstars

The cookbook entries are extremely valuable as short and sweet task-bask documentation. However, they have been written over many years by multiple authors, and aren't of a consistent writing style or quality. We should go through each one and verify that they:

  • Is still valuable in its current form
  • Follow the Google developer documentation style guide
  • Follow our own preferred styles and requirements
  • Are up to date in their statements and endorsements
  • The code still works as expected
  • All code uses the latest packages
  • Have a runnable DartPad sample that follows the previous steps if it's possible

parlough avatar Jul 11 '23 19:07 parlough

@parlough : Consider this the framing issue for this project.

atsansone avatar Jul 11 '23 20:07 atsansone

TODO: Someone add sorted by ranking list of cookbook recipes to this list. \cc @stef-luo

parlough avatar Jul 12 '23 18:07 parlough

@parlough I'm sharing a Google Sheet with you!

stef-luo avatar Jul 17 '23 18:07 stef-luo

Wow, @parlough, some of the recipes get so few views that maybe we should retire them!

sfshaza2 avatar Jul 17 '23 18:07 sfshaza2

@parlough I'm sharing a Google Sheet with you!

Thank you @stef-luo!!

Wow, @parlough, some of the recipes get so few views that maybe we should retire them!

I'll do a quick dive into some of the ones with lower views. I have a feeling some should be retired but I want to make sure it's not because of poor search discoverability.

parlough avatar Jul 17 '23 19:07 parlough