check-style

Validate Markdown documentation style and Phase 4 formatting compliance.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides fast, lightweight validation of documentation style to ensure Phase 4 compliance during authoring and PR reviews.

Core Features & Use Cases

  • Pre-commit style checks: quickly validate AGENTS.md and related docs before commits.
  • Consistent tone and structure: enforce formatting, bolding, and section ordering for reliable docs.
  • Quick feedback loop: delivers concise reports to speed up editing workflows.

Quick Start

Run the check-style command on your Markdown files to identify and fix style issues, for example: /check-style docs/**/*.mdx --fix

Frequently Asked Questions about check-style

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

FAQPage Schema
How do I validate markdown documentation style for pre-commit checks?

You can validate markdown documentation style by running a lightweight style check on your files before commits. This enforces consistent formatting, heading capitalization, and meta descriptions alignment to ensure Phase 4 compliance.

Can I auto-fix markdown formatting issues during PR reviews?

Yes, you can auto-fix markdown formatting issues by invoking the style check with the --fix flag. This automatically corrects bold formatting and section ordering problems to streamline PR reviews.

What is the best way to enforce consistent heading capitalization in markdown docs?

The best way to enforce consistent heading capitalization is to use an automated documentation linter. It quickly validates your markdown files and delivers concise reports to speed up your editing workflow.

Does pre-commit documentation linting work with AGENTS.md files?

Yes, pre-commit documentation linting works directly with AGENTS.md and related markdown files. It provides a quick feedback loop to validate Phase 4 formatting compliance during local authoring.

Why does my markdown documentation fail Phase 4 formatting compliance?

Markdown documentation fails Phase 4 formatting compliance when it violates lightweight rules such as meta descriptions alignment, heading capitalization, and bold formatting. Running a style check identifies these specific issues.

What are the limitations of lightweight markdown style validation?

Lightweight markdown style validation focuses strictly on Phase 4 formatting compliance, bold formatting, and section ordering. It does not perform deep semantic analysis or validate complex technical accuracy outside its specific rule set.