Skip to content

Library has inadequate documentation in the docs directory #124

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

Open
maxdeviant opened this issue Oct 8, 2020 · 1 comment
Open

Library has inadequate documentation in the docs directory #124

maxdeviant opened this issue Oct 8, 2020 · 1 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.

Comments

@maxdeviant
Copy link
Member

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, at least a short tutorial that expands on the quick start in the README.

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

Describe the solution you'd like
At least a short tutorial needs to be added to the docs directory, or other documentation as described in this Divio article.

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.

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

@thomashoneyman thomashoneyman added type: documentation Improvements or additions to documentation. good first issue First-time contributors who are looking to help should work on these issues. help wanted labels Oct 8, 2020
@wclr
Copy link

wclr commented Dec 22, 2020

The link to https://documentation.divio.com looks like a little bit of trolling. )

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

4 participants