Documentation: Difference between revisions
No edit summary |
|||
| Line 8: | Line 8: | ||
|+ Documentation of OFF codebases and APIs | |+ Documentation of OFF codebases and APIs | ||
|- | |- | ||
! Product !! Doc !! | ! Product !! Doc !! Comment | ||
|- | |- | ||
| Server code || | | Server code || [https://openfoodfacts.github.io/openfoodfacts-server/ Code doc] || Example | ||
|- | |- | ||
| API | | API || [https://github.com/openfoodfacts/api-documentation API doc] || Example | ||
|- | |- | ||
| Android || [https://openfoodfacts.github.io/openfoodfacts-androidapp/ Code 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 | | Dart package || [https://openfoodfacts.github.io/openfoodfacts-dart/ Code Doc] || Example | ||
|- | |- | ||
| | | iPhone || Example || Example | ||
|} | |} | ||
=== 2021 Documentation roadmap === | === 2021 Documentation roadmap === | ||
Revision as of 15:36, 31 August 2021
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 | 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