Merge pull request #53 from alexandremendoncaalvaro/docs/three-product-surfaces

docs: align product surfaces with three-product reality (OFX, CLI, GUI)

Author: alexandremendoncaalvaro

README.md

@@ -2,12 +2,15 @@
 
 ![CorridorKey OFX Plugin](./assets/ofx_example.gif)
 
-Native AI keying runtime and OFX plugin for **DaVinci Resolve**, built in collaboration with **Corridor Digital**.
+Native AI keying runtime and OFX plugin for **DaVinci Resolve and Foundry Nuke**, built in collaboration with **Corridor Digital**.
 
-CorridorKey-Runtime provides two supported surfaces:
+CorridorKey-Runtime provides three product surfaces:
 
-- **DaVinci Resolve OFX plugin** for interactive keying inside Resolve
-- **CLI runtime** for local processing, diagnostics, and automation
+- **OFX plugin** for interactive keying inside DaVinci Resolve and Foundry Nuke
+- **CLI** (`corridorkey`) for local processing, diagnostics, and automation
+- **GUI** (Tauri-based desktop app) for users who prefer a graphical workflow over the CLI
+
+The OFX plugin and the CLI ship in the same installer: the OFX bundle places `corridorkey.exe` next to `CorridorKey.ofx` and registers it on the system `PATH`, so the CLI is available after the OFX install. The GUI is distributed as a separate desktop installer that embeds its own copy of the runtime payload.
 
 Current public builds support:
 
@@ -26,25 +29,27 @@ Current public builds support:
 - Native local execution
 - Practical deployment in real editing workflows
 - Support for **NVIDIA RTX** and **Apple Silicon**
-- Stable surfaces for both **DaVinci Resolve users** and **CLI/integration workflows**
+- Stable surfaces for **DaVinci Resolve and Foundry Nuke users**, **CLI/integration workflows**, and **desktop GUI operators**
 
 ## Supported Surfaces
 
-### OFX plugin for DaVinci Resolve
-
-Use CorridorKey directly inside DaVinci Resolve through the OFX plugin.
-
+### OFX plugin for DaVinci Resolve and Foundry Nuke
 
+Use CorridorKey directly inside DaVinci Resolve or Foundry Nuke through the OFX plugin. The plugin is host-agnostic and registers itself at the standard OpenFX bundle path, so any OFX 1.4-compliant host that scans that path picks it up.
 
-### CLI runtime
+### CLI (`corridorkey`)
 
-Use the CLI for:
+The OFX installer ships the `corridorkey` CLI alongside the plugin and registers its directory on `PATH`. After installing the OFX bundle, `corridorkey` is callable from any terminal. Use it for:
 
 - environment diagnostics
 - scripted processing
 - machine-readable JSON output
 - automation and integration workflows
 
+### GUI (Tauri desktop app)
+
+A Tauri-based desktop application is available as a separate installer for users who prefer a graphical workflow over the CLI. The GUI embeds its own copy of the runtime payload, so it does not require the OFX bundle to be installed.
+
 ## Documentation
 
 ### User Help

docs/ARCHITECTURE.md

@@ -17,15 +17,16 @@ The project exists to ship CorridorKey inference as a native, distributable,
 and integrable runtime for real hardware. The architecture enforces strict
 separation between the Core (inference, math, I/O), the Application
 (orchestration, OFX service, diagnostics), and the Interfaces (CLI, OFX
-plugin).
+plugin for DaVinci Resolve and Foundry Nuke, and Tauri desktop GUI).
 
 **Key Principles:**
 
-1. **Library First.** The engine is the product boundary. CLI and OFX plugin
-   consume the same runtime rather than reimplementing behavior.
-2. **Interface Segregation.** Each surface (CLI, OFX plugin) is a thin client
-   over the App/Core contracts. Business logic never lives in an interface
-   layer.
+1. **Library First.** The engine is the product boundary. CLI, OFX plugin,
+   and Tauri GUI all consume the same runtime rather than reimplementing
+   behavior.
+2. **Interface Segregation.** Each surface (CLI, OFX plugin, Tauri GUI) is
+   a thin client over the App/Core contracts. Business logic never lives in
+   an interface layer.
 3. **Predictable Operations.** Diagnostics, fallback behavior, and error
    reporting are first-class concerns, not afterthoughts.
 4. **Curated Platform Tracks.** The official product tracks are Apple Silicon
@@ -72,15 +73,26 @@ Orchestration of Core capabilities into coherent jobs and services.
 - OFX runtime service: out-of-process session brokering, IPC protocol, and
   session lifecycle management for the OFX plugin.
 - Product-track policy: artifact selection, compatibility rules, and support
-  behavior shared by CLI and OFX.
+  behavior shared by CLI, OFX, and the Tauri GUI.
 
-### Layer 3: Interfaces (`src/cli`, `src/plugins/ofx`)
+### Layer 3: Interfaces (`src/cli`, `src/plugins/ofx`, `src/gui`)
 
 User-facing surfaces. Each is a thin consumer of App/Core contracts.
 
 - **CLI** (`src/cli`): Argument parsing, output formatting, command dispatch.
+  Ships inside the OFX installer alongside `CorridorKey.ofx` and is registered
+  on the system `PATH` so it is callable from any terminal after the OFX
+  install. Also available standalone in the portable runtime bundle that
+  feeds the Tauri GUI installer.
 - **OFX Plugin** (`src/plugins/ofx`): OpenFX host integration, render
   callback, runtime client that communicates with the App-layer OFX service.
+  Host-agnostic at the OFX 1.4 contract level; Resolve and Nuke 17 are the
+  validated hosts today, with per-host workarounds gated behind explicit
+  branches that never regress the path the other host depends on.
+- **Tauri GUI** (`src/gui`): Tauri 2 + React desktop application. Distributed
+  as a separate desktop installer that embeds its own copy of the runtime
+  payload (the staged output of `package_windows.ps1`); does not require the
+  OFX bundle to be installed.
 
 ---
 

docs/RELEASE_GUIDELINES.md

@@ -601,7 +601,14 @@ it explicitly:
 - macOS: `scripts/release_pipeline_macos.sh --display-label X.Y.Z-mac.N --publish-github --notes-file <path>`
 - Linux: `scripts/linux.sh --task release --version X.Y.Z --display-label X.Y.Z-linux.N --publish-github --notes-file <path>`
 
-### CorridorKey OFX
+### CorridorKey OFX (OFX plugin + bundled CLI)
+
+This release track ships the OFX plugin used by DaVinci Resolve and
+Foundry Nuke, plus the `corridorkey` CLI bundled inside the same
+installer. The CLI's directory is registered on the system `PATH` at
+install time, so a single OFX install delivers both the OFX surface
+and the CLI surface; the Tauri GUI is shipped separately (see the
+"CorridorKey Runtime" track below).
 
 The host-coverage qualifier `[Nuke & Resolve]` precedes the platform
 qualifier on every OFX release title, regardless of platform combination.
@@ -620,7 +627,17 @@ every example into a broken local link.
 - Windows and Linux: `CorridorKey OFX vX.Y.Z [Nuke & Resolve] (Windows & Linux)`
 - Windows, macOS, and Linux: `CorridorKey OFX vX.Y.Z [Nuke & Resolve] (Windows, macOS & Linux)`
 
-### CorridorKey Runtime
+### CorridorKey Runtime (Tauri GUI desktop app)
+
+This release track ships the Tauri-based desktop GUI defined in
+`src/gui`. The historical name "Runtime" is preserved on the release
+title and on the asset filename
+(`CorridorKey_Runtime_v<label>_<Platform>_<Track>_Installer.exe`)
+because changing it would break the auto-updater for users already on
+this track. The product surface is the GUI; the embedded runtime
+payload it ships is a copy of the same artifacts the OFX installer
+ships (see Section 1 "What This Is" in `docs/SPEC.md` for the full
+three-surface breakdown).
 
 - Windows only: `CorridorKey Runtime vX.Y.Z (Windows)`
 - macOS only: `CorridorKey Runtime vX.Y.Z (macOS)`

docs/SPEC.md

@@ -22,14 +22,24 @@ model. It exists to eliminate the Python dependency from model execution and
 to deliver a distributable, hardware-accelerated inference engine for
 professional video production workflows.
 
-The product currently provides:
-
-- A **CLI** (`corridorkey`) for direct command-line and pipeline use.
-- An **OFX plugin** for DaVinci Resolve on Windows and macOS, backed by an
-  out-of-process runtime service.
-
-Both surfaces consume the same underlying library. Logic is never duplicated
-between them.
+The product currently provides three surfaces:
+
+- An **OFX plugin** for DaVinci Resolve and Foundry Nuke on Windows and macOS,
+  backed by an out-of-process runtime service. The plugin is host-agnostic at
+  the OFX 1.4 contract level; per-host workarounds (Resolve and Nuke 17 today)
+  live in dedicated branches that never regress the path the other host
+  depends on.
+- A **CLI** (`corridorkey`) for direct command-line and pipeline use. The CLI
+  ships inside the OFX installer and is registered on the system `PATH` at
+  install time, so a single OFX install delivers both the OFX plugin and the
+  CLI. The CLI is also available standalone in the portable runtime bundle.
+- A **GUI** (Tauri-based desktop app) for users who prefer a graphical
+  workflow over the CLI. The GUI is distributed as a separate desktop
+  installer that embeds its own copy of the runtime payload; it is not bundled
+  into the OFX installer.
+
+All three surfaces consume the same underlying library. Logic is never
+duplicated between them.
 
 ### 1.2 What This Is Not
 
@@ -45,10 +55,12 @@ between them.
 
 - **Local operators** who want native execution without Python or virtual
   environments.
-- **Color graders and compositors** using DaVinci Resolve on officially
-  supported hardware.
+- **Color graders and compositors** using DaVinci Resolve or Foundry Nuke on
+  officially supported hardware.
 - **Pipeline integrators** who need a stable CLI or library surface for
   automated workflows.
+- **Desktop users** who prefer a graphical interface to the CLI for keying
+  and diagnostics tasks.
 
 ---
 
@@ -80,7 +92,7 @@ The complete support table is in [Support Matrix](../help/SUPPORT_MATRIX.md).
 
 ### 3.1 Layer Overview
 
-- **Interface layer:** CLI and OFX plugin
+- **Interface layer:** CLI, OFX plugin, and Tauri GUI
 - **Application layer:** job orchestration, OFX runtime service, diagnostics
 - **Core layer:** inference session management, device detection, frame I/O,
   post-process, and session policies
@@ -111,9 +123,9 @@ App-layer OFX runtime service. The plugin is a thin IPC client; it does not
 load ONNX sessions or GPU backends directly.
 
 This design isolates backend failures, TensorRT RTX compilation errors, and
-VRAM exhaustion from the DaVinci Resolve host process. The session broker in
-the service layer pools initialized sessions across multiple OFX node
-instances to avoid redundant GPU warmups.
+VRAM exhaustion from the host process (DaVinci Resolve or Foundry Nuke). The
+session broker in the service layer pools initialized sessions across multiple
+OFX node instances to avoid redundant GPU warmups.
 
 Frame data moves between plugin and service over shared memory. The IPC
 protocol is versioned to ensure the plugin and service remain compatible