sub-docs
Skill9 starsChanged 8 months agoMITView on GitHub
After significant feature work, synchronize all SubFrame documentation references. This skill automates the "Before Ending Work" checklist. Current version: !node -e "console.log(require('./package.json').version)" 2>/dev/null || echo "unknown" Recent commits (last 10): !git log --oneline --no-decorate -10 2>/dev/null || echo "No git history" Files changed (unstaged + staged): !git diff --name-only HEAD 2>/dev/null | head -30 Argument: $ARGUMENTS The argument should describe what feature/changes were made. If empty, infer from recent git changes. Read the recent changes (git diff, argument context) and…
The file
We split this skill into the rules it gives an agent
9 rules. About 0 are common, 5 are distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 13
After significant feature work, synchronize all SubFrame documentation references.
- Distinctive: line 34
Read the recent changes (git diff, argument context) and categorize:
- Distinctive: line 42
Read CLAUDE.md and update only the sections that need changes.
- Distinctive: line 45
Only add genuinely new entries — don't duplicate
- Distinctive: line 46
Keep formatting consistent with existing entries
- Very specific: line 47
Don't modify user-written content outside SubFrame-managed sections
- Very specific: line 51
Read .subframe/docs-internal/changelog.md and add entries under ## [Unreleased].
- Distinctive: line 53
Format: Follow the existing changelog style:
- Very specific: line 60
If the work involved an architecture decision worth preserving, add a session note to .subframe/PROJECT_NOTES.md under ## Session Notes.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
<!-- @subframe-version 0.14.0-beta --><!-- @subframe-managed -->name: sub-docs description: Sync all SubFrame documentation after feature work. Updates CLAUDE.md lists, changelog, PROJECT_NOTES decisions, and STRUCTURE.json. argument-hint: [summary of what changed] disable-model-invocation: false allowed-tools: Bash, Read, Edit, Write, Grep, Glob
SubFrame Documentation Sync
After significant feature work, synchronize all SubFrame documentation references. This skill automates the "Before Ending Work" checklist.
Dynamic Context
Current version:
!node -e "console.log(require('./package.json').version)" 2>/dev/null || echo "unknown"
Recent commits (last 10):
!git log --oneline --no-decorate -10 2>/dev/null || echo "No git history"
Files changed (unstaged + staged):
!git diff --name-only HEAD 2>/dev/null | head -30
Instructions
Argument: $ARGUMENTS
The argument should describe what feature/changes were made. If empty, infer from recent git changes.
Step 1: Identify What Changed
Read the recent changes (git diff, argument context) and categorize:
- New source modules → update CLAUDE.md module lists (if applicable)
- New components → update CLAUDE.md component lists (if applicable)
- Architecture decisions → add to
.subframe/PROJECT_NOTES.mdSession Notes - User-facing features → add to
.subframe/docs-internal/changelog.mdunder [Unreleased]
Step 2: Update CLAUDE.md
Read CLAUDE.md and update only the sections that need changes. If CLAUDE.md has module/component lists, add new entries. Preserve existing formatting and ordering.
Rules:
- Only add genuinely new entries — don't duplicate
- Keep formatting consistent with existing entries
- Don't modify user-written content outside SubFrame-managed sections
Step 3: Update Changelog
Read .subframe/docs-internal/changelog.md and add entries under ## [Unreleased].
Format: Follow the existing changelog style:
- Group under
### Added,### Changed,### Fixed,### Removed - Bold feature name, em-dash, brief description
- Sub-bullets for implementation details
Step 4: Update PROJECT_NOTES (if architecture decision)
If the work involved an architecture decision worth preserving, add a session note to .subframe/PROJECT_NOTES.md under ## Session Notes.
Format:
### [YYYY-MM-DD] Title
**Context:** Why this decision was needed.
**Decision:** What was chosen.
**Key architectural choices:**
- Point 1
- Point 2
**Files:** list of key filesSkip this step for routine changes (bug fixes, minor UI tweaks, config changes).
Step 5: Regenerate STRUCTURE.json
Run: npm run structure
This picks up any new/renamed/deleted source files.
Step 6: Summary
Present a checklist of what was updated:
- CLAUDE.md — what was added/changed
- changelog.md — entries added
- PROJECT_NOTES.md — decision added (or skipped)
- STRUCTURE.json — regenerated
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

