Skip to content

docs: clarify Robotoff intro paragraph in README#1538

Merged
alexgarel merged 1 commit intoopenfoodfacts:mainfrom
ggallitz:patch-1
Apr 23, 2025
Merged

docs: clarify Robotoff intro paragraph in README#1538
alexgarel merged 1 commit intoopenfoodfacts:mainfrom
ggallitz:patch-1

Conversation

@ggallitz
Copy link
Contributor

@ggallitz ggallitz commented Apr 3, 2025

Reason for change:
The original sentence was somewhat unclear and internally inconsistent — it treated "updates," "insights," and "predictions" as if they were all on the same level, but later implied that predictions are combined to form insights. After reviewing the flow of how Robotoff works, I reworded the description to better reflect its role in managing the full process from predictions to user-reviewed updates. Explanation based on the Predictions and Insights docs (https://openfoodfacts.github.io/robotoff/explanations/predictions/)

What

  • Updated the first paragraph of the README.md file
  • Clarified the relationships between predictions, insights, and updates

Screenshot

Not applicable — documentation only (Markdown text edit)

Fixes bug(s)

None

Part of

Minor documentation improvements (no issue filed yet)

Reason for change:
The original sentence was somewhat unclear and internally inconsistent — it treated "updates," "insights," and "predictions" as if they were all on the same level, but later implied that predictions are combined to form insights. After reviewing the flow of how Robotoff works, I reworded the description to better reflect its role in managing the full process from predictions to user-reviewed updates.
Explanation based on the Predictions and Insights docs (https://openfoodfacts.github.io/robotoff/explanations/predictions/)
@ggallitz
Copy link
Contributor Author

ggallitz commented Apr 3, 2025

Let me know if anything needs adjusting — happy to update!

Copy link
Member

@alexgarel alexgarel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ggallitz

@alexgarel alexgarel merged commit c6b3fd9 into openfoodfacts:main Apr 23, 2025
5 of 7 checks passed
raphael0202 pushed a commit that referenced this pull request May 16, 2025
🤖 I have created a release *beep* *boop*
---


##
[1.66.0](v1.65.0...v1.66.0)
(2025-05-16)


### Features

* Implement auto-rotation for selected images using Google Cloud Vision
predictions
([#1562](#1562))
([564d7a4](564d7a4))
* improve image orientation insights
([#1567](#1567))
([5c581b3](5c581b3))


### Bug Fixes

* add missing question formatter
([5ec6db1](5ec6db1))
* bump pre-commit hook version
([#1564](#1564))
([065977a](065977a))
* failing code quality tests
([#1556](#1556))
([2ccdd77](2ccdd77))
* improve ImageOrientation importers and annotator
([#1566](#1566))
([3d160c8](3d160c8))


### Technical

* clarify Robotoff intro paragraph in README
([#1538](#1538))
([c6b3fd9](c6b3fd9))
* fix test annotate + test nutrients JSON
([#1561](#1561))
([1678921](1678921))
* Regenerate poetry.lock after pyproject.toml changes
([#1555](#1555))
([4472af1](4472af1))
* updated ubuntu version pinning and some minor errors related to
deployment
([#1558](#1558))
([fcd09a0](fcd09a0))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants