Skip to content

docs(renderers): clarify optional renderer setup for Full packages - #226

Merged
wybaby168 merged 4 commits into
flyfish-dev:mainfrom
p4535992:documentation/rendering-optional
Aug 30, 2026
Merged

docs(renderers): clarify optional renderer setup for Full packages#226
wybaby168 merged 4 commits into
flyfish-dev:mainfrom
p4535992:documentation/rendering-optional

Conversation

@p4535992

@p4535992 p4535992 commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Document that the eight Full packages and @file-viewer/preset-all keep their published compatibility baseline while DICOM and digital-signature inspection remain explicit opt-ins.
  • Replace placeholder snippets with runnable npm and CLI examples using rendererMode: 'extend'.
  • State the DICOM, signature-trust, nested-preview, CLI full, and prebuilt web-full boundaries precisely.
  • Keep the English and Chinese guides aligned.

Related issue

N/A: focused documentation clarification for the published 3.0 package boundary.

Change classification

  • User-visible UI or rendering change
  • Non-visual change
  • File-format or renderer behavior
  • Public API, package, Worker, WASM, or deployment-path change

Verification

Check Result
pnpm docs:build Pass
pnpm install --frozen-lockfile --offline Pass

Sample / fixture evidence

  • N/A: documentation-only change; no file-format behavior changed.

Visual evidence

  • N/A: documentation-only change; no rendered UI changed.

Risk and compatibility

  • Affected packages/formats: English and Chinese modular-renderer guidance for Full packages, DICOM, digital signatures, the CLI, and the prebuilt web-full bundle.
  • Compatibility or migration risk: No runtime or package behavior changes; the examples reflect the current 3.0 manifests and CLI catalog.
  • Rollback: Revert the documentation commits.

Checklist

  • I added or updated focused automated coverage, or explained why it is not needed.
  • I updated user-facing documentation or release notes when behavior or API changed, or marked them not applicable.
  • I verified offline/private-deployment paths when changing Worker, WASM, fonts, vendor assets, or URLs.
  • I did not commit secrets, customer files, private samples, generated caches, or unrelated changes.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Aug 29, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-08-29T08:51:23.077667Z c14a9ed PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@wybaby168

Copy link
Copy Markdown
Member

Thanks! I aligned this with the 3.0 package boundaries, added runnable examples and Chinese parity, and verified the docs build.

@wybaby168
wybaby168 merged commit 1fbadee into flyfish-dev:main Aug 30, 2026
5 of 6 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.

2 participants