docs: trim skill READMEs and ADR/changelog narration
Two related simplification-audit findings, bundled because they edit some of the same skill-audit files and splitting would fragment single-file diffs. Finding 10: delete 48 per-skill/reference README.md files (they restated SKILL.md in narrative form and no agent ever loads them) plus 2 scaffold templates. Drop the README criterion from skill-audit's file-structure.md and finding-criteria.md, and the README-generation step from skill-author's new-skill.sh; update new-skill.bats to match. Plugin-root READMEs are kept intentionally, out of scope. Finding 12: strip historical ADR-0020/ADR-0023 citations and changelog-style narration from model-facing skill content across kyberforge and git plugin skills. Delete skill-author's one-time retrofit.md migration guide and its references. Some ADR-0023 tags were not narration but check-rtk-prefix's required opt-out marker for intentionally-bare git commands -- those were restored, not stripped. Mirror re-synced and full pre-commit/pre-push suite verified green. Refs: SIMPLIFICATION-AUDIT.md findings 10, 12 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YR2CjVumUbEGWcMikcoXBD
This commit is contained in:
@@ -1,35 +0,0 @@
|
||||
# git-submodules
|
||||
|
||||
Add, initialize, update, pin, inspect, and remove git submodules in multi-repository projects.
|
||||
|
||||
## What it does
|
||||
|
||||
This skill handles submodule operations within the git workflow suite: cloning a superproject with
|
||||
its nested repositories, adding a dependency as a submodule, initializing and updating with
|
||||
pinning or branch tracking, parallel and recursive traversal, rebinding URLs and tracked branches,
|
||||
and the full removal sequence including the `.git/modules/` cleanup git leaves behind. It returns
|
||||
structured results suitable for agent composition.
|
||||
|
||||
It sits alongside the other git skills rather than duplicating them: `git-worktrees` covers
|
||||
multiple checkouts of a single repository, and `git-remotes` covers the superproject's own remotes.
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
/git-submodules
|
||||
```
|
||||
|
||||
Describe the submodule task. The skill applies the shared working rules, dispatches to the
|
||||
reference for that task, and returns structured results (operation, status, per-submodule details,
|
||||
conflicts, and a recovery `next_step` when applicable).
|
||||
|
||||
## Files
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `SKILL.md` | Skill instructions for agents — gotchas, shared working rules, and the task dispatch table |
|
||||
| `references/README.md` | Describes contents of references/ |
|
||||
| `references/setup-and-update.md` | Loaded when cloning a superproject, adding a submodule, initializing, updating, or re-pinning one, or running a command across all of them — includes the full `add` and `update` flag tables, the pinning workflows, and the `foreach` shell-variable table |
|
||||
| `references/urls-and-config.md` | Loaded when changing where a submodule points or how it is configured — `.gitmodules` vs `.git/config` anatomy, both key tables, `sync`/`set-url`/`set-branch`, local mirror overrides, relative URLs, the custom-`update` security gate, and `absorbgitdirs` |
|
||||
| `references/removal.md` | Loaded when removing or deinitializing a submodule — why `deinit` is not removal, and the four-step removal sequence |
|
||||
| `references/sources.md` | Research sources and provenance |
|
||||
@@ -1,31 +0,0 @@
|
||||
---
|
||||
source_keys:
|
||||
- git-scm-submodule-docs
|
||||
---
|
||||
|
||||
# References
|
||||
|
||||
One file per task branch in SKILL.md's dispatch table. Load only the one that matches the request.
|
||||
|
||||
## setup-and-update.md
|
||||
|
||||
Cloning a superproject that has submodules, adding a dependency as a submodule, initializing
|
||||
without cloning, updating or re-pinning, and running one command across every submodule. Carries
|
||||
the `add` and `update` flag tables, the keep-pinned and move-the-pin-forward workflows, and the
|
||||
`foreach` shell-variable table (`$name`, `$sm_path`, `$displaypath`, `$sha1`, `$toplevel`).
|
||||
|
||||
## urls-and-config.md
|
||||
|
||||
Where a submodule points and how it is configured: the `.gitmodules` vs `.git/config` split, both
|
||||
key tables, `sync` / `set-url` / `set-branch`, local mirror overrides, relative URL resolution, the
|
||||
security gate on custom `update` commands, and `absorbgitdirs`.
|
||||
|
||||
## removal.md
|
||||
|
||||
Removing a submodule, and why `deinit` alone does not remove one. Carries the full four-step
|
||||
removal sequence including the manual `.git/modules/<name>/` cleanup.
|
||||
|
||||
## sources.md
|
||||
|
||||
Research sources that informed this skill — provenance chain for git-scm-submodule-docs reference
|
||||
material.
|
||||
Reference in New Issue
Block a user