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.

Sign up for GitHub

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

Jump to bottom

Improve Documentation #26

Open
dbrody opened this issue Nov 30, 2021 · 1 comment
Open

Improve Documentation #26

dbrody opened this issue Nov 30, 2021 · 1 comment

Comments

@dbrody
Copy link
Contributor

dbrody commented Nov 30, 2021

Currently the getting started page is blank and the examples are all in test cases. I think improving the documentation could help adoption and use of the package.
@coreyti
Copy link
Member

coreyti commented Dec 1, 2021

100%

As we drive toward prepping a release candidate, we're putting more effort and intention into adding (module) docs. Intending to bring in the "guidelines" soon.

I'd like to leave this issue open for now as a good place to track progress and feedback on the effort.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@coreyti @dbrody