find-style-issues

Identify style issues in Markdown documentation files with Vale checks.

7|7|Updated Feb 2, 2015
One-click install
npx skills add https://github.com/giantswarm/docs --skill find-style-issues
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: find-style-issues
Source: https://github.com/giantswarm/docs/tree/main/.claude/skills/find-style-issues
Command: npx skills add https://github.com/giantswarm/docs --skill find-style-issues

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python, vale, and includes scripts (resource) components.

What problem does it solve?

This Skill streamlines the process of finding style issues in documentation, such as long paragraphs, non-sentence-case headings, over-long shell code lines, and Vale findings, enabling quick and targeted improvements.

Core Features & Use Cases

  • Style Issue Detection: Identifies and ranks documentation pages by the number of style problems they contain.
  • Custom Scanning: Scans specific files or directories and can include Vale findings for a more detailed analysis.
  • Use Case: When reviewing a large documentation set, use this Skill to quickly identify pages that need attention to improve readability and consistency.

Quick Start

Run the find-style-issues skill on your documentation directory to identify pages with style issues.

Frequently Asked Questions about find-style-issues

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

FAQPage Schema
How do I check my Markdown documentation for style issues?

To check Markdown documentation for style issues, you can scan files to identify long paragraphs, non-sentence-case headings, and over-long shell code lines. This process highlights pages needing readability improvements.

How do I use Vale to scan documentation for readability problems?

You can use Vale through a script to scan your documentation directory, generating findings that rank pages by the number of style problems. This pinpoints exactly where to target improvements.

Do I need Python to run Vale checks on Markdown files?

Yes, you need Python installed to execute the script that runs Vale checks and identifies style issues in Markdown files. Python provides the execution environment for the documentation review process.

What is the best way to find non-sentence-case headings in a large documentation set?

The best way to find non-sentence-case headings in a large documentation set is to run an automated style checking script. This scans directories and ranks pages by the total number of style problems found.

Why does my documentation style checking fail on long paragraphs?

Documentation style checking flags long paragraphs because they reduce readability and consistency. The scanning process identifies these specific style issues so you can break them down for targeted improvements.