deno_std icon indicating copy to clipboard operation
deno_std copied to clipboard

tracking: complete documentation

Open iuioiua opened this issue 1 year ago • 7 comments

Documentation is essential for obvious reasons and key for the stabilization of packages. Requirements for each package:

  1. Pass without error for public entrypoints using deno doc --lint <file>
  2. Adhere to the documentation guidelines.

All packages need to have their documentation complete and validated:

  • [x] archive #5636
  • [x] assert #4876
  • [x] async
  • [x] bytes
  • [x] cli #4815
  • [x] collections
  • [x] crypto #4884
  • [x] csv #4920
  • [x] data-structures #4847
  • [x] datetime
  • [x] dotenv #5095
  • [x] encoding #4838
  • [x] expect #4836
  • [x] fmt #4829
  • [x] front-matter #4789
  • [x] fs #4788
  • [x] html #4878
  • [x] http
  • [x] ini #5020
  • [x] io #5656
  • [x] json #4798
  • [x] jsonc #4814
  • [ ] log
  • [x] media-types
  • [x] msgpack #4832
  • [x] net #4982
  • [x] path #4900
  • [x] regexp
  • [x] semver #4846
  • [x] streams #4852
  • [x] testing #5033
  • [x] text #4837
  • [x] toml #4799
  • [x] ulid #4825
  • [x] url
  • [x] uuid #4790
  • [x] webgpu
  • [x] yaml

iuioiua avatar Nov 02 '23 04:11 iuioiua

xpost: #3878

lucacasonato avatar Nov 29 '23 18:11 lucacasonato

@iuioiua could you update the list here?

lino-levan avatar Dec 01 '23 22:12 lino-levan

It should be up-to-date as of now.

iuioiua avatar Dec 02 '23 00:12 iuioiua

related #4299

kt3k avatar Feb 12 '24 09:02 kt3k

Update: I've reset the checklist. The remaining packages should be validated to meet the updated documentation requirements.

iuioiua avatar Apr 12 '24 06:04 iuioiua

Can we close this now?

kt3k avatar Jul 26 '24 03:07 kt3k

Not yet. The remaining packages should be documented, even if they're not getting stabilized. Even if they end up getting removed, documenting them will give us a better understanding of them too.

iuioiua avatar Jul 26 '24 03:07 iuioiua