mirror of
https://github.com/rennf93/roboco.git
synced 2026-08-03 07:23:24 +02:00
Renn F
3441e37120
Post-audit sweep over the 135 audit-fix commits since19a474d3: 1. Stripped every # Fxxx: audit-ID token from comments AND every Fxxx token from docstring openings across 211 blocks / ~626 lines. The CEO flagged these twice: audit-issue IDs in code confuse future devs/agents. The descriptive text is preserved; only the Fxxx token is removed (and bloated narrative blocks trimmed to 1-3 lines keeping the one non-obvious invariant). 2. Trimmed bloated comments/docstrings to the concise standard (1-3 lines). 3. Added missing behavior-change docs for the audit-fix batch: prompts/roles (documenter, pr_reviewer, qa), user-facing docs (api auth, websockets, agent-gateway, megatask, merge-model, task-lifecycle, grok, resilience, conventions, panel, security, troubleshooting), and the RAG corpus (cell-pm, main-pm, pr-reviewer, qa roles; conventions; messaging-tools; escalation; megatask; task-claiming workflows). Comment/docstring/prose ONLY — zero code-line edits (verified: the diff contains no def/class/return/if/for/await/assignment/call lines). Gates green: ruff format + ruff check clean, mypy clean on roboco/. The only pytest failures are the pre-existing sync_branch tracing-decision gap (B1,250be5c2) — not sweep-caused and tracked separately.
RAG Knowledge Base Documentation
Optimized documentation for the RoboCo AI agent knowledge base. Each file is sized for effective RAG chunking.
Structure
docs/rag/
├── roles/ # Agent role responsibilities
├── workflows/ # Step-by-step task flows
├── standards/ # Coding, security, testing rules
├── architecture/ # System components
├── tools/ # MCP tools reference
└── troubleshooting/ # Common issues and fixes
Organization Principles
- One topic per file - Each file covers a single concept
- Chunk-friendly - Content fits in 512-1536 token chunks
- Self-contained - Each file provides complete context
- Actionable - Focus on what agents need to DO
For Agents
When searching the knowledge base:
- Use
roboco_kb_search()for semantic search - Use
roboco_rag_query()for AI-synthesized answers - Use
roboco_ask_mentor()for conversational help
See docs/rag/tools/kb-tools.md for the full KB tool reference.