DX-2362: Fix 163 broken internal anchor fragment links - #1866
Closed
sharadregoti wants to merge 2 commits into
Closed
DX-2362: Fix 163 broken internal anchor fragment links#1866sharadregoti wants to merge 2 commits into
sharadregoti wants to merge 2 commits into
Conversation
Fixes all broken anchor fragments identified by the CI anchor checker introduced in DX-2361 (#1865). Root causes fixed: - Release note anchors: old slugify removed dots from version numbers (e.g. 5.3.0 → #530-release-notes); updated to dot-to-hyphen format (#5-3-0-release-notes) across gateway, dashboard, helm-chart, operator, portal, and archived release note pages - Restructured pages: logs-metrics, portal/install, and tyk-self-managed/install were reorganised; removed or updated stale anchors to current headings - Moved content: JWT signature validation content moved to dedicated page; updated links from json-web-tokens to jwt-signature-validation - Wrong anchor names: fixed typos and outdated anchors in implement-tls, certificates, mdcb, graphql, dynamic-client-registration, dashboard-config - Mintlify slug nuance: headings with ": " generate double hyphens (--); fixed portal step links and other colon-containing headings - Validator: updated heading regex to detect headings inside ordered list items (pattern used in troubleshooting-debugging.mdx) Result: 0 broken anchor fragments (was 163 across 60 files) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Failed to generate code suggestions for PR |
… hyphen
Corrects a wrong assumption in the previous commit: Mintlify omits ':'
from headings entirely (like '()[]/?!'), so 'Step 1: Create' generates
'step-1-create' not 'step-1--create'.
Changes:
- slugify_heading: add ':' to the removal regex alongside '()[]/?!'
- Revert portal step anchors from '--' back to single '-'
- Revert rate-limit scope anchor (': API-level' → '-api-level' not '--api-level')
- Fix custom-developer-portal anchor (only one '--' from '.', not from ':')
- Fix mutual-tls anchor: 'mTLS): Two-Way' → 'mtls-two-way' (single hyphen)
- Fix portal/install docker anchor: 'Installation: Docker' → 'installation-docker'
Result: 0 broken anchor fragments
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
1 participant
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.
Jira Ticket
DX-2362
Summary
Root Causes Fixed
Release note anchors (old format → new format with dots-as-hyphens)
Old slugify removed dots from version numbers (
5.3.0→#530-release-notes); correct format is#5-3-0-release-notes. Fixed across gateway, dashboard, helm-chart, operator, portal, and archived release note pages.Restructured pages
api-management/logs-metrics.mdx,portal/install.mdx, andtyk-self-managed/install.mdxwere reorganised; stale anchors removed or updated to current headings.Moved content
JWT signature validation content moved to a dedicated page (
jwt-signature-validation.mdx); updated links that still pointed tojson-web-tokens.mdx.Wrong anchor names
Fixed typos and outdated anchors in
implement-tls,certificates,mdcb,graphql,dynamic-client-registration,dashboard-configuration, and others.Mintlify slug nuance — double hyphens from
:Headings containing
": "generate double hyphens in anchors (e.g.Step 1: Create→#step-1--create). Updated portal step links and other colon-containing headings that were using single hyphens.Validator script fix
Updated
heading_reregex to also match headings that appear inside ordered list items (the patternN. ##### Headingused extensively introubleshooting-debugging.mdx). This eliminates false positives for that file.Result
Test Plan
🤖 Generated with Claude Code