Documentation: Difference between revisions
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
[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 | ||
* | * 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 | |||
Revision as of 08:58, 2 February 2021
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