diff --git a/packages/website/src/routes/docs/worktrees.tsx b/packages/website/src/routes/docs/worktrees.tsx index dac603ba1..24832c39e 100644 --- a/packages/website/src/routes/docs/worktrees.tsx +++ b/packages/website/src/routes/docs/worktrees.tsx @@ -57,14 +57,44 @@ function Worktrees() {
{`~/.paseo/worktrees/
 ├── my-project/
-│   ├── feature-auth/        # worktree for feature-auth branch
-│   └── fix-login-bug/       # worktree for fix-login-bug branch
+│   ├── tidy-fox/            # random slug
+│   └── bold-owl/            # random slug
 └── another-repo/
-    └── refactor-api/        # worktree for refactor-api branch`}
+ └── swift-hare/ # random slug`}

The project name is derived from your git remote URL or repository directory name. - Worktree names map to branch names. + Directory names are random slugs — the branch name is separate and chosen when + you first launch an agent in the worktree. +

+ + + {/* Branches */} +
+

Branches

+

+ When you create a worktree, Paseo generates a random directory name. The branch name + is set when you first launch an agent. You can specify a branch name, or Paseo will + generate one for you. +

+

+ This means the worktree directory and branch are independent. You can rename the + branch later without affecting the worktree path. +

+
+ + {/* Multiple agents */} +
+

Multiple agents per worktree

+

+ You can launch multiple agents into the same worktree. They share the working + directory and branch, which is useful when you want agents to collaborate on + the same feature or when one agent hands off to another. +

+

+ Be mindful of conflicts — agents working on the same files simultaneously can + step on each other. This works best when agents have distinct responsibilities + or run sequentially.

@@ -174,7 +204,10 @@ function Worktrees() {

  1. - Start an agent with a worktree — Paseo creates the branch and runs setup + Create a worktree — Paseo creates the directory and runs setup +
  2. +
  3. + Launch an agent — Paseo creates or assigns a branch
  4. Agent works in isolation — changes stay in its worktree @@ -190,8 +223,8 @@ function Worktrees() {

- You can run multiple agents in different worktrees simultaneously. Each has its - own branch and working directory. + You can run multiple agents in different worktrees simultaneously. Each worktree + has its own branch and working directory.