api-documentation icon indicating copy to clipboard operation
api-documentation copied to clipboard

What can I help with ?

Open teolemon opened this issue 2 years ago • 5 comments

Who for

What

Fix bugs

  • [ ] openfoodfacts/api-documentation#4

Simplify, clarify and fix the existing documentation

  • [ ] Fix the image upload explanations

Document new APIs

  • [ ] openfoodfacts/api-documentation#5
  • [ ] openfoodfacts/api-documentation#14
  • [x] openfoodfacts/api-documentation#15
  • [ ] openfoodfacts/openfoodfacts-server#10180
  • [ ] openfoodfacts/api-documentation#17
  • [ ] openfoodfacts/openfoodfacts-server#10183
  • [x] openfoodfacts/api-documentation#19
  • [x] openfoodfacts/api-documentation#9
  • [ ] openfoodfacts/api-documentation#10
  • [ ] openfoodfacts/openfoodfacts-server#10187
  • [ ] openfoodfacts/api-documentation#71
  • [ ] openfoodfacts/api-documentation#70
  • [ ] openfoodfacts/api-documentation#68
  • [ ] openfoodfacts/api-documentation#66
  • [ ] openfoodfacts/api-documentation#62
  • [ ] openfoodfacts/api-documentation#61
  • [ ] openfoodfacts/api-documentation#49
  • [ ] openfoodfacts/api-documentation#37

Create API use cases

  • [x] openfoodfacts/api-documentation#6
  • [ ] openfoodfacts/api-documentation#21

Document and valorize the SDKs within the doc

  • [ ] openfoodfacts/openfoodfacts-server#10179

Disseminate the doc

  • [x] openfoodfacts/api-documentation#8

To be sorted

  • [ ] openfoodfacts/openfoodfacts-server#10184
  • [ ] openfoodfacts/api-documentation#12
  • [ ] openfoodfacts/api-documentation#13
  • [ ] openfoodfacts/api-documentation#20
  • [ ] openfoodfacts/api-documentation#22

Done

  • [ ] openfoodfacts/api-documentation#1
  • [ ] openfoodfacts/api-documentation#2
  • [ ] openfoodfacts/api-documentation#3

Why

  • The better the documentation, the easier it is to use the API, the better Open Food Facts can fulfill its mission

teolemon avatar Aug 26 '21 21:08 teolemon