Repository navigation
docs: fix the broken x-badges and x-enumDescriptions links - #2896
Merged
Merged
Conversation
AlexVarchuk
approved these changes
Nov 10, 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
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.
What/Why/How?
3ab62e5 changed the x-badges and x-enumDescriptions links in
docs/redoc-vendor-extensions.mdto/docs/platform/author/reference/.... Those pages return 404, so thelinkcheckjob fails on every pull request tov2.x.This points both links at the current pages under
/docs/platform/content/api-docs/openapi-extensions/. The x-enumDescriptions page no longer has an "Enum Description Object" section, so that link goes to#options, which describes the same map.Reference
linkcheckfailure on #2894: https://github.com/Redocly/redoc/actions/runs/42817961780/job/129947426639Tests
mlc ./docs(v0.16.1, as in thelinkcheckjob): 0 errors, previously 2.Check yourself