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 #18

Open
byteface opened this issue Aug 14, 2021 · 2 comments
Open

docs #18

byteface opened this issue Aug 14, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed up-for-grabs https://up-for-grabs.net/#/

Comments

@byteface
Copy link
Owner

js docs are particularly weak. only really auto docs with no examples.

best examples would be the use of Casting to get the method you need.

@byteface
Copy link
Owner Author

flagging this as help wanted . as docs are getting more hits than the repo. about twice as many. probably due to google. so really beefing these up would be great. a copy pastable example for pretty much every function is useful for noobs. i know as im a perpetual noob.

@byteface byteface added the help wanted Extra attention is needed label Aug 21, 2021
@byteface
Copy link
Owner Author

another note. just ignore 'warnings' when doing make html as long as it compiles is fine. Although if anyone can clear up the warnings then that's also useful.

@byteface byteface added documentation Improvements or additions to documentation up-for-grabs https://up-for-grabs.net/#/ good first issue Good for newcomers labels Nov 16, 2021
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 help wanted Extra attention is needed up-for-grabs https://up-for-grabs.net/#/
Projects
None yet
Development

No branches or pull requests

1 participant