getcompanion-ai/co-mono
1
0
Fork 0
mirror of https://github.com/getcompanion-ai/co-mono.git synced 2026-04-15 20:03:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: fix outdated custom tools paths and add missing header shortcut (#283)

Browse source 
* docs: fix custom tools example paths to use index.ts structure

* fix: add missing ctrl+g shortcut to startup header

* docs: fix /session -> /resume for session switching references
This commit is contained in:
Aliou Diallo 2025-12-23 03:29:31 +01:00 • committed by GitHub
parent 2953a9d8d4
commit 7470dde1e9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 10 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

6
packages/coding-agent/docs/custom-tools.md
View file

@ -192,7 +192,7 @@ interface ToolSessionEvent {
**Reasons:**
- `start`: Initial session load on startup
- `switch`: User switched to a different session (`/session`)
- `switch`: User switched to a different session (`/resume`)
- `branch`: User branched from a previous message (`/branch`)
- `clear`: User cleared the session (`/clear`)
@ -400,12 +400,12 @@ const factory: CustomToolFactory = (pi) => {
## Examples
See [`examples/custom-tools/todo.ts`](../examples/custom-tools/todo.ts) for a complete example with:
See [`examples/custom-tools/todo/index.ts`](../examples/custom-tools/todo/index.ts) for a complete example with:
- `onSession` for state reconstruction
- Custom `renderCall` and `renderResult`
- Proper branching support via details storage
Test with:
```bash
pi --tool packages/coding-agent/examples/custom-tools/todo.ts
pi --tool packages/coding-agent/examples/custom-tools/todo/index.ts
```

4
packages/coding-agent/docs/hooks.md
View file

@ -120,7 +120,7 @@ user branches (/branch)
├─► session (reason: "before_branch", can cancel)
└─► session (reason: "branch", AFTER branch)
user switches session (/session)
user switches session (/resume)
│
├─► session (reason: "before_switch", can cancel)
└─► session (reason: "switch", AFTER switch)
@ -165,7 +165,7 @@ pi.on("session", async (event, ctx) => {
**Reasons:**
- `start`: Initial session load on startup
- `before_switch` / `switch`: User switched sessions (`/session`)
- `before_switch` / `switch`: User switched sessions (`/resume`)
- `before_clear` / `clear`: User cleared the session (`/clear`)
- `before_branch` / `branch`: User branched the session (`/branch`)
- `shutdown`: Process is exiting (double Ctrl+C, Ctrl+D, or SIGTERM)