Skip to content

Library has inadequate documentation in the docs directory #25

Open
@JordanMartinez

Description

@JordanMartinez

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 an up to date changelog or any extra documentation in the docs directory.

Describe the solution you'd like
The changelog needs to be updated for at least the most recent release (we can then start curating it going forward) and 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    type: documentationImprovements or additions to documentation.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions