README.md

workshop-rs Documentation

This directory is the canonical documentation index for workshop-rs. The root README.md is the user-facing project overview. workshop-rs is both an independently usable raw Workshop implementation and WrightKit's canonical Workshop semantic core.

Documentation model

language-support.md          authoritative Workshop language support matrix
implementation-role.md       standalone implementation and consumer relationship
  └─ docs/adr/               accepted point-in-time architecture decisions
      └─ living references   catalog, gameplay, provenance, conformance, release
          └─ executable evidence   crates, datasets, tests, census, corpus

GitHub issues/PRs own active execution scope and sequencing; durable contracts belong in documentation.

Workshop language support

• Language support matrix: the single authoritative index and status matrix for all Workshop language capabilities, linking to component inventories in language-support/:
  • Program Structure & Variables
  • Events & Event Filters
  • Conditions & Control Flow
  • Operators & Variable Modifications
  • Actions Inventory
  • Values Inventory
  • Enumerated Domains
  • Custom-Game Settings
  • Strings & Localization
  • Tooling & Semantic Capabilities

Architecture and ownership

• Implementation role: standalone Workshop implementation identity, canonical ownership, dependency direction from opy-rs / del-rs / Wright, and consumer-driven evolution rules.
• Canonical action layout: native Workshop action-width queries for validated WIR sequences, including structured action expansion and explicit layout errors.
• ADR-0001: Workshop Catalog, Locale, Provenance, and Version Boundaries: semantic-code/catalog separation, locale-independent identities, missing-mapping behavior, and version identity.
• ADR-0002 (Gameplay): Hero Gameplay Domain API and Provenance Boundary: typed hero/ability topology, variants, open identities, and dataset lifecycle.
• ADR-0006: Canonical Typed Workshop Settings Semantics: setting identity, scope, targets, domains, applicability, provenance, and authored-versus-effective numeric semantics.
• Repository ownership rules: cross-repository routing, provenance, validation, and delivery rules.

Workshop catalog, localization, and provenance

• Provenance record: catalog, event/filter, locale, gameplay, fixture, and dataset provenance.
• Test fixture provenance: source origin and verification for raw Workshop/settings fixtures.

Hero gameplay data and query APIs

• Hero gameplay dataset: embedded dataset schema, role facts, ability keywords, and validation boundaries.
• Gameplay query API: read-only semantic queries, kit lookups, Custom Game calculations, and locale-aware ability resolution.
• Hero gameplay topology survey: roster/slot/variant evidence used by the domain model.

Conformance, census, and compatibility evidence

• ADR-0002: Workshop Conformance Result and Feature Identity Contract: stable feature/result/evidence schema.
• ADR-0003: Canonical Sharded Workshop Feature Census: deterministic offline census and WIR capability shards.
• ADR-0004: Provenance-Linked Real-Project Evidence: preserved real-project and minimized regression evidence.
• ADR-0005: Seasonal Workshop Client Validation Workflow: live-client capture and structured drift review.

Release and operations

• Release automation: release/publish workflow, artifacts, checksums, and maintainer runbook.

Authority map

Contract	Primary document
Workshop language support status	language-support.md
Repository/consumer role	implementation-role.md
Catalog & semantic boundaries	adr/0001-catalog-boundaries.md
Provenance & evidence	provenance.md
Hero gameplay model	adr/0002-gameplay-domain-api.md, gameplay-data.md
Gameplay queries	gameplay-query.md
Conformance	adr/0002-conformance-contract.md
Feature census	adr/0003-sharded-census.md
Real-project evidence	adr/0004-real-project-evidence.md
Seasonal validation	adr/0005-seasonal-client-validation.md
Typed Workshop settings	adr/0006-settings-semantic-schema.md
Release & publishing	release.md

Note

Source-language-specific syntax, runtime lowering, compiler quirks, or reconstruction belong to opy-rs / del-rs, even when those implementations consume canonical Workshop contracts from this repository.