Skip to content

Library needs more in-depth documentation in the docs directory #154

Open
@thomashoneyman

Description

@thomashoneyman

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.

The axios library for JavaScript has, in its README, a nice breakdown of how to perform several common requests using the library.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueFirst-time contributors who are looking to help should work on these issues.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