Enforce canonical QDoc structure and frontmatter conformance for documentation topics.
npx skills add https://github.com/qt/qtqa --skill skill-qdoc
Please help me install this Agent Skill. Skill: skill-qdoc Source: https://github.com/qt/qtqa/tree/main/documentation_review/skills/skill-qdoc Command: npx skills add https://github.com/qt/qtqa --skill skill-qdoc
QDoc documentation often suffers from inconsistent conventions across modules, making cross‑module linking and navigation error‑prone. This Skill provides a canonical reference for QDoc internals (node system, link resolution, index files, and qdocconf guidelines) to standardize how documentation is described and discovered.
Describe QDoc internals with canonical commands and best practices for your module using this Skill.
High-intent search queries and answers about installing and using this skill.
QDoc link resolution relies on a node system and index files to standardize cross-module navigation. Enforcing canonical structure and frontmatter conformance ensures accurate linking and reliable AI-assisted retrieval across C++ and QML.
Configuring qdocconf files involves following canonical reference guidelines for index files, macros, and Qt Help architecture. This standardizes how documentation topics are described, indexed, and discovered across your module.
Yes, QDoc supports documentation generation for both C++ and QML projects. It enforces mandatory companions and section templates to ensure accurate topic discovery and consistent structural conventions across both environments.
QDoc index files fail to resolve links when documentation lacks canonical structure and frontmatter conformance. Enforcing mandatory companions and section templates standardizes topic indexing to support accurate cross-module navigation and reliable retrieval.
You need QDoc context commands and macros when building or troubleshooting documentation pages to enforce canonical structure. They standardize how topics are described and indexed, supporting accurate discovery across C++ and QML modules.
qtRoute QDoc-annotated C++ and QML files through Vale linting with scopes and code block exclusions.
qtIdentify cross-product documentation breakages from Qt module changes.
qtDocument Qt export and QML registration macros for API visibility.
yfyang86Apply Dennis Ritchie's mental models to system design and language architecture decisions.
