Documentation: Difference between revisions
No edit summary |
|||
| Line 1: | Line 1: | ||
=== Documentation === | === Documentation === | ||
* [[Product_Opener_documentation|Product Opener documentation (web)]] | * [[Product_Opener_documentation|Product Opener documentation (web)]] | ||
* [[API|Old API documentation]] | * [[API|Old API documentation (deprecated)]] | ||
* | * [https://openfoodfacts.github.io/api-documentation Latest version of the documentation] | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
Revision as of 17:44, 11 September 2021
Documentation
- Product Opener documentation (web)
- Old API documentation (deprecated)
- Latest version of the documentation
| Product | Doc | Comment |
|---|---|---|
| Server code | Code doc | Example |
| API | API doc | Example |
| Android | Code doc | Example |
| Flutter | Code doc | Example |
| Dart package | Code Doc | Example |
| iPhone | Code Doc | Example |
2021 Documentation roadmap
- Set up a bi-monthly call for documentation
Set up a process to make publication a breeze
- Publish the new documentation to our new servers
- Automate the publication of the documentation
- Deprecate the old wiki doc
Set up a process to keep documentation fresh
- Keep the documentation on par with the API
- Generate new separate, fast-moving documentation from the questions in #api or #general, and consider integrating some of it in the main documentation
Improve the documentation
- Document assumptions and things we (d/w)on't do