openfoodfacts/openfoodfacts-server

Create a openfoodfacts-events section with high-level explanation and a link to the openfoodfacts-events API

Open

#7,748 opened on Nov 22, 2022

View on GitHub
 (10 comments) (0 reactions) (0 assignees)Perl (477 stars) (236 forks)batch import
Road to Docgood first issueopenfoodfacts-events⏰ Stale📚 Documentation🕹️ Gamification

Description

What

  • Create a openfoodfacts-events section with high-level explanation and a link to the openfoodfacts-events API

Part of

  • #7446

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Open Food Facts documentation structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue requests creating a new section titled 'openfoodfacts events' with a high level explanation and a link to the openfoodfacts events API. The work involves navigating the repository's documentation files, likely in a docs folder or similar, to add this section. There are 10 comments on the issue that may contain guidance on preferred location or style. Check the comments for any proposed structure or links to existing examples. Since the repository is openfoodfacts server, the documentation might be in Markdown files. Look for a folder like 'docs' or 'api docs' and read related files to maintain consistency.