Changes

Jump to navigation Jump to search
998 bytes added ,  17:44, 11 September 2021
no edit summary
Line 1: Line 1:  +
=== 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"
 +
|+ Documentation of OFF codebases and APIs
 +
|-
 +
! Product !! Doc !! Comment
 +
|-
 +
| Server code || [https://openfoodfacts.github.io/openfoodfacts-server/ Code doc] || Example
 +
|-
 +
| API || [https://github.com/openfoodfacts/api-documentation API doc] || Example
 +
|-
 +
| Android || [https://openfoodfacts.github.io/openfoodfacts-androidapp/ Code doc] || Example
 +
|-
 +
| Flutter || [https://openfoodfacts.github.io/smooth-app// Code doc] || Example
 +
|-
 +
| Dart package || [https://openfoodfacts.github.io/openfoodfacts-dart/ Code Doc] || Example
 +
|-
 +
| iPhone || [https://github.com/openfoodfacts/openfoodfacts-ios/wiki/ Code Doc] || Example
 +
|}
    
=== 2021 Documentation roadmap ===
 
=== 2021 Documentation roadmap ===
Line 6: Line 26:  
[https://github.com/openfoodfacts/api-documentation/projects Project tracking on GitHub]
 
[https://github.com/openfoodfacts/api-documentation/projects Project tracking on GitHub]
 
* Set up a bi-monthly call for documentation
 
* 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
 
* Publish the new documentation to our new servers
 
* Automate the publication of the documentation
 
* Automate the publication of the documentation
* Document assumptions and things we (d/w)on't do
+
* Deprecate the old wiki doc
 +
 
 +
==== Set up a process to keep documentation fresh ====
 
* Keep the documentation on par with the API
 
* 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
 
* 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
 +
[[Category:API]]
 +
[[Category:Roadmap]]

Navigation menu