mirror of
https://github.com/rennf93/roboco.git
synced 2026-08-03 07:23:24 +02:00
Documenter MCP tools and general support + improved workflow
This commit is contained in:
@@ -90,29 +90,31 @@ If none: `roboco_agent_idle()`
|
||||
- Understand what was built and why
|
||||
|
||||
### 6. WRITE
|
||||
**File Paths** - Write documentation to `/app/docs/`:
|
||||
- `/app/docs/backend/` - Backend documentation
|
||||
- `/app/docs/backend/api/` - API documentation
|
||||
- `/app/docs/backend/changelog.md` - Changelog
|
||||
Use `roboco_docs_write()` - system handles paths and deduplication automatically:
|
||||
|
||||
**API Documentation** (if new/changed endpoints)
|
||||
- Endpoint URL, method
|
||||
- Request/response schemas
|
||||
- Example requests/responses
|
||||
- Error cases
|
||||
|
||||
**README Updates** (if new features)
|
||||
- Feature description
|
||||
- Usage examples
|
||||
- Configuration options
|
||||
|
||||
**Changelog Entry**
|
||||
```markdown
|
||||
## [version] - YYYY-MM-DD
|
||||
### Added/Changed/Fixed
|
||||
- {Description}
|
||||
```python
|
||||
roboco_docs_write({
|
||||
"task_id": "your-task-uuid",
|
||||
"filename": "user-api.md",
|
||||
"doc_type": "api", # api, qa, guide, readme, changelog, architecture, design
|
||||
"title": "User API Endpoints",
|
||||
"content": "# User API\n\n## GET /api/users\n..."
|
||||
})
|
||||
```
|
||||
|
||||
**SMART DEDUPLICATION**: System searches RAG for similar existing docs.
|
||||
- If similar doc exists → updates it (no duplicates)
|
||||
- If no match → creates new doc
|
||||
- You don't need to remember paths or check if doc exists
|
||||
|
||||
**Doc Types:**
|
||||
- `api` - API documentation
|
||||
- `qa` - QA test plans
|
||||
- `guide` - User guides
|
||||
- `readme` - README updates
|
||||
- `changelog` - Changelog entries
|
||||
- `architecture` - Architecture docs
|
||||
|
||||
Update progress: `roboco_task_progress(task_id, "Completed API docs...", 50)`
|
||||
|
||||
### 7. SUBMIT TO PM
|
||||
@@ -232,6 +234,9 @@ tools:
|
||||
- roboco_channel_list, roboco_channel_history
|
||||
- roboco_message_send, roboco_message_get, roboco_ask_question
|
||||
- roboco_session_history_for_task # Get discussion history for your task
|
||||
# Documentation (auto-deduplication via RAG)
|
||||
- roboco_docs_write # Write/update docs (handles dedup automatically)
|
||||
- roboco_docs_read, roboco_docs_list, roboco_docs_delete
|
||||
```
|
||||
|
||||
## Permissions
|
||||
|
||||
@@ -90,29 +90,30 @@ If none: `roboco_agent_idle()`
|
||||
- Understand usage patterns
|
||||
|
||||
### 6. WRITE
|
||||
**File Paths** - Write documentation to `/app/docs/`:
|
||||
- `/app/docs/frontend/` - Frontend documentation
|
||||
- `/app/docs/frontend/components/` - Component documentation
|
||||
- `/app/docs/frontend/changelog.md` - Changelog
|
||||
Use `roboco_docs_write()` - system handles paths and deduplication automatically:
|
||||
|
||||
**Component Documentation**
|
||||
- Props interface
|
||||
- Usage examples
|
||||
- States and variants
|
||||
- Accessibility notes
|
||||
|
||||
**README Updates** (if new features)
|
||||
- Feature description
|
||||
- Installation/setup
|
||||
- Usage examples
|
||||
|
||||
**Changelog Entry**
|
||||
```markdown
|
||||
## [version] - YYYY-MM-DD
|
||||
### Added/Changed/Fixed
|
||||
- {Description}
|
||||
```python
|
||||
roboco_docs_write({
|
||||
"task_id": "your-task-uuid",
|
||||
"filename": "button-component.md",
|
||||
"doc_type": "api", # api, qa, guide, readme, changelog, architecture, design
|
||||
"title": "Button Component",
|
||||
"content": "# Button Component\n\n## Props\n..."
|
||||
})
|
||||
```
|
||||
|
||||
**SMART DEDUPLICATION**: System searches RAG for similar existing docs.
|
||||
- If similar doc exists → updates it (no duplicates)
|
||||
- If no match → creates new doc
|
||||
- You don't need to remember paths or check if doc exists
|
||||
|
||||
**Doc Types:**
|
||||
- `api` - Component/API documentation
|
||||
- `guide` - Usage guides
|
||||
- `readme` - README updates
|
||||
- `changelog` - Changelog entries
|
||||
- `design` - Design documentation
|
||||
|
||||
### 7. SUBMIT TO PM
|
||||
`roboco_task_docs_complete(task_id, doc_notes?)` - Mark documentation done
|
||||
This sends the task to the Cell PM for final review and completion.
|
||||
@@ -230,6 +231,9 @@ tools:
|
||||
- roboco_channel_list, roboco_channel_history
|
||||
- roboco_message_send, roboco_message_get, roboco_ask_question
|
||||
- roboco_session_history_for_task # Get discussion history for your task
|
||||
# Documentation (auto-deduplication via RAG)
|
||||
- roboco_docs_write # Write/update docs (handles dedup automatically)
|
||||
- roboco_docs_read, roboco_docs_list, roboco_docs_delete
|
||||
```
|
||||
|
||||
## Permissions
|
||||
|
||||
@@ -90,29 +90,29 @@ If none: `roboco_agent_idle()`
|
||||
- Understand usage guidelines
|
||||
|
||||
### 6. WRITE
|
||||
**File Paths** - Write documentation to `/app/docs/`:
|
||||
- `/app/docs/ux_ui/` - UX/UI documentation
|
||||
- `/app/docs/ux_ui/design-system/` - Design system documentation
|
||||
- `/app/docs/ux_ui/changelog.md` - Changelog
|
||||
Use `roboco_docs_write()` - system handles paths and deduplication automatically:
|
||||
|
||||
**Component Guidelines**
|
||||
- When to use this component
|
||||
- Variants and states
|
||||
- Dos and don'ts
|
||||
- Accessibility notes
|
||||
|
||||
**Design System Updates**
|
||||
- Token additions/changes
|
||||
- Pattern documentation
|
||||
- Usage examples
|
||||
|
||||
**Changelog Entry**
|
||||
```markdown
|
||||
## [version] - YYYY-MM-DD
|
||||
### Added/Changed/Fixed
|
||||
- {Description}
|
||||
```python
|
||||
roboco_docs_write({
|
||||
"task_id": "your-task-uuid",
|
||||
"filename": "button-guidelines.md",
|
||||
"doc_type": "design", # api, qa, guide, readme, changelog, architecture, design
|
||||
"title": "Button Component Guidelines",
|
||||
"content": "# Button Guidelines\n\n## When to Use\n..."
|
||||
})
|
||||
```
|
||||
|
||||
**SMART DEDUPLICATION**: System searches RAG for similar existing docs.
|
||||
- If similar doc exists → updates it (no duplicates)
|
||||
- If no match → creates new doc
|
||||
- You don't need to remember paths or check if doc exists
|
||||
|
||||
**Doc Types:**
|
||||
- `design` - Design system documentation
|
||||
- `guide` - Usage guidelines
|
||||
- `readme` - README updates
|
||||
- `changelog` - Changelog entries
|
||||
|
||||
### 7. SUBMIT TO PM
|
||||
`roboco_task_docs_complete(task_id, doc_notes?)` - Mark documentation done
|
||||
This sends the task to the Cell PM for final review and completion.
|
||||
@@ -230,6 +230,9 @@ tools:
|
||||
- roboco_channel_list, roboco_channel_history
|
||||
- roboco_message_send, roboco_message_get, roboco_ask_question
|
||||
- roboco_session_history_for_task # Get discussion history for your task
|
||||
# Documentation (auto-deduplication via RAG)
|
||||
- roboco_docs_write # Write/update docs (handles dedup automatically)
|
||||
- roboco_docs_read, roboco_docs_list, roboco_docs_delete
|
||||
```
|
||||
|
||||
## Permissions
|
||||
|
||||
Reference in New Issue
Block a user