Skip to content

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

Open
p4535992 wants to merge 3 commits into
flyfish-dev:mainfrom
p4535992:documentation/rendering-optional
Open

docs(renderers): clarify optional renderer setup for Full packages#226
p4535992 wants to merge 3 commits into
flyfish-dev:mainfrom
p4535992:documentation/rendering-optional

Conversation

@p4535992

Copy link
Copy Markdown
Contributor

Summary

  • Clarify that optional specialist renderers are not automatically included in the historical @file-viewer/*-full packages or the frozen preset-all compatibility matrix.
  • Add a generic installation and registration pattern that can be reused for current and future optional renderers.
  • Document how to extend an existing Full installation with an optional renderer using rendererMode: 'extend', with DICOM as a concrete example.
  • Clarify the CLI workflow and the difference between historical Full packages, the CLI full profile, and the prebuilt web-full browser bundle.

Related issue

N/A: documentation clarification only; no existing issue is being closed.

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
Documentation/content review of docs/guide/on-demand-renderers.md Pass
Runtime/build tests N/A — documentation-only change

Sample / fixture evidence

  • N/A: no file-format or renderer behavior is changed.

Visual evidence

  • Before: N/A — documentation-only change.
  • After: N/A — documentation-only change.

Risk and compatibility

  • Affected packages/formats: Documentation for optional renderers and historical @file-viewer/*-full integrations. No package or format implementation is changed.
  • Compatibility or migration risk: None expected. This documents the existing opt-in renderer behavior and does not change runtime, API, package, Worker, WASM, asset, or deployment behavior.
  • 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.

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