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

Add extensive documentation #96

Open
3 tasks
Saethox opened this issue Jun 23, 2022 · 0 comments
Open
3 tasks

Add extensive documentation #96

Saethox opened this issue Jun 23, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Saethox
Copy link
Collaborator

Saethox commented Jun 23, 2022

Before going public (or even sooner, if possible), we should review all of our documentation, as large parts still lack it.

  • Fix broken links and images.
  • Add documentation to all public structs and methods.
  • Add examples and guides for best practices to all relevant structs and methods.
@Saethox Saethox added the documentation Improvements or additions to documentation label Jun 23, 2022
@Saethox Saethox added this to the Basic Framework milestone Jun 23, 2022
@luleyleo luleyleo self-assigned this Jul 22, 2022
@HeleNoir HeleNoir mentioned this issue Aug 29, 2022
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

2 participants