prospector/docs/README.md
Natalie bd91dc19ea
Some checks failed
CI / verify (push) Failing after 44s
docs(prospector): grouped feature documentation + eval pipeline docs
Add docs/features/README.md — feature docs grouped by area (AI system,
engine, training & eval, GPU/cost/ops, interfaces) with a reading order.
Rewrite tooling/eval/README.md to document the full built pipeline (lib,
mine_cluster, sweep, rationalize, run, score, gpu.py) grouped by stage.
Point docs/README.md at the grouped index. Remove stale gpu.sh (gpu.py
replaced it); gitignore __pycache__/prompts.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-30 10:41:16 -04:00

1.8 KiB

@prospector/docs

Docs and references for the prospector system.

  • PROSPECTOR.md — the unified definition of the app: what it is, architecture, operator surfaces, invariants, dependencies, build & deploy. Read this first; everything else drills down from it.
  • STANDARDS.md — house rules (feature-sliced modules, pure/IO split, reuse, co-located Vitest, LOC caps). src/markets/ is the reference module.
  • MIGRATION_FROM_LP.md — context for the move off lilith-platform.
  • features/ — per-feature docs grouped by feature (AI system, the engine, training & eval, GPU/cost/ops, interfaces). Start with features/ai-system-plan.md for the AI master plan.

Spec: ../designs/ — per-view interactive HTML prototypes, the authoritative UI + behavior contract. Open them in a browser.

Unified prototype: prototype/ — all 16 views fused into one self-contained, hash-routed Design Component (prototype/Prospector.html). The designs above, navigable as one app. See prototype/README.md + prototype/BREAKDOWN.md.

Workspace context: This extraction established the pattern now used for finances and marketing. See the top-level high-level hub at ../../../docs/README.md (or @ct/docs/) for links to all applications' docs/, packages, and platforms/projects.

Backend index: ../src/README.md — modules, routes, consumers, ground truth.

The app is a NestJS backend (src/) + Chrome PWA (web/) + MCP server (@packages/mcp-prospector/), served same-origin on its own Postgres DB. There is no Swift/native target; the PWA is the operator surface. A platform my/ SSO port is a future goal, not a current dependency.

Last updated: 2026-06-29 (unified definition; de-Swift).