Architecture and feature documentation

These guides describe the current SparkStudio source, including development work that may be newer than the downloadable installer. The source/documentation review date is September 30, 2026. A documented implementation is not a claim that every browser, deployment, integration or failure condition has passed acceptance.

Start with Product and architecture, then Projects. For installation, use the guide attached to your exact release; Windows installation records the preview.9 boundary. Verification and roadmap separates dated observations from current capability summaries and remaining gates. Earlier ledger entries retain the facts and limitations of their original checks; they are not instructions to start an old development package or assertions about the currently running gateway.

Overview and installation

• Product and architecture
• Projects and portable packages
• Windows installer
• Preview release cycle
• Security and accounts
• Verification and roadmap

Designer and presentation

• Component coverage
• Property sheet, input events and groups
• Canvas precision
• Authoring defaults
• Images and popups
• Asset library
• Drawing and symbols
• Visual styles
• Caption translations

Bindings, state and reusable forms

• Property bindings
• Application state
• Input-state bindings
• Private instance state
• Templates and repeaters
• Nested forms
• Template parameter bindings
• State-driven template parameters
• Query controls and tables
• Query-backed properties
• Read-query testing

Scripting and events

• Scripting workspace
• Gateway events
• Component property/lifecycle events
• Component messages
• Python UI actions
• Python component events
• Lifecycle and session messaging workshop

Project tools and diagnostics

• Project search
• Resource changes
• Bulk replacement
• Publication history
• Preview communication
• Designer diagnostics

Gateway and operations

• Gateway console
• Connection operations
• Tag engineering
• Deployment settings
• Network access
• Offline gateway recovery
• Scheduled configuration backups

Workshops and verification

Use the example catalog and build instructions for independently authored workshops. Portable examples import as unpublished projects; setup-required examples also need the documented gateway resources. Match a workshop to its companion build. Use the preview.9 companion bundle for Python component events and lifecycle/session messaging; preview.8 and earlier do not include those features.

artifacts/sparkproj/ is the only maintained location for loose .sparkproj packages, with guides and provenance in index.json. It is ignored by Git. node tools/build-workshops.mjs --version <version> updates this directory and creates an immutable ZIP, manifest and checksums under artifacts/workshops/<version>/, without duplicate loose packages. Example loaders import authored JSON directly. Historical artifact paths in dated verification records may have been archived or removed; use the current package directory or the frozen release ZIP.

The September 30 documentation audit reconciled the overview, reusable forms, bindings, state, events, recovery and roadmap summaries against current frontend models/editors, gateway validators/services, Python helpers and existing verification records. It also checked documentation navigation, local links and referenced tool paths. It did not rerun all runtime, installer, network or database acceptance suites. Current source behavior, recorded verification and released binary coverage remain distinct.