Skip to content

Add documentation site #27

Description

@mwaddell

Create a documentation site (Docusaurus?) and publish it to GitHub Pages through CI/CD

  • Include a "Quickstart" guide, troubleshooting, etc.
    • Test the quickstart guide on a fresh clone of the project (follow the instructions verbatim)
  • Include pdoc output for API documentation
  • Include a CHANGELOG.md (see https://keepachangelog.com/) in the documentation
    • Update CI to update it through a release pipeline?
  • Manually test all documented functionality and run all examples.
    • Run through every permutation of the supported arguments and test with known good/bad addresses to confirm everything works as documented.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

ci/cdTasks related to the build pipelinesdocumentationImprovements or additions to documentation

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions