Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bipinhcs11 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion tools/skill_generator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Python 3.10+ (standard library only — no third-party dependencies). Modules us
| `link-ingest` | Stage 4 — apply links to each SKILL.md's frontmatter + body. |
| `update-emit` | Phase 2 — write update prompts for features affected by `git diff`. |
| `update-ingest` | Phase 2 — apply per-feature responses; bump version; optionally commit. |
| `validate` | Ad-hoc — validate one or more SKILL.md files against the artifact-3 contract. |
| `doctor` | Pre-flight — 30-second look at a Java repo before running the pipeline; no AI turns, nothing written to disk. |

## End-to-end run (with paste steps in between)

Expand Down Expand Up @@ -82,7 +84,7 @@ It also infers `framework` (Spring Boot, Spring MVC, Struts, Quarkus, Raw Servle

### What Stage 1 skips

Silently skipped: `target/`, `build/`, `.git/`, `generated/`, `.mvn/`, `node_modules/`, `.idea/`, `.vscode/`, `.gradle/`, `out/`, `bin/`, `dist/`, `.settings/`. Binary extensions are not opened: `.class`, `.jar`, `.war`, `.ear`, `.zip`, `.tar`, `.gz`, `.so`, `.dylib`, `.dll`, image and font extensions. Files with `// DO NOT EDIT`, `@Generated`, or `// generated by` markers in the first 2KB are skipped. Files shorter than 10 characters are skipped.
Silently skipped: `target/`, `build/`, `.git/`, `generated/`, `.mvn/`, `node_modules/`, `.idea/`, `.vscode/`, `.gradle/`, `out/`, `dist/`, `.settings/`. Note: `bin/` is intentionally **not** excluded — legacy apps store shell scripts there; Eclipse-compiled `.class` output inside `bin/` is still filtered by binary extensions. Binary extensions are not opened: `.class`, `.jar`, `.war`, `.ear`, `.zip`, `.tar`, `.gz`, `.so`, `.dylib`, `.dll`, image and font extensions. Files with `// DO NOT EDIT`, `@Generated`, or `// generated by` markers in the first 2KB are skipped. Files shorter than 10 characters are skipped.

## Output schema (top-level)

Expand Down