ls-script-and-docs-quality

Enforce quality standards for scripts and Markdown documentation in repositories.

3|2|Updated Dec 25, 2025
One-click install
npx skills add https://github.com/CruxExperts/localsetup --skill ls-script-and-docs-quality
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ls-script-and-docs-quality
Source: https://github.com/CruxExperts/localsetup/tree/main/_localsetup/skills/ls-script-and-docs-quality
Command: npx skills add https://github.com/CruxExperts/localsetup --skill ls-script-and-docs-quality

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Ensures Markdown compatibility, encoding consistency, and disciplined script and documentation generation to reduce defects and enable auditable quality across a repository.

Core Features & Use Cases

  • Markdown compatibility: enforce ASCII-first content, avoid EM dash, and ensure UTF-8 encoding.
  • Script generation discipline: require clear headers, documented functions, robust error handling, and predictable outputs.
  • Documentation discipline: standardize in-repo docs, references, and living guidelines to support development workflows.

Quick Start

Apply these quality guidelines to every new script or markdown document you create or update.

Frequently Asked Questions about ls-script-and-docs-quality

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

FAQPage Schema
How do I enforce markdown compatibility and consistent encoding in documentation?

Enforce markdown compatibility by standardizing content to ASCII-first text, avoiding EM dashes, and ensuring UTF-8 encoding across repository documentation. This reduces defects and maintains auditable quality for in-repo docs, references, and living guidelines.

What is the best way to standardize script generation quality across a repository?

Standardize script generation by requiring clear headers, documenting all functions, implementing robust error handling, and ensuring predictable outputs. This disciplined approach reduces defects and enables automated vetting for consistent tooling.

How do I apply documentation quality guidelines to existing scripts and markdown files?

Apply documentation quality guidelines to every new or updated script and markdown document. Enforce explicit Quick Start instructions and structured frontmatter metadata to standardize both new and existing repository content.

Does this documentation linting approach work for teams producing both code and release notes?

Yes, this documentation linting approach works for teams producing code, docs, and release notes. It enforces coding standards and documentation discipline wherever markdown compatibility and script-generation quality matter across the repository.

Why do I need frontmatter metadata for automated vetting of markdown documents?

Frontmatter metadata is required for automated vetting to enable consistent tooling and enforce documentation discipline. It allows automated systems to parse, validate, and standardize markdown content and scripts across the repository.

What are the limitations of using coding standards for markdown and script quality?

The limitations of these coding standards include strict ASCII-first content requirements and the prohibition of EM dashes, meaning contributors must strictly avoid non-ASCII characters to pass automated quality checks and maintain markdown compatibility.