Validate local-bin executable scripts against README documentation headings.
npx skills add https://github.com/edwardsnjd/dot-files --skill document-scripts
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
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.
configuration/local-bin/.local/bin/ has a corresponding heading in configuration/local-bin/README.md.Run the validation script to find any missing documentation for local-bin scripts.
High-intent search queries and answers about installing and using this skill.
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.
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.
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.
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.
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.
edwardsnjdAdd a new script to the local bin directory and document it in the README.
EnigmaWUGenerate structured markdown README files for test cases.
SkillPanelManage project documentation and standards in the .maister/docs/ repository.
felix-howardAnalyze codebase changes and generate or update project documentation files.