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.

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

Library has inadequate documentation in the docs directory #61

Open
thomashoneyman opened this issue Oct 6, 2020 · 0 comments
Open
Labels
good first issue First-time contributors who are looking to help should work on these issues. type: documentation Improvements or additions to documentation.

Comments

@thomashoneyman
Copy link
Contributor

Is your change request related to a problem? Please describe.
As described in the documentation section of the Library Guidelines, Contributors libraries are expected to have some documentation in the docs directory -- specifically, a changelog and at least a short tutorial that expands on the quick start in the README.

This library currently doesn't have any extra documentation in the docs directory.

Describe the solution you'd like
The argonaut-codecs docs directory has a good example of expanded documentation for a Contributor library. But it would even be useful to add something considerably smaller and shorter to this library.

We could add an expanded version of the quick start -- breaking down the most important types and functions in the library and then explaining how to create and use common formatters for things like numbers, dates, RFC3339 strings, and so on.

Additional context
See the Governance repository for more information about requirements in the Contributors organization.

@thomashoneyman thomashoneyman added help wanted good first issue First-time contributors who are looking to help should work on these issues. type: documentation Improvements or additions to documentation. labels Oct 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue First-time contributors who are looking to help should work on these issues. type: documentation Improvements or additions to documentation.
Development

No branches or pull requests

2 participants