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

Document project #53

Open
lunakv opened this issue Jun 15, 2023 · 0 comments
Open

Document project #53

lunakv opened this issue Jun 15, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed high priority Must be done as soon as humanly possible

Comments

@lunakv
Copy link
Owner

lunakv commented Jun 15, 2023

The extent of the current documentation is limited to the API docs, an outdated(?) README and some docstrings in code. This is very insufficient for anyone trying to come in and understand the project.

We must focus on creating a proper comprehensive developer documentation for the project, either here in a GitHub wiki or using something like ReadTheDocs.
@lunakv lunakv added documentation Improvements or additions to documentation help wanted Extra attention is needed high priority Must be done as soon as humanly possible labels Jun 15, 2023
@lunakv lunakv added this to the v0.5 milestone Jun 15, 2023
@lunakv lunakv removed this from the v0.5 milestone Jun 8, 2024
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 help wanted Extra attention is needed high priority Must be done as soon as humanly possible
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lunakv