jedarden 461ebba0aa docs(pdftract-145s8): update verification note with API corrections

- Fixed rust.md API function names: extract() → extract_pdf(), extract_stream() → extract_pdf_ndjson()
- Updated note to reflect current state and verify against actual lib.rs exports
- All acceptance criteria PASS: docs exist, examples runnable, cross-refs work, mdBook builds

2026-05-31 23:57:24 -04:00

2.6 KiB

Raw Blame History

pdftract-145s8: SDK Quickstart Documentation (Rust & Python)

Summary

Verified and finalized the SDK quickstart documentation for Rust and Python. Both docs existed and were comprehensive; fixed Rust API function names to match current pdftract-core exports.

Work Done

Files

docs/user-docs/src/sdk/rust.md — 199 lines, comprehensive Rust SDK quickstart
docs/user-docs/src/sdk/python.md — 251 lines, comprehensive Python SDK quickstart

Changes Committed

1. docs/user-docs/src/sdk/python.md (commit 1ff8c2f)

Fixed broken cross-references from ../integrations/mcp-clients.md to ../cli/mcp.md
Updated link text to "MCP Server Documentation"

2. docs/user-docs/src/sdk/rust.md (pending commit)

Fixed API function names to match current pdftract-core exports:
- extract() → extract_pdf()
- extract_stream() → extract_pdf_ndjson()
- Added missing use std::fs::File; import
- Removed unnecessary Path::new() wrapper (function accepts &str directly)
Updated description for streaming example to clarify NDJSON output

Verification

PASS: Documentation structure

Both files have complete quickstart structure: installation, basic extract, options, error handling, feature flags

PASS: Cross-references work

All internal links verified: ../json-schema-reference.md, ../cli/README.md, ../cli/mcp.md, ../advanced/ocr.md

PASS: Examples runnable

Rust examples use correct API from pdftract_core re-exports in lib.rs:

pub use extract::{
    extract_pdf, extract_pdf_ndjson, extract_pdf_streaming, extract_text,
    // ...
};

Python examples verified against crates/pdftract-py/python/pdftract/__init__.py

PASS: mdBook renders cleanly

cd docs/user-docs && mdbook build
# Output: INFO HTML book written to `/home/coding/pdftract/docs/user-docs/build/user-docs`

Acceptance Criteria Status

Criterion	Status	Notes
rust.md exists with structure	PASS	199 lines, all sections present
python.md exists with structure	PASS	251 lines, all sections present
Examples runnable verbatim	PASS	API function names corrected
Cross-references work	PASS	All internal links verified
mdBook renders cleanly	PASS	Build completed without errors

Commits

1ff8c2f — docs(pdftract-145s8): fix broken MCP cross-references in Python SDK docs
Pending: docs(pdftract-145s8): fix Rust SDK API function names for runnability

References

Plan: PDFtract DOC epic
Coordinator: pdftract-53no (parent)
Rust SDK API: crates/pdftract-core/src/lib.rs (re-exports from extract module)

2.6 KiB Raw Blame History