check-resources

Validate and correct resource sections in documentation files.

78|252|Updated Feb 7, 2024
One-click install
npx skills add https://github.com/hashicorp/web-unified-docs --skill check-resources
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: check-resources
Source: https://github.com/hashicorp/web-unified-docs/tree/main/content/well-architected-framework/docs/.claude/skills/check-resources
Command: npx skills add https://github.com/hashicorp/web-unified-docs --skill check-resources

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps ensure documentation resources sections are consistently formatted, with clear link descriptions and logical organization, reducing review cycles and reader confusion.

Core Features & Use Cases

  • Link Description Validation: Enforces descriptive, action-oriented link text and proper context placement.
  • Organization & Grouping: Guides whether to use flat lists or grouped subsections to improve navigability.
  • Auto-Fix & Validation: Offers auto-fixes for common issues and dry-run checks to surface changes before applying.

Quick Start

Use the /check-resources skill to validate and fix resources in docs (e.g., /check-resources docs/**/*.mdx) and generate a report for review.

Frequently Asked Questions about check-resources

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

FAQPage Schema
How do I validate and auto-fix resource links in markdown documentation?

You can validate documentation resources by running a dedicated linter that targets single-file and multi-file reviews to ensure consistent link descriptions and proper organization, generating a report of necessary changes.

What is the best way to enforce consistent formatting for resource sections in docs?

Enforcing consistent formatting for documentation resource sections requires an automated validation process that targets link descriptions and organizational grouping, reducing review cycles and ensuring logical structure for reader navigability.

Can I check multiple markdown files for broken links and formatting issues at once?

Yes, you can validate multiple markdown files simultaneously by passing file path patterns like `docs/**/*.mdx` to the linter, which performs multi-file reviews to ensure consistent link descriptions and proper organization across the entire documentation set.

Does auto-fixing documentation resources modify files directly or just report errors?

Auto-fixing documentation resources offers two modes: an auto-fix mode that modifies files directly to apply corrections, and a report-only mode that surfaces necessary changes as a dry-run check without modifying the original files.

Why do my documentation links fail formatting checks during code review?

Documentation links fail formatting checks when they lack descriptive, action-oriented link text or proper context placement; running a validation linter identifies these structural issues and enforces organizational rules before the review cycle.

Are there limitations to linting tools that validate markdown resource sections?

Limitations of linting tools for markdown resource sections include strict reliance on predefined formatting rules like AGENTS.md, meaning they enforce structural consistency and link descriptions rather than verifying if the external URLs themselves are live or resolving correctly.