Skip to content

Commit 4201c1c

Browse files
Dchuong03claude
andcommitted
docs: fix all documentation for publish readiness
- Delete TEAM_MANAGEMENT.md (documents non-existent feature) - Delete USER_GUIDE_VIEW_ONLY_APP.md (wrong premise - app is not view-only) - Rewrite GETTING_STARTED.md: fix CLI flags, update tagline, correct shortcuts - Rewrite CLAUDE_CODE_INTEGRATION.md: accurate 32 MVP tools, add CLI init, remove non-existent team/session tools, add OKR/Training tools - Rewrite QUICK_START.md: CLI init first, complete tool list, fix build command - Fix DEMO_SCENARIOS.md: correct shortcuts (Knowledge=Cmd+3, Sessions via Cmd+2) - Fix PRODUCT_STRATEGY.md: update messaging from orchestration to intelligence - Fix docs/README.md: update tagline, remove deleted doc references Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 40eab9a commit 4201c1c

8 files changed

Lines changed: 326 additions & 1032 deletions

docs/CLAUDE_CODE_INTEGRATION.md

Lines changed: 93 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,35 @@ Integrate SidStack with Claude Code via the Model Context Protocol (MCP).
44

55
## Setup
66

7-
### 1. Configure MCP Server
7+
### Option 1: CLI Init (Recommended)
88

9-
Add to your Claude Code settings (`.mcp.json` or MCP settings UI):
9+
```bash
10+
cd your-project
11+
npx @sidstack/cli init --scan
12+
```
13+
14+
This automatically:
15+
- Creates `.mcp.json` with the MCP server config
16+
- Creates `.claude/settings.local.json` for tool auto-approval
17+
- Sets up governance (principles, skills)
18+
- Generates knowledge docs from your codebase
19+
20+
### Option 2: Manual MCP Config
21+
22+
Add to `.mcp.json` or Claude Code MCP settings:
1023

1124
```json
1225
{
1326
"mcpServers": {
1427
"sidstack": {
1528
"command": "npx",
16-
"args": ["-y", "@sidstack/mcp-server"],
17-
"env": {
18-
"SIDSTACK_PROJECT_PATH": "/path/to/your/project",
19-
"SIDSTACK_API_URL": "http://localhost:19432"
20-
}
29+
"args": ["-y", "@sidstack/mcp-server"]
2130
}
2231
}
2332
}
2433
```
2534

26-
### 2. Start the API Server
27-
28-
The desktop app starts the API server automatically. For CLI-only usage:
29-
30-
```bash
31-
sidstack serve
32-
```
33-
34-
This starts the REST API on `localhost:19432`.
35-
36-
### 3. Verify Connection
35+
### Verify Connection
3736

3837
In Claude Code, ask:
3938
```
@@ -42,96 +41,74 @@ List my SidStack tasks
4241

4342
Claude should use the `task_list` MCP tool.
4443

45-
## Available MCP Tools
44+
## Available MCP Tools (32)
4645

47-
### Task Management
46+
### Knowledge (9)
4847

4948
| Tool | Description |
5049
|------|-------------|
51-
| `task_create` | Create a new task with governance |
52-
| `task_list` | List tasks with filters |
53-
| `task_get` | Get task details |
54-
| `task_update` | Update status/progress |
55-
| `task_breakdown` | Split task into subtasks |
56-
| `task_complete` | Mark task as completed |
57-
| `task_governance_check` | Check governance compliance |
58-
59-
### Session Management
50+
| `knowledge_context` | Build context for a task/module |
51+
| `knowledge_search` | Search across knowledge docs |
52+
| `knowledge_list` | List available docs |
53+
| `knowledge_get` | Get single document with full content |
54+
| `knowledge_modules` | List modules with stats |
55+
| `knowledge_create` | Create knowledge document |
56+
| `knowledge_update` | Update knowledge document |
57+
| `knowledge_delete` | Delete knowledge document |
58+
| `knowledge_health` | Check knowledge coverage health |
59+
60+
### Tasks (5)
6061

6162
| Tool | Description |
6263
|------|-------------|
63-
| `session_launch` | Launch Claude session in terminal |
64-
| `session_list` | List active/recent sessions |
65-
| `session_get` | Get session details |
66-
| `session_update_status` | Update session status |
67-
| `session_resume` | Resume a previous session |
68-
| `session_stats` | Get session statistics |
64+
| `task_create` | Create task with governance |
65+
| `task_update` | Update status/progress |
66+
| `task_list` | List tasks with filtering |
67+
| `task_get` | Get task details |
68+
| `task_complete` | Complete with quality gate check |
6969

70-
### Knowledge
70+
### Impact Analysis (3)
7171

7272
| Tool | Description |
7373
|------|-------------|
74-
| `knowledge_list` | List knowledge documents |
75-
| `knowledge_get` | Get document content |
76-
| `knowledge_search` | Search documents by keyword |
77-
| `knowledge_context` | Build context for Claude sessions |
78-
| `knowledge_modules` | List modules with doc counts |
74+
| `impact_analyze` | Run impact analysis on a change |
75+
| `impact_check_gate` | Check gate status (blocked/warning/clear) |
76+
| `impact_list` | List analyses |
7977

80-
### Tickets
78+
### Tickets (4)
8179

8280
| Tool | Description |
8381
|------|-------------|
84-
| `ticket_create` | Create a ticket |
85-
| `ticket_list` | List tickets |
86-
| `ticket_get` | Get ticket details |
82+
| `ticket_create` | Create ticket |
83+
| `ticket_list` | List/filter tickets |
8784
| `ticket_update` | Update ticket status |
88-
| `ticket_start_session` | Start session for ticket |
8985
| `ticket_convert_to_task` | Convert ticket to task |
9086

91-
### Impact Analysis
87+
### Training (8)
9288

9389
| Tool | Description |
9490
|------|-------------|
95-
| `impact_analyze` | Run impact analysis |
96-
| `impact_check_gate` | Check gate status |
97-
| `impact_run_validation` | Run validation check |
98-
| `impact_approve_gate` | Approve gate |
99-
| `impact_list` | List analyses |
91+
| `incident_create` | Report an incident |
92+
| `incident_list` | List incidents |
93+
| `lesson_create` | Create lesson from incident |
94+
| `lesson_list` | List lessons |
95+
| `skill_create` | Create reusable skill |
96+
| `skill_list` | List skills |
97+
| `rule_check` | Check rules for context |
98+
| `training_context_get` | Get training context for session |
10099

101-
### Training Room
100+
### OKRs (2)
102101

103102
| Tool | Description |
104103
|------|-------------|
105-
| `incident_create` | Create incident report |
106-
| `lesson_create` | Create lesson from incident |
107-
| `lesson_approve` | Approve a lesson |
108-
| `skill_create` | Create skill from lesson |
109-
| `rule_create` | Create enforcement rule |
110-
| `rule_check` | Check rule compliance |
104+
| `okr_list` | List objectives and key results |
105+
| `okr_update` | Update key result progress |
111106

112-
### Teams
107+
### Sessions (1)
113108

114109
| Tool | Description |
115110
|------|-------------|
116-
| `team_create` | Create agent team |
117-
| `team_list` | List teams |
118-
| `team_add_member` | Add agent to team |
119-
| `team_remove_member` | Remove agent from team |
120-
121-
## Hook System
122-
123-
SidStack includes hooks that run automatically during Claude Code sessions:
124-
125-
### Pre-Edit Impact Check
126-
Before editing files, SidStack checks if the affected module has open impact analysis blockers. This provides warnings but does not block edits.
127-
128-
Bypass with:
129-
```bash
130-
SIDSTACK_SKIP_IMPACT_CHECK=1
131-
```
132-
133-
### Task Start Suggestion
134-
When a task starts, SidStack suggests running impact analysis for high-impact task types (feature, refactor, breaking_change, architecture).
111+
| `session_launch` | Launch Claude session with context |
135112

136113
## Governance for Agents
137114

@@ -141,7 +118,7 @@ Agents automatically follow governance rules from `.sidstack/governance.md`:
141118
Rules agents must follow (code quality, testing, security, collaboration).
142119

143120
### Skills
144-
Capability-based workflows agents use for implementation, design, testing, review, and deployment.
121+
Capability-based workflows agents use for implementation and review.
145122

146123
### Quality Gates
147124
```bash
@@ -163,17 +140,16 @@ pnpm test # Must pass
163140
3. "Analyze the impact of this change"
164141
→ impact_analyze
165142
166-
4. "Launch a session to implement this"
167-
→ session_launch
143+
4. [Implement the feature]
168144
169145
5. "Mark the task as complete"
170146
→ task_complete (runs quality gates)
171147
```
172148

173-
### Bug Fix
149+
### Bug Fix with Learning
174150
```
175151
1. "Create a bugfix task for the login timeout"
176-
→ task_create (requires acceptance criteria)
152+
→ task_create
177153
178154
2. "Start working on this task"
179155
→ task_update (status: in_progress)
@@ -189,3 +165,36 @@ pnpm test # Must pass
189165
6. "Complete the task"
190166
→ task_complete
191167
```
168+
169+
### Ticket-Driven Work
170+
```
171+
1. "Create a ticket for the Safari login bug"
172+
→ ticket_create
173+
174+
2. "Approve the ticket and convert to task"
175+
→ ticket_update (status: approved)
176+
→ ticket_convert_to_task
177+
178+
3. "Load context for this task"
179+
→ knowledge_context
180+
181+
4. [Implement the fix]
182+
183+
5. "Complete the task"
184+
→ task_complete
185+
```
186+
187+
### OKR-Driven Work
188+
```
189+
1. "Show our project goals"
190+
→ okr_list
191+
192+
2. "Create a task for KR-1.1"
193+
→ task_create
194+
195+
3. [Implement the feature]
196+
197+
4. "Complete the task and update OKR progress"
198+
→ task_complete
199+
→ okr_update
200+
```

docs/DEMO_SCENARIOS.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Step-by-step scenarios showcasing SidStack's key features.
9797

9898
### Steps
9999

100-
1. **Open Sessions** (`5`)
100+
1. **Open Task Manager** (`2`)
101101
2. **Launch new session**:
102102
- Click "Launch Session" button
103103
- Select workspace path
@@ -164,7 +164,7 @@ Step-by-step scenarios showcasing SidStack's key features.
164164

165165
### Steps
166166

167-
1. **Open Knowledge Browser** (`2`)
167+
1. **Open Knowledge Browser** (`3`)
168168
2. **Browse by type** - filter by:
169169
- Business Logic
170170
- API Endpoints
@@ -223,26 +223,25 @@ Step-by-step scenarios showcasing SidStack's key features.
223223

224224
1. **Initialize governance** in a new project:
225225
```bash
226-
sidstack init --governance
226+
npx @sidstack/cli init --scan
227227
```
228228
2. **Show governance structure**:
229229
```bash
230-
sidstack governance show
230+
npx @sidstack/cli governance show
231231
```
232232
3. **Check compliance**:
233233
```bash
234-
sidstack governance check --json
234+
npx @sidstack/cli governance check --json
235235
```
236-
4. **Spawn a governed agent** in Claude Code:
236+
4. **Use in Claude Code**:
237237
```
238-
/sidstack:agent worker Implement user registration with email verification
238+
/sidstack
239239
```
240240
5. **Observe agent behavior**:
241241
- Agent reads principles before starting
242242
- Follows capability skill (implement/feature.md)
243243
- Creates task, tracks progress
244244
- Runs quality gates before completing
245-
- Uses handoff protocol if spawning sub-agents
246245

247246
### What to highlight
248247
- Zero-config governance setup

0 commit comments

Comments
 (0)