jedarden/pdftract

Fork 0

Commit graph

Author	SHA1	Message	Date
jedarden	55da9ddf51	feat(bf-4cbfb): add community profiles directory and CONTRIBUTING guide - Create profiles/community/ directory structure with CONTRIBUTING.md - CONTRIBUTING.md covers all required contribution areas: * File naming convention and directory structure * Required profile fields and schema requirements * Local testing workflow with validation steps * PR submission process and review guidelines * License requirements for fixture PDFs * Review checklist and quality standards - Update extraction_loader.rs to add Community profile origin - Update profiles_cmd.rs to list community profiles separately - Document community profiles in profile-authoring.md search path - Add test-profile example to verify implementation Acceptance criteria met: ✅ profiles/community/CONTRIBUTING.md exists with comprehensive guide ✅ Code supports loading and listing community profiles ✅ Path documented in profile-authoring.md Closes bf-4cbfb	2026-07-05 13:01:54 -04:00
jedarden	ef3f4929e3	docs(bf-2i8zv): add YAML footguns and profiles validation guide Add docs/research/profile-authoring.md documenting YAML authoring gotchas for document profiles and the pdftract profiles validate command. Coverage: - YAML footguns: scalar type coercion (on, yes, true), significant indentation, multi-line strings - The match: combinator DSL (all:, any:, none:) with correct and incorrect examples - The fields: DSL (near:, region:, pick:, regex:, parse:) - Common validation errors and pdftract profiles validate messages - Profile search path resolution order - PROFILE_SECRETS_FORBIDDEN constraint Acceptance criteria: - File exists with all 6 topic areas covered ✓ - At least 3 annotated YAML examples ✓ Required by ADR-007 (plan line 480).	2026-07-05 12:48:15 -04:00

Author

SHA1

Message

Date

jedarden

55da9ddf51

feat(bf-4cbfb): add community profiles directory and CONTRIBUTING guide

- Create profiles/community/ directory structure with CONTRIBUTING.md
- CONTRIBUTING.md covers all required contribution areas:
  * File naming convention and directory structure
  * Required profile fields and schema requirements
  * Local testing workflow with validation steps
  * PR submission process and review guidelines
  * License requirements for fixture PDFs
  * Review checklist and quality standards
- Update extraction_loader.rs to add Community profile origin
- Update profiles_cmd.rs to list community profiles separately
- Document community profiles in profile-authoring.md search path
- Add test-profile example to verify implementation

Acceptance criteria met:
✅ profiles/community/CONTRIBUTING.md exists with comprehensive guide
✅ Code supports loading and listing community profiles
✅ Path documented in profile-authoring.md

Closes bf-4cbfb

2026-07-05 13:01:54 -04:00

jedarden

ef3f4929e3

docs(bf-2i8zv): add YAML footguns and profiles validation guide

Add docs/research/profile-authoring.md documenting YAML authoring
gotchas for document profiles and the pdftract profiles validate
command.

Coverage:
- YAML footguns: scalar type coercion (on, yes, true), significant
  indentation, multi-line strings
- The match: combinator DSL (all:, any:, none:) with correct
  and incorrect examples
- The fields: DSL (near:, region:, pick:, regex:, parse:)
- Common validation errors and pdftract profiles validate messages
- Profile search path resolution order
- PROFILE_SECRETS_FORBIDDEN constraint

Acceptance criteria:
- File exists with all 6 topic areas covered ✓
- At least 3 annotated YAML examples ✓

Required by ADR-007 (plan line 480).

2026-07-05 12:48:15 -04:00

2 commits