Skip to content

[DOC] Create Initial Documentation #23

@RNKuhns

Description

@RNKuhns

Describe the documentation issue

Create an initial documentation for the package.

Suggest a concrete fix/improvement

There is currently no documentation. We should create basic documentation ahead of the first release. The docs can be improved in the subsequent releases.

There should be a landing (index) page, a get started page, API Reference, basic developer documentation, and a changelog. Additional user documentation can be added later, along with full developer documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions