Skip to content

[1/2] fix: remove every dead link from the API reference - #152

Merged
dazzatronus merged 1 commit into
mainfrom
derk/reference-dead-links
Sep 30, 2026
Merged

dazzatronus merged 1 commit into
mainfrom
derk/reference-dead-links

Conversation

@dazzatronus

@dazzatronus dazzatronus commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

The API reference had eleven dead links: four in-page links to sections that don't exist, and seven external ones that fail.

In-page:

  • #preprocessing (Render Asset) now points to VideoAsset, which documents transcode.
  • #render-video (Get Asset by Render ID) now points to #render-asset, the endpoint's current name.
  • RichTextBorder and RichTextPadding are registered as components. The rich-text tables linked to sections widdershins never generated.

External:

  • The three base URLs contain a {version} placeholder, so they're shown as code instead of links (a build-docs.sh rewrite of widdershins's server list).
  • The expired signed-URL example on Direct Upload is shown as code.
  • The deprecated disk property drops its link to the removed disk-types guide.
  • Mux and Akamai NetStorage point to the vendors' current docs.

Published package: zod adds richTextBorderSchema and richTextPaddingSchema. Nothing is removed or renamed, and validation of border and padding is unchanged across 32 test inputs. schema.d.ts and the JSON Schema gain the two named types. As a fix:, merging releases a patch.

tests/reference-links.cjs fails on any in-page link without a target and any link to a placeholder URL. External links were checked once: all 47 now load.

Verify: pnpm build:docs && node tests/reference-links.cjs.

Merge with a merge commit, not a squash, so this fix: reaches the release notes.

Stack (merge in order)

PR Adds Why it is separate
1/2 ← this PR #152 Removes every dead link from the reference A fix: patch release
2/2 #153 Deprecates the Mux and TikTok destinations A deprecation, released as a minor version; edits the same Mux description

@dazzatronus dazzatronus changed the title fix: remove every dead link from the API reference [1/2] fix: remove every dead link from the API reference Sep 30, 2026
@dazzatronus
dazzatronus merged commit 814f793 into main Sep 30, 2026
1 check passed
@dazzatronus
dazzatronus deleted the derk/reference-dead-links branch September 30, 2026 01:54
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 1.20.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant