check-structure
OfficialKeep WAF docs consistently structured.
Authorhashicorp
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill validates WAF documentation structure against established patterns to prevent inconsistencies across AGENTS.md driven docs, improving readability and maintainability.
Core Features & Use Cases
- Why section validation: ensures a "Why [topic]" header exists with 3-4 bold challenges and a clear impact description.
- List introductions verification: enforces that lists begin with "the following" in introductions.
- Workflow connections: checks that the body text links related WAF documents to illustrate topic connections.
- Document ending order: validates the recommended sequence of sections (HashiCorp resources, External resources, Next steps) and can auto-fix order where possible.
- Auto-fix hints: provides actionable guidance for formatting improvements without content changes.
Quick Start
/check-structure docs/your-section/**/*.mdx
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: check-structure Download link: https://github.com/hashicorp/web-unified-docs/archive/main.zip#check-structure Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.