Skip to content

Commit ded5109

Browse files
committed
docs: refines documentation
Updates documentation to reflect current features and improve clarity. Specifically: - Adds `protocol` field to agent config documentation. - Removes outdated information about planned AI CLI integrations. - Clarifies the purpose of MCP tools. - Excludes CNAME and CHANGELOG.md from pre-commit checks.
1 parent 6964cb1 commit ded5109

4 files changed

Lines changed: 16 additions & 31 deletions

File tree

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ repos:
44
rev: v6.0.0
55
hooks:
66
- id: end-of-file-fixer
7-
exclude: ^tests/__snapshots__/
7+
exclude: ^(tests/__snapshots__/|CNAME$)
88
- id: trailing-whitespace
99
exclude: ^tests/__snapshots__/
1010
- id: check-yaml
@@ -19,7 +19,7 @@ repos:
1919
rev: 1.0.0
2020
hooks:
2121
- id: mdformat
22-
exclude: ^(\.github/|README\.md$)
22+
exclude: ^(\.github/|README\.md$|CNAME$|CHANGELOG\.md$)
2323
additional_dependencies:
2424
- mdformat-gfm
2525
- mdformat-ruff

docs/config.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,15 @@ active = true
5050
"*" = "claude"
5151
```
5252

53-
| Field | Purpose |
54-
| --------------------- | --------------------- |
55-
| `identity` | Unique agent ID |
56-
| `name` | Display name |
57-
| `short_name` | Compact label |
58-
| `active` | Enable agent |
59-
| `run_command` | AUTO mode ACP command |
60-
| `interactive_command` | PAIR mode CLI command |
53+
| Field | Purpose |
54+
| --------------------- | ---------------------------- |
55+
| `identity` | Unique agent ID |
56+
| `name` | Display name |
57+
| `short_name` | Compact label |
58+
| `protocol` | Protocol type (default: acp) |
59+
| `active` | Enable agent |
60+
| `run_command` | AUTO mode ACP command |
61+
| `interactive_command` | PAIR mode CLI command |
6162

6263
### Multiple agents
6364

docs/index.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,9 @@ uv run kagan
1515

1616
## Supported AI CLIs
1717

18-
Available now:
19-
2018
- Claude Code
2119
- OpenCode
2220

23-
Coming soon:
24-
25-
- Gemini
26-
- Codex
27-
- More providers
28-
2921
## Key bindings (cheat sheet)
3022

3123
### Navigation

docs/user-guide.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,9 @@ Kagan is a keyboard-first Kanban TUI for AI-assisted development.
1313

1414
## Supported AI CLIs
1515

16-
Available now:
17-
1816
- Claude Code
1917
- OpenCode
2018

21-
Coming soon:
22-
23-
- Gemini
24-
- Codex
25-
- More providers
26-
2719
## Install & run
2820

2921
```bash
@@ -135,11 +127,11 @@ Press `p`, describe a goal, approve or refine the proposed tickets.
135127

136128
## MCP tools
137129

138-
| Tool | Purpose |
139-
| --------------------------------------- | ------------------------------------ |
140-
| `get_context(ticket_id)` | Ticket context + acceptance criteria |
141-
| `update_scratchpad(ticket_id, content)` | Append notes |
142-
| `request_review(ticket_id, summary)` | Move to REVIEW |
130+
| Tool | Purpose |
131+
| --------------------------------------- | ------------------------------------------------------------------------------------ |
132+
| `get_context(ticket_id)` | Get ticket context including title, description, acceptance criteria, and scratchpad |
133+
| `update_scratchpad(ticket_id, content)` | Append notes to ticket scratchpad |
134+
| `request_review(ticket_id, summary)` | Move PAIR ticket to REVIEW (requires all changes to be committed) |
143135

144136
Run server:
145137

0 commit comments

Comments
 (0)