jedarden/pdftract

Fork 0

Commit graph

Author	SHA1	Message	Date
jedarden	2ccdaecda1	docs(pdftract-5nare): add comprehensive FAQ with 24 questions Added docs/user-docs/src/faq.md with 24 FAQ entries covering: - General questions (what is pdftract, extract vs extract_text, JS execution) - Installation and setup (proxy, system requirements) - Usage (broken_vector, OCR speed, page ranges, images, batch processing) - Configuration (custom profiles, OCR accuracy, confidence scores) - Output formats (Markdown, tables, metadata, passwords) - Troubleshooting (errors, empty output, debugging, memory usage) Each answer is 1-3 paragraphs with cross-links to fuller docs. mdBook builds successfully. Acceptance criteria: - PASS: docs/user-docs/src/faq.md exists - PASS: 24 questions covered (target: 15-25) - PASS: Each answer is 1-3 paragraphs - PASS: Cross-links work - PASS: mdBook renders cleanly Closes: pdftract-5nare	2026-05-25 00:22:48 -04:00
jedarden	d9d21df157	docs(pdftract-653ah): add runbook integration for pdftract doctor - Created docs/operations/manual-platform-smoke.md with comprehensive smoke test runbook for KU-12 quarterly manual platform testing - Added troubleshooting table covering all 14 doctor checks - Cross-referenced runbook from installation.md and quickstart.md - Added CI gate test (doctor_runbook_coverage.rs) to verify troubleshooting table completeness Acceptance criteria: ✓ Step 1: pdftract doctor as first section in runbook ✓ Troubleshooting table covers all FAIL-capable checks ✓ installation.md mentions pdftract doctor with runbook link ✓ quickstart.md uses pdftract doctor as first example command ✓ CI gate parses runbook and asserts all checks are present ✓ mdBook build succeeds ✓ No broken internal links Closes: pdftract-653ah	2026-05-24 13:26:31 -04:00
jedarden	a34f9c18d0	docs(pdftract-1g87): create mdBook scaffolding for user documentation - book.toml with title, authors, build directory, edit-url-template - src/SUMMARY.md with complete TOC for all planned sections - src/introduction.md: what pdftract does and doesn't do (Non-Goals) - src/installation.md: cargo, pip, Homebrew, Docker; KU-12 caveat verbatim - src/quickstart.md: five-minute walkthrough with executable commands - 39 draft placeholder files for CLI reference, schema, profiles, SDKs, advanced topics, troubleshooting, FAQ mdbook build completes cleanly with zero warnings (linkcheck optional). See notes/pdftract-1g87.md for verification details. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>	2026-05-18 00:38:51 -04:00

Author

SHA1

Message

Date

jedarden

2ccdaecda1

docs(pdftract-5nare): add comprehensive FAQ with 24 questions

Added docs/user-docs/src/faq.md with 24 FAQ entries covering:
- General questions (what is pdftract, extract vs extract_text, JS execution)
- Installation and setup (proxy, system requirements)
- Usage (broken_vector, OCR speed, page ranges, images, batch processing)
- Configuration (custom profiles, OCR accuracy, confidence scores)
- Output formats (Markdown, tables, metadata, passwords)
- Troubleshooting (errors, empty output, debugging, memory usage)

Each answer is 1-3 paragraphs with cross-links to fuller docs.
mdBook builds successfully.

Acceptance criteria:
- PASS: docs/user-docs/src/faq.md exists
- PASS: 24 questions covered (target: 15-25)
- PASS: Each answer is 1-3 paragraphs
- PASS: Cross-links work
- PASS: mdBook renders cleanly

Closes: pdftract-5nare

2026-05-25 00:22:48 -04:00

jedarden

d9d21df157

docs(pdftract-653ah): add runbook integration for pdftract doctor

- Created docs/operations/manual-platform-smoke.md with comprehensive
  smoke test runbook for KU-12 quarterly manual platform testing
- Added troubleshooting table covering all 14 doctor checks
- Cross-referenced runbook from installation.md and quickstart.md
- Added CI gate test (doctor_runbook_coverage.rs) to verify
  troubleshooting table completeness

Acceptance criteria:
✓ Step 1: pdftract doctor as first section in runbook
✓ Troubleshooting table covers all FAIL-capable checks
✓ installation.md mentions pdftract doctor with runbook link
✓ quickstart.md uses pdftract doctor as first example command
✓ CI gate parses runbook and asserts all checks are present
✓ mdBook build succeeds
✓ No broken internal links

Closes: pdftract-653ah

2026-05-24 13:26:31 -04:00

jedarden

a34f9c18d0

docs(pdftract-1g87): create mdBook scaffolding for user documentation

- book.toml with title, authors, build directory, edit-url-template
- src/SUMMARY.md with complete TOC for all planned sections
- src/introduction.md: what pdftract does and doesn't do (Non-Goals)
- src/installation.md: cargo, pip, Homebrew, Docker; KU-12 caveat verbatim
- src/quickstart.md: five-minute walkthrough with executable commands
- 39 draft placeholder files for CLI reference, schema, profiles, SDKs, advanced topics, troubleshooting, FAQ

mdbook build completes cleanly with zero warnings (linkcheck optional).

See notes/pdftract-1g87.md for verification details.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

2026-05-18 00:38:51 -04:00

3 commits