docs: streamline repo docs, point to ra-h.app/docs
- Delete CODE_OF_CONDUCT.md (generic boilerplate) - Simplify README.md, link to ra-h.app/docs as primary - Simplify CONTRIBUTING.md - Fix bug_report.md (was referencing PostgreSQL, uses SQLite) - Gut bloated PR template - Simplify feature_request.md - Update docs/README.md to point to website - Update docs/9_open-source.md
This commit is contained in:
@@ -1,6 +1,8 @@
|
||||
# RA-H Open Source
|
||||
|
||||
This is the open source, BYO-key (bring your own API keys) version of RA-H.
|
||||
**Full docs:** [ra-h.app/docs](https://ra-h.app/docs)
|
||||
|
||||
This is the open source, BYO-key version of RA-H.
|
||||
|
||||
## What's Included
|
||||
|
||||
@@ -8,6 +10,7 @@ This is the open source, BYO-key (bring your own API keys) version of RA-H.
|
||||
- Local SQLite storage with vector search
|
||||
- Complete agent system (ra-h, mini-rah, wise-rah)
|
||||
- All tools and workflows
|
||||
- MCP server for external AI assistants
|
||||
- Settings panel with API key management
|
||||
|
||||
## What's Not Included
|
||||
@@ -17,14 +20,14 @@ This is the open source, BYO-key (bring your own API keys) version of RA-H.
|
||||
- Subscription/payment system
|
||||
- Auto-updates
|
||||
|
||||
## Relationship to Private Repo
|
||||
## Relationship to Main Repo
|
||||
|
||||
This repo is a **mirror** of the private `ra-h` repository. Features are developed privately and synced here periodically.
|
||||
This repo is a mirror of the private `ra-h` repository. Features are developed privately and synced here.
|
||||
|
||||
- **Contributions welcome** - See [CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- **Bug reports** - Open an issue on GitHub
|
||||
- **Feature requests** - Open an issue; major features are typically built in the private repo first
|
||||
- **Bug reports** - Open an issue
|
||||
- **Feature requests** - Open an issue; major features typically built privately first
|
||||
|
||||
## Setup
|
||||
|
||||
See the main [README.md](../README.md) for installation instructions.
|
||||
See [README.md](../README.md) for installation.
|
||||
|
||||
+17
-30
@@ -1,46 +1,33 @@
|
||||
# RA-H Documentation
|
||||
|
||||
Technical documentation for RA-H — AI-powered knowledge management.
|
||||
**Primary documentation:** [ra-h.app/docs](https://ra-h.app/docs)
|
||||
|
||||
The website docs are the source of truth. These local docs are a reference mirror.
|
||||
|
||||
## Quick Links
|
||||
|
||||
- **Full Docs:** [ra-h.app/docs](https://ra-h.app/docs)
|
||||
- **Website:** [ra-h.app](https://ra-h.app)
|
||||
- **Download:** [ra-h.app/download](https://ra-h.app/download)
|
||||
- **Open Source:** [github.com/bradwmorris/ra-h_os](https://github.com/bradwmorris/ra-h_os)
|
||||
- **GitHub:** [github.com/bradwmorris/ra-h_os](https://github.com/bradwmorris/ra-h_os)
|
||||
|
||||
## Documentation Index
|
||||
## Local Reference
|
||||
|
||||
| # | Document | Description |
|
||||
|---|----------|-------------|
|
||||
| 0 | [Overview](./0_overview.md) | What is RA-H, design philosophy, tech stack |
|
||||
| 0 | [Overview](./0_overview.md) | What is RA-H, design philosophy |
|
||||
| 1 | [Architecture](./1_architecture.md) | Agent hierarchy, system design |
|
||||
| 2 | [Schema](./2_schema.md) | Database schema, nodes, edges, embeddings |
|
||||
| 3 | [Context & Memory](./3_context-and-memory.md) | Auto-context system, how agents see your knowledge |
|
||||
| 4 | [Tools & Workflows](./4_tools-and-workflows.md) | Available tools, editable workflows |
|
||||
| 5 | [Logging & Evals](./5_logging-and-evals.md) | Debugging, evaluation framework |
|
||||
| 6 | [UI](./6_ui.md) | 3-panel layout, views, Settings |
|
||||
| 7 | [Voice](./7_voice.md) | Voice interface (STT/TTS) |
|
||||
| 8 | [MCP Server](./8_mcp.md) | External agent connector (Claude Code, etc.) |
|
||||
| 9 | [Open Source](./9_open-source.md) | Sync strategy, repo differences |
|
||||
| 3 | [Context & Memory](./3_context-and-memory.md) | Auto-context system |
|
||||
| 4 | [Tools & Workflows](./4_tools-and-workflows.md) | Available tools, workflows |
|
||||
| 5 | [Logging & Evals](./5_logging-and-evals.md) | Debugging, evaluation |
|
||||
| 6 | [UI](./6_ui.md) | 3-panel layout, views |
|
||||
| 7 | [Voice](./7_voice.md) | Voice interface |
|
||||
| 8 | [MCP Server](./8_mcp.md) | External agent connector |
|
||||
|
||||
## For Users
|
||||
## Troubleshooting
|
||||
|
||||
Start here:
|
||||
1. [Overview](./0_overview.md) — What RA-H is and how it works
|
||||
2. [MCP Server](./8_mcp.md) — Connect Claude Code to your knowledge base
|
||||
See [TROUBLESHOOTING.md](./TROUBLESHOOTING.md) for common issues.
|
||||
|
||||
## For Developers
|
||||
## Questions?
|
||||
|
||||
If you're contributing or self-hosting:
|
||||
1. [Architecture](./1_architecture.md) — Understand the agent hierarchy
|
||||
2. [Schema](./2_schema.md) — Database structure
|
||||
3. [Tools & Workflows](./4_tools-and-workflows.md) — How to extend RA-H
|
||||
4. [Open Source](./9_open-source.md) — Contribution workflow
|
||||
|
||||
## Development Process
|
||||
|
||||
Internal development docs are in `docs/development/`:
|
||||
- `process/` — Workflow, handoff, kickstart
|
||||
- `backlog/` — Task backlog
|
||||
- `prd-*.md` — Product requirement documents
|
||||
- `completed/` — Archived PRDs
|
||||
Check [ra-h.app/docs](https://ra-h.app/docs) or open an issue on GitHub.
|
||||
|
||||
Reference in New Issue
Block a user