Improve existing introduction for novice users

openfoodfacts / api-documentation

Version 2 of the documentation of the V1 API. The code behind the API is at https://github.com/openfoodfacts/openfoodfacts-server. An effort is made there to create a V3 of the documentation based on OpenAPI

18 stars 7 forks source link

Improve existing introduction for novice users #75

Open alexgarel opened 2 years ago

alexgarel commented 2 years ago

As someone who is not an experimented developers (innovator, scientists, junior programmer) I come to the API documentation

I want to :

have an introduction that explain me what is an API
links me to useful definitions and tutorials (eg: https://developer.mozilla.org/en-US/docs/Glossary/API)
eventually add a use case to explain why I would use it

pratik2315 commented 2 years ago

Hey! I saw that this issue is open. Im new here and this seems like a perfect issue to start with! Can I work on this if its okay with everyone?

alexgarel commented 2 years ago

@pratik2315 yes, go :-)