Skip to content

docs: make start_here navigable #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Cheewye wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: make start_here navigable #136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 22 additions & 20 deletions START_HERE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,38 @@
This page is a human-first map of the iURi repo.

## Start with iURi Core
- `docs/core/README.md`
- [docs/core/README.md](docs/core/README.md)

## If you want X, read Y
- Core conversation pipeline: `backend/core/brain_core.py`
- Routing + presets: `backend/core/context_router.py`
- Guardian veracity policy + gate: `docs/veracity_v2_policy.md` and `backend/core/rag_agent/veracity_gate.py`
- Smoke/scenario harness: `backend/tools/smoke_context_router.py`
- Core conversation pipeline: [backend/core/brain_core.py](backend/core/brain_core.py)
- Routing + presets: [backend/core/context_router.py](backend/core/context_router.py)
- Guardian veracity policy + gate: [docs/veracity_v2_policy.md](docs/veracity_v2_policy.md) and [backend/core/rag_agent/veracity_gate.py](backend/core/rag_agent/veracity_gate.py)
- Smoke/scenario harness: [backend/tools/smoke_context_router.py](backend/tools/smoke_context_router.py)

## Repo quick map
- `backend/` server-side code
- `frontend/` web UI
- `sap/` safety, policy, and telemetry
- `tests/` tests
- `tools/` internal tools
- `docs/` documentation
- [backend/](backend/) server-side code
- [frontend/](frontend/) web UI
- [sap/](sap/) safety, policy, and telemetry
- [tests/](tests/) tests
- [tools/](tools/) internal tools
- [docs/](docs/) documentation

## Run locally
- Local prod smoke: `docs/deploy/LOCAL_PROD_SMOKE.md`
- Local prod smoke: [docs/deploy/LOCAL_PROD_SMOKE.md](docs/deploy/LOCAL_PROD_SMOKE.md)

## Applications
- Totem: `docs/totem/README.md`
- iURi Mar / Pescadores: `docs/legacy/README_pescadores.md`
- Totem: [docs/totem/README.md](docs/totem/README.md)
- iURi Mar / Pescadores: [docs/legacy/README_pescadores.md](docs/legacy/README_pescadores.md)

## Run the smoke/scenario harness
- `python -m backend.tools.smoke_context_router`
```bash
python -m backend.tools.smoke_context_router
```

## Shareable repo tour (6 bullets)
- iURi is a guarded conversation system with auditability.
- Start with `README.md` for the repo map.
- Institutional overview lives in `docs/totem/README.md`.
- The core pipeline is in `backend/core/brain_core.py`.
- Routing and presets live in `backend/core/context_router.py`.
- The smoke/scenario harness is in `backend/tools/smoke_context_router.py`.
- Start with [README.md](README.md) for the repo map.
- Institutional overview lives in [docs/totem/README.md](docs/totem/README.md).
- The core pipeline is in [backend/core/brain_core.py](backend/core/brain_core.py).
- Routing and presets live in [backend/core/context_router.py](backend/core/context_router.py).
- The smoke/scenario harness is in [backend/tools/smoke_context_router.py](backend/tools/smoke_context_router.py).