module

Spacetime::Docs

The Spacetime::Docs module is the authoritative technical reference and documentation guide.

Learning Tracks & Topic Index

The documentation is paced into 3 distinct tracks:

1. Getting started (A_GETTING_STARTED)

Submodule Title Description
Introduction Introduction to Spacetime-CR Overview of the SpacetimeDB Crystal SDK, Two-Tier DSL, BSATN/SATS-JSON codecs, and real-time client.
Quickstart Quickstart Guide Install spacetime-cr, define serializable table models, subscribe to queries, and call reducers.

2. Guides (B_GUIDES)

Submodule Title Description
ArchitectureAndSats Architecture & SATS Type System Deep dive into the Spacetime Algebraic Type System (SATS), 256-bit integers, Identity, and AlgebraicValue.
BsatnAndWireProtocol BSATN & v1 Wire Protocol Binary Spacetime Algebraic Type Notation (BSATN) encoding rules and WebSocket v1 protocol envelopes.
ClientCacheAndSubscriptions Client Cache & Real-Time Subscriptions Managing reactive in-memory TableCache(T) state, primary key updates, and deterministic LoopbackTransport testing.
CodegenAndWasmAbi Schema Codegen & WASM Module ABI Generating strongly-typed Crystal bindings from SpacetimeDB schemas and targeting wasm32-unknown-unknown.

3. Reference (C_REFERENCE)

Submodule Title Description
CliAndHttpApi CLI & HTTP REST API Reference Command-line usage for spacetime-cr and REST endpoints in Spacetime::HTTPClient.

Class methods

topic_01_quick_start

Quick-Start Commands: Essential commands for building, running, and testing.

Quick-Start Commands:

shards install
shards build spacetime-cr
bin/spacetime-cr doctor
bin/spacetime-cr generate --schema schema.json --output src/module_bindings.cr
Source
topic_02_reading_paths

Learning Tracks & Reading Paths: Curated reading order from beginner to advanced.

Structured Learning Tracks

1. Getting started (A_GETTING_STARTED)
  • A_GETTING_STARTED::Introduction: Introduction to Spacetime-CR — Overview of the SpacetimeDB Crystal SDK, Two-Tier DSL, BSATN/SATS-JSON codecs, and real-time client.
  • A_GETTING_STARTED::Quickstart: Quickstart Guide — Install spacetime-cr, define serializable table models, subscribe to queries, and call reducers.
2. Guides (B_GUIDES)
  • B_GUIDES::ArchitectureAndSats: **Architecture & SATS Type System** — Deep dive into the Spacetime Algebraic Type System (SATS), 256-bit integers, Identity, and AlgebraicValue.
  • B_GUIDES::BsatnAndWireProtocol: **BSATN & v1 Wire Protocol** — Binary Spacetime Algebraic Type Notation (BSATN) encoding rules and WebSocket v1 protocol envelopes.
  • B_GUIDES::ClientCacheAndSubscriptions: **Client Cache & Real-Time Subscriptions** — Managing reactive in-memory TableCache(T) state, primary key updates, and deterministic LoopbackTransport testing.
  • B_GUIDES::CodegenAndWasmAbi: **Schema Codegen & WASM Module ABI** — Generating strongly-typed Crystal bindings from SpacetimeDB schemas and targeting wasm32-unknown-unknown.
3. Reference (C_REFERENCE)
  • C_REFERENCE::CliAndHttpApi: **CLI & HTTP REST API Reference** — Command-line usage for spacetime-cr and REST endpoints in Spacetime::HTTPClient.
Source
topic_03_table_of_contents

Master Table of Contents: Complete hierarchical topic index.

Complete Documentation Index

A_GETTING_STARTED
  • A_GETTING_STARTED::Introduction: Introduction to Spacetime-CR — Overview of the SpacetimeDB Crystal SDK, Two-Tier DSL, BSATN/SATS-JSON codecs, and real-time client.
  • A_GETTING_STARTED::Quickstart: Quickstart Guide — Install spacetime-cr, define serializable table models, subscribe to queries, and call reducers.
B_GUIDES
  • B_GUIDES::ArchitectureAndSats: **Architecture & SATS Type System** — Deep dive into the Spacetime Algebraic Type System (SATS), 256-bit integers, Identity, and AlgebraicValue.
  • B_GUIDES::BsatnAndWireProtocol: **BSATN & v1 Wire Protocol** — Binary Spacetime Algebraic Type Notation (BSATN) encoding rules and WebSocket v1 protocol envelopes.
  • B_GUIDES::ClientCacheAndSubscriptions: **Client Cache & Real-Time Subscriptions** — Managing reactive in-memory TableCache(T) state, primary key updates, and deterministic LoopbackTransport testing.
  • B_GUIDES::CodegenAndWasmAbi: **Schema Codegen & WASM Module ABI** — Generating strongly-typed Crystal bindings from SpacetimeDB schemas and targeting wasm32-unknown-unknown.
C_REFERENCE
  • C_REFERENCE::CliAndHttpApi: **CLI & HTTP REST API Reference** — Command-line usage for spacetime-cr and REST endpoints in Spacetime::HTTPClient.
Source

Nested types