diff --git a/.gitignore b/.gitignore index 686e441..6a87c51 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ # Local agent / MCP config (project rules under .cursor/rules are tracked) .claude/ +.codex/ .cursor/* !.cursor/rules/ !.cursor/rules/** diff --git a/CHANGELOG.md b/CHANGELOG.md index 70fd0f7..32c7518 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -76,6 +76,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 `--force`, `--concurrency`, and explicit path arguments ### Changed +- Docs: socialise hosted dashboard + ([neomatrix369.github.io/demos/tripwire-dashboard/](https://neomatrix369.github.io/demos/tripwire-dashboard/)) + and demo walkthrough video + ([YouTube](https://youtu.be/omGOw9ruN3Y)) across README, QUICKSTART, docs hub, + architecture, prototypes, screenshots, setup commands, and prerequisites. - README restored to the fuller pre–slice-44 entry shape and brought current: providers/scanners table (Modal, Supabase, Cisco, Snyk, Tessl five-row, DepShield, Ossprey, SIE, Model Studio), hosted demo link, Live setup, guide diff --git a/QUICKSTART.md b/QUICKSTART.md index 7ee7d9f..fc72cda 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -6,7 +6,8 @@ | Path | Effort | What you get | |---|---|---| -| [Hosted dashboard](https://neomatrix369.github.io/demos/tripwire-dashboard/) | **No clone** — browse in browser | Live/Mock UI preview on GitHub Pages | +| [Hosted dashboard](https://neomatrix369.github.io/demos/tripwire-dashboard/) | **No clone** — browse in browser | Mock UI preview on GitHub Pages | +| [Demo walkthrough (video)](https://youtu.be/omGOw9ruN3Y) | **No clone** — watch first | End-to-end tour of the dashboard | | [Try the demo](#try-the-demo-recommended) | **Recommended** — no cloud accounts | Local discovery + Mock dashboard | | [Live scan](#live-advanced) | **Advanced** — five vendors + `.env` | Real scans stored online | @@ -99,6 +100,8 @@ Cheat lines (full catalog linked): ## Next +- Hosted UI (no clone): [neomatrix369.github.io/demos/tripwire-dashboard/](https://neomatrix369.github.io/demos/tripwire-dashboard/) +- Demo video: [YouTube walkthrough](https://youtu.be/omGOw9ruN3Y) - Docs map: [docs/README.md](docs/README.md) - Architecture: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) - Status: [docs/STATUS.md](docs/STATUS.md) diff --git a/README.md b/README.md index 29edcec..d42801d 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,7 @@ CI / Nightly / Complexity badges reflect GitHub Actions on `main`. | If you want to… | Go here | |---|---| | **Try a hosted dashboard** (no clone) | [Live demo on neomatrix369.github.io](https://neomatrix369.github.io/demos/tripwire-dashboard/) | +| **Watch the demo walkthrough** | [YouTube — Tripwire dashboard tour](https://youtu.be/omGOw9ruN3Y) | | **Try a safe demo** (no cloud accounts) — Recommended | [QUICKSTART — Try the demo](QUICKSTART.md#try-the-demo-recommended) | | **Run a real Live scan** — Advanced | [QUICKSTART — Live](QUICKSTART.md#live-advanced) | | **Change the code** | [CONTRIBUTING](CONTRIBUTING.md) | @@ -140,7 +141,8 @@ logs a warning and skips. With SIE but without Model Studio, SIE-only reviews st Use Mock demo data only when you want a no-account look at the UI; it does not replace the Live setup above or produce a scan result. Prefer the [hosted demo](https://neomatrix369.github.io/demos/tripwire-dashboard/) when you -do not need a local clone. +do not need a local clone, or watch the +[demo walkthrough on YouTube](https://youtu.be/omGOw9ruN3Y). ```bash git clone https://github.com/neomatrix369/tripwire.git diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 8fcbfb0..1e216d2 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -179,7 +179,7 @@ C4Container - `sandbox/` — Modal app + scanner adapters (`scanners.py`); unit tests in `sandbox/tests/` - `db/schema.sql` — Postgres/Supabase DDL + rollup + `dashboard_latest_runs` view (Live dashboard: one latest `scan_run` per item); anon SELECT + Realtime -- `prototypes/dc-dashboard/` — Live/Mock dashboard (Horizon A ship UI; prototype path). Shows router pathway strips (`Scan → ■` / `Scan → SIE → ■` / `Scan → SIE → Model Studio`), Escalated / SIE-only filters, and skill quality triage tabs (**Quality ≥ 80** / **Quality < 80** / **No quality score** — slice 42 A14–A15 ON BRANCH) — [reading-router-results.md](./user-guide/reading-router-results.md) +- `prototypes/dc-dashboard/` — Live/Mock dashboard (Horizon A ship UI; prototype path). Public Mock preview: [neomatrix369.github.io/demos/tripwire-dashboard/](https://neomatrix369.github.io/demos/tripwire-dashboard/) · [demo video](https://youtu.be/omGOw9ruN3Y). Shows router pathway strips (`Scan → ■` / `Scan → SIE → ■` / `Scan → SIE → Model Studio`), Escalated / SIE-only filters, and skill quality triage tabs (**Quality ≥ 80** / **Quality < 80** / **No quality score** — slice 42 A14–A15 ON BRANCH) — [reading-router-results.md](./user-guide/reading-router-results.md) - `prototypes/sie-studio/` / `prototypes/model-studio/` — sample CLIs for router backends - `scripts/` — setup (Supabase/Modal), `serve-dashboard.mjs`, hygiene gates, router fixtures - `fixtures/` — smoke targets — [fixtures/README.md](../fixtures/README.md) diff --git a/docs/README.md b/docs/README.md index 4d1abb1..67bbec4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,6 +12,8 @@ Start here: [QUICKSTART](../QUICKSTART.md) · Repo entry: [README](../README.md) | Your task | Start here | Then | |---|---|---| +| Browse hosted dashboard (no clone) | [GitHub Pages demo](https://neomatrix369.github.io/demos/tripwire-dashboard/) | [Demo video](https://youtu.be/omGOw9ruN3Y) · [QUICKSTART](../QUICKSTART.md) | +| Watch demo walkthrough (no clone) | [YouTube tour](https://youtu.be/omGOw9ruN3Y) | [Hosted dashboard](https://neomatrix369.github.io/demos/tripwire-dashboard/) · [screenshots](./screenshots/README.md) | | Try demo (no accounts) | [QUICKSTART — demo](../QUICKSTART.md#try-the-demo-recommended) | [Setup commands](./user-guide/setup-commands.md) · [screenshots](./screenshots/README.md) | | Check tools and fit | [Prerequisites](./user-guide/prerequisites.md) | [QUICKSTART](../QUICKSTART.md) | | Create accounts (Setup) | [Supabase setup](./user-guide/supabase-setup.md) | [Modal setup](./user-guide/modal-setup.md) → optional scanners via [env-vars](./user-guide/env-vars.md#vendor-procurement-quick-steps) | @@ -29,7 +31,7 @@ Start here: [QUICKSTART](../QUICKSTART.md) · Repo entry: [README](../README.md) | Guide | What it covers | |---|---| -| [QUICKSTART.md](../QUICKSTART.md) | Demo (Recommended) then Live (Advanced) | +| [QUICKSTART.md](../QUICKSTART.md) | Demo (Recommended) then Live (Advanced); [hosted dashboard](https://neomatrix369.github.io/demos/tripwire-dashboard/) · [demo video](https://youtu.be/omGOw9ruN3Y) | | [user-guide/prerequisites.md](./user-guide/prerequisites.md) | Required tools, technical fit, capability prerequisites | | [user-guide/setup-commands.md](./user-guide/setup-commands.md) | Command SSOT: bootstrap, flags, fails, maintenance | | [user-guide/env-vars.md](./user-guide/env-vars.md) | Configure (keys): procurement SSOT for `.env` | diff --git a/docs/screenshots/README.md b/docs/screenshots/README.md index 8e7bd54..06d3284 100644 --- a/docs/screenshots/README.md +++ b/docs/screenshots/README.md @@ -6,6 +6,8 @@ Product UI and CLI captures, grouped by surface. Paths are relative to this fold and Escalated / SIE-only examples stay stable. **CLI shots are live terminal captures** from the current CLI. +**Try the UI without cloning:** [hosted dashboard](https://neomatrix369.github.io/demos/tripwire-dashboard/) (Mock on GitHub Pages) · [demo walkthrough video](https://youtu.be/omGOw9ruN3Y). + Skill cards show compact **`R`** (risk density) and **`Q`** (Tessl quality) badges; card colour is worst-of finding status — **colour ≠ density**. @@ -41,7 +43,7 @@ Help output (including `route`) and discovery / live scan feedback. Heatmap grid, severity filters, tiered-router filters, type views, and list layout (Mock demo). Card colour is worst-of actionable finding severity; chips -show finding counts. +show finding counts. Compare with the live [hosted dashboard](https://neomatrix369.github.io/demos/tripwire-dashboard/) or the [YouTube walkthrough](https://youtu.be/omGOw9ruN3Y). ### Overview grid diff --git a/docs/user-guide/prerequisites.md b/docs/user-guide/prerequisites.md index 7d024fe..19a4111 100644 --- a/docs/user-guide/prerequisites.md +++ b/docs/user-guide/prerequisites.md @@ -4,6 +4,8 @@ Start here: [QUICKSTART](../../QUICKSTART.md) · Hub: [docs/README](../README.md) +**No clone:** [hosted dashboard](https://neomatrix369.github.io/demos/tripwire-dashboard/) (Mock on GitHub Pages) · [demo walkthrough video](https://youtu.be/omGOw9ruN3Y). + Pins: Node **22** (`.nvmrc`) · Python **3.12** (`.python-version`). Use this page to determine what must be ready before running any command sequence. diff --git a/docs/user-guide/setup-commands.md b/docs/user-guide/setup-commands.md index 5928ed6..2b5a854 100644 --- a/docs/user-guide/setup-commands.md +++ b/docs/user-guide/setup-commands.md @@ -7,6 +7,8 @@ Start here: [QUICKSTART](../../QUICKSTART.md) · Hub: [docs/README](../README.md Use this page as the single source for shared setup, validation, scan, and maintenance commands. +**No clone:** [hosted dashboard](https://neomatrix369.github.io/demos/tripwire-dashboard/) (Mock on GitHub Pages) · [demo walkthrough video](https://youtu.be/omGOw9ruN3Y). + ## CLI flags (reference) | Command / flag | What it does | diff --git a/prototypes/README.md b/prototypes/README.md index b4b5189..cdbd72f 100644 --- a/prototypes/README.md +++ b/prototypes/README.md @@ -23,6 +23,8 @@ Came from [QUICKSTART](../QUICKSTART.md)? Use the **Normal users** path, then re ## Viewing the dashboard +**No clone:** browse the [hosted dashboard on GitHub Pages](https://neomatrix369.github.io/demos/tripwire-dashboard/) (Mock-only public deploy). **Walkthrough:** [demo video on YouTube](https://youtu.be/omGOw9ruN3Y). + Item detail shows a **router strip** for scanned items: - `Scan → SIE → Model Studio` when escalated - `Scan → SIE → ■` when SIE ran and did not escalate (`routing_review`)