Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows
Refactor skill docs to use `reference/` directory
Maximilian Roos0963768cd949
diff --git a/.claude-plugin/skills/worktrunk/SKILL.md b/.claude-plugin/skills/worktrunk/SKILL.mdindex b0a669431..f6d7219e0 100644--- a/.claude-plugin/skills/worktrunk/SKILL.md+++ b/.claude-plugin/skills/worktrunk/SKILL.md@@ -10,10 +10,10 @@ Help users work with Worktrunk, a CLI tool for managing git worktrees.## Available Documentation- **SKILL.md**: Configuration workflows and common patterns-- **README.md**: Features, installation, examples, FAQ+- **reference/README.md**: Features, installation, examples, FAQ- **reference/*.md**: Detailed configuration and hook specifications-For general usage, consult README.md. For configuration, follow the workflows below.+For general usage, consult reference/README.md. For configuration, follow the workflows below.## Two Types of Configuration@@ -24,14 +24,14 @@ Worktrunk uses two separate config files with different scopes and behaviors:- **Location**: `~/.config/worktrunk/config.toml` (never checked into git)- **Contains**: LLM integration, worktree path templates, approved commands- **Permission model**: Always propose changes and get consent before editing-- **See**: `references/user-config.md` for detailed guidance+- **See**: `reference/user-config.md` for detailed guidance### Project Config (`.config/wt.toml`)- **Scope**: Team-wide automation shared by all developers- **Location**: `<repo>/.config/wt.toml` (checked into git)- **Contains**: Hooks for worktree lifecycle (post-create, pre-merge, etc.)- **Permission model**: Proactive (create directly, changes are reversible via git)-- **See**: `references/project-config.md` for detailed guidance+- **See**: `reference/project-config.md` for detailed guidance## Determining Which Config to Use@@ -92,7 +92,7 @@ Most common request. Follow this sequence:wt merge # in a repo with uncommitted changes```-**See `references/user-config.md` for complete details.**+**See `reference/user-config.md` for complete details.**### Setting Up Project Hooks (Project Config)@@ -138,7 +138,7 @@ Common request for workflow automation. Follow discovery process:wt switch --create test-hooks```-**See `references/project-config.md` for complete details.**+**See `reference/project-config.md` for complete details.**## Permission Models@@ -157,17 +157,17 @@ Common request for workflow automation. Follow discovery process:## Common Tasks Reference### User Config Tasks-- Set up LLM integration → `references/user-config.md#llm-setup`-- Customize worktree paths → `references/user-config.md#worktree-paths`-- Custom commit templates → `references/user-config.md#templates`-- Troubleshoot LLM issues → `references/user-config.md#troubleshooting`+- Set up LLM integration → `reference/user-config.md#llm-setup`+- Customize worktree paths → `reference/user-config.md#worktree-paths`+- Custom commit templates → `reference/user-config.md#templates`+- Troubleshoot LLM issues → `reference/user-config.md#troubleshooting`### Project Config Tasks-- Set up hooks for new project → `references/project-config.md#new-project`-- Add hook to existing config → `references/project-config.md#add-hook`-- Use template variables → `references/project-config.md#variables`-- Convert command formats → `references/project-config.md#formats`-- Troubleshoot hook execution → `references/project-config.md#troubleshooting`+- Set up hooks for new project → `reference/project-config.md#new-project`+- Add hook to existing config → `reference/project-config.md#add-hook`+- Use template variables → `reference/project-config.md#variables`+- Convert command formats → `reference/project-config.md#formats`+- Troubleshoot hook execution → `reference/project-config.md#troubleshooting`## Key Commands@@ -184,13 +184,13 @@ wt config --help## Loading Additional Documentation-Load **README.md** for general features, installation, commands, and examples.+Load **reference/README.md** for general features, installation, commands, and examples.Load **reference files** for detailed configuration, hook specifications, and troubleshooting.Find specific sections with grep:```bash-grep -A 20 "## Installation" README.md-grep -A 20 "## LLM Setup" references/user-config.md-grep -A 30 "### post-create-command" references/project-config.md+grep -A 20 "## Installation" reference/README.md+grep -A 20 "## LLM Setup" reference/user-config.md+grep -A 30 "### post-create-command" reference/project-config.md```diff --git a/.claude-plugin/skills/worktrunk/README.md b/.claude-plugin/skills/worktrunk/reference/README.mdsimilarity index 100%rename from .claude-plugin/skills/worktrunk/README.mdrename to .claude-plugin/skills/worktrunk/reference/README.mddiff --git a/.config/lychee.toml b/.config/lychee.tomlindex f20da6f8b..ac6775502 100644--- a/.config/lychee.toml+++ b/.config/lychee.toml@@ -35,5 +35,5 @@ exclude = [# Exclude files with relative paths intended for different locationsexclude_path = [- ".claude-plugin/skills/worktrunk/README.md",+ ".claude-plugin/skills/worktrunk/reference/README.md",]diff --git a/tests/plugin_sync.rs b/tests/plugin_sync.rsindex 9d539c0bd..2c3e018a4 100644--- a/tests/plugin_sync.rs+++ b/tests/plugin_sync.rs@@ -3,7 +3,7 @@ use std::path::Path;/// Ensures the skill directory has an up-to-date copy of README.md///-/// This test keeps `.claude-plugin/skills/worktrunk/README.md` synchronized with+/// This test keeps `.claude-plugin/skills/worktrunk/reference/README.md` synchronized with/// the root `README.md`. The skill references README for general usage information,/// so it needs to stay current.///@@ -13,7 +13,8 @@ use std::path::Path;fn sync_readme_to_skill() {let project_root = env!("CARGO_MANIFEST_DIR");let root_readme = Path::new(project_root).join("README.md");- let skill_readme = Path::new(project_root).join(".claude-plugin/skills/worktrunk/README.md");+ let skill_readme =+ Path::new(project_root).join(".claude-plugin/skills/worktrunk/reference/README.md");// Read both fileslet root_content = fs::read_to_string(&root_readme)@@ -46,7 +47,7 @@ fn sync_readme_to_skill() {// Report what happenedpanic!(- "README.md was out of sync. Updated .claude-plugin/skills/worktrunk/README.md\n\+ "README.md was out of sync. Updated .claude-plugin/skills/worktrunk/reference/README.md\n\Lines: {} -> {} ({:+} lines)\n\n\This is expected if you modified README.md. Re-run tests to verify the sync.",old_lines, new_lines, diff