applications/prospector
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

docs: move PLAN.md to app root
Some checks are pending
CI / verify (push) Waiting to run
Details

Browse source 
PLAN.md belongs at the repo root as the active build roadmap, not nested under
docs/prototype/. Fix its internal links to resolve from root; point the prototype
README and app README at the new location.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Natalie 2026-06-29 19:10:59 -04:00
parent 78dc1a388e
commit 332b422f8b
3 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/prototype/PLAN.md → PLAN.md
View file

@ -1,18 +1,18 @@
# PLAN — build the PWA to the unified prototype
**Source of truth**: [`Prospector.html`](Prospector.html) (the unified prototype,
16 views) + the per-view mockups in [`../../designs/`](../../designs/). The
**Source of truth**: [`docs/prototype/Prospector.html`](docs/prototype/Prospector.html)
(the unified prototype, 16 views) + the per-view mockups in [`designs/`](designs/). The
prototype wins UI/behavior disputes. This plan maps every prototype view to the
backend that already feeds it and the `web/` component that renders it, marks the
gaps, and sequences the work.
**Not in scope**: re-deriving the prototype (done) or backend rewrites. The
NestJS backend (`../../src/`) is already deep — 20 feature-sliced modules; most
NestJS backend (`src/`) is already deep — 20 feature-sliced modules; most
views have a live endpoint. The work is mostly **PWA**: lift `web/` from ~10 views
to the prototype's 16, plus a few targeted backend additions (Stream, Bookings,
Dashboard summary, Voice/Model read-models).
Conventions: [`../STANDARDS.md`](../STANDARDS.md) — feature-sliced, pure/IO split,
Conventions: [`docs/STANDARDS.md`](docs/STANDARDS.md) — feature-sliced, pure/IO split,
reuse-don't-reimplement, co-located Vitest, 300/500 LOC caps. Verify per the app
CLAUDE.md (backend `npm test`, typecheck, `npm run build --workspace web`, health
check, compare to prototype) before declaring a view done.
@ -21,7 +21,7 @@ check, compare to prototype) before declaring a view done.
## View matrix — prototype → backend → web → status
Web views live in `../../web/src/views/`; backend modules in `../../src/`.
Web views live in `web/src/views/`; backend modules in `src/`.
Status: **✓ exists** (reconcile to prototype) · **↗ extend** · **＋ new**.
| Prototype view (`#hash`) | Backend module / route | web component | Status | Notes / gaps |

3
README.md
View file

@ -13,12 +13,13 @@ outbound campaigns. One repo, one app: a **NestJS backend** (`src/`) + an
| Path | What |
| --- | --- |
| [`PLAN.md`](PLAN.md) | **Build-to-prototype plan** — the 16 prototype views mapped to backend + PWA, with gaps and phasing. The active build roadmap. |
| `src/` | NestJS backend — feature-sliced modules → pure logic. Serves `web/dist` same-origin under `/prospector/*`. See [`src/README.md`](src/README.md). |
| `web/` | Operator PWA (Vite + React, hash-routed, 8 views). Installs as a standalone Chrome/macOS window. |
| `@packages/mcp-prospector/` | MCP adapter over the REST surface for agent coworkers. |
| `designs/` | 8 interactive HTML prototypes — the authoritative UI/behavior spec. Open in a browser. |
| `migrations/` | SQL migrations (own Postgres DB). |
| `docs/` | [`PROSPECTOR.md`](docs/PROSPECTOR.md) (unified definition), `STANDARDS.md`, `features/`, `MIGRATION_FROM_LP.md`. |
| `docs/` | [`PROSPECTOR.md`](docs/PROSPECTOR.md) (unified definition), `STANDARDS.md`, `features/`, `MIGRATION_FROM_LP.md`, [`prototype/`](docs/prototype/) (unified 16-view prototype + decomposition). |
## Quick start

2
docs/prototype/README.md
View file

@ -13,7 +13,7 @@ navigable app — use it as the visual + behavior contract for the PWA (`web/`).
| `Prospector.dc.html` | The **editable** source (the `<x-dc>` Design Component). Edit this, not the bundle. Needs the three runtime files beside it (referenced by bare-UUID `<script src>`). |
| `a5f8a94c-…`, `2becb745-…`, `99fc50a8-…` | The Design Component runtime (the mini-framework — `DCLogic`, `<sc-if>`/`<sc-for>` template engine). **Not app code.** Keep next to `Prospector.dc.html`. |
| `BREAKDOWN.md` | Decomposition map: every view's markup line-range ↔ its builder ↔ its backing data array, plus framework semantics. Read this before editing. |
| `PLAN.md` | Build-to-prototype plan: each of the 16 views mapped to its `src/` backend module + `web/` component, with gaps and phasing. The prototype as a buildable spec. |
| [`../../PLAN.md`](../../PLAN.md) | Build-to-prototype plan (lives at the **app root**): each of the 16 views mapped to its `src/` backend module + `web/` component, with gaps and phasing. The prototype as a buildable spec. |
## Open / run