Skip to content

Docs: Fix broken source code links in the Lambda docs - #12630

Merged
JonnyBurger merged 3 commits into
remotion-dev:mainfrom
DeryFerd:docs/lambda-source-links
Oct 29, 2026
Merged

JonnyBurger merged 3 commits into
remotion-dev:mainfrom
DeryFerd:docs/lambda-source-links

Conversation

@DeryFerd

Copy link
Copy Markdown
Contributor

Summary

The Lambda docs pages end with a "Source code for this function" link pointing at the file that implements the function on GitHub. 15 of the 33 GitHub links across the 75 pages under packages/docs/docs/lambda point to paths that no longer exist on main, so they land on a 404. #12454 fixed the one broken link on the validateWebhookSignature() page; this PR fixes the remaining 15.

14 of the 15 are the same breakage: the Lambda API surface moved from packages/lambda/src/api/ into packages/lambda-client/src/, and the links kept the old prefix. Every one of them has an exact counterpart in the new location, so each fix is a one-line URL swap. The affected files are app-router-webhook.ts, delete-function.ts, delete-render.ts, estimate-price.ts, express-webhook.ts, get-aws-client.ts, get-compositions-on-lambda.ts, get-functions.ts, get-render-progress.ts, get-sites.ts, pages-router-webhook.ts, presign-url.ts, render-still-on-lambda.ts and speculate-function-name.ts.

The last one is a stale asset path: the cost example page links packages/example/public/bigbuckbunny.mp4, but the video lives at packages/example-videos/videos/bigbuckbunny.mp4. Nothing else in the diff: no rewording, no reordering, exactly one line changes per page.

Validation

I enumerated every github.com/remotion-dev/remotion/blob/main/ link on the 75 lambda docs pages with a small script and checked each target against the repository, instead of sampling a few pages. The script strips anchors and query strings before the existence check, so a URL like file.ts#L1-L3 is not counted as a missing file.

  • Before the change: 33 links total, 15 broken. After: 33 links total, 0 broken.
  • Each of the 14 replacement paths was verified to exist on main before the swap (packages/lambda-client/src/<file> for the moved files), as was packages/example-videos/videos/bigbuckbunny.mp4 for the asset link.
  • bun .github/scripts/check-docs-available-from.ts exits 0 over 1239 docs pages.
  • The diff is exactly 15 files with one changed line each (+15/−15), all under packages/docs/docs/lambda/.

Tradeoffs

These links can rot again the next time a file moves. I kept the diff to the URL fixes so the change stays a five-minute review, and the docs build only catches broken page links, not broken GitHub source links, so a small link checker in CI would be the durable fix if you want one later.

@vercel

vercel Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated
bugs Ready Ready Preview Oct 29, 2026 8:22am UTC
remotion Ready Ready Preview Oct 29, 2026 8:22am UTC

Request Review

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ No new issues found.

Reviewed changes

Documentation-only fix that repoints stale GitHub source links on the Lambda docs pages.

  • Moved API source links — 14 lambda pages now point at packages/lambda-client/src/<file>.ts instead of the removed packages/lambda/src/api/<file>.ts.
  • Cost example asset — cost-example.mdx now links packages/example-videos/videos/bigbuckbunny.mp4 instead of the old packages/example/public/ path.

I verified each new target resolves on the branch: all 14 files exist under packages/lambda-client/src/, packages/example-videos/videos/bigbuckbunny.mp4 exists, and the 11 remaining packages/lambda/src/api/ links left untouched (e.g. deploy-function.ts, get-regions.ts, iam-validation/*) still resolve, so none were missed. The author's claim of 33 total links / 0 broken after the change holds up.

Pullfrog  | View workflow run | Using deepseek-v4.1-flash | 𝕏

@JonnyBurger
JonnyBurger merged commit 3e2a2e1 into remotion-dev:main Oct 29, 2026
18 checks passed

This branch was successfully deployed

2 active deployments
Preview – remotion — 25a46892 Deployed Oct 29, 2026 by vercel[bot]
Preview – bugs — 25a46892 Deployed Oct 29, 2026 by vercel[bot]
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