Skip to content

Commit 0476d89

Browse files
authored
[docs] Fix stale documentation (#87)
[docs] Fix stale documentation across agent files and command reference
1 parent 3943bfe commit 0476d89

6 files changed

Lines changed: 17 additions & 19 deletions

File tree

.claude/skills/rimba/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ curl -sSfL https://raw.githubusercontent.com/lugassawan/rimba/main/scripts/insta
2222
| See all worktrees | `rimba list` or `rimba list --json` |
2323
| Check worktree health | `rimba status` |
2424
| Navigate to a worktree | `cd $(rimba open <task>)` |
25-
| Update from source branch | `rimba sync <task>` or `rimba sync` (all) |
26-
| Finish a feature | `rimba merge <task>` then `rimba remove <task>` |
25+
| Update from source branch | `rimba sync <task>` or `rimba sync --all` |
26+
| Finish a feature | `rimba merge <task>` (auto-removes worktree) |
2727
| Clean up merged work | `rimba clean --merged` |
2828
| Pause a task | `rimba archive <task>` (keeps branch) |
2929
| Run across worktrees | `rimba exec "<cmd>"` |

.cursor/rules/rimba.mdc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ See AGENTS.md at the repo root for full documentation.
1616
2. `rimba list` — list all worktrees
1717
3. `rimba status` — health overview (dirty, stale, behind)
1818
4. `rimba open <task>` — print path or run shortcut (--ide, --agent)
19-
5. `rimba sync [task]` — rebase worktree(s) onto source
20-
6. `rimba merge <task>` — fast-forward merge into source
19+
5. `rimba sync [task]` — rebase worktree(s) onto main
20+
6. `rimba merge <task>` — merge into main and auto-clean up
2121
7. `rimba remove <task>` — delete worktree + branch
2222
8. `rimba archive <task>` — remove worktree, keep branch
2323
9. `rimba exec <cmd>` — run across all worktrees
@@ -27,7 +27,7 @@ See AGENTS.md at the repo root for full documentation.
2727
## Workflow Recipes
2828

2929
**New feature:** `rimba add <task>` then work in the worktree directory.
30-
**Finish feature:** `rimba merge <task>` then `rimba remove <task>`.
30+
**Finish feature:** `rimba merge <task>` (auto-removes worktree).
3131
**Housekeeping:** `rimba status` then `rimba clean --merged`.
3232

3333
## JSON Output

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ See AGENTS.md at the repo root for full rimba documentation.
99

1010
- `rimba add <task>` — create worktree
1111
- `rimba list` / `rimba status` — inspect worktrees
12-
- `rimba merge <task>` — merge back to source branch
12+
- `rimba merge <task>` — merge into main and auto-clean up
1313
- `rimba clean --merged` — remove merged worktrees
1414
- `rimba exec <cmd>` — run command across all worktrees
1515
- `rimba mcp` — start MCP server for AI tool integration

AGENTS.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ curl -sSfL https://raw.githubusercontent.com/lugassawan/rimba/main/scripts/insta
2121
| Concern | Commands |
2222
|---------|----------|
2323
| Create & navigate | `rimba add <task>`, `rimba open <task>` |
24-
| Inspect | `rimba list`, `rimba status`, `rimba log [task]` |
24+
| Inspect | `rimba list`, `rimba status`, `rimba log` |
2525
| Sync & merge | `rimba sync [task]`, `rimba merge <task>` |
2626
| Clean up | `rimba clean --merged`, `rimba archive <task>`, `rimba remove <task>` |
2727
| Cross-cutting | `rimba exec <cmd>`, `rimba conflict-check`, `rimba deps status` |
@@ -43,8 +43,7 @@ rimba clean --merged # remove worktrees whose branches are merged
4343

4444
**Merge and clean up:**
4545
```sh
46-
rimba merge my-feature # fast-forward merge into source branch
47-
rimba remove my-feature # remove worktree + branch
46+
rimba merge my-feature # merge into main and auto-clean up
4847
```
4948

5049
## JSON Output

docs/commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -514,7 +514,7 @@ rimba update --force # Also works on dev builds
514514
|------|-------------|
515515
| `--force` | Update even if running a development build |
516516

517-
> **Note:** If the binary cannot be replaced due to file permissions, rimba automatically retries with `sudo`.
517+
> **Note:** If the binary cannot be replaced due to file permissions, rimba installs to `~/.local/bin` instead.
518518
519519
---
520520

internal/agentfile/content.go

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ curl -sSfL https://raw.githubusercontent.com/lugassawan/rimba/main/scripts/insta
2828
| Concern | Commands |
2929
|---------|----------|
3030
| Create & navigate | ` + "`" + `rimba add <task>` + "`" + `, ` + "`" + `rimba open <task>` + "`" + ` |
31-
| Inspect | ` + "`" + `rimba list` + "`" + `, ` + "`" + `rimba status` + "`" + `, ` + "`" + `rimba log [task]` + "`" + ` |
31+
| Inspect | ` + "`" + `rimba list` + "`" + `, ` + "`" + `rimba status` + "`" + `, ` + "`" + `rimba log` + "`" + ` |
3232
| Sync & merge | ` + "`" + `rimba sync [task]` + "`" + `, ` + "`" + `rimba merge <task>` + "`" + ` |
3333
| Clean up | ` + "`" + `rimba clean --merged` + "`" + `, ` + "`" + `rimba archive <task>` + "`" + `, ` + "`" + `rimba remove <task>` + "`" + ` |
3434
| Cross-cutting | ` + "`" + `rimba exec <cmd>` + "`" + `, ` + "`" + `rimba conflict-check` + "`" + `, ` + "`" + `rimba deps status` + "`" + ` |
@@ -50,8 +50,7 @@ rimba clean --merged # remove worktrees whose branches are merged
5050
5151
**Merge and clean up:**
5252
` + "```" + `sh
53-
rimba merge my-feature # fast-forward merge into source branch
54-
rimba remove my-feature # remove worktree + branch
53+
rimba merge my-feature # merge into main and auto-clean up
5554
` + "```" + `
5655
5756
## JSON Output
@@ -83,7 +82,7 @@ See AGENTS.md at the repo root for full rimba documentation.
8382
8483
- ` + "`" + `rimba add <task>` + "`" + ` — create worktree
8584
- ` + "`" + `rimba list` + "`" + ` / ` + "`" + `rimba status` + "`" + ` — inspect worktrees
86-
- ` + "`" + `rimba merge <task>` + "`" + ` — merge back to source branch
85+
- ` + "`" + `rimba merge <task>` + "`" + ` — merge into main and auto-clean up
8786
- ` + "`" + `rimba clean --merged` + "`" + ` — remove merged worktrees
8887
- ` + "`" + `rimba exec <cmd>` + "`" + ` — run command across all worktrees
8988
- ` + "`" + `rimba mcp` + "`" + ` — start MCP server for AI tool integration
@@ -124,8 +123,8 @@ See AGENTS.md at the repo root for full documentation.
124123
2. ` + "`" + `rimba list` + "`" + ` — list all worktrees
125124
3. ` + "`" + `rimba status` + "`" + ` — health overview (dirty, stale, behind)
126125
4. ` + "`" + `rimba open <task>` + "`" + ` — print path or run shortcut (--ide, --agent)
127-
5. ` + "`" + `rimba sync [task]` + "`" + ` — rebase worktree(s) onto source
128-
6. ` + "`" + `rimba merge <task>` + "`" + ` — fast-forward merge into source
126+
5. ` + "`" + `rimba sync [task]` + "`" + ` — rebase worktree(s) onto main
127+
6. ` + "`" + `rimba merge <task>` + "`" + ` — merge into main and auto-clean up
129128
7. ` + "`" + `rimba remove <task>` + "`" + ` — delete worktree + branch
130129
8. ` + "`" + `rimba archive <task>` + "`" + ` — remove worktree, keep branch
131130
9. ` + "`" + `rimba exec <cmd>` + "`" + ` — run across all worktrees
@@ -135,7 +134,7 @@ See AGENTS.md at the repo root for full documentation.
135134
## Workflow Recipes
136135
137136
**New feature:** ` + "`" + `rimba add <task>` + "`" + ` then work in the worktree directory.
138-
**Finish feature:** ` + "`" + `rimba merge <task>` + "`" + ` then ` + "`" + `rimba remove <task>` + "`" + `.
137+
**Finish feature:** ` + "`" + `rimba merge <task>` + "`" + ` (auto-removes worktree).
139138
**Housekeeping:** ` + "`" + `rimba status` + "`" + ` then ` + "`" + `rimba clean --merged` + "`" + `.
140139
141140
## JSON Output
@@ -177,8 +176,8 @@ curl -sSfL https://raw.githubusercontent.com/lugassawan/rimba/main/scripts/insta
177176
| See all worktrees | ` + "`" + `rimba list` + "`" + ` or ` + "`" + `rimba list --json` + "`" + ` |
178177
| Check worktree health | ` + "`" + `rimba status` + "`" + ` |
179178
| Navigate to a worktree | ` + "`" + `cd $(rimba open <task>)` + "`" + ` |
180-
| Update from source branch | ` + "`" + `rimba sync <task>` + "`" + ` or ` + "`" + `rimba sync` + "`" + ` (all) |
181-
| Finish a feature | ` + "`" + `rimba merge <task>` + "`" + ` then ` + "`" + `rimba remove <task>` + "`" + ` |
179+
| Update from source branch | ` + "`" + `rimba sync <task>` + "`" + ` or ` + "`" + `rimba sync --all` + "`" + ` |
180+
| Finish a feature | ` + "`" + `rimba merge <task>` + "`" + ` (auto-removes worktree) |
182181
| Clean up merged work | ` + "`" + `rimba clean --merged` + "`" + ` |
183182
| Pause a task | ` + "`" + `rimba archive <task>` + "`" + ` (keeps branch) |
184183
| Run across worktrees | ` + "`" + `rimba exec "<cmd>"` + "`" + ` |

0 commit comments

Comments
 (0)