Skip to content

docs: fix two documentation drift issues in tools/skill_generator/README.md#20

Open
bipinhcs11 wants to merge 1 commit into
mainfrom
docs/tools-readme-subcommand-map-drift
Open

docs: fix two documentation drift issues in tools/skill_generator/README.md#20
bipinhcs11 wants to merge 1 commit into
mainfrom
docs/tools-readme-subcommand-map-drift

Conversation

@bipinhcs11
Copy link
Copy Markdown
Owner

What and why

Two documentation drift issues in tools/skill_generator/README.md that have been present since the feat/skill-validator (PR #5) and feat/skill-gen-doctor (PR #8) merges.

1. validate and doctor missing from the Subcommand map table

The subcommand map listed 9 subcommands but the CLI (cli.py) exposes 11. validate and doctor were added in earlier PRs but never reflected in the README's own index. Any developer who reads the table to discover what commands are available won't find two of them.

2. bin/ incorrectly listed as a silently skipped directory

The "What Stage 1 skips" paragraph claimed bin/ is silently skipped. The code disagrees:

DEFAULT_EXCLUDE_DIRS = {
    "target", "build", ".git", "generated", ".mvn",
    "node_modules", ".idea", ".vscode", ".gradle",
    "out", "dist", ".settings",
    # Note: "bin/" intentionally NOT excluded — legacy apps put shell scripts there.
    # Eclipse compiled output (.class files) inside bin/ is still filtered by BINARY_EXTENSIONS.
}

bin/ is intentionally absent. A developer reading the README to understand what the crawler walks would assume bin/ is safe to fill with output — the opposite of the intended behaviour.

Changes

Location Change
Subcommand map table Add validate and doctor rows
"What Stage 1 skips" Remove bin/ from the excluded-dirs list; add a note explaining it is intentionally NOT excluded and why

No logic changes

Pure documentation fix. All 172 tests pass unchanged.

Follow-ups (not in this PR)

https://claude.ai/code/session_01JiDRe3frmV8eeK53c8GHnp


Generated by Claude Code

…DME.md

The `validate` and `doctor` subcommands were added in the feat/skill-validator
and feat/skill-gen-doctor PRs but were never reflected in the Subcommand map
table, making the README's own index a lie for any developer who reads it first.

The "What Stage 1 skips" paragraph listed `bin/` as silently excluded, but
DEFAULT_EXCLUDE_DIRS in crawler.py explicitly does NOT include it — and even
has a code comment explaining why ("legacy apps put shell scripts there").
Any developer who relies on the README to understand what the crawler skips
would assume bin/ is safe to put ignored output in, which is the opposite of
the intended behaviour.

Changes:
  - Add `validate` and `doctor` rows to the Subcommand map table
  - Remove `bin/` from the silently-skipped directory list
  - Add an explicit note that bin/ is intentionally NOT excluded, and why

No logic changes. All 172 tests pass unchanged.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants