docs: audit README vs implementation, fix discrepancies & enable PDF C2PA#23
Merged
docs: audit README vs implementation, fix discrepancies & enable PDF C2PA#23
Conversation
Thorough audit found README claims that didn't match the actual code. Fixes across all 8 README files (zh-CN, en, de, ja, ko, hi, es, zh-CN copy): - "76 AI tools" → "62 AI tools" (76 was pattern count including aliases) - "10 detection methods" → "11" (visible_watermark.rs was undocumented) - Added visible watermark detection description to all READMEs - Moved --deep from "Global Flags" to new "Check Options" section (it's check-specific) - Documented --lang flag (existed in code but missing from all READMEs) - Added --min-confidence and -r/--recursive to Check Options table - Added Loudly to audio tool table (was in known_tools.rs but not documented) - Added missing Qwen, Wan, Google AI to stale translation tool tables - Synced stale docs/README.zh-CN.md with main README.md - Fixed EXIF confidence from "LOW" to "LOW–MEDIUM" in stale translations - Updated flow diagrams to include visible watermark Also: - Enabled c2pa "pdf" feature for actual PDF C2PA manifest support - Added Adobe Firefly test fixture and 4 integration tests Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
Thorough audit of all 8 README files against the actual codebase. Fixed 6 discrepancies where documentation didn't match implementation, and enabled C2PA PDF support that was available but not activated.
Changes
visible_watermark.rs(609 lines) was completely undocumented; added description in all languages--deepmislabeled as global flag — moved to new "Check Options" section (it'sCheckArgs-specific, not global)--langflag — existed incli.rsbut missing from all READMEsdocs/README.zh-CN.md— was missingclaim_generator_info,Creditfield, AIGC JSON parsing, and had wrong EXIF confidence levelpdffeature in Cargo.toml — Adobe Firefly PDFs embed C2PA manifests, but the feature wasn't activatedai_firefly.png) with 4 integration tests covering C2PA, XMP, JSON output, and info commandChecklist
cargo fmt -- --checkpassescargo clippy -- -D warningspassescargo testpasses