fraqtal/agentic-dev
Template
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs(product): record ADR-027/028/029 supersessions in bundle README

Browse Source 
The bundle was authored 2026-07-10 for the Electron/local-first plan;
ADR-027/028/029 (2026-07-12) supersede it where they conflict. Prepend
a Repo supersessions section, add the Veect.dc.html ground-truth row
to the authority table (ADR-029 $5), and mark $3's 'codebase seeds
packages/editor' instruction as superseded.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016j8z4VHjedXDTjEDNg7qHK
This commit is contained in:
Danijel Martinek
2026-07-12 14:26:56 +02:00
parent f70357db94
commit ae86501c12
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/product/README.md
View File

@@ -4,6 +4,14 @@ _Entry point for the development agent. Generated 2026-07-10._
You are about to build **Veect**. This bundle is the complete product, design, and technical specification. Read this README first — it tells you what each document is, **which document wins when two disagree**, the invariants you must never break, and exactly where to start.
## Repo supersessions (2026-07-12)
This bundle was authored 2026-07-10 for the Electron/local-first plan. On 2026-07-12 the repo's ADRs superseded it where the two conflict — when anything below disagrees with an ADR, the ADR wins:
- **[ADR-027 — hosted SaaS + control-plane/runner split](../decisions/adr-027-hosted-saas-and-runner-split.md).** Veect v1 is a hosted cloud SaaS, not an Electron desktop app. Retires the tech spec §3 runtime machinery (bundled Node, PATH shim, ABI policy, `safeStorage`), the GitHub device flow, per-workspace SQLite, and the self-host Docker image for v1.
- **[ADR-028 — iframe canvas](../decisions/adr-028-iframe-canvas.md).** The board renders real repo components through runner-served iframes; NodeRenderer retires to the Playground only.
- **[ADR-029 — DesignDoc v1 + editor rebuild](../decisions/adr-029-designdoc-v1-and-editor-rebuild.md).** DesignDoc v1 is the canonical committed schema, and the editor is **rebuilt** under template conventions — this supersedes this README's §3 "the codebase seeds `packages/editor` — do not rebuild" instruction. The prototype codebase is reference material only, at `docs/product/reference/`.
---
## 1. What Veect is (read this once)
@@ -30,6 +38,7 @@ Documents were written across several iterations and **deliberately supersede ea
| ----------------------------------------------------------------------------------------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| **How the system must behave** (architecture, connections, git, adapters, AI, milestones) | **`veect-technical-spec.md`** (rev 1.2.2) | The primary build document. Start here after this README. |
| **Visual & interaction language** (color, type, radius, icons, motion, components) | **`veect-design-spec-current.md`** | Ground truth from the built prototype. **Wins over the design brief's older art-direction section.** |
| **Editor interaction & copy ground truth** (where newer than the design spec) | **`reference/project/Veect.dc.html`** | Per ADR-029 §5, the ground-truth order is `Veect.dc.html` > `veect-design-spec-current.md` > prototype codebase (reference only). |
| **UI/UX still to be built** (repo-connect, publish, environment, editor deltas) | **`veect-ui-gap-spec.md`** | Your UI work order. Everything the prototype doesn't cover yet. |
| **UX intent** (north star, principles, journeys, signature moments, voice, a11y) | **`design-brief-veect.md`** | Authoritative for _intent_; where its §11 art direction conflicts with the design spec, the design spec wins (it says so itself). |
| **Product scope — what & why** (features, out-of-scope, personas, acceptance criteria) | **`design-app-prd.md`** | Distribution details superseded by the tech spec; wedge/personas/JTBD/scope discipline still authoritative. |
@@ -49,7 +58,7 @@ Documents were written across several iterations and **deliberately supersede ea
## 3. What already exists vs. what you're building
**⚠️ Not in this bundle (request from the founder):** the **interactive prototype** (`Veect.dc.html`), the **landing page** (`Veect Landing.dc.html`), and the **React 18 / TypeScript codebase** (`veect-codebase/`). These are the founder's built artifacts. `veect-design-spec-current.md` is their specification. **The codebase seeds `packages/editor`** — do not rebuild the editor from scratch.
**⚠️ Not in this bundle (request from the founder):** the **interactive prototype** (`Veect.dc.html`), the **landing page** (`Veect Landing.dc.html`), and the **React 18 / TypeScript codebase** (`veect-codebase/`). These are the founder's built artifacts. `veect-design-spec-current.md` is their specification. **The codebase seeds `packages/editor`** — do not rebuild the editor from scratch. _Superseded by ADR-029: the editor is rebuilt under template conventions; the prototype codebase is reference-only._
**Already built (inherit, do not redesign):** the entire editor — canvas (React Flow substrate, zustand store), 3-pane panels, activity bar, responsive **multi-view frames** (desktop/tablet/mobile clusters), constrained-AI UX (compose ghosts, scoped edits, refusal protocol, model picker), Polish pass, history with restore cursor, token editor with live ripple, isolation mode, the **bidirectional code grammar** (TSX generates _and_ parses back), and the landing page. See `veect-ui-gap-spec.md` §1.