fix(restapi): resolve broken markdown link breaking prod build#190
Merged
Conversation
The link in restendpoints.md (line 1386) used the `restapi/` plugin prefix, which points outside the restapi docs plugin and fails to resolve. With `onBrokenMarkdownLinks: 'throw'` this aborted the production build/deploy. Make it relative to the plugin like every other link in the file. Fixed in both the live and versioned (2.28.0) copies.
ecunado
force-pushed
the
fix/restapi-2.28-broken-link
branch
from
7d9a1af to
1e61a78
Compare
cmg91
approved these changes
Jun 30, 2026
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
2 participants
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.
Problem
The production deploy (
dev→main) failed atyarn deploy:Failed run
Cause
Within a docs plugin, links must be relative to the plugin itself. Line 1386 used the
restapi/prefix, which points outside the plugin and fails to resolve. WithonBrokenMarkdownLinks: 'throw'this aborts the entire build. Introduced in03a3924 restApi v2.28.Fix
Applied to both the live file and the versioned (2.28.0) copy.
Verification
Local
yarn build(with lockfile deps) →[SUCCESS] Generated static files. The remaining broken anchors are pre-existing warnings only and do not block the deploy.