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

Add DocC documentation & host it #41

Open
Jeehut opened this issue Jul 2, 2021 · 0 comments
Open

Add DocC documentation & host it #41

Jeehut opened this issue Jul 2, 2021 · 0 comments
Labels
enhancement New feature or request
Milestone
1.0.0

Comments

@Jeehut
Copy link
Member

Jeehut commented Jul 2, 2021

Problem Statement

The documentation is all in the README and lacks structure for different use cases.

Suggested Solution

DocC provides a good "GettingStarted.md" file and the option to provide multiple tutorials for different use cases. It should be used, hosted and linked to in the README.
@Jeehut Jeehut added the enhancement New feature or request label Jul 2, 2021
@Jeehut Jeehut added this to the 1.0.0 milestone Jul 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
1.0.0
Development

No branches or pull requests
1 participant
@Jeehut