Skip to content

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

Improve documentation clarity and structure

Maximilian Roosc5a623d88e1e
diff --git a/docs/content/list.md b/docs/content/list.md
index 1ba19f802..ec11d745a 100644
--- a/docs/content/list.md
+++ b/docs/content/list.md
@@ -86,6 +86,8 @@ $ wt list --format=json
| Age | Time since last commit |
| Message | Last commit message (truncated) |
+### CI status
+
The CI column shows GitHub/GitLab pipeline status:
| Indicator | Meaning |
diff --git a/docs/content/why-worktrunk.md b/docs/content/why-worktrunk.md
index e89951601..e8e8f8102 100644
--- a/docs/content/why-worktrunk.md
+++ b/docs/content/why-worktrunk.md
@@ -9,22 +9,22 @@ Here's a quick demo:
<figure class="demo">
<img src="/assets/wt-demo.gif" alt="Worktrunk demo showing wt list, wt switch, and wt merge">
-<figcaption>Listing worktrees, creating one, working, merging back</figcaption>
+<figcaption>Listing worktrees, creating a worktree, working, merging back</figcaption>
</figure>
-## Context: git worktrees
+## Git worktrees are a great primitive
AI agents like Claude Code and Codex can increasingly handle longer tasks
without supervision, and it's very practical to run several in parallel. Git
worktrees provide each agent with its own working directory, avoiding agents
stepping on each other's changes.
-But the git worktree UX is clunky. Even something as simple as "start a new worktree" is complicated:
+But the git worktree UX is clunky. Even something as simple as "start a new worktree" is verbose:
`git worktree add -b feature ../repo.feature`, then `cd ../repo.feature`.
-## What Worktrunk adds
+## Worktrunk makes git worktrees easy
-Worktrunk makes worktrees easy to use — branch-based navigation, unified status, and workflow automation.
+Worktrunk makes git worktrees easy to use — branch-based navigation, unified status, and workflow automation.
**Core commands:**
@@ -40,7 +40,7 @@ Worktrunk makes worktrees easy to use — branch-based navigation, unified statu
- **[Lifecycle hooks](@/hook.md)** — run commands on create, pre-merge, post-merge
- **[LLM commit messages](@/llm-commits.md)** — generate commit messages from diffs via [llm](https://llm.datasette.io/)
- **[Merge workflow](@/merge.md)** — squash, rebase, merge, clean up in one command
-- ...and lots more.
+- ...and [lots more](#next-steps)
## Core commands in practice
@@ -113,7 +113,7 @@ $ wt config shell install
- Learn the core commands: [wt switch](@/switch.md), [wt list](@/list.md), [wt merge](@/merge.md), [wt remove](@/remove.md)
- Set up [project hooks](@/hook.md) for automated setup
-- Explore [LLM commit messages](@/llm-commits.md), [fzf-like picker](@/select.md), [Claude Code integration](@/claude-code.md)
+- Explore [LLM commit messages](@/llm-commits.md), [fzf-like picker](@/select.md), [Claude Code integration](@/claude-code.md), [CI status & PR links](@/list.md#ci-status)
- Run `wt --help` or `wt <command> --help` for quick CLI reference
## Further reading
diff --git a/src/cli.rs b/src/cli.rs
index 622a32fa3..34752b3ea 100644
--- a/src/cli.rs
+++ b/src/cli.rs
@@ -1359,6 +1359,8 @@ $ wt list --format=json
| Age | Time since last commit |
| Message | Last commit message (truncated) |
+### CI status
+
The CI column shows GitHub/GitLab pipeline status:
| Indicator | Meaning |