Skip to content

Correct link resolution and add a step-by-step link fixer - #417

Merged
selectiveduplicate merged 2 commits into
wso2:apim-doc-migrationfrom
Dimagidhp:update-doc-validation-skill
Aug 7, 2026
Merged

Correct link resolution and add a step-by-step link fixer#417
selectiveduplicate merged 2 commits into
wso2:apim-doc-migrationfrom
Dimagidhp:update-doc-validation-skill

Conversation

@Dimagidhp

Copy link
Copy Markdown
Contributor

Purpose

Fixes three link-resolution bugs in the doc validation skill. Also adds fix_links.py to apply a fix plan one group at a time.

Checklist

  • llms.txt — N/A, no doc pages in this PR
  • Image alt text — N/A, no doc pages in this PR
  • Frontmatter — N/A, no doc pages in this PR

Goals

Make "no broken links" mean it, and make applying link fixes reviewable.

Approach

  • Resolve links the way mkdocs does; apply fixes one verified group at a time.

Release note

Doc validation skill: corrected link resolution to match mkdocs, added detection of
anchors the build never generates, and added a step-by-step link fixer.

Documentation

SKILL.md and references/conventions.md, in this PR.

Security checks

  • Secure coding standards? yes
  • FindSecurityBugs? N/A — Python
  • No keys, passwords, tokens or secrets? yes

@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: fdf94234-7db4-4896-9dfa-2092a97aa531

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

# Tag name is captured so an `<a href>` is reported as a broken LINK and an
# `<img src>` as a missing IMAGE. Lumping them together mislabels every raw-HTML
# link as an image, which sends whoever reads the report looking for the wrong thing.
HTML_SRC = re.compile(r'<(img|a|source|iframe)[^>]+(?:src|href)="([^"]+)"')

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The regex requires double-quotes to be used, but what if single quotes are used? So it's better to watch out for both.

@selectiveduplicate
selectiveduplicate merged commit 36a0128 into wso2:apim-doc-migration Aug 7, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants