Skip to content

Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows

docs: Clarify and shorten documentation for quick comprehension

Maximilian Roosf5482e57d983
diff --git a/docs/content/advanced.md b/docs/content/advanced.md
index 2f2f4c4c0..f5f958a74 100644
--- a/docs/content/advanced.md
+++ b/docs/content/advanced.md
@@ -86,19 +86,12 @@ wsc new-feature # Creates worktree, runs hooks, launches Claude
### Eliminate cold starts
-Use `post-create` hooks to install dependencies and copy caches:
-
-```toml
-[post-create]
-"cache" = "cp -r ../.cache .cache" # Copy shared cache
-"install" = "npm ci"
-```
-
-For copy-on-write on macOS:
+`post-create` hooks install deps and copy caches. Use copy-on-write on macOS:
```toml
[post-create]
"cache" = "cp -c -r ../.cache .cache" # Uses APFS clones
+"install" = "npm ci"
```
### Local CI gate
@@ -109,7 +102,6 @@ For copy-on-write on macOS:
[pre-merge]
"test" = "cargo test"
"lint" = "cargo clippy -- -D warnings"
-"format" = "cargo fmt --check"
```
### Monitor CI across branches
@@ -118,20 +110,18 @@ For copy-on-write on macOS:
$ wt list --full --branches
```
-Shows PR/CI status for all branches, including those without worktrees. CI column links to PR pages in terminals with hyperlink support.
+Shows PR/CI status for all branches, including those without worktrees.
-### JSON API for scripting
+### JSON API
```bash
$ wt list --format=json
```
-Useful for dashboards, statuslines, and custom scripts.
+For dashboards, statuslines, and scripts.
### Task runners in hooks
-Reference your existing task runner:
-
```toml
[post-create]
"setup" = "task install"
@@ -140,12 +130,10 @@ Reference your existing task runner:
"validate" = "just test lint"
```
-### Working with stacked branches
-
-Create a branch from the current one:
+### Stacked branches
```bash
$ wt switch --create feature-part2 --base=@
```
-This branches from your current HEAD, not from main.
+Branches from current HEAD, not main.
diff --git a/docs/content/concepts.md b/docs/content/concepts.md
index 7ba770ec6..402b559bb 100644
--- a/docs/content/concepts.md
+++ b/docs/content/concepts.md
@@ -46,34 +46,3 @@ Worktrunk uses **path-first lookup** when resolving arguments:
3. Otherwise, treat the argument as a branch name
This means `wt switch foo` will switch to `repo.foo/` even if that worktree is on a different branch.
-
-## Branch lifecycle
-
-Typical workflow:
-
-```
- ┌─────────────────┐
- │ wt switch -c │
- │ (create) │
- └────────┬────────┘
- │
- ▼
- ┌─────────────────┐
- │ Work on branch │
- │ (commits) │
- └────────┬────────┘
- │
- ▼
- ┌─────────────────┐
- │ wt merge │
- │ (or CI merge) │
- └────────┬────────┘
- │
- ▼
- ┌─────────────────┐
- │ wt remove │
- │ (cleanup) │
- └─────────────────┘
-```
-
-With `wt merge`, the entire workflow from working tree → main branch is automated: stage, commit, squash, rebase, run tests, merge, cleanup.
diff --git a/docs/content/quickstart.md b/docs/content/quickstart.md
index 196cf2f7c..1e626fbab 100644
--- a/docs/content/quickstart.md
+++ b/docs/content/quickstart.md
@@ -3,8 +3,6 @@ title = "Quick Start"
weight = 1
+++
-Get up and running with Worktrunk in under a minute.
-
## Install
```bash
@@ -28,8 +26,6 @@ $ wt switch feature-api
✅ Switched to worktree for feature-api at ../repo.feature-api
```
-Use branch names, not paths. Worktrunk handles the navigation.
-
## List worktrees
```bash