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.

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

Documentation #1

Open
1 of 5 tasks
MrPezser opened this issue Nov 19, 2024 · 0 comments
Open
1 of 5 tasks

Documentation #1

MrPezser opened this issue Nov 19, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@MrPezser
Copy link
Contributor

MrPezser commented Nov 19, 2024

Documentation needs

  • Code needs to be adequately commented
  • Some type of structure diagram showing module interactions and typical logic flow
  • Roadmap to list out development priorities
  • Write out next steps from roadmap as their issues
  • Document describing the mathematics / theory behind the code
@MrPezser MrPezser self-assigned this Nov 22, 2024
@MrPezser MrPezser added the documentation Improvements or additions to documentation label Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant