Skip to content

Latest commit

 

History

History
107 lines (80 loc) · 6.27 KB

File metadata and controls

107 lines (80 loc) · 6.27 KB

Open Design

Open Design is a local-first design workspace where projects contain generated design files and agent conversations. This glossary records domain language only, not implementation details.

Language

Project: A top-level design workspace that contains conversations and design files. Avoid: repo, folder, session

Normal Artifact: A project design output represented by an artifact entry file and its artifact manifest. Avoid: live artifact, generic file upload

Live Artifact: A refreshable project design output stored as a live-artifact record with source data and preview state. Avoid: normal artifact, static artifact

Artifact Entry File: The primary project file that opens or renders a normal artifact. Avoid: support file, asset, sidecar

Artifact Manifest: The sidecar metadata that identifies a project file as a normal artifact and records its kind, renderer, exports, and entry file. Avoid: live-artifact document, project metadata

Active Project: The project the user most recently interacted with in the Open Design UI and that MCP tools may use when no project is specified. Avoid: latest project, default project

Home Composer Media Surface: A Home-only composer intent that lets the prompt card expose media-specific defaults before project creation. The current media surfaces are image, video, hyperframes, and audio; they map onto the existing project kinds at submit time instead of extending the backend ProjectKind union. Avoid: project kind, backend kind

Chip Rail: The row of intent chips below the Home prompt card. A chip chooses the composer surface, default scenario plugin, default option state, and project kind stamp before the user presses Run. Avoid: plugin list, template list

HyperFrames Composer Surface: A standalone Home composer media surface shown between Video and Audio for HTML-based motion generation. It submits as kind: "video" with videoModel: "hyperframes-html" so persisted projects keep the existing video backend shape while the Home UI still gives HyperFrames its own entry point. Avoid: new project kind, separate backend media kind

Essential Audio Generation: A Home Audio entry workflow for the audio capabilities that the product can attempt directly in v1. It includes speech and sound effects, and excludes music until there is an integrated music generation path. Avoid: audio studio, full music workflow

Audio Source Field: The inline Home Audio option that provides the source content for generation. Speech uses a Text source because the content is spoken; sound effects use a Prompt source because the content describes a sound to synthesize. Avoid: generic subject field, hidden prompt text

ElevenLabs Fallback Voice: The default voice option shown when the Home Audio composer cannot load configured ElevenLabs voices. It keeps ElevenLabs speech runnable by selecting the same default voice id the daemon uses when no explicit voice is supplied. Avoid: required credential setup, empty voice selector

AMR Cloud: The user-facing cloud runtime option for Open Design's official model router, shown in onboarding and login-oriented product surfaces. Avoid: Vela, local CLI label

AMR CLI: The local command-line runtime adapter used to run AMR from an installed or packaged native CLI. Avoid: AMR Cloud, cloud account

AMR CLI Distribution Contract: The separately owned release contract that provides the native AMR CLI builds Open Design can package. Avoid: Open Design release channel, package build step, source checkout

AMR CLI Distribution Slice: The set of native AMR CLI platforms currently available through the distribution contract; platforms outside the slice do not bundle the AMR CLI. Avoid: Open Design supported platforms, release channel, future platform promise

AMR Account Status: Whether the user has authenticated the account needed to use AMR Cloud. Avoid: profile badge, environment, CLI version

AMR Environment Profile: The target AMR service environment a packaged runtime is configured to use. Avoid: release channel, account status, app identity

Onboarding Skip: The explicit path that lets a user leave onboarding without completing the currently selected setup option. Avoid: continue, finish setup, passive close

Relationships

  • A Project contains zero or more Normal Artifacts.
  • A Normal Artifact has exactly one Artifact Entry File.
  • A Normal Artifact has exactly one Artifact Manifest.
  • A Live Artifact belongs to a Project but is distinct from a Normal Artifact.
  • An Active Project can be used as the target for MCP operations when the caller omits an explicit Project.
  • A Home Composer Media Surface maps user intent to an existing project kind and project metadata at submit time.
  • The Chip Rail is the visible Home entry point for choosing a Home Composer Media Surface.
  • Essential Audio Generation uses an Audio Source Field plus model options before creating an audio Project.
  • AMR Cloud is the user-facing product choice; AMR CLI is the local execution adapter behind that capability.
  • The AMR CLI Distribution Contract is owned separately from Open Design; Open Design release packaging consumes it instead of defining the native CLI release itself.
  • The first AMR CLI Distribution Slice is mac arm64 only.
  • AMR Account Status describes account readiness for AMR Cloud, not the environment profile or CLI installation state.
  • An AMR Environment Profile is independent from release channel identity; a beta, preview, nightly, or stable package can target different AMR service environments when explicitly configured.
  • Onboarding Skip bypasses setup completion requirements that belong to the normal onboarding continue path.

Example dialogue

Dev: "When a coding agent creates a Codex deck through MCP, should it create a live artifact?" Domain expert: "No. Unless the user asked for refreshable data, create a Normal Artifact: write the Artifact Entry File and persist its Artifact Manifest in the Active Project."

Flagged ambiguities

  • "artifact creation" was used to mean both Normal Artifact creation and Live Artifact creation; resolved: this capability creates Normal Artifacts only.