[codex] document photo processing recovery behavior#99
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue
The documentation around item photo processing and AI classification had unresolved gaps and contradictory behavior across
Item,Background Removal,AI Classification, andAdd Item. The open questions made implementation and QA expectations unclear, especially for failure and retry paths.User Effect
Without explicit rules, teams can implement different fallback behavior for failed cutout/classification cases, and users may get inconsistent outcomes when processing fails or network is unavailable.
Root Cause
The docs described only the happy path and left key operational decisions undefined:
Fix
This PR aligns the processing model across documentation pages and separates target behavior from current gaps.
Updated target behavior
docs/domain/item.mdoriginal+cutout).docs/features/background-removal.mdProcessing Failed+ retry) and one-item-per-photo expectation.docs/features/ai-classification.mdcutoutpreferred,originalfallback).docs/flows/add-item.mdCurrent-state gaps tracked explicitly
docs/constraints/current-limitations.mddocs/constraints/open-questions.mdValidation
Documentation-only change.
git diff --cached --checkbefore commit (no whitespace issues).