Docs: Add CompatibilityTable and fix backticks in renderer docs#6610
Docs: Add CompatibilityTable and fix backticks in renderer docs#6610JonnyBurger merged 2 commits intomainfrom
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
docs: Add CompatibilityTable and fix backticks in renderer docsThere was a problem hiding this comment.
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/rendererAPI 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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
|
Fixed 2 review comments — corrected |

Summary
<CompatibilityTable>to all 13 active@remotion/rendererAPI pages showing Node.js + Bun + SSR support only (no browser/player/studio/serverless/client-side)Test plan
🤖 Generated with Claude Code