Skip to content

Commit c814d3d

Browse files
committed
docs: move reviewing sections to main Workspaces page
Move 'Reviewing Code' and 'Reviewing Functionality' sections from local.md to workspaces.md since they apply to both local and SSH workspaces. Changes: - Add reviewing sections to workspaces.md after 'Key Concepts' - Remove reviewing sections from local.md (now focuses on worktree mechanics and filesystem layout) - Add note in 'Reviewing Functionality' about detached HEAD being specific to local workspaces This reduces duplication and puts shared concepts in the parent page where they're easier to find.
1 parent 9789ec6 commit c814d3d

File tree

2 files changed

+23
-21
lines changed

2 files changed

+23
-21
lines changed

docs/local.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,3 @@ Example layout:
2020
improved-auth-ux/
2121
fix-ci-flakes/
2222
```
23-
24-
## Reviewing Code
25-
26-
Here are a few practical approaches to reviewing changes from workspaces, depending on how much you want your agent to interact with `git`:
27-
28-
- **Agent codes, commits, and pushes**: Ask agent to submit a PR and review changes in your git Web UI (GitHub, GitLab, etc.)
29-
- Also see: [Agentic Git Identity](./agentic-git-identity.md)
30-
- This is the preferred approach for `cmux` development but requires additional care with repository security.
31-
- **Agent codes and commits**: Review changes from the main repository via `git diff <workspace-branch>`, push changes when deemed acceptable.
32-
- **Agent codes**: enter worktree (click Terminal icon in workspace top bar), run `git add -p` and progressively accept changes into a commit.
33-
34-
## Reviewing Functionality
35-
36-
Some changes (especially UI ones) require the Human to determine acceptability. An effective approach for this is:
37-
38-
1. Ask agent to commit WIP when it's ready for Human review
39-
2. Human, in main repository, checks out the workspace branch in a detached HEAD state: `git checkout --detach <workspace-branch>`
40-
41-
**Note**: This workflow uses the detached HEAD state because the branch is already checked out in the workspace and you cannot check out the same branch multiple times across worktrees.
42-
43-
If you want faster iteration in between commits, you can hop into the worktree directory and run a dev server (e.g. `bun dev`) there directly and observe the agent's work in real-time.

docs/workspaces.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,27 @@ The workspace backend is selected when you create a workspace:
2424
- **Parallel execution**: Run multiple workspaces simultaneously on different tasks
2525
- **Shared commits**: Local workspaces (using worktrees) share commits with the main repository immediately
2626

27+
## Reviewing Code
28+
29+
Here are a few practical approaches to reviewing changes from workspaces, depending on how much you want your agent to interact with `git`:
30+
31+
- **Agent codes, commits, and pushes**: Ask agent to submit a PR and review changes in your git Web UI (GitHub, GitLab, etc.)
32+
- Also see: [Agentic Git Identity](./agentic-git-identity.md)
33+
- This is the preferred approach for `cmux` development but requires additional care with repository security.
34+
- **Agent codes and commits**: Review changes from the main repository via `git diff <workspace-branch>`, push changes when deemed acceptable.
35+
- **Agent codes**: Enter worktree (click Terminal icon in workspace top bar), run `git add -p` and progressively accept changes into a commit.
36+
37+
## Reviewing Functionality
38+
39+
Some changes (especially UI ones) require the Human to determine acceptability. An effective approach for this is:
40+
41+
1. Ask agent to commit WIP when it's ready for Human review
42+
2. Human, in main repository, checks out the workspace branch in a detached HEAD state: `git checkout --detach <workspace-branch>` (for local workspaces)
43+
44+
**Note**: For local workspaces, this workflow uses the detached HEAD state because the branch is already checked out in the workspace and you cannot check out the same branch multiple times across worktrees.
45+
46+
If you want faster iteration in between commits, you can hop into the workspace directory and run a dev server (e.g. `bun dev`) there directly and observe the agent's work in real-time.
47+
48+
---
49+
2750
See the specific workspace type pages for detailed setup and usage instructions.

0 commit comments

Comments
 (0)