Add comprehensive README files for all 9 built-in profiles (invoice,
receipt, contract, scientific_paper, slide_deck, form, bank_statement,
legal_filing, book_chapter). Each README includes:
- Match Criteria Summary: prose description of what makes a document match
- Extracted Fields table: field_name, type, description, example, source_hint
- Known Limitations: bullet list of edge cases and failure modes
- Sample Input Pointer: links to fixtures directory
- Configuration Tips: how to override via --profile or export
The xtask doc-profile skeleton generator was already implemented
and was used to generate the initial skeleton, which was then enhanced
with profile-specific human-authored content.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Complete per-profile README documentation for all 9 built-in profiles.
Each README follows the consistent 6-section structure with match criteria,
extracted fields, known limitations, sample input pointers, and configuration tips.
Fix: receipt README date field type (string → date to match YAML).
Files updated:
- profiles/builtin/invoice/README.md
- profiles/builtin/receipt/README.md
- profiles/builtin/contract/README.md
- profiles/builtin/scientific_paper/README.md
- profiles/builtin/slide_deck/README.md
- profiles/builtin/form/README.md
- profiles/builtin/bank_statement/README.md
- profiles/builtin/legal_filing/README.md
- profiles/builtin/book_chapter/README.md
- notes/pdftract-4iier.md
Acceptance criteria:
- All 9 README files exist at correct paths
- All follow consistent 6-section structure
- All Extracted Fields tables match YAML profile_fields
- All Known Limitations sections are non-empty and profile-specific
- All Sample Input pointers reference existing fixtures
- xtask doc-profile skeleton generator is implemented
Co-Authored-By: Claude Code (glm-4.7) <noreply@anthropic.com>
Complete the per-profile README documentation for all 9 built-in profiles:
- slide_deck: Add Known Limitations section
- form: Add Match Criteria Summary and Known Limitations
- bank_statement: Add Match Criteria Summary and Known Limitations
- legal_filing: Add Match Criteria Summary and Known Limitations
- book_chapter: Add Match Criteria Summary and Known Limitations
The xtask doc-profile skeleton generator already existed and provides
automated README generation from profile.yaml files.
All READMEs now follow the consistent 6-section structure:
1. Title and description
2. Match Criteria Summary (prose description)
3. Extracted Fields (table with field details)
4. Known Limitations (document-specific edge cases)
5. Sample Input Pointer (fixture references)
6. Configuration Tips (override instructions)
Acceptance criteria:
- All nine README files exist at profiles/builtin/<type>/README.md
- Each follows the consistent 6-section structure
- Extracted Fields tables match the corresponding profile YAML
- Known Limitations is non-empty and document-specific
- Sample Input Pointer links to actual fixtures
- xtask doc-profile skeleton generator exists
Co-Authored-By: Claude Code <noreply@anthropic.com>
