Experimental claude skills for docs updates#10473
Draft
gitKrystan wants to merge 7 commits intomainfrom
Draft
Conversation
gitKrystan
force-pushed
the
claude-skills
branch
from
d1dc476 to
115cf88
Compare
Refactor .claude/skills to follow Claude Code best practices by consolidating 7 separate documentation skills into a single updating-warp-drive-docs skill with progressive disclosure. Changes: - Consolidate 7 skills (1,705 lines) into 1 lean skill (238 lines) - Create 6 comprehensive reference files (4,232 total lines) - Organize 11 example files by documentation type - Apply imperative/infinitive writing style throughout - Add comprehensive trigger phrases for better discovery - Merge TypeDoc and VitePress expertise into single references Benefits: - Single entry point for all documentation work - Better token efficiency (238 vs 400+ lines loaded initially) - Progressive disclosure: load detailed expertise only when needed - Clearer user experience with one obvious skill - Easier maintenance with centralized coordination Structure: - SKILL.md: 238 lines (lean entry point with decision tree) - references/: 6 files with detailed expertise - tech-writing.md (166 lines) - api-docs.md (418 lines) - guides.md (562 lines) - readmes.md (801 lines) - typedoc.md (1,030 lines, merged from 2 sources) - vitepress.md (1,255 lines, merged from 2 sources) - examples/: 11 files organized by type - api-docs/ (1 file) - guides/ (5 files) - readmes/ (3 files) - typedoc/ (1 file) - vitepress/ (1 file) Removed skills: - tech-writer-expert - typedoc-expert - vitepress-expert - warp-drive-update-docs - warp-drive-update-api-docs - warp-drive-update-guides - warp-drive-update-readmes Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Improve skill triggering by adding "document the API" as an explicit trigger phrase. Also adjust overview wording for clarity. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
gitKrystan
commented
Feb 16, 2026
| const store = new Store(); | ||
|
|
||
| // Use the store | ||
| const user = store.findRecord('user', '1'); |
Contributor
Author
There was a problem hiding this comment.
TODO: Tell it not to document deprecated/legacy features under "Quick Start" and "Key Concepts"
gitKrystan
commented
Feb 16, 2026
| @@ -0,0 +1,436 @@ | |||
| # @warp-drive/core | |||
Contributor
Author
There was a problem hiding this comment.
This is generated by claude using the skill above + no edits from me.
Using this to validate the skill. We shouldn't merge w/o full vetting.
gitKrystan
changed the title
gitKrystan
commented
Feb 16, 2026
| }); | ||
| ``` | ||
|
|
||
| ## API Overview |
Contributor
Author
There was a problem hiding this comment.
FIXME: Tell it not to do this since TSDoc already does this.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The idea here is to create skills to make it easier to draft API Docs and Guides w/ AI for a hu-mon to manually edit. I am hoping this can help us to get docs up quicker.
Sample convo: