docs: fix two documentation drift issues in tools/skill_generator/README.md#20
Open
bipinhcs11 wants to merge 1 commit into
Open
docs: fix two documentation drift issues in tools/skill_generator/README.md#20bipinhcs11 wants to merge 1 commit into
bipinhcs11 wants to merge 1 commit into
Conversation
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why
Two documentation drift issues in
tools/skill_generator/README.mdthat have been present since thefeat/skill-validator(PR #5) andfeat/skill-gen-doctor(PR #8) merges.1.
validateanddoctormissing from the Subcommand map tableThe subcommand map listed 9 subcommands but the CLI (
cli.py) exposes 11.validateanddoctorwere 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 directoryThe "What Stage 1 skips" paragraph claimed
bin/is silently skipped. The code disagrees:bin/is intentionally absent. A developer reading the README to understand what the crawler walks would assumebin/is safe to fill with output — the opposite of the intended behaviour.Changes
validateanddoctorrowsbin/from the excluded-dirs list; add a note explaining it is intentionally NOT excluded and whyNo logic changes
Pure documentation fix. All 172 tests pass unchanged.
Follow-ups (not in this PR)
tests/test_update.py; one of them should be merged and the rest closed.TOOL_VERSIONand also edits this README (the version string and schema example at the bottom). If that merges first, a trivial rebase of this PR is needed.https://claude.ai/code/session_01JiDRe3frmV8eeK53c8GHnp
Generated by Claude Code