prospector/docs/README.md
Natalie bcbd558e9d
Some checks are pending
CI / verify (push) Waiting to run
refactor!: drop Swift/native macOS app, unify on the PWA
Remove all Swift/legacy artifacts — no native app, no swift-react UI, no
tech debt. The Chrome PWA (web/) on the NestJS backend (src/) + MCP server
is the sole way forward.

Removed:
- @packages/prospector-client, @packages/prospector-ui (Swift packages)
- Sources/ (QuinnProspector, QuinnProspectorCore), Config/, project.yml,
  QuinnProspector.xcodeproj, Resources/
- PLAN.md (stale my/-port plan, superseded)

Rewired:
- .forgejo/workflows/ci.yml → Node CI (npm ci → typecheck/test/build for
  backend + web + MCP) instead of Swift build/test
- .gitignore → drop .build/, *.xcodeproj/

Unified definition:
- docs/PROSPECTOR.md — new single source of truth (architecture, surfaces,
  invariants, dependencies, build/deploy)
- README.md, CLAUDE.md, docs/README.md, src/README.md → PWA-forward,
  point at docs/PROSPECTOR.md, no Swift/legacy references

designs/ kept intact as the authoritative UI/behavior spec.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-29 11:59:04 -04:00

1.2 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/deploy.md, draft-engine.md, mcp.md.

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

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).