mirror of
https://github.com/rennf93/roboco.git
synced 2026-08-03 07:23:24 +02:00
Renn F
f48106cbb6
Markdown and editors soft-wrap on their own, so the manual ~75-char line breaks across the docs added nothing but noise. Join wrapped prose, list items, and paragraphs into single lines across 67 docs — README, CLAUDE.md, deployment, usage, the RAG knowledge base, and the agent role prompts. Whitespace-only: code fences, tables, and blockquote alerts are byte-identical and the change is token-verified (no content altered). Applied with a deterministic reflow tool (committed separately). Also lands two doc edits that were awaiting commit: the measured under-load resource numbers in usage.md and the pr_reviewer additions to the org-structure RAG doc.
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.