Skip to content

Comments

Docs: Add CompatibilityTable and fix backticks in renderer docs#6610

Merged
JonnyBurger merged 2 commits intomainfrom
docs/renderer-compatibility-tables
Feb 20, 2026
Merged

Docs: Add CompatibilityTable and fix backticks in renderer docs#6610
JonnyBurger merged 2 commits intomainfrom
docs/renderer-compatibility-tables

Conversation

@JonnyBurger
Copy link
Member

Summary

  • Add <CompatibilityTable> to all 13 active @remotion/renderer API pages showing Node.js + Bun + SSR support only (no browser/player/studio/serverless/client-side)
  • Fix missing backticks around API names in "See also" sections across 7 renderer doc pages

Test plan

  • Verify docs site builds correctly
  • Check CompatibilityTable renders on renderer API pages
  • Confirm backtick formatting looks correct in See also links

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings February 20, 2026 09:58
@vercel
Copy link
Contributor

vercel bot commented Feb 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
bugs Ready Ready Preview, Comment Feb 20, 2026 10:18am
remotion Ready Ready Preview, Comment Feb 20, 2026 10:18am

Request Review

@JonnyBurger JonnyBurger changed the title docs: Add CompatibilityTable and fix backticks in renderer docs Docs: Add CompatibilityTable and fix backticks in renderer docs Feb 20, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves the documentation for the @remotion/renderer package by adding compatibility information and fixing markdown formatting. The changes ensure users can quickly understand where each renderer API can be used (Node.js/Bun environments with SSR support only, excluding browsers and serverless functions).

Changes:

  • Added <CompatibilityTable> component to 13 active @remotion/renderer API documentation pages
  • Fixed missing backticks around API function names in "See also" sections across 7 renderer doc pages

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.

Show a summary per file
File Description
packages/docs/docs/renderer/stitch-frames-to-video.mdx Added CompatibilityTable and fixed backticks in See also links
packages/docs/docs/renderer/select-composition.mdx Added CompatibilityTable section
packages/docs/docs/renderer/render-still.mdx Added CompatibilityTable section
packages/docs/docs/renderer/render-media.mdx Added CompatibilityTable and fixed backticks in See also links
packages/docs/docs/renderer/render-frames.mdx Added CompatibilityTable and fixed backticks in See also links
packages/docs/docs/renderer/open-browser.mdx Added CompatibilityTable section
packages/docs/docs/renderer/make-cancel-signal.mdx Added CompatibilityTable section
packages/docs/docs/renderer/get-video-metadata.mdx Added CompatibilityTable and fixed backticks in See also links
packages/docs/docs/renderer/get-silent-parts.mdx Added CompatibilityTable and fixed backticks in See also links
packages/docs/docs/renderer/get-compositions.mdx Added CompatibilityTable section
packages/docs/docs/renderer/extract-audio.mdx Added CompatibilityTable and fixed backticks in See also links
packages/docs/docs/renderer/ensure-browser.mdx Added CompatibilityTable section
packages/docs/docs/renderer/combine-chunks.mdx Added CompatibilityTable and fixed backticks in See also links

Copy link
Contributor

@pullfrog pullfrog bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low urgency. The CompatibilityTable additions are correct and consistent across all 13 active renderer pages. The backtick fixes look good. One pre-existing bug: renderStill() links to /docs/renderer/stitch-frames-to-video instead of /docs/renderer/render-still in two files — worth fixing since these lines are already being touched.

Pullfrog  | Fix all ➔Fix 👍s ➔View workflow runpullfrog.com𝕏

Copy link
Contributor

@pullfrog pullfrog bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clean docs PR. All 13 active @remotion/renderer API pages get the CompatibilityTable, the 3 removed APIs (ensureFfmpeg, ensureFfprobe, getCanExtractFramesFast) and non-API pages (types, TableOfContents) are correctly skipped. Backtick fixes in "See also" sections are complete — no unbackticked function references remain. Props are consistent across all pages and match the expected renderer profile (Node.js + Bun + SSR only). LGTM.

Pullfrog  | View workflow runpullfrog.com𝕏

@pullfrog
Copy link
Contributor

pullfrog bot commented Feb 20, 2026

Fixed 2 review comments — corrected renderStill() links in get-video-metadata.mdx and render-media.mdx to point to /docs/renderer/render-still. Changes pushed.

Pullfrog  | View workflow run | Using Cursor CLI | Triggered by Pullfrogpullfrog.com𝕏

@JonnyBurger JonnyBurger merged commit 6d6a733 into main Feb 20, 2026
18 checks passed
@JonnyBurger JonnyBurger deleted the docs/renderer-compatibility-tables branch February 20, 2026 10:34
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