Documentation: Difference between revisions
No edit summary |
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]] | ||
* | |||
* | |||
{| class="wikitable sortable" | |||
|+ Documentation of OFF codebases and APIs | |||
|- | |||
! Product !! Doc !! Doc | |||
|- | |||
| Server code || Example || Example | |||
|- | |||
| API || Example || [https://github.com/openfoodfacts/api-documentation Doc repo] | |||
|- | |||
| Android || [https://openfoodfacts.github.io/openfoodfacts-androidapp/ Code doc] || Example | |||
|- | |||
| iPhone || Example || Example | |||
|- | |||
| Flutter || Example || Example | |||
|- | |||
| Dart package || [https://openfoodfacts.github.io/openfoodfacts-dart/ Code Doc] || Example | |||
|- | |||
| Example || Example || Example | |||
|- | |||
| Example || Example || Example | |||
|- | |||
| Example || Example || Example | |||
|- | |||
| Example || Example || Example | |||
|} | |||
=== 2021 Documentation roadmap === | === 2021 Documentation roadmap === | ||
Revision as of 18:00, 27 August 2021
Documentation
| Product | Doc | Doc |
|---|---|---|
| Server code | Example | Example |
| API | Example | Doc repo |
| Android | Code doc | Example |
| iPhone | Example | Example |
| Flutter | Example | Example |
| Dart package | Code Doc | Example |
| Example | Example | Example |
| Example | Example | Example |
| Example | Example | Example |
| Example | Example | 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