skill-cross-product-check

Identify cross-product documentation breakages from Qt module changes.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Cross-product Reference Check identifies potential breakages in downstream Qt products caused by documentation changes in a single module, enabling preemptive fixes and safer releases.

Core Features & Use Cases

  • Verify cross-product documentation references across doc.qt.io, doc-snapshots.qt.io, and qt.io marketing pages.
  • Report verified snapshot paths, index file availability, and per-product link mechanisms to guide remediation.
  • Support changes such as page rename, title change, filename change, API rename, and QML type rename to assess impact.

Quick Start

Run this skill during a documentation change review to audit cross-product reference impacts across Qt documentation.

Frequently Asked Questions about skill-cross-product-check

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

FAQPage Schema
How do I check for cross-product documentation breakages before a Qt module release?

Downstream Qt product documentation breakages occur when module changes rename pages, titles, filenames, APIs, or QML types. Identifying these reference changes early prevents broken links and ensures safer releases across doc.qt.io and marketing pages.

How do I verify cross-product documentation references after an API rename?

Verify cross-product documentation references by running an audit during the documentation change review. This generates a prioritized verification workflow reporting snapshot paths, index file availability, and per-product link mechanisms to guide remediation.

Does cross-product verification support doc-snapshots.qt.io and qt.io marketing pages?

Yes, cross-product verification supports doc-snapshots.qt.io and qt.io marketing pages alongside doc.qt.io. It assesses reference impacts from module changes across these platforms to document and help fix downstream breakages.

What is the best way to track QML type renames across Qt documentation?

The best way to track QML type renames is applying a cross-product reference check across Qt documentation properties. This audits affected links, verifies snapshot paths, and outputs a prioritized workflow to remediate broken references.

What limitations exist when verifying cross-product documentation links for Qt modules?

Verification is limited to assessing page renames, title changes, filename changes, API renames, and QML type renames. It reports per-product link mechanisms and index availability, but does not automatically fix the broken references it discovers.