document-scripts
CommunityDocument local-bin scripts
Authoredwardsnjd
Version1.0.0
Installs0
System Documentation
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 inconfiguration/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.
Dependency Matrix
Required Modules
None requiredComponents
scripts
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: document-scripts Download link: https://github.com/edwardsnjd/dot-files/archive/main.zip#document-scripts Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.