docs: replace stale MVP-scaffold README with the current v0.70 reality
Some checks failed
Security / Security check (push) Failing after 1s

Signed-off-by: flemming-it <stefan.a.flemming@googlemail.com>
This commit is contained in:
flemming-it 2026-07-07 13:44:40 +02:00
parent 5d511dcd99
commit bac881db3c

View file

@ -1,44 +1,62 @@
# Ch∆In Studio # Ch∆In Studio
Desktop GUI client for the Ch∆In Platform hub. Tier-2 generic Desktop GUI client for the Ch∆In Platform hub. Tier-2 generic
platform client per `docs/architecture/client.md`. Connects to a platform client per `docs/architecture/client.md` in the
local or remote `chain serve` over gRPC. platform repo. Connects to a local or remote `chain serve` over
gRPC / gRPC-Web.
> **Status (2026-05-05):** MVP scaffold. Three pages with mock > **Status:** live product (v0.70+). Every page talks to the hub
> data, no live gRPC connection yet. Validates the visual > through [`chain_client_sdk`](../fai_chain_client_sdk_dart);
> direction before the Dart SDK is wired in. > 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 1. **Welcome** — onboarding checklist, guided setup wizard,
permissions. Click → manifest detail. bundled documentation reader.
2. **Audit** — live stream of hub events (when wired). Filter 2. **Store** — browse/search/install modules across multiple
by event type and flow. stores (pinned publisher keys, private sources, AI AskBar);
3. **Approvals** — pending `system.approval@^0` reviews with installed modules live here as a filter.
approve / reject buttons. 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: Plus: settings dialog (System-AI, integrations/MCP/n8n,
**composition** (modules), **audit** (events), security, maintenance), Cmd+K palette, release-channel switcher.
**human-in-the-loop** (approvals).
## Stack ## Stack
- Flutter 3.40+ (Desktop: macOS, Linux, Windows) - Flutter 3.40+ (Desktop: macOS, Linux, Windows)
- gRPC client via [`chain_client_sdk`](../fai_chain_client_sdk_dart) (sibling - gRPC client via [`chain_client_sdk`](../fai_chain_client_sdk_dart)
repo; pinned by relative path during development) (sibling repo; pinned by relative path during development)
- No external runtime dependencies; bundles its own Dart VM - No external runtime dependencies; bundles its own Dart VM
## Run locally ## Run locally
```bash ```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 ## Repo placement
Will be published as `fai/studio` on Forgejo (`git.flemming.ws`). Published as `fai/chain-studio` on Forgejo (`git.flemming.ai`).
The local directory `chain_studio/` follows the established The local directory follows the established `fai_chain_*` layout
`fai_chain/` layout convention. convention.
## Why "Studio" and not "Stage" ## 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 developer English. "Studio" is the established industry pattern
for creator-tools (Visual Studio, Android Studio, RStudio) and for creator-tools (Visual Studio, Android Studio, RStudio) and
matches the GUI's audience of module developers, operators, and matches the GUI's audience of module developers, operators, and
power users. The rename was applied across all `docs/` in the power users.
platform repo on 2026-05-05.