[1/2] fix: remove every dead link from the API reference - #152
Merged
Merged
Conversation
|
🎉 This PR is included in version 1.20.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
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 toVideoAsset, which documentstranscode.#render-video(Get Asset by Render ID) now points to#render-asset, the endpoint's current name.RichTextBorderandRichTextPaddingare registered as components. The rich-text tables linked to sections widdershins never generated.External:
{version}placeholder, so they're shown as code instead of links (abuild-docs.shrewrite of widdershins's server list).diskproperty drops its link to the removed disk-types guide.Published package: zod adds
richTextBorderSchemaandrichTextPaddingSchema. Nothing is removed or renamed, and validation ofborderandpaddingis unchanged across 32 test inputs.schema.d.tsand the JSON Schema gain the two named types. As afix:, merging releases a patch.tests/reference-links.cjsfails 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)