Skip to content
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

📖 Consolidate documentation #135

Open
CasperWA opened this issue Apr 25, 2024 · 0 comments
Open

📖 Consolidate documentation #135

CasperWA opened this issue Apr 25, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@CasperWA
Copy link
Collaborator

There is a lot of documentation currently in the README.
Also, PR #114 will add CLI API documentation.

All of this documentation should be consolidated in a proper browser-able documentation site.

The sections of the README should also be split down to more manageable portions.

@CasperWA CasperWA added the documentation Improvements or additions to documentation label Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant