Skip to content

Commit 2d40f91

Browse files
os-litantclaude
andauthored
docs(skills): admit hand-authored reference files under references/ (#14786)
The catalog anatomy in `skills/README.md` reserved `references/` for the generated `_index.md` alone and assigned every hand-authored per-topic file to `rules/`. Three published skills already keep hand-authored anchors under `references/` (`objectstack-data/references/data-hooks.md`, `objectstack-platform/references/plugin-hooks.md`), each linked directly from its own `SKILL.md` and cited by path from sibling packages, so the anatomy described a layout the catalog does not have. Amend the anatomy rather than move the files: the reader reaches the same text either way, and a move would be a multi-package rename with binding checks and ceiling-row renames for zero reader value. `_index.md` keeps its "generated — do not hand-edit" line and its `gen:skill-refs` pointer, byte-identical; `rules/` keeps its per-topic role. The requirement travels with the permission: a hand-authored reference file must be linked from `SKILL.md`. Claude-Session: https://claude.ai/code/session_01LraLgQVGq8egUwfYZpbYt1 Co-authored-by: Claude <noreply@anthropic.com>
1 parent f22ed22 commit 2d40f91

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

skills/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ apps too).
5252
```
5353
skills/<skill-name>/
5454
├── SKILL.md # frontmatter + prose guide
55-
├── references/
55+
├── references/ # may also hold hand-authored reference files linked from SKILL.md
5656
│ └── _index.md # generated pointers into @objectstack/spec sources
5757
│ # (pnpm --filter @objectstack/spec gen:skill-refs — do not hand-edit)
5858
├── rules/ # (optional) detailed per-topic rule files linked from SKILL.md

0 commit comments

Comments
 (0)