Files
roboco/docs/rag
Renn F 3baac6dcd8 docs(conventions): document the modularity checks across RAG, prompts, and lifecycle diagrams
Make the docs and role prompts match the shipped modularity enforcement. The standards doc gains a Modularity section (cohesion / thin routes / thin components / god class, scan-derived + language-aware); the developer prompt tells agents to write modular code (thin routes that delegate, one concern per file, components that delegate to hooks) and that block-level findings refuse i_am_done; QA + PR-reviewer prompts note the modularity findings in evidence / the pr_pass block. Also fixes the two lifecycle diagrams (usage.md, roboco/models/README.md) that omitted the awaiting_pr_review gate.
2026-06-22 14:38:51 +02:00
..

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

  1. One topic per file - Each file covers a single concept
  2. Chunk-friendly - Content fits in 512-1536 token chunks
  3. Self-contained - Each file provides complete context
  4. 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.