When to use this skill

Use this skill whenever the local-bin scripts have changed, or just to check the docs are correct.

What to ensure

Ensure that every main executable script under configuration/local-bin/.local/bin/ is documented in configuration/local-bin/README.md.

Check for any missing headings in the README (but use judgement to ignore any libraries). Use the scripts to avoid reinventing the logic:

Run the validation script (relative to this skill): scripts/find-missing-headings
For each missing heading that looks like a script:
1. Find the corresponding script
2. Read it
3. Add its documentation section to the README (see below for template)

Note:

Most scripts have no file extension.
There are some libraries in that directory but only the top level executable scripts should be documented.

Use this skill whenever the local-bin scripts have changed, or just to check the docs are correct.

Ensure that every main executable script under configuration/local-bin/.local/bin/ is documented in configuration/local-bin/README.md.

Check for any missing headings in the README (but use judgement to ignore any libraries). Use the scripts to avoid reinventing the logic:

Run the validation script (relative to this skill): scripts/find-missing-headings
For each missing heading that looks like a script:
1. Find the corresponding script
2. Read it
3. Add its documentation section to the README (see below for template)

Note:

Most scripts have no file extension.
There are some libraries in that directory but only the top level executable scripts should be documented.