Skip to content

docs: bring COMPOSER.md and renderer-abstraction.md up to the shipped product - #73

Merged
ryandmonk merged 1 commit into
mainfrom
docs/ecosystem-sync
Aug 10, 2026
Merged

docs: bring COMPOSER.md and renderer-abstraction.md up to the shipped product#73
ryandmonk merged 1 commit into
mainfrom
docs/ecosystem-sync

Conversation

@ryandmonk

Copy link
Copy Markdown
Contributor

From an ecosystem-wide documentation audit. The README was rewritten last milestone; the documents it links as canonical were not — so the README was more current than its own deeper docs.

  • docs/COMPOSER.md was the Phase-1 vertical-slice diary: Acme UI, "no hosted AI", agent-required Build. Every one of those is false now, and the phase-by-phase narrative it carried already lives in IMPLEMENTATION_LOG.md. Rewritten as the architecture companion to the README — one pipeline with three proposal seams; where a project's vocabulary comes from (base + authored delta, canonical references never mutated); accept in browser vs repository; the agent's real HTTP surface; the Worker's two API routes; rendering policy; a guarantee→enforcement table; and which test proves each claim. Every route, storage key, and number verified against main.
  • docs/renderer-abstraction.md claimed shadcn "covers all 12 catalog names" and that the unimplemented fallback is "exercised by the parity suite rather than by a shipped gap". Measured: shadcn covers 11 of 27, Astryx 12 of 12 — partial adoption is a shipped state. Added wireframe-renderers to the layer map and documented the two-layer behavior introduced last milestone: the package keeps its honest placeholder; the app composes wireframe under native so users never see it, with coverage reported from the pre-merge registry.

docs/deployment.md was audited and found accurate (repo-root wrangler.jsoncdspack-studio-composer, worker at apps/composer/worker/index.mjs, health-check claims) and is untouched. The dated historical records (AUDIT, IMPLEMENTATION_LOG, PHASE-NEXT, NAV-REFACTOR) are left as records rather than rewritten for age.

🤖 Generated with Claude Code

… product

The README was updated last milestone; the documents it links as canonical
were not, so the README was more current than its own deeper docs.

- docs/COMPOSER.md was the Phase-1 vertical-slice diary (Acme UI, "no hosted
  AI", agent-required Build) — every one of those claims is now false, and
  the phase-by-phase narrative it carried already lives in
  IMPLEMENTATION_LOG.md. Rewritten as the architecture companion to the
  README: the one pipeline with three proposal seams; where a project's
  vocabulary comes from (base + authored delta, canonical references never
  mutated); accept in browser vs repository; the agent's real HTTP surface;
  the Worker's two API routes; rendering policy; a guarantee→enforcement
  table; and what test proves each claim. Every route, storage key, and
  number verified against main.
- docs/renderer-abstraction.md claimed shadcn "covers all 12 catalog names"
  and that the unimplemented fallback is "exercised by the parity suite
  rather than by a shipped gap". Both are false against the production v3
  catalog: shadcn covers 11 of 27 (verified by planRegistry), Astryx 12 of
  12, and partial adoption is a shipped state. Corrected, added
  wireframe-renderers to the layer map, and documented the two-layer
  unsupported-component behavior: the package keeps its honest placeholder;
  the app composes wireframe under native so users never see it, with
  coverage reported from the PRE-merge registry.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings August 10, 2026 19:15
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 10, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
dspack-studio-composer aecaf61 Aug 10 2026, 07:18 PM

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Composer and renderer abstraction documentation to align with the current shipped architecture and rendering policy, replacing older phase-diary content with implementation-verified descriptions of pipeline seams, storage, agent/worker surfaces, and partial renderer coverage.

Changes:

  • Rewrite docs/COMPOSER.md as an architecture companion to the README, documenting pipeline flow, vocabulary provenance (base+delta), accept/export behavior, and the agent/worker HTTP surfaces.
  • Update docs/renderer-abstraction.md to reflect the current multi-registry reality (Astryx/shadcn/wireframe), including the two-layer unsupported-component policy and how Composer composes wireframe fallbacks under native registries.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/COMPOSER.md Rewritten from vertical-slice narrative to a current architecture/internal-surfaces reference (pipeline seams, storage keys, accept/export rules, agent/worker routes, guarantees/tests).
docs/renderer-abstraction.md Updated layer boundaries and unsupported-component behavior to match current shipped renderer composition and measured partial shadcn coverage.
Suppressed comments (3)

docs/COMPOSER.md:60

  • app/project-portability.ts is not a valid repo path; the portability helper lives at apps/composer/app/project-portability.ts. Updating the reference keeps the doc actionable.
(`app/project-portability.ts`). Import validates fail-closed (version gate,

docs/COMPOSER.md:124

  • The referenced files app/projects.ts and app/providers.ts don’t exist at that path in this repo; they’re under apps/composer/app/…. Updating these references keeps the guarantee table accurate.
| The reference is never mutated | base+delta merge (`app/projects.ts`) |
| No credential in the browser | `app/providers.ts` writes endpoints and model only |

docs/COMPOSER.md:108

  • In this repo there’s no app/registries.ts at the root; the implementation referenced here is apps/composer/app/registries.ts. Using the full path matches earlier references in the doc and prevents confusion with other app/ directories.
does** — composed per component in `app/registries.ts`, which merges the
wireframe registry under the native one (native wins name-by-name) behind a

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/COMPOSER.md

| Source | Base vocabulary | Persistence |
|---|---|---|
| `reference` | a packaged design system (`app/demo-data.ts`: shadcn/ui v3, Astryx) | delta in `localStorage` |
@ryandmonk
ryandmonk merged commit bfe5a90 into main Aug 10, 2026
3 checks passed
@ryandmonk
ryandmonk deleted the docs/ecosystem-sync branch August 10, 2026 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants