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

Need better documentation #24

Open
cr0ybot opened this issue Mar 18, 2022 · 0 comments
Open

Need better documentation #24

cr0ybot opened this issue Mar 18, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone
Release 1.0.0

Comments

@cr0ybot
Copy link
Owner

cr0ybot commented Mar 18, 2022

We need a better documentation solution than just dumping everything into the README. I suppose we could use the wiki feature, but I'd prefer a solution that considers the release version.

I like the simplicity of Docsify but it also doesn't handle versions. This article discusses a way that you can have Docsify handle versions, it just requires extra automation.
@cr0ybot cr0ybot added the documentation Improvements or additions to documentation label Mar 18, 2022
@cr0ybot cr0ybot added this to the Release 1.0.0 milestone Mar 18, 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
Release 1.0.0
Development

No branches or pull requests
1 participant
@cr0ybot