check-docs-style

Validates Nx documentation pages against the astro-docs style guide and information architecture rules.

29.3k|3.0k|Updated Aug 11, 2017
One-click install
npx skills add https://github.com/nrwl/nx --skill check-docs-style
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: check-docs-style
Source: https://github.com/nrwl/nx/tree/main/.claude/skills/check-docs-style
Command: npx skills add https://github.com/nrwl/nx --skill check-docs-style

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation edits in the Nx repo often drift from the astro-docs style guide and sidebar information architecture, requiring manual review cycles to catch style violations and misplaced pages.

Core Features & Use Cases

  • Information architecture audit: Evaluates new or moved pages against seven placement principles using the sidebar hierarchy in astro-docs/sidebar.mts.
  • Automated style validation: Runs nx run astro-docs:vale and fixes errors and unambiguous warnings directly in modified .mdoc, .mdx, and .md files.
  • Manual rule pass: Walks the full STYLE_GUIDE.md rule set on changed text, since Vale only covers a subset of the guide.
  • Use Case: After editing a docs page under astro-docs/src/content/, the skill automatically audits its sidebar placement, runs Vale, fixes violations, and reports a structured summary of results.

Quick Start

Check the style and information architecture of the docs pages I just modified in astro-docs.

Frequently Asked Questions about check-docs-style

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

FAQPage Schema
How do I check Nx documentation against the style guide?

Run this skill after editing docs files in astro-docs/src/content. It executes `nx run astro-docs:vale` for mechanical rules, then manually checks your changed text against every rule in STYLE_GUIDE.md and fixes violations.

How do I decide where a new Nx docs page belongs in the sidebar?

The skill audits page placement against seven information architecture principles, including progressive disclosure, category homogeneity, and the pen-and-paper test, using astro-docs/sidebar.mts to evaluate sibling pages.

Does Vale catch all style guide violations in Nx docs?

No. Vale enforces only a subset of mechanical rules, so a clean Vale run does not mean the guide passed. The skill performs an additional manual rule-by-rule pass over your changed text to catch what Vale misses.

How do I suppress false positive Vale warnings in Nx docs?

Use inline Vale comments like `<!-- vale Nx.Headings = NO -->` around legitimate exceptions such as camelCase CLI option headings. Prefer wrapping headings in backticks first, and never suppress rules just to avoid real fixes.

When does the docs style check run automatically?

It triggers automatically whenever .mdoc, .mdx, or .md files under astro-docs/src/content are created or modified, without needing to be asked, and also responds to phrases like check style or validate docs.