ce-rtd-auditor

Audits ReadTheDocs projects for navigation, accuracy, and ADR consistency, generating severity-ranked findings.

78|15|Updated May 1, 2023
One-click install
npx skills add https://github.com/Moffran/calibrated_explanations --skill ce-rtd-auditor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ce-rtd-auditor
Source: https://github.com/Moffran/calibrated_explanations/tree/main/.claude/skills/ce-rtd-auditor
Command: npx skills add https://github.com/Moffran/calibrated_explanations --skill ce-rtd-auditor

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill helps documentation teams audit ReadTheDocs (RTD) projects for navigation, technical accuracy, audience fit, and ADR/standards consistency, reducing release risk.

Core Features & Use Cases

  • Load and apply the RTD audit checklist to a docs/ project to ensure coverage.
  • Validate navigation, index structure, toctrees, and cross-page references.
  • Verify API references and ADR links for consistency with governance standards.
  • Generate prioritized findings and actionable fixes to guide documentation improvements.

Quick Start

Run the RTD audit against your docs/ folder after loading the RTD audit checklist.

Frequently Asked Questions about ce-rtd-auditor

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

FAQPage Schema
How do I audit ReadTheDocs documentation for navigation and accuracy?

To audit ReadTheDocs documentation, load the RTD audit checklist against your docs/ folder to validate navigation, toctree references, API links, and ADRs. The audit generates prioritized findings with severity levels to guide technical documentation improvements.

What does a toctree validation check for in RTD documentation?

Toctree validation checks ReadTheDocs documentation for index structure consistency and broken cross-page references. It ensures navigation trees are properly configured and aligned with governance standards, generating severity-ranked findings supported by project references.

Can I use an RTD audit to verify ADR links and API references?

Yes, you can audit ReadTheDocs projects to verify API references and Architecture Decision Record (ADR) links for consistency with governance standards. The audit applies a checklist to changed pages and outputs actionable fixes with severity levels.

How do I generate prioritized findings for documentation release risk?

Generate prioritized documentation findings by running an RTD audit against your docs/ project. The audit evaluates technical accuracy, audience fit, and ADR alignment, outputting severity-ranked findings with actionable fixes and supporting references to reduce release risk.

Does the ReadTheDocs audit checklist work for projects without dependencies?

Yes, the ReadTheDocs audit checklist works for standard docs/ projects without requiring external dependencies. It focuses on evaluating changed pages, toctree structures, API references, and ADR consistency directly within your existing documentation files.