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

Write a dedicated documentation page (DOCUMENTATION.md) #35

Open
mufeedvh opened this issue Jul 2, 2022 · 0 comments
Open

Write a dedicated documentation page (DOCUMENTATION.md) #35

mufeedvh opened this issue Jul 2, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone
v0.2.1

Comments

@mufeedvh
Copy link
Owner

mufeedvh commented Jul 2, 2022

Every function in the configuration file should be documented in detail as to what it does and how it works, currently it's just a dump of the JSON file and doesn't go into detail on any of the options.

A file called DOCUMENTATION.md should be created for this outside of the README.
@mufeedvh mufeedvh added the documentation Improvements or additions to documentation label Jul 2, 2022
@mufeedvh mufeedvh added this to the v0.2.1 milestone Jul 2, 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
v0.2.1
Development

No branches or pull requests
1 participant
@mufeedvh