SeasonOfDocs
Open Food Facts is not just a mobile app that's the Wikipedia for food. It's also a very valuable platform for developpers, scientists and others.
Create a developper page for OpenFoodFacts.org
Goal: onboard prospective developpers and people wanting to use Open Food Facts in their app
- basic information about getting started as a contributor to the open source project - rules around licence agreements, processes for pull requests and reviews, building the project, pointers to the Slack room, the API docs…
url: https://world.openfoodfacts.org/developers source code: https://github.com/openfoodfacts/openfoodfacts-server
Build a dedicated documentation site
Build a central documentation site on a platform to be decided by the technical writer and open source mentor, and publish an initial set of basic documents on the site. Examples of platforms include:
- Read the Docs
- A static site generator such as Hugo, Jekyll, Sphinx, and more
- GitHub Pages
Write conceptual overviews of the Open Food Facts products
1. Write a conceptual overview and introduction to the Open Food Facts server - Explain the high level goals, the architecture, the libraries used, the known limitations and the high level wishlist
future url: https://docs.openfoodfacts.org
2. Write a conceptual overview and introduction to Open Food Facts mobile app for iOS
- Explain the high level goals, the architecture, the libraries used, the known limitations and the high level wishlist
source code: https://github.com/openfoodfacts/openfoodfacts-ios
3. Write a conceptual overview and introduction to Open Food Facts mobile app for Android - Explain the high level goals, the architecture, the libraries used, the known limitations and the high level wishlist
source code: https://github.com/openfoodfacts/openfoodfacts-androidapp
4. Write a conceptual overview and introduction to the Open Food Facts API - Explain the high level goals, the architecture, the libraries used, the known limitations and the high level wishlist - Write guidelines on how to implement the API to ensure a sound and safe user experience
source code: https://github.com/openfoodfacts/openfoodfacts-server current documentation: https://en.wiki.openfoodfacts.org/
Refactor the "How to add a product" documentation
- Refresh screenshots and instructions to match the new UI
- Automate screenshot generation across languages
- Create a documentation of the advanced features of Open Food Facts for scientists, journalists…
- Document the advanced search feature, and the graph generation, with examples
Document the Open Food Facts API
1. General
The Open Food Facts API has grown organically through the years, and has been documented as we go, but not in a systematic way. New practices like automatic API generation from the Code could be added.
https://en.wiki.openfoodfacts.org/API
2. READ
The READ part of the API is very important for the official client, as well as for apps who send direct calls from their users to the API (provided volume stays reasonable).
The project can be divided in one part for the images, one for the data.
https://en.wiki.openfoodfacts.org/API/Read
3. WRITE
The WRITE part is very important to let apps send images and data contributed by their users, to Open Food Facts. The better documented, and the easier it is to implement contribution within 3rd party apps, the more images and data we'll get, the faster we'll have full food transparency worldwide.
The project can be divided in one part for the images, one for the data.
https://en.wiki.openfoodfacts.org/API/Write
4. Automatic generation
Add documentation within the code to generate documentation and SDKs automatically. Automatic generation from code with things like Swagger would be very interesting
Document usage of the mobile apps
- Refresh screenshots and instructions to match the new UI
- Finish to automate screenshot generation across languages
source code: https://github.com/openfoodfacts/openfoodfacts-ios source code: https://github.com/openfoodfacts/openfoodfacts-androidapp