document-scripts

Name: document-scripts
Availability: InStock
Author: edwardsnjd

Validate local-bin executable scripts against README documentation headings.

9|1|Updated Jun 6, 2018

Search Tags:#documentation #validation #readme #scripts #local-bin

Ready to run

npx skills add https://github.com/edwardsnjd/dot-files --skill document-scripts

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-scripts
Source: https://github.com/edwardsnjd/dot-files/tree/main/.agents/skills/document-scripts
Command: npx skills add https://github.com/edwardsnjd/dot-files --skill document-scripts

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill ensures that all executable scripts in the local-bin directory are properly documented in the corresponding README file, preventing outdated or missing documentation.

Core Features & Use Cases

Documentation Validation: Automatically checks if each script in configuration/local-bin/.local/bin/ has a corresponding heading in configuration/local-bin/README.md.
Guidance for Documentation: Provides a clear process and template for adding new script documentation.
Use Case: After adding a new utility script to your local bin, run this Skill to verify and add its documentation to the central README, ensuring discoverability and maintainability for yourself and others.

Quick Start

Run the validation script to find any missing documentation for local-bin scripts.

Frequently Asked Questions about document-scripts

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

FAQPage Schema

How do I validate local-bin scripts against README headings?▼

Run the validation script in a bash environment to cross-reference executable files in your local-bin directory against existing README headings, identifying any scripts lacking proper documentation.

What is the best way to keep developer tooling documentation updated?▼

Keeping developer tooling documentation updated involves automatically cross-referencing executable scripts in your local-bin directory with the central README file to prevent outdated or missing documentation.

Do I need a bash environment to check for missing script documentation?▼

Yes, a bash environment is required to execute the validation script that cross-references local-bin executable files with README headings to find missing script documentation.

How do I document new utility scripts in a central README?▼

To document new utility scripts in a central README, use the validation script's output to identify missing entries, then manually review and add documentation using the provided template to ensure discoverability.

Why are my local-bin scripts not showing up in the README?▼

Local-bin scripts may not appear in the README if documentation was not added after creation. Running a validation script cross-references executable files against README headings to flag these missing entries.