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

Implement documentation #3

Open
dalonsoa opened this issue Oct 17, 2022 · 0 comments
Open

Implement documentation #3

dalonsoa opened this issue Oct 17, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation Hacktoberfest

Comments

@dalonsoa
Copy link
Contributor

dalonsoa commented Oct 17, 2022 •
edited
Loading

Problem

At the moment, there is no documentation whatsoever, for neither users and contributors.

Proposed solution

Implement a documentation system, ideally using MKDocs, with one part tutorial like explaining how to use the tool in different scenarios, and another side more technical describing the API - taken from the docstrings... when there are docstrings.
@dalonsoa dalonsoa added documentation Improvements or additions to documentation Hacktoberfest labels Oct 17, 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 Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dalonsoa