Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

tracking: complete documentation #3764

Open
3 of 38 tasks
iuioiua opened this issue Nov 2, 2023 · 5 comments
Open
3 of 38 tasks

tracking: complete documentation #3764

iuioiua opened this issue Nov 2, 2023 · 5 comments
Labels
good first issue Good for newcomers

Comments

@iuioiua
Copy link
Collaborator

iuioiua commented Nov 2, 2023 •
edited

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:

  • archive
  • assert
  • async
  • bytes
  • cli
  • collections
  • console
  • crypto
  • csv
  • data_structures
  • datetime
  • dotenv
  • encoding
  • expect
  • fmt
  • front_matter
  • fs
  • html
  • http
  • ini
  • json
  • jsonc
  • log
  • media_types
  • msgpack
  • net
  • path
  • regexp
  • semver
  • streams
  • testing
  • text
  • toml
  • ulid
  • url
  • uuid
  • webgpu
  • yaml
@iuioiua iuioiua added the good first issue Good for newcomers label Nov 2, 2023
@iuioiua iuioiua pinned this issue Nov 8, 2023
This was referenced Nov 15, 2023
Closed
Merged
Closed
@kt3k kt3k mentioned this issue Nov 21, 2023
Merged
@lucacasonato
Copy link
Member

xpost: #3878

This was referenced Nov 29, 2023
Closed
Merged
Merged
@lino-levan
Copy link
Contributor

@iuioiua could you update the list here?

@iuioiua
Copy link
Collaborator Author

iuioiua commented Dec 2, 2023

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

This was referenced Dec 4, 2023
Merged
Merged
Merged
Merged
Merged
This was referenced Dec 11, 2023
Merged
Merged
This was referenced Dec 18, 2023
Merged
Merged
Merged
@babiabeo babiabeo mentioned this issue Dec 30, 2023
Merged
@sylc sylc mentioned this issue Jan 2, 2024
Merged
This was referenced Jan 4, 2024
Merged
Open
Merged
Merged
This was referenced Jan 11, 2024
Merged
Merged
This was referenced Jan 11, 2024
Merged
Merged
Merged
Merged
Merged
@sylc sylc mentioned this issue Jan 19, 2024
Merged
@kt3k
Copy link
Member

kt3k commented Feb 12, 2024

related #4299

@babiabeo babiabeo mentioned this issue Feb 12, 2024
Merged
@iuioiua iuioiua mentioned this issue Mar 11, 2024
Merged
@iuioiua iuioiua mentioned this issue Mar 19, 2024
Merged
@iuioiua iuioiua changed the title tracking: document all public APIs tracking: complete documentation Apr 12, 2024
@iuioiua
Copy link
Collaborator Author

iuioiua commented Apr 12, 2024

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

@iuioiua iuioiua mentioned this issue Apr 12, 2024
Closed
@iuioiua iuioiua changed the title tracking: complete documentation tracking: complete documentation for stabilization Apr 12, 2024
@iuioiua iuioiua changed the title tracking: complete documentation for stabilization tracking: complete documentation Apr 16, 2024
This was referenced Apr 16, 2024
Merged
Open
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@kt3k @lucacasonato @lino-levan @iuioiua