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

Docs need improvements #31

Closed
Tracked by #54
RobDavenport opened this issue Aug 5, 2022 · 0 comments
Closed
Tracked by #54

Docs need improvements #31

RobDavenport opened this issue Aug 5, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers RS Related to the gamercade_rs crate

Comments

@RobDavenport
Copy link
Member

The bare minimum documentation has been written, but the format is far from idea.

It should be improved to allow users to much more clearly understand the Api. Things like line breaks, inner links, etc.

@RobDavenport RobDavenport added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 5, 2022
@RobDavenport RobDavenport transferred this issue from gamercade-io/gamercade_rs Aug 22, 2022
@RobDavenport RobDavenport added the RS Related to the gamercade_rs crate label Aug 22, 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 good first issue Good for newcomers RS Related to the gamercade_rs crate
Projects
None yet
Development

No branches or pull requests

1 participant