Agent skill

Check Docs Style

by nrwl in nrwl/nx

Check modified Nx documentation pages against the astro-docs style guide.

MITAuto-check passedFrontend & Design

Install Check Docs Style

skills CLI
$ npx skills add nrwl/nx --skill check-docs-style -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install nrwl/nx check-docs-style --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/nrwl/nx.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/check-docs-style .claude/skills/check-docs-style && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
check-docs-style
GitHub stars
29k
Token cost
~1.3k tokens
SKILL.md length
663 words
Files
1
Skills in repo
21
Repo updated
First seen
Licence
MIT

At a glance

Check modified Nx documentation pages against the astro-docs style guide.

  • Works in 2 steps: Information architecture audit → Style validation
  • Editing docs content in the nx repo
  • SKILL.md covers Phase 1: Information…, Phase 2: Style validation and Output summary
  • Calls nx

What it does

Check Docs Style is an agent skill from nrwl/nx. Check modified Nx documentation pages against the astro-docs style guide. Auto-trigger after writing or editing docs content in the nx repo. Also trigger on "check style", "style guide", "docs review", "validate docs". Should run as a final step whenever docs files are modified. IMPORTANT: anytime astro-docs//.mdoc files are modified, this should always run automatically without being asked.

Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Frontend & Design, covering Static sites and blogs. It works with Astro. The repository describes itself as: The Monorepo Platform that amplifies both developers and AI agents. Nx optimizes your builds, scales your CI, and fixes failed PRs automatically. Ship in half the time. The licence is MIT.

When your agent uses it

  • Editing docs content in the nx repo
  • Tasks that involve Static sites and blogs

Example prompts

  • “check style”
  • “style guide”
  • “docs review”
  • “/check-docs-style”

Requirements

  • Pre-approved tools (allowed-tools): Read, Glob, Grep

Workflow steps

2 steps, taken from the step headings in SKILL.md.

  1. Information architecture audit
  2. Style validation

What it can do on your machine

Read from SKILL.md and the folder at commit db71d69. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Read
    • Glob
    • Grep

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • nx

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Check Docs Style loads about 1.3k tokens when it runs. Until then it costs about 104 tokens; SKILL.md has 663 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~104
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from nrwl/nx at commit db71d69, republished under its MIT licence (© nrwl). 663 words, ~1,315 tokens.

Download SKILL.mdSave it as .claude/skills/check-docs-style/SKILL.md (or your agent's skills folder).
name
check-docs-style
description
Check modified Nx documentation pages against the astro-docs style guide. Auto-trigger after writing or editing docs content in the nx repo. Also trigger on "check style", "style guide", "docs review", "validate docs". Should run as a final step whenever docs files are modified. IMPORTANT: anytime astro-docs/**/*.mdoc files are modified, this should always run automatically without being asked.
allowed-tools
Read, Glob, Grep

Nx docs style check

You are a documentation editor for Nx. Whenever you detect that the user is writing or editing documentation files in astro-docs/src/content/ (.mdoc, .mdx, .md), automatically run this check and fix any issues. Do not wait to be asked.

Phase 1: Information architecture audit

Read astro-docs/STYLE_GUIDE.md (the "Information architecture" section) and astro-docs/sidebar.mts to understand where the page lives in the sidebar hierarchy.

For every new or moved page, evaluate against ALL SEVEN principles. These are non-negotiable:

1. Progressive disclosure ("journey" rule)
  • Is this for the first 30 minutes (Getting Started), first 30 days (Features), or forever (Reference)?
  • Flag if the content complexity doesn't match the section's experience level.
2. Category homogeneity ("scan" rule)
  • Look at sibling pages in the same sidebar section.
  • Do they all share the same content type (concepts, tasks, or products)?
  • Flag if this page mixes types that siblings don't.
3. Type-based navigation ("intent" rule)
  • Is this a learning page (narrative/guide) or a lookup page (reference/API)?
  • Flag if it's in the wrong category (e.g., a reference page in a guides section).
4. Pen and paper test ("theory" rule)
  • Can the page be explained using only pen and paper (no terminal needed)?
  • YES = belongs in "How Nx Works" (architecture/concepts)
  • NO (needs terminal/code examples) = belongs in "Platform Features" or "Technologies"
  • Flag if a concept page has terminal output, CLI commands, or code-heavy examples.
5. Universal vs. specific ("placement" rule)
  • Does this feature apply to every Nx user?
  • YES = "Platform Features"
  • NO (only React/Angular/etc. users) = "Technologies"
  • Flag if a technology-specific page is in Platform Features or vice versa.
6. Golden path ("one way" rule)
  • Does the page teach one default workflow, or does it enumerate flags and variants?
  • Flag sentences a first-time user needs neither to succeed nor to choose. Those belong in a Knowledge Base guide.
7. One page per feature ("don't make me hunt" rule)
  • List the questions a new reader, or an AI answering for one, would ask about this feature.
  • Flag any answer that lives only on another page. The feature page should carry the question even when the detail fans out to a Knowledge Base guide.
  • This is the counterweight to principle 6, not an exception to it: trim variants, keep decisions.

Phase 2: Style validation

Show full SKILL.md (289 more words)Show less
Step 1: Run Vale and fix errors

Run nx run astro-docs:vale to check the modified files.

  • errors — fix these automatically. Edit the file to resolve the violation.
  • warnings — fix these automatically when the fix is unambiguous (e.g., sentence case headings). For ambiguous cases, suggest the fix and ask.
  • suggestions — mention them to the user but do not auto-fix.
Step 2: Apply the guide by hand (Vale covers only a subset)

Vale enforces only the mechanical rules, and even the ones it implements are partial. A clean Vale run is not evidence the guide passed. Reading the guide is also not enough; you have to test your changed text against each rule.

For the diff you just made:

  1. Run the guide's own "Pre-publish pass order" end to end, in order, on your changed text. Where a pass is a procedure (a grep, a count, a rewrite), perform it on your text rather than just confirming the pass exists.
  2. Then go through the rest of STYLE_GUIDE.md rule by rule, checking your changed lines against every rule the pass order did not already cover. A rule counts as checked only after you've read your actual sentences through it, not after you've read the rule.
  3. Fix every violation. If a rule genuinely doesn't apply to this change, move on.
Handling false positives

Use inline Vale comments to suppress legitimate exceptions:

markdown
<!-- vale Nx.Headings = NO -->

## extractLicenses

<!-- vale Nx.Headings = YES -->

Common cases where suppression is appropriate:

  • CLI option headings (e.g., ## extractLicenses) — camelCase by design. Prefer wrapping in backticks first (## \extractLicenses``).
  • Product possessives in historical/migration context (e.g., "Angular's original schematic system")
  • Terminology in migration docs (e.g., explaining what "schematics" were before being renamed)

Do NOT suppress rules just to avoid fixing real violations.

Output summary

After fixing, report what you did:

## Style check results

### Information architecture: [PASS/FAIL]
[List any violations or confirm all seven principles pass]

### Vale: [X errors fixed, Y warnings fixed, Z suggestions noted]
[Summary of changes made]

### Manual fixes: [list of additional fixes applied]

© nrwl, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .claude/skills/check-docs-style of nrwl/nx.

Open the folder on GitHubat commit db71d69

Compare with similar skills

Check Docs Style next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Check Docs Style compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Check Docs Style this skillnrwl/nx29k—~1.3kAutomated safety check: PassMIT
Doc Writermicrosoft/aspire.dev196—~7.6kAutomated safety check: PassMIT
Tabler Astro Dev Servertabler/tabler42k—~1.2kAutomated safety check: PassMIT
Tabler Astro Component Scriptstabler/tabler42k—~2.1kAutomated safety check: PassMIT
Kill AI Slopyetone/kill-ai-slop1.3k—~1.4kAutomated safety check: PassApache-2.0
Motion Dev Animations199-biotechnologies/motion-dev-animations-skill1141 repos~2.8kAutomated safety check: NotesMIT

Similar skills

  • Doc Writer

    microsoft/aspire.dev

    Official

    Guidelines for producing accurate and maintainable documentation for the Aspire documentation site.

    196 GitHub stars~7.6k tokensUpdated yesterday
    Frontend & DesignAuto-check passed
  • Starts the right Tabler dev server, keeps it from clashing with builds and verifies changes in the browser before a page or component is handed back.

    42k GitHub stars~1.2k tokensUpdated yesterday
    Frontend & DesignAuto-check passed
  • Rules for adding or fixing client-side scripts in Tabler's Astro components so the copied preview HTML stays readable, self-contained and runs in the right order.

    42k GitHub stars~2.1k tokensUpdated yesterday
    Frontend & DesignAuto-check passed
  • Kill AI Slop

    yetone/kill-ai-slop

    Find and remove AI slop — the generic, machine-default visual and copy tics of vibe-coded products — from a web project.

    1.3k GitHub stars~1.4k tokensUpdated 24 days ago
    Frontend & DesignAuto-check passed
  • Motion Dev Animations

    199-biotechnologies/motion-dev-animations-skill

    Creates 120fps GPU-accelerated animations with Motion.dev (Framer Motion successor) for React, Next.js, Svelte, and Astro projects.

    114 GitHub starsUsed in 1 repo~2.8k tokens
    Frontend & DesignAuto-check: notes
  • Astro

    devantler-tech/ksail

    Skill for building with the Astro web framework. An agent skill from devantler-tech/ksail.

    165 GitHub starsUsed in 3 repos~1.1k tokens
    Frontend & DesignAuto-check passed
  • Monitor CI

    nrwl/nx

    Monitor Nx Cloud CI pipeline and handle self-healing fixes. An agent skill from nrwl/nx.

    29k GitHub starsUsed in 6 repos~4.7k tokens
    Auto-check passed
  • Nx Import

    nrwl/nx

    Import, merge, or combine repositories into an Nx workspace using nx import.

    29k GitHub starsUsed in 6 repos~3.5k tokens
    Auto-check passed
  • Run Nx generators with prioritization for workspace-plugin generators.

    29k GitHub starsUsed in 2 repos~592 tokens
    Auto-check: notes
  • Author or scope a first-party Nx migration. An agent skill from nrwl/nx.

    29k GitHub stars~12k tokensUpdated today
    Auto-check: notes
  • Generate code using nx generators. An agent skill from nrwl/nx.

    29k GitHub starsUsed in 1 repo~2.2k tokens
    Auto-check passed
  • Sync docs commits from master out to the live docs branches in the nx repo: cherry-picks docs( / feat(nx-dev) commits onto website-<major AND the latest <major.<minor.x release branch.

    29k GitHub stars~1.2k tokensUpdated today
    Auto-check passed

Works with

Questions about Check Docs Style

What does Check Docs Style do?

Check modified Nx documentation pages against the astro-docs style guide. Check Docs Style is an agent skill from nrwl/nx. Check modified Nx documentation pages against the astro-docs style guide.

When should I use Check Docs Style?

Check Docs Style fits situations like: editing docs content in the nx repo; tasks that involve Static sites and blogs.

How do I install Check Docs Style in Claude Code?

Run `npx skills add nrwl/nx --skill check-docs-style -a claude-code`. Or copy the skill folder (.claude/skills/check-docs-style in nrwl/nx) into .claude/skills/check-docs-style in your project. Claude Code loads it when a task matches its description.

How do I install Check Docs Style in Codex?

Run `npx skills add nrwl/nx --skill check-docs-style -a codex`. Or copy the skill folder (.claude/skills/check-docs-style in nrwl/nx) into .agents/skills/check-docs-style in your project. Codex loads it when a task matches its description.

Can I use Check Docs Style in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add nrwl/nx --skill check-docs-style -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/check-docs-style, .gemini/skills/check-docs-style, .github/skills/check-docs-style and .opencode/skills/check-docs-style in your project.

What does Check Docs Style need to run?

Going by SKILL.md and its folder, Check Docs Style needs the command-line tools its instructions call (nx). Its frontmatter pre-approves these tools: Read, Glob, Grep.

Does Check Docs Style access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Check Docs Style safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Check Docs Style use?

Check Docs Style is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Check Docs Style use?

About 1.3k tokens (SKILL.md is roughly 5.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Check Docs Style?

Skills that share tags, products or a category with Check Docs Style: Doc Writer (microsoft/aspire.dev, 196 stars), Tabler Astro Dev Server (tabler/tabler, 42k stars), Tabler Astro Component Scripts (tabler/tabler, 42k stars) and Kill AI Slop (yetone/kill-ai-slop, 1.3k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Check Docs Style?

nrwl (a GitHub organization) maintains it in nrwl/nx, which has 29,399 GitHub stars. The repository holds 21 skills in this directory. The repository was last updated on October 9, 2026.

Source: nrwl/nx on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.