ls-framework-audit

Audit repository documentation, links, skill matrix, and version facts for release readiness.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill provides a single-entrypoint workflow to run a comprehensive pre-release audit across repository documentation, links, skill-matrix, and version facts, ensuring release readiness and reducing post-release issues.

Core Features & Use Cases

  • Single-entrypoint audit: run all checks in one command, which produces a structured report.
  • Phases covered: doc checks (ensuring essential docs and files exist), link checks (detects plain-text references to docs or internal paths), skill matrix (validates each skill via sandbox smoke tests), version/facts verification (ensures VERSION, README and generated facts.json agree), and maintainer reference detection.
  • Use Case: Before releasing a new framework version, run the audit to validate docs, links, and consistency, surfacing any blocking issues for remediation.

Quick Start

Run the audit from the repo root to generate a comprehensive report and verify all checks pass.

Frequently Asked Questions about ls-framework-audit

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

FAQPage Schema
How do I run a pre-release audit for a multi-skill framework repository?

A framework audit validates documentation standards, link integrity, skill matrix consistency, and version facts. It ensures VERSION, README, and generated facts.json agree across the repository, surfacing blocking issues before a release.

What does a pre-release framework audit check for in a multi-skill repository?

The audit validates each skill by running sandbox-based smoke tests and parsing skill-smoke YAML configurations. This phase checks the skill matrix to confirm individual skills function correctly and meet repository standards before release.

Do I need Python and PyYAML to validate my skill matrix with sandbox smoke tests?

Yes, you need Python 3.10 or higher and the PyYAML package installed. These dependencies are required for parsing the skill-smoke YAML files and executing the sandbox-based tests during the skill matrix validation phase.

How do I verify version consistency across README, VERSION, and facts.json before release?

Run the version and facts verification phase of the audit to ensure VERSION, README, and generated facts.json agree. This check detects mismatches in version facts across your multi-skill repository to prevent release inconsistencies.

Can I detect broken documentation links and missing internal paths in my framework?

Yes, the link checks phase detects plain-text references to documentation or internal paths within the repository. This identifies broken links and missing files during the pre-release audit to ensure documentation integrity.

What is the best way to ensure release readiness for a framework with multiple skills?

The best way to ensure release readiness is running a comprehensive single-entrypoint audit that covers doc checks, link checks, skill matrix validation, and version facts verification. This produces a structured report surfacing all blocking issues for remediation.