Skip to content

docs: explain Rust-owned publication exports#60

Merged
Iktahana merged 1 commit into
mainfrom
agent/update-publication-docs
Jul 23, 2026
Merged

docs: explain Rust-owned publication exports#60
Iktahana merged 1 commit into
mainfrom
agent/update-publication-docs

Conversation

@Iktahana

Copy link
Copy Markdown
Contributor

What changed

  • rewrite the English, Japanese, and Traditional Chinese publication guides so they describe the current Rust-owned EPUB, DOCX, export-profile, page-size, and PDF print-data implementation
  • clarify that JavaScript remains a thin compatibility and host layer, and that future Python, Swift, and Android bindings can expose the same Rust behavior without reimplementing it
  • update package READMEs, Rust API status, CLI guidance, Python binding limitations, and contributor contract-test instructions
  • document the release gate: unit and coverage jobs complete before DOCX, PDF, EPUB, and HTML publication contracts
  • improve reader-facing wording, correct stale links, and use Markdown highlighting for the homepage MDI example

Why

The previous documentation still described configured EPUB/DOCX as JavaScript publication-adapter work and listed Rust profile support as pending. That no longer matched the implementation and could lead users—and future binding authors—to build against the wrong ownership model.

User and developer impact

Readers now get one consistent explanation across all three languages: Rust validates publication profiles and generates EPUB/DOCX, while hosts only handle platform concerns such as launching Chromium. Python’s current limitation is described accurately as an unexposed wrapper API rather than missing Rust functionality.

Validation

  • pnpm typecheck
  • pnpm docs:build — 392 pages built
  • pnpm --filter @illusions-lab/mdi test — 32 tests
  • pnpm --filter mdast-util-mdi test — 25 tests
  • local-link audit across 38 changed prose files
  • stale publication-ownership phrase audit
  • git diff --check

@codecov

codecov Bot commented Jul 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@Iktahana
Iktahana merged commit 628dcba into main Jul 23, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant