From 64c64a41288f3ab2008de589b7df77807013de0c Mon Sep 17 00:00:00 2001 From: Cheewye Date: Thu, 29 Jan 2026 14:14:20 -0300 Subject: [PATCH] docs(sap): make start_here navigable Co-authored-by: Cursor --- START_HERE.md | 42 ++++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/START_HERE.md b/START_HERE.md index 2a15b6d69..46add7898 100644 --- a/START_HERE.md +++ b/START_HERE.md @@ -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).