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

Documentation site #24

Open
tonyketcham opened this issue Jul 6, 2022 · 0 comments
Open

Documentation site #24

tonyketcham opened this issue Jul 6, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone
v1.0 🌿

Comments

@tonyketcham
Copy link
Collaborator

As a user of the tool, I would like to have a well-structured documentation site to reference with visuals and code examples.

Having all the documentation included in the README causes cognitive overload as there's no tight scoping around different concepts - it can appear as a wall of text that causes the reader to glaze over.
@tonyketcham tonyketcham added the documentation Improvements or additions to documentation label Jul 6, 2022
@tonyketcham tonyketcham added this to the Beta Release 🍾 milestone Jul 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v1.0 🌿
Development

No branches or pull requests
1 participant
@tonyketcham