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

Ready documentation for 1.0.0 #85

Open
kmaasrud opened this issue Apr 11, 2022 · 0 comments
Open

Ready documentation for 1.0.0 #85

kmaasrud opened this issue Apr 11, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone
1.0.0

Comments

@kmaasrud
Copy link
Member

kmaasrud commented Apr 11, 2022 •
edited
Loading

Before publishing 1.0.0, the docs should at least explain the main idea behind mdzk, it's core concepts, the CLI and the JSON representation. The README should also explain mdzk a bit better than it currently does.
@kmaasrud kmaasrud added the documentation Improvements or additions to documentation label Apr 11, 2022
@kmaasrud kmaasrud added this to the 1.0.0 milestone Apr 11, 2022
@kmaasrud kmaasrud pinned this issue Apr 12, 2022
@kmaasrud kmaasrud linked a pull request May 12, 2022 that will close this issue
Documentation #98
Closed
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
1.0.0
Development

Successfully merging a pull request may close this issue.

Documentation mdzk-rs/mdzk
1 participant
@kmaasrud