Repository navigation
tracking: complete documentation #3764
Description
Documentation is essential for obvious reasons and key for the stabilization of packages. Requirements for each package:
- Pass without error for public entrypoints using
deno doc --lint <file> - Adhere to the documentation guidelines.
All packages need to have their documentation complete and validated:
- archive docs(archive): complete documentation #5636
- assert docs(assert): improve docs #4876
- async
- bytes
- cli docs(cli): make check_docs pass #4815
- collections
- crypto docs(crypto): improve docs #4884
- csv docs(csv): improve API docs #4920
- data-structures docs(data-structures): enables doc lint of data-structures #4847
- datetime
- dotenv docs(dotenv): improve
dotenvdocs #5095 - encoding docs(encoding): Cleanup and fix doc lints #4838
- expect docs(expect): document methods and add examples #4836
- fmt docs(fmt): improve API docs #4829
- front-matter docs(front-matter): improve docs for stabilization #4789
- fs docs(fs): improve documentation #4788
- html docs(html): improve API docs #4878
- http
- ini docs(ini): improve ini docs #5020
- io docs(io): document
std/io#5656 - json docs(json): lint
@std/jsondocs #4798 - jsonc fix: complete docs for std/jsonc #4814
- log
- media-types
- msgpack docs(msgpack): complete documentation of the package #4832
- net docs(net): complete documentation #4982
- path docs(path): improve API docs #4900
- regexp
- semver docs(semver): improve docs #4846
- streams docs(streams): improve docs for stabilization #4852
- testing docs(testing): improve the docs of
@std/testing#5033 - text docs(text): pass docs check #4837
- toml docs(toml): lint
@std/tomldocs #4799 - ulid docs(ulid): finish documentation #4825
- url
- uuid docs(uuid): update module docs #4790
- webgpu
- yaml
Activity
lucacasonato commentedon Nov 29, 2023
xpost: #3878
lino-levan commentedon Dec 1, 2023
@iuioiua could you update the list here?
iuioiua commentedon Dec 2, 2023
It should be up-to-date as of now.
kt3k commentedon Feb 12, 2024
related #4299
[-]tracking: document all public APIs[/-][+]tracking: complete documentation[/+]iuioiua commentedon Apr 12, 2024
Update: I've reset the checklist. The remaining packages should be validated to meet the updated documentation requirements.
[-]tracking: complete documentation[/-][+]tracking: complete documentation for stabilization[/+][-]tracking: complete documentation for stabilization[/-][+]tracking: complete documentation[/+]docs(front-matter): improve docs for stabilization (#4789)
docs(streams): improve docs for stabilization (#4852)
kt3k commentedon Jul 26, 2024
Can we close this now?
iuioiua commentedon Jul 26, 2024
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 commentedon Sep 16, 2025
@std/logis no longer around. Closing :)