Commit graph

11 commits

Author SHA1 Message Date
jedarden
7a1b0d434b docs(bf-10qd4): mark unpublished install channels as coming-soon
- Update badges (crates.io, PyPI) to show 'coming-soon' status
- Add prominent warning that public releases are not yet available
- Reorganize Installation section with development instructions first
- Mark each planned install channel with clear status indicators
- Update distribution table to show which SDKs are not yet published

This addresses the issue where README instructed users to install from
nonexistent artifacts (crates.io, PyPI, Docker Hub, Homebrew).

All install commands now clearly indicate they are planned but not yet
available. Users are directed to build from source instead.

References: bf-10qd4
2026-07-05 15:43:52 -04:00
jedarden
26d622e2d8 docs(bf-3ourh): verify CJK fixtures exist and document in PROVENANCE
CJK fixtures and tests already exist from previous work:
- tests/fixtures/cjk/ contains all 4 required PDFs
- Ground truth files for each encoding (GB18030, Shift-JIS, EUC-KR, Big5)
- Tests in crates/pdftract-core/tests/cjk_encoding.rs and tests/test_encoding.rs
- Tests fail due to unimplemented CJK encoding (expected for Phase 2.3)
- Updated PROVENANCE.md with CJK fixture entries

Fixtures are ready for CJK encoding implementation.

Closes bf-3ourh
2026-06-24 12:35:47 -04:00
jedarden
56d7c1b3f7 docs(pdftract-5gld): update README with MSRV and enhanced documentation links
- Add MSRV 1.78 to installation section
- Enhance documentation section with descriptive link text
- Ensure all required links are present (user-docs, extraction-output-schema, sdk-architecture, manual-platform-smoke)

Closes pdftract-5gld
2026-06-08 20:00:38 -04:00
jedarden
7cb00643c8 docs(pdftract-4bpph): add README.md with KU-12 caveat, status badges, and quickstart
Some checks failed
Schema Generation Validation / Validate JSON Schema (push) Has been cancelled
Schema Generation Validation / Validate JSON Syntax (push) Has been cancelled
- Add README.md at repo root with required sections
- Platform support table with KU-12 caveat linking to manual-platform-smoke.md
- Status badges: crates.io, docs.rs, CI (Argo Workflows), license
- Installation instructions: cargo, pip, Docker, Homebrew
- Quickstart examples: Rust (5 lines), Python (3 lines), CLI (3 lines)
- Documentation links to user-docs, API reference, contributing, security

See notes/pdftract-4bpph.md for acceptance criteria status.
2026-05-28 08:11:08 -04:00
jedarden
569999898a docs(pdftract-4618): adopt Contributor Covenant v2.1 and link from templates
- Update CODE_OF_CONDUCT.md to official Contributor Covenant v2.1 text
- Change enforcement contact from security@jedarden.com to community@jedarden.com
- Add links to CODE_OF_CONDUCT.md from all issue templates
- Add Code of Conduct link to README Contributing section

Satisfies GitHub Community Standards requirement for CODE_OF_CONDUCT.md
linked from issue templates and README.

Refs: pdftract-4618
Signed-off-by: jedarden <github@jedarden.com>
2026-05-24 13:06:57 -04:00
jedarden
97fecb7b4b docs(contributing): add Argo-CI caveat, DCO sign-off, and contributor templates
- Restructured CONTRIBUTING.md with all nine required sections:
  - Project licensing (MIT OR Apache-2.0, DCO sign-off required)
  - Code of conduct (Contributor Covenant v2.1)
  - Security reporting (link to SECURITY.md)
  - Development setup (with OCR dependencies)
  - Local validation checklist (6 commands matching pdftract-ci)
  - CI on forks caveat (maintainer-triggered, 48-hour response)
  - PR template requirements
  - Commit message style (Conventional Commits)
  - Issue triage

- Created CODE_OF_CONDUCT.md (Contributor Covenant v2.1)

- Created .github/PULL_REQUEST_TEMPLATE.md with required fields:
  - Linked issue or RFC
  - Scope statement (Phase / Acceptance Scenario)
  - Test plan
  - Manual-test evidence
  - Performance impact

- Created issue templates:
  - bug_report.md (with pdftract doctor output requirement)
  - feature_request.md (with use case and proposed solution)
  - performance_regression.md (with baseline vs current)

- Updated README.md with Contributing section linking to CONTRIBUTING.md

- Added footer links to CONTRIBUTING.md in all templates

Closes: pdftract-i9rk

Verification: notes/pdftract-i9rk.md
Signed-off-by: jedarden <github@jedarden.com>
2026-05-24 06:00:48 -04:00
jedarden
96f71e9b52 feat(pdftract-1u80): add cargo binstall metadata and installation docs
Add [package.metadata.binstall] to crates/pdftract-cli/Cargo.toml to enable
cargo binstall to download pre-built binaries from GitHub Releases instead
of compiling from source. Also add comprehensive Installation section to
README.md documenting cargo binstall as the recommended install method.

Bead: pdftract-1u80

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-23 21:23:17 -04:00
jedarden
bb5346b305 docs(pdftract-58kz): add security policy documentation
Add comprehensive SECURITY.md covering:
- Supported versions policy
- Private vulnerability reporting (email + GitHub)
- 90-day disclosure window with timelines
- CVE assignment via GitHub Security Advisories
- In-scope and out-of-scope vulnerability classes
- Safe harbor policy for good-faith researchers

Add security issue template redirecting users to private reporting.
Add Security section to CONTRIBUTING.md and README.md with links to SECURITY.md.
Add docs/security/pgp-public-key.asc placeholder with generation instructions.

References: bead pdftract-58kz, plan line 3433

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-20 19:39:24 -04:00
jedarden
12f4cb4d81 feat(pdftract-2w02): pin MSRV to 1.78 with CI gate
Add MSRV (Minimum Supported Rust Version) pinning to 1.78 for
pdftract-core and pdftract-cli. The MSRV gate prevents silent
absorption of newer Rust features that would break downstream
consumers on older toolchains.

Changes:
- CI: Add quality-matrix DAG with msrv-check step (rust:1.78-slim)
- CI: Add clippy-check, fmt-check, cargo-audit, cargo-deny templates
- README: Add MSRV badge (shields.io)
- clippy.toml: Enable msrv=1.78 for MSRV-aware lints
- CONTRIBUTING.md: Document MSRV bump policy (MINOR version event)

The rust-version was already declared in workspace Cargo.toml;
this bead adds the CI enforcement and documentation.

Refs: pdftract-2w02
2026-05-20 19:03:53 -04:00
jedarden
f87579b100 Rewrite README to lead with capabilities, drop competitor references
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-16 14:46:33 -04:00
jedarden
4ae798c8b1 Initial repo scaffold with README and docs structure
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-16 14:26:16 -04:00