skills.rest
mims-harvard
mims-harvardOFFICIAL
Explore all skills by this author →
Website𝕏@marinkazitnikGitHub

devtu-docs-quality

Validate and audit ToolUniverse documentation quality with Python scripts.

1.6k|244|Updated Mar 3, 2025
Search Tags:#automation#documentation#python#validation#audit#tooluniverse
One-click install
npx skills add https://github.com/mims-harvard/ToolUniverse --skill devtu-docs-quality
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: devtu-docs-quality
Source: https://github.com/mims-harvard/ToolUniverse/tree/main/skills/devtu-docs-quality
Command: npx skills add https://github.com/mims-harvard/ToolUniverse --skill devtu-docs-quality

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the validation and auditing of documentation quality within ToolUniverse projects, reducing manual review time and surfacing issues early.

Core Features & Use Cases

  • Automated validation: reusable Python scripts for detecting deprecated commands, inconsistent terminology, broken links, and other common documentation problems.
  • ToolUniverse-specific audits: circular navigation checks, MCP configuration duplication detection, tool count standardization, and auto-generated header verification.
  • CI/CD integration guidance: recommended hooks and steps to regenerate docs and validate changes as part of a PR workflow.

Quick Start

Run the validation workflow to audit your docs: python scripts/validate_documentation.py

Frequently Asked Questions about devtu-docs-quality

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

FAQPage Schema
How do I automate documentation quality checks for a Python project?▼

Automate documentation quality checks by running a Python validation script to detect deprecated commands, inconsistent terminology, and broken links. This enforces patterns and collects actionable results for pre-release reviews and ongoing governance.

What documentation issues can automated validation scripts detect?▼

Automated validation scripts detect common documentation problems including deprecated commands, inconsistent terminology, broken links, circular navigation, and MCP configuration duplication, enabling rapid detection of issues across multiple formats.

How do I audit ToolUniverse documentation for circular navigation and configuration duplication?▼

Audit ToolUniverse documentation by running ToolUniverse-specific audits that perform circular navigation checks, MCP configuration duplication detection, tool count standardization, and auto-generated header verification.

Can I integrate documentation validation into my CI/CD pipeline?▼

You can integrate documentation validation into CI/CD pipelines using recommended hooks and steps to regenerate docs and validate changes as part of a PR workflow, ensuring ongoing documentation governance.

What's the best way to enforce documentation standards during a pre-release review?▼

The best way to enforce standards during pre-release reviews is running a reusable Python validation script that targets ToolUniverse-specific audits, surfacing issues early and reducing manual review time.

Do I need Python to run documentation audits for ToolUniverse projects?▼

Yes, you need Python to run the documentation audits for ToolUniverse projects. The validation workflow is executed via a reusable Python script, specifically invoking scripts/validate_documentation.py to collect results.

Related Skills

Explore More Content & Communication Skills→
CentauriounCentaurioun

devtu-docs-quality

Detect and correct incorrect, outdated, and redundant documentation in ToolUniverse repositories.

Community
Advanced
EojEdredEojEdred

audit-dev01

Audits governance proposals against bylaws for compliance gaps and misalignments.

Community
Intermediate
sandmark78sandmark78

knowledge-filler

Generate Markdown knowledge-point entries for a domain and range.

Community
Intermediate
Norman-Norman-NormanNorman-Norman-Norman
7

editor

Analyze documentation text for grammar, style, and factual accuracy.

Official
Basic