skill-linking-check

Detect and fix broken documentation links in QDoc references.

19|29|Updated May 6, 2013
One-click install
npx skills add https://github.com/qt/qtqa --skill skill-linking-check
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: skill-linking-check
Source: https://github.com/qt/qtqa/tree/main/documentation_review/skills/skill-linking-check
Command: npx skills add https://github.com/qt/qtqa --skill skill-linking-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Reference framework to ensure documentation links remain correct after code changes, preventing broken navigation and stale anchors.

Core Features & Use Cases

  • Cross-reference verifications across modules
  • Anchor and target resolution rules documentation
  • Cross-module dependency impact checks and change impact signaling

Quick Start

Run a link integrity review after each code change to confirm all documentation targets resolve correctly.

Frequently Asked Questions about skill-linking-check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I fix broken documentation links caused by code changes?▼

To fix broken documentation links caused by code changes, run a link integrity review to catch renamed targets, missing anchors, and cross-module link issues across QDoc references.

What is the best way to check QDoc references for missing anchors?▼

Checking QDoc references for missing anchors requires applying cross-reference verifications across modules during code reviews to ensure documentation targets resolve correctly.

Can I detect cross-module dependency impacts on documentation links during CI?▼

Yes, you can detect cross-module dependency impacts on documentation links during CI by applying this reference framework to signal change impacts and verify anchor resolution rules.

When do I need to run a documentation link integrity review?▼

You need to run a documentation link integrity review after each code change to prevent broken navigation and stale anchors in your reference framework.

Does this link checking method support YAML frontmatter for anchor rules?▼

Yes, this link checking method supports a YAML frontmatter with name and description, alongside a structured description body documenting anchor rules, link syntax, and dependency impacts.

Why are my cross-module QDoc links not resolving correctly after a refactor?▼

Cross-module QDoc links fail to resolve correctly after a refactor because renamed targets and missing anchors occur, requiring cross-reference verifications to identify and fix the broken navigation.