From bac881db3cfb34a62a51134b65e3d18c768b99db Mon Sep 17 00:00:00 2001 From: flemming-it Date: Tue, 7 Jul 2026 13:44:40 +0200 Subject: [PATCH] docs: replace stale MVP-scaffold README with the current v0.70 reality Signed-off-by: flemming-it --- README.md | 63 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 40 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index ed9cda7..35556bd 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,62 @@ # Ch∆In Studio Desktop GUI client for the Ch∆In Platform hub. Tier-2 generic -platform client per `docs/architecture/client.md`. Connects to a -local or remote `chain serve` over gRPC. +platform client per `docs/architecture/client.md` in the +platform repo. Connects to a local or remote `chain serve` over +gRPC / gRPC-Web. -> **Status (2026-05-05):** MVP scaffold. Three pages with mock -> data, no live gRPC connection yet. Validates the visual -> direction before the Dart SDK is wired in. +> **Status:** live product (v0.70+). Every page talks to the hub +> through [`chain_client_sdk`](../fai_chain_client_sdk_dart); +> there is no mock data. End users launch Studio via +> `chain studio`, which downloads and verifies a prebuilt bundle +> from the release mirror (sha256 + signature) or rebuilds from +> source when a dev workspace is configured. -## Pages (MVP scope) +## Pages -1. **Modules** — installed modules, capabilities, declared - permissions. Click → manifest detail. -2. **Audit** — live stream of hub events (when wired). Filter - by event type and flow. -3. **Approvals** — pending `system.approval@^0` reviews with - approve / reject buttons. +1. **Welcome** — onboarding checklist, guided setup wizard, + bundled documentation reader. +2. **Store** — browse/search/install modules across multiple + stores (pinned publisher keys, private sources, AI AskBar); + installed modules live here as a filter. +3. **Flows** — graph + text flow editor with a live Run tab + (streamed step events, inline approvals). Editor ships as the + [`chain_studio_flow_editor`](../fai_chain_studio_flow_editor) + package. +4. **Audit** — live event stream (`StreamEvents`) with filters, + hash-chain verification, gated log reset. +5. **Approvals** — pending `system.approval@^0` reviews with + approve / reject and payload disclosure. +6. **Doctor** — diagnostics, daemon lifecycle, binary recovery. +7. **Föderation** — satellite list, bootstrap-token enrolment, + revocation. -These three cover the platform's central properties: -**composition** (modules), **audit** (events), -**human-in-the-loop** (approvals). +Plus: settings dialog (System-AI, integrations/MCP/n8n, +security, maintenance), Cmd+K palette, release-channel switcher. ## Stack - Flutter 3.40+ (Desktop: macOS, Linux, Windows) -- gRPC client via [`chain_client_sdk`](../fai_chain_client_sdk_dart) (sibling - repo; pinned by relative path during development) +- gRPC client via [`chain_client_sdk`](../fai_chain_client_sdk_dart) + (sibling repo; pinned by relative path during development) - No external runtime dependencies; bundles its own Dart VM ## Run locally ```bash -flutter run -d macos +flutter run -d macos # or -d linux / -d windows +flutter test ``` +`chain studio` prefers a configured dev workspace and will +`flutter run` from source when one resolves — see +`crates/chain_runtime_mgmt` in the platform repo. + ## Repo placement -Will be published as `fai/studio` on Forgejo (`git.flemming.ws`). -The local directory `chain_studio/` follows the established -`fai_chain/` layout convention. +Published as `fai/chain-studio` on Forgejo (`git.flemming.ai`). +The local directory follows the established `fai_chain_*` layout +convention. ## Why "Studio" and not "Stage" @@ -46,5 +64,4 @@ The local directory `chain_studio/` follows the established developer English. "Studio" is the established industry pattern for creator-tools (Visual Studio, Android Studio, RStudio) and matches the GUI's audience of module developers, operators, and -power users. The rename was applied across all `docs/` in the -platform repo on 2026-05-05. +power users.