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 Documentation #3

Open

caioluis opened this issue Dec 27, 2023 · 0 comments

Labels

Milestone

First production ...

Owner

caioluis commented Dec 27, 2023

The code is completely undocumented, and this feels horrible

Document every function so it can be easily understood when using the crate.
It could also be nice to meta-document things, so I can share with the Discord community.
Link the tests to the documentation, so that it doesn't become obsolete when the code changes.

caioluis added the documentation label

caioluis modified the milestones: Platform SDK, First production release

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment