docs-style-lint

Lint Avalonia documentation pages for style, tone, and accessibility issues.

157|301|Updated Apr 24, 2023
One-click install
npx skills add https://github.com/AvaloniaUI/avalonia-docs --skill docs-style-lint
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-style-lint
Source: https://github.com/AvaloniaUI/avalonia-docs/tree/main/.claude/skills/docs-style-lint
Command: npx skills add https://github.com/AvaloniaUI/avalonia-docs --skill docs-style-lint

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Avalonia docs can drift from house style, voice, terminology, accessibility, and SEO standards as teams review and edit content. This Skill automatically analyzes pages to enforce consistency and catch deviations.

Core Features & Use Cases

  • Linting against house rules for structure, voice, terminology, formatting, linking, tone, and Diataxis alignment.
  • Accessibility and SEO checks, including image alt text, meta descriptions, and cross-link validation.
  • Auto-audits during editing, publishing, or page reviews to surface issues before release.

Quick Start

Run the Avalonia docs style lint on a target file or the whole repository to identify issues before publishing.

Frequently Asked Questions about docs-style-lint

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

FAQPage Schema
How do I audit Avalonia documentation for style and accessibility issues?

You can audit Avalonia documentation by running a style lint on target files or the whole repository, which identifies style, tone, and accessibility issues before publishing.

What documentation checks does the Avalonia docs style lint perform?

The docs style lint performs structure, voice, terminology, formatting, linking, and Diataxis alignment checks, alongside accessibility and SEO validation including image alt text and metadata.

Can I enforce Diataxis alignment and terminology consistency across new tutorials and release notes?

Yes, the lint validates Diataxis alignment and terminology usage for new and updated content, including tutorials, references, explanations, and release notes during editing workflows.

What's the best way to catch SEO and cross-link deviations in Avalonia docs before release?

Running auto-audits during editing, publishing, or page reviews surfaces SEO metadata issues and cross-link validation deviations against repository templates before release.

Does the documentation linter validate image alt text and metadata across all content types?

Yes, the linter checks image alt text and metadata for tutorials, references, explanations, and release notes to ensure compliance with Avalonia documentation accessibility and SEO standards.