docs: standardize RA-OS naming and add process docs

This commit is contained in:
“BeeRad”
2026-02-01 09:47:33 +11:00
parent 6c510096a3
commit 16db5b61b6
13 changed files with 134 additions and 38 deletions
+37
View File
@@ -0,0 +1,37 @@
# Documentation Process (RA-OS)
Docs should be short, accurate, and easy to scan. Prefer clarity over completeness.
## Where Things Live
- `README.md` — one-page product + quick start.
- `docs/README.md` — docs index (add new docs here).
- `docs/0_overview.md` — product overview + core concepts.
- `docs/4_tools-and-workflows.md` — MCP tools + guides.
- `docs/8_mcp.md` — setup + troubleshooting for MCP.
## Update Rules
- If behavior changes, update the relevant doc and the docs index.
- If MCP tools change, update both the tools table and the schemas.
- If the UI changes meaningfully, update `docs/6_ui.md`.
- Keep naming consistent: **RA-OS** only.
## Style Guidelines
- Use short sections and bullets.
- Keep code blocks minimal and copy-pastable.
- Use ASCII art sparingly (hero or section headers only).
- Avoid hype and marketing tone in docs.
## Media
- Place screenshots/GIFs in `docs/assets/`.
- Keep GIFs under 5MB.
- Prefer static screenshots when possible.
## Docs QA
- Read each changed doc top-to-bottom.
- Verify all paths and commands.
- Ensure the quick start still works on a clean clone.
+48
View File
@@ -0,0 +1,48 @@
# Development Process (RA-OS)
This repo is the open-source build of RA-H. Keep changes focused, reviewable, and easy to sync upstream.
## Branching
- Create a feature branch off `main` for all changes.
- Use short, descriptive names: `docs-...`, `fix-...`, `feat-...`.
- Avoid direct commits to `main`.
## Local Setup
```bash
git clone https://github.com/bradwmorris/ra-h_os.git
cd ra-h_os
npm install
npm rebuild better-sqlite3
scripts/dev/bootstrap-local.sh
npm run dev
```
## Dev Loop
1. Reproduce or define the change.
2. Implement in a small, isolated diff.
3. Run checks (see below).
4. Update docs if behavior or UX changes.
## Checks
```bash
npm run type-check
npm run lint
npm run build
```
## PR Checklist
- Clear description of the change and why it matters.
- Screenshots or GIFs for UI changes.
- Docs updated if the public-facing behavior changed.
- Checks pass locally.
## Sync Policy (Private Upstream)
- Changes land in `ra-h_os` first.
- If a change should exist in the private repo, it will be ported upstream.
- Public contributions will not be overwritten by syncs.