Skip to content

README.md

Latest commit

 

History

History
174 lines (151 loc) · 9.9 KB

README.md

File metadata and controls

174 lines (151 loc) · 9.9 KB
Raw

docs — SSTIM Reference Documents

Narrative and technical specifications. The ontology's machine-readable form lives in ../static/ontology/; this directory holds the prose that justifies and explains it.

Each technical document is as-built (describes shipped code) or target (a design the code is growing toward), stated in its own opening banner. When the two disagree, the code and the as-built docs win.

concept/ — what the domain is and what we claim

technical/ — specifications

As-built. PATCH_STUDIO.md (the live authoring model, patch-studio-model-3, with model-1 and model-2 import) · SENSORY_FIELD.md (legacy Field contracts, adapters, starters, and /field/* redirects) · PHOTOSENSITIVITY_SAFETY.md (advisory, policy, flash-rate cap) · PWA_SERVICE_WORKER.md (caching, the three traps, compliance matrix) · SESSION_PACKAGE.md (a patch as a portable scientific object) · EQUIPMENT_CHECK.md (design: what the delivery chain can reproduce, asserted as sstim-ex:DeviceCapability) · PRIVATE_SYNC.md (bsc-lab-private-sync-1) · PORTABLE_DEPLOYMENT.md (deployment, migration, and the remaining gaps) · PUBLIC_ENTRANCE.md (the landing IA, shipped 2026-07-18) · KNOWLEDGE_BROWSER_UX.md (browser UX and its backlog).

Contracts. PRESET_FORMAT.md — the preset catalog JSON shared with BioSynCare, distinct from the Patch Studio model above. SESSION_MODEL.md — preset vs. session instance. Both are the source for their planned JSON Schemas.

Target. AUDIO_ENGINE_ARCHITECTURE.md (three-clock model, scheduler, orchestrator; as-built engines in ../src/engines/README.md) and VISUAL_ENGINE_ARCHITECTURE.md (PixiJS v8 design; as-built visuals in PATCH_STUDIO.md §5). PATCH_STUDIO_FIELD_INTEGRATION.md tracks the partially implemented Sensory Field cutover: ordinary first-class colour-field and spatial visual tracks, starters, compatibility routes, and the shared visual projection stage are in place; runtime extraction, unified exposure validation, final acceptance gates, and legacy retirement remain. AGENT_AUTOMATION_BOUNDARY.md records what a conversational agent-automation layer would have to respect if one were ever added — nothing in it is built or on the roadmap.

Defensive publications — do not modify after first commit (CLAUDE.md §3.4): BREATHING_MODEL.md, SYMMETRY_SYSTEM.md, MARTIGLI_BINAURAL.md.

decisions/ — architecture decision records

Lightweight ADRs (Context, Decision, Alternatives, Consequences) capturing non-obvious choices. decisions/README.md holds the index — it is not duplicated here, because the copy that was went stale at ADR 0011 while the series continued to grow.

DELIVERED.md is an archive of completed TODO.md items — history, not tasks. Nothing reads it during work.

ontology/ — plans and reviews

ontology/CURRENT_STATE.md is the maintained current-state and next-steps summary, and ontology/SSTIM_DIRECTIONS.md records where the model is going and why — waveforms, panning and modulation, protocol namespacing, and coverage of all known senses. ontology/README.md indexes the module architecture, improvement and publication plans, registry submissions, and the dated audits. Ontology design itself is documented at ../static/ontology/README.md.

gallery/ — selected captures

gallery/README.md collects original captures of the BSC Lab instruments and authored patches. Images stay beside their captions in the gallery rather than entering the PWA's precached static/ asset set.

brand/ — the isotype, and how it was derived

brand/README.md holds the historical BSC Lab isotype exploration: the parent mark measured off its artwork, the generator that builds every candidate from those constants, a WCAG audit of the BSC colour system, and a link to the full development history. The adopted mark (marks/merge-d.svg) is the source of static/favicon.svg and static/icons/.

ecosystem/ — IP, governance, outreach

  • ECOSYSTEM_INTEGRATION.md — living tracker across the five workstreams. Start here for outreach and positioning.
  • W3C_REPOSITORY_MIGRATION.md — executed 2026-08-23; still not production-cutover authorization. Decision analysis, gates and checkpointed plan for moving the complete repository and parallel publication site to w3c-cg/sstim, while preserving identifiers, histories, licensing provenance, immutable releases, production W3ID routing, and the existing Pages deployment. Its acceptance matrix now carries measured results.
  • W3C_REPOSITORY_MIGRATION_REPORT.md — the dated implementation and acceptance record: preserved-history evidence from a fresh clone, live /sstim/ results, the post-deployment failure ledger, the applied ref protection, and the remaining steps before any W3ID cutover.
  • OUTREACH_TARGETS.md — prospective labs, orgs, standards bodies and events, with the ask per target, the 90-day sequence, KPIs, and a consent-governed log (ADR 0024).
  • INTERVIEW_TARGETS.md — who to interview and why, scored on two axes (ontology gap, scientific/strategic), with the measured modality-coverage baseline that ranks them and the Track A / Track B boundary that keeps SSTIM contribution separate from BioSynCare product discovery.
  • INTERVIEW_PROTOCOL.md — the five separate consents, the relationship types, review-before-publication, and withdrawal handling, written against the controlled values in sstim-ecosystem.ttl (ADR 0024, ADR 0031).
  • ECOSYSTEM_OPERATIONS.md — running the consent-gated publication pipeline.
  • PATCH_STUDIO_CONFORMANCE_AND_NEUTRALITY.md — separates public SSTIM conformance from optional, version-pinned BSC catalog compatibility and gives the coalition decision gates.
  • HED_BIDS_INTEROP.md — SSTIM ↔ HED event profile and optional BIDS/NWB bindings (ADR 0025).
  • IP_STRATEGY.md and DEFENSIVE_PUBLICATIONS.md — publication-first over patents, plus the filing tracker.
  • w3id/README.md — how the persistent-namespace targets are generated and guarded; the route contract itself is in w3id/sstim/README.md.
  • W3C Community Group — launched, charter not yet ratified. CHARTER.md is the live instrument and owns the status-discipline wording; W3C_COMMUNITY_GROUP_PROPOSAL.md is the submitted proposal, kept as a record and not updated. First deliverable draft: USE_CASES_AND_REQUIREMENTS.md — 14 use cases derived from encoded Turtle rather than invented, each linked to its instance file and competency query, with 16 requirements and the open questions where an outside answer would change the vocabulary. Interviews: INTERVIEW_TARGETS.md, INTERVIEW_PROTOCOL.md. Outreach: INVITATION_TEMPLATE.md, CONSORTIUM_INVITATION.md. People: ADVISORY_BOARD.md (the source of truth for advisory consent state), PARTNERS.md.

Alongside the code

../src/README.md (architecture) · ../src/engines/README.md (the four audio engines) · ../src/rdf/README.md · ../src/ui/README.md · ../src/core/README.md (planned).

docs/credentials/ and docs/funding/ are gitignored working directories and are not part of the published documentation.