Skip to content

Commit 6c3a51e

Browse files
justin808claude
andcommitted
Use shell expansion to inline docs skill references
The SKILL.md previously told agents to manually read reference files. Now uses !`cat` directives to auto-expand them, ensuring references are always loaded without relying on agent behavior. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent f232f10 commit 6c3a51e

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

skills/docs/SKILL.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,25 @@ description: Generate, audit, or update project documentation to a professional
77

88
Generate and maintain documentation that meets or exceeds the standard set by the best open-source Rails/JS projects (Inertia Rails, Vite Ruby, Rails itself).
99

10-
## Before You Start
10+
## Reference: Quality Standard
1111

12-
1. Read `references/quality-standard.md` in this skill directory to understand the bar we are targeting.
13-
2. Read `references/templates.md` for structural templates by doc type.
12+
!`cat "$(dirname "$0")/references/quality-standard.md"`
13+
14+
## Reference: Documentation Templates
15+
16+
!`cat "$(dirname "$0")/references/templates.md"`
17+
18+
## Reference: Competitive Landscape
19+
20+
!`cat "$(dirname "$0")/references/competitive-landscape.md"`
1421

1522
## Workflow
1623

1724
### Step 1: Assess the current state
1825

1926
- Scan the repo for existing docs: `docs/`, `README.md`, `CHANGELOG.md`, `CONTRIBUTING.md`, inline code comments, Wiki, and any hosted doc site config (VitePress, Docusaurus, Jekyll, etc.)
2027
- Identify what exists, what is outdated, and what is missing
21-
- Compare against the quality checklist in `references/quality-standard.md`
28+
- Compare against the Quality Standard reference above
2229

2330
### Step 2: Determine scope
2431

@@ -119,7 +126,7 @@ When invoked as `/docs <target>`:
119126
- If `<target>` is a file path: generate/update docs FOR that code file (inline comments, module-level docs, method docs)
120127
- If `<target>` is a directory: generate/update docs for the entire module
121128
- If `<target>` is a doc type keyword (e.g., "readme", "api", "quickstart", "migration", "troubleshooting", "llms.txt", "audit"): generate that specific doc type
122-
- If `<target>` is "audit": run a full gap analysis against `references/quality-standard.md` and report findings
129+
- If `<target>` is "audit": run a full gap analysis against the Quality Standard reference above and report findings
123130

124131
## Language-Specific Conventions
125132

0 commit comments

Comments
 (0)