docs: synchronize the README with the shipped Composer - #71
Merged
Conversation
The README still described the studio-era product — Composer as "the second surface", "the hosted composer runs no hosted AI", Build "requires the local agent" — all predating hosted-AI generation, first-class projects, Local AI configuration, Examples, ownership, and portability. Rewritten product-first for two audiences (evaluators, and design engineers cloning it to run their own local models): what it is → try it hosted → quick start → Local AI (Ollama, UI-driven; OpenAI-compatible incl. LM Studio/llama.cpp/vLLM/LocalAI) → Hosted AI + coexistence → projects & portability (.composerproject.json) → repository connection (agent folder picker, osascript/zenity) → design-system references (contract + profile + registry) → the working views → native/wireframe rendering honesty → architecture (the proposal seam varies; the deterministic authority does not) → Studio → workspace → development → deployment → known limitations. Every command verified from a CLEAN worktree checkout this change: frozen install, composer dev (HTTP 200), agent dev (health ok), composer unit tests 19/19, and real Ollama discovery through the agent's /provider/test. All referenced paths exist; all URLs return 200; no machine paths, usernames, or key material. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
dspack-studio-composer | e19aa1e | Aug 10 2026, 05:17 PM |
There was a problem hiding this comment.
Pull request overview
Updates the root README to reflect the current “Composer” product positioning and workflows, replacing older descriptions that no longer match recent milestones (hosted vs local AI behavior, quick start, project/repo workflows, and architecture).
Changes:
- Rewrites the README structure to a product-first flow: what it is → try hosted → run locally → configure AI → projects → architecture → development.
- Documents Hosted/Local/Scripted provider options (including Hosted+Local coexistence) and adds UI-driven setup steps for local providers (Ollama + OpenAI-compatible).
- Refreshes workspace map, development commands, deployment notes, and known limitations to match current repo layout.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| ## Local AI — Ollama | ||
|
|
||
| The browser is only a client: it cannot reach a model on `localhost` by itself, and it never stores a provider secret. The **local agent is the bridge** — it owns endpoint communication and any credential: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The root README predated the last four Composer milestones — it still called Composer "the second surface" and claimed "the hosted composer runs no hosted AI" and that Build requires the local agent. Rewritten product-first per the documentation brief:
what it is → try it (hosted) → run it locally → configure AI → projects → architecture → development.
composer devHTTP 200,agent devhealth ok, unit tests 19/19 from clean./provider/test;OLLAMA_URLdocumented as the advanced fallback; the browser/agent boundary stated./v1/modelsdiscovery + manual entry, session-only credential, raw-JSON fail-loud caveat..composerproject.jsonportability.Hygiene: all referenced paths exist, all URLs 200, every command maps to a real script/config, no machine paths/usernames/keys.
🤖 Generated with Claude Code