@remotion/docs, @remotion/lambda: Fix docs card asset resolution and lambda ambient type bleed#6752
Open
bhaktofmahakal wants to merge 15 commits intoremotion-dev:mainfrom
Open
Conversation
Co-authored-by: bhaktofmahakal <[email protected]>
Co-authored-by: bhaktofmahakal <[email protected]>
Co-authored-by: bhaktofmahakal <[email protected]>
Co-authored-by: bhaktofmahakal <[email protected]>
Co-authored-by: bhaktofmahakal <[email protected]>
Co-authored-by: bhaktofmahakal <[email protected]>
Co-authored-by: bhaktofmahakal <[email protected]>
# Conflicts: # packages/docs/docs/shapes/arrow.mdx # packages/docs/docs/shapes/make-arrow.mdx # packages/docs/src/remotion/Article.tsx # packages/lambda/tsconfig.json
Contributor
There was a problem hiding this comment.
Low-urgency — changes are well-scoped and follow existing patterns.
Summary:
- Docs: Frontmatter image paths match the existing convention for shape components (
/generated/articles-docs-shapes-*.png) Article.tsx: Arrow preview implementation is clean;staticFile()for the logo ensures deterministic rendering in CI/Vercel- Lambda
tsconfig.json:"types": ["node"]is a valid fix to isolate ambient types and prevent TS1540 errors from transitive@types/*packages
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the determinism and presentation of Remotion docs “card” renders by switching the card logo to a local static asset and adding Arrow-specific previews/cover images. It also tightens the Lambda package TypeScript configuration to avoid unintended ambient @types/* interference during builds.
Changes:
- Add Arrow article cover images and commit the newly generated docs card PNGs.
- Update the docs
ArticleRemotion composition to optionally render an<Arrow />header preview and to load the Remotion logo viastaticFile(). - Update
@remotion/lambdatsconfig.jsonto include Node types explicitly.
Reviewed changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/lambda/tsconfig.json | Explicitly includes Node ambient typings to prevent unrelated @types/* bleed in builds. |
| packages/docs/src/remotion/Article.tsx | Adds conditional Arrow preview rendering for Arrow articles; switches logo asset to staticFile() for deterministic rendering. |
| packages/docs/docs/shapes/arrow.mdx | Adds image: frontmatter pointing to the generated card asset. |
| packages/docs/docs/shapes/make-arrow.mdx | Adds image: frontmatter pointing to the generated card asset. |
| packages/docs/static/generated/articles-docs-shapes-arrow.png | New generated docs card image for the Arrow article. |
| packages/docs/static/generated/articles-docs-shapes-make-arrow.png | New generated docs card image for the makeArrow article. |
Co-authored-by: bhaktofmahakal <[email protected]>
Co-authored-by: bhaktofmahakal <[email protected]>
Co-authored-by: bhaktofmahakal <[email protected]>
…tribute-again' into bhaktofmahakal/vercel-fix-docs-lambda
Contributor
Author
waiting for merge. |
JonnyBurger
requested changes
Mar 2, 2026
Member
JonnyBurger
left a comment
There was a problem hiding this comment.
Hmm, this is too random.
Cards do not look good and there seem other, unrelated changes.
Either reduce it to 1 thing at a time, otherwise I cannot accept the PR.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces improvements to the documentation site and a minor configuration update for the Lambda package. The main focus is on enhancing the visual presentation of the Arrow shape documentation by adding preview images and interactive previews. Additionally, a small TypeScript configuration change is made to the Lambda package.
Documentation site enhancements:
arrow.mdxandmake-arrow.mdxdocumentation files for better visual context. [1] [2]Articlecomponent inArticle.tsxto display an interactive<Arrow />preview in the header for Arrow-related articles, using specific layout adjustments for these previews. [1] [2] [3] [4]staticFilehelper for consistency and improved asset management.Configuration update:
"types": ["node"]to thetsconfig.jsonof the Lambda package to ensure Node.js types are available during compilation.Replaced external docs card logo URL with local staticFile('img/remotion-white.png') to make card rendering deterministic in CI/Vercel.Regenerate affected arrow docs cards under packages/docs/static/generated/.
Add "types": ["node"] in packages/lambda/tsconfig.json to avoid unrelated ambient @types/* packages causing TS declaration build errors (TS1540 seen with @types/revalidator).
Screenshot :