Skip to content

README.md

Latest commit

 

History

History
60 lines (40 loc) · 3.2 KB

README.md

File metadata and controls

60 lines (40 loc) · 3.2 KB

Sim Steward documentation — start here

Agents: Read only the tier that matches the task. Do not glob all of docs/ unless asked.

Editing files outside the SimHub rule doc allowlist does not attach the full SimHub plugin rule pack (see .cursor/rules/SimHub.mdc globs).

Tier A — canonical (most plugin/dashboard work)

Doc Use when
GRAFANA-LOGGING.md Loki labels, events, LogQL, housekeeping
TROUBLESHOOTING.md Runtime issues, logs, deploy

Tier A+ — architecture (data structures + flows)

Doc Use when
ARCHITECTURE.md Class diagrams (PluginSnapshot, LogEntry, WS messages), ER diagram (data API), sequence diagrams (action dispatch, incident pipeline); Code map table at top links partial SimStewardPlugin files

ContextStream index and mapping

  • Workspace: Open this repo as a single-folder Cursor workspace rooted at simhub-plugin so search and tooling are not mixed with unrelated paths (other clones, AppData, etc.).
  • ContextStream project: Keep the ContextStream project path aligned with that same folder so ingest_local / MCP index the intended tree.
  • Corpus hygiene: .cursorignore trims noise for Cursor; after changing ignore rules or large doc/code moves, run a forced ContextStream ingest (pnpm run contextstream:ingest:force — see .cursor/skills/contextstream/SKILL.md).
  • Structural graph: ContextStream code graph may not expose C# module edges; use keyword/semantic search plus the Code map in ARCHITECTURE.md for navigation.

Tier B — topic hubs (open when needed)

Doc Use when
USER-FEATURES-PM.md PM-style user features (12 flows), connections, vision vs shipped vs PRODUCT-FLOW.md
USER-FLOWS.md Step-by-step user journeys through today's UI (mermaid diagrams); PM issues and flow gaps
observability-local.md Local Grafana/Loki stack, pnpm scripts, loki-gateway
observability-scaling.md Many users, large grids, Loki cardinality
DATA-ROUTING-OBSERVABILITY.md OTel vs Loki vs Prometheus, ~1k-user sizing, car telemetry taxonomy
observability-testing.md Harness, AssertLokiQueries, Explore validation
IRACING-REPLAY-INCIDENT-INDEX-REQUIREMENTS.md Replay-only incident index (SDK), TR-019 JSON, WebSocket actions, Web/sim-steward-dash/replay-incident-index.html
DATA-API-DEPLOY.md Data API env (local vs prod)
REDEPLOY-CONCEPT.md Redeploy mental model

Not for code agents

  • docs/marketing/ — Human-facing pages; excluded from default search via .cursorignore.

Elsewhere

  • docs/RULES-MinimalOutput.md — Referenced from .cursor/rules/00_MinimalOutput.mdc (global).
  • Observability code: observability/local/, tests/observability/, harness/.