docs: pre-release audit and documentation improvements

- Simplify CONTRIBUTING.md for open source contributors
- Update version to 0.1.0 (Open Source) in overview
- Clarify BYO-key requirement in UI docs
- Expand open source explanation in docs/9
- Add comprehensive pre-public release audit notes
This commit is contained in:
“BeeRad”
2025-12-24 09:43:51 +11:00
parent 79895100c0
commit 52602a06c4
5 changed files with 237 additions and 160 deletions
+27 -6
View File
@@ -1,9 +1,30 @@
# RA-H BYO-Key Plan (Future Work)
# RA-H Open Source
The production repo remains private and powers the packaged Mac app. A separate, minimal open-source project will be created later for users who want to run RA-H with their own API keys. That future repo will include:
This is the open source, BYO-key (bring your own API keys) version of RA-H.
1. Basic three-panel UI
2. Local SQLite storage
3. Simple Settings → API Keys experience (no Supabase/subscription backend)
## What's Included
No active work is happening in this repo toward that goal right now. Track progress in `docs/development/prd-private-repo-reset.md`.
- Full three-panel UI (Nodes | Focus | Helpers)
- Local SQLite storage with vector search
- Complete agent system (ra-h, mini-rah, wise-rah)
- All tools and workflows
- Settings panel with API key management
## What's Not Included
- Mac app packaging (Tauri)
- Supabase authentication
- Subscription/payment system
- Auto-updates
## Relationship to Private Repo
This repo is a **mirror** of the private `ra-h` repository. Features are developed privately and synced here periodically.
- **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
## Setup
See the main [README.md](../README.md) for installation instructions.