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

📗 Help improve the docs! #201

Open
JWCook opened this issue Jul 5, 2021 · 0 comments
Open

📗 Help improve the docs! #201

JWCook opened this issue Jul 5, 2021 · 0 comments
Labels
docs Documentation-related issues good first issue Good for newcomers

Comments

@JWCook
Copy link
Member

JWCook commented Jul 5, 2021

Since pyinaturalist aims to make iNaturalist data access simpler and more accessible, documentation is an important part of this project. If you are looking for ways to help out, there is always room for more improvement in the docs. You can help by making changes yourself and submitting a PR, or you can just add comments to this issue describing changes you'd like to see.

Links

Types of documentation

  • User guide: The User Guide is intended to be beginner-friendly. If any parts are confusing or could use more detail, please help improve it!
  • Response attribute descriptions: There are hundreds of different attributes on API responses, and pyinaturalist models document most of them. There are still more to document, though, and some of the descriptions could use more detail.
  • Request parameter descriptions: Similarly, the API request functions document their request parameters, and some of them could use more detail.
  • Data visualizations: See Add data visualization examples #62 for more details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation-related issues good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant