docs: update process and contributor guidance

This commit is contained in:
“BeeRad”
2026-03-07 11:44:27 +11:00
parent 467a588713
commit 46ac8d9bde
6 changed files with 87 additions and 54 deletions
+22 -45
View File
@@ -1,15 +1,14 @@
# RA-OS - Knowledge Management System
# RA-OS
## What This Is
LLM-powered knowledge management system built for emergence and flexibility. This is the **open source, self-hosted version** with BYO (bring your own) API keys.
Open-source, local-first knowledge graph app with MCP integration.
## Tech Stack
- Next.js 15 + TypeScript + Tailwind CSS
- SQLite + sqlite-vec (vector search)
- Anthropic (Claude) + OpenAI (GPT) models via Vercel AI SDK
- 3-panel UI: Nodes | Focus | Helpers
## Core Stack
- Next.js 15 + TypeScript + Tailwind
- SQLite + sqlite-vec
- BYO API keys (OpenAI/Anthropic)
## Quick Start
## Run Locally
```bash
git clone https://github.com/bradwmorris/ra-h_os.git
cd ra-h_os
@@ -19,42 +18,20 @@ scripts/dev/bootstrap-local.sh
npm run dev
```
Open http://localhost:3000 and enter your API keys (OpenAI + Anthropic).
## Source of Truth for Workflow
- `AGENTS.md` - agent and contributor workflow
- `CONTRIBUTING.md` - PR and contribution policy
## Agent System
**Orchestrator (Easy Mode):** GPT-5 Mini - DEFAULT - fast, cheap orchestration
**Orchestrator (Hard Mode):** Claude Sonnet 4.5 - deep reasoning (toggle via UI)
**Oracle (Wise ra-h):** GPT-5 - complex workflows, multi-step planning
**Delegates:** GPT-4o mini - spawned for write operations, extraction, batch tasks
## Key Paths
- `src/services/database/` - data layer
- `src/tools/` - MCP tool implementations
- `src/config/guides/` - built-in guide content
- `app/api/` - API routes
Tools available: queryNodes, queryEdge, searchContentEmbeddings, webSearch, think, executeWorkflow, createNode, updateNode, createEdge, updateEdge, youtubeExtract, websiteExtract, paperExtract
## Workflows System
- **Code-first registry:** Defined in `src/services/workflows/registry.ts`
- **Integrate workflow:** Database-wide connection discovery for focused nodes
- 5-step process: plan → ground → search → contextualize → append
- Finds 3-8 strong connections across your database
## Database
- SQLite at `~/Library/Application Support/RA-H/db/rah.sqlite`
- Schema defined in `docs/2_schema.md`
- Health check: `GET /api/health/db`
## Key Files
- `src/services/agents/` - Agent executors and delegation
- `src/tools/` - All available tools
- `src/config/prompts/` - Agent system prompts
- `src/services/workflows/` - Workflow definitions
- `src/components/` - React components
## Documentation
- `docs/0_overview.md` - System overview
- `docs/1_architecture.md` - Architecture details
- `docs/2_schema.md` - Database schema
- `docs/4_tools-and-workflows.md` - Tools reference
## Contributing
See `CONTRIBUTING.md` for guidelines. Issues and PRs welcome!
## License
MIT - see LICENSE file
## Docs
- `docs/README.md`
- `docs/0_overview.md`
- `docs/2_schema.md`
- `docs/4_tools-and-guides.md`
- `docs/6_ui.md`
- `docs/8_mcp.md`