module
Bakelite::Docs
Overview
The Bakelite::Docs module is the authoritative technical reference and documentation guide.
Learning Tracks & Topic Index
The documentation is paced into 6 distinct tracks:
1. Overview (A_OVERVIEW)
| Submodule | Title | Description |
|---|---|---|
INTRODUCTION |
Introduction to Bakelite | High-performance virtual filesystem and binary container engine for Crystal. |
2. Architecture (B_ARCHITECTURE)
| Submodule | Title | Description |
|---|---|---|
CHUNKING_AND_IO |
Chunking and Streaming IO | Architecture of bounded-memory streaming and random access IO. |
3. Dsl (C_DSL)
| Submodule | Title | Description |
|---|---|---|
MACROS_AND_VOLUMES |
Compile-Time DSL and Volumes | Using Bakelite macros to embed and organize assets in code. |
4. Containers (D_CONTAINERS)
| Submodule | Title | Description |
|---|---|---|
BINARY_CONTAINERS |
Binary Containers and CLI Toolchain | Post-compile executable overlay and standalone archive manipulation. |
5. Scale (E_SCALE)
| Submodule | Title | Description |
|---|---|---|
LARGE_ASSET_STREAMING |
Large Asset Streaming and Scale (100MB & 1GB) | Memory bounds, streaming architecture, and scale testing for massive assets. |
6. Concurrency (F_CONCURRENCY)
| Submodule | Title | Description |
|---|---|---|
THREAD_SAFETY |
Concurrency and Thread Safety | Thread-safe container sharing, multi-fiber reads, and synchronized IO. |
Defined in:
bakelite/docs.crbakelite/docs/a_overview/introduction.cr
bakelite/docs/b_architecture/chunking_and_io.cr
bakelite/docs/c_dsl/macros_and_volumes.cr
bakelite/docs/d_containers/binary_containers.cr
bakelite/docs/e_scale/large_asset_streaming.cr
bakelite/docs/f_concurrency/thread_safety.cr
Class Method Summary
-
.topic_01_quick_start : Nil
Quick-Start Commands: Essential commands for building, running, and testing.
-
.topic_02_reading_paths : Nil
Learning Tracks & Reading Paths: Curated reading order from beginner to advanced.
-
.topic_03_table_of_contents : Nil
Master Table of Contents: Complete hierarchical topic index.
Class Method Detail
def self.topic_01_quick_start : Nil
#
Quick-Start Commands: Essential commands for building, running, and testing.
Bakelite Quick Start:
shards install
crystal spec
bin/bakelite pack bin/game.exe assets/ --mount assets
def self.topic_02_reading_paths : Nil
#
Learning Tracks & Reading Paths: Curated reading order from beginner to advanced.
Structured Learning Tracks
1. Overview (A_OVERVIEW)
A_OVERVIEW::INTRODUCTION: Introduction to Bakelite — High-performance virtual filesystem and binary container engine for Crystal.
2. Architecture (B_ARCHITECTURE)
B_ARCHITECTURE::CHUNKING_AND_IO: Chunking and Streaming IO — Architecture of bounded-memory streaming and random access IO.
3. Dsl (C_DSL)
C_DSL::MACROS_AND_VOLUMES: Compile-Time DSL and Volumes — Using Bakelite macros to embed and organize assets in code.
4. Containers (D_CONTAINERS)
D_CONTAINERS::BINARY_CONTAINERS: Binary Containers and CLI Toolchain — Post-compile executable overlay and standalone archive manipulation.
5. Scale (E_SCALE)
E_SCALE::LARGE_ASSET_STREAMING: **Large Asset Streaming and Scale (100MB & 1GB)** — Memory bounds, streaming architecture, and scale testing for massive assets.
6. Concurrency (F_CONCURRENCY)
F_CONCURRENCY::THREAD_SAFETY: Concurrency and Thread Safety — Thread-safe container sharing, multi-fiber reads, and synchronized IO.
def self.topic_03_table_of_contents : Nil
#
Master Table of Contents: Complete hierarchical topic index.
Complete Documentation Index
A_OVERVIEW
A_OVERVIEW::INTRODUCTION: Introduction to Bakelite — High-performance virtual filesystem and binary container engine for Crystal.
B_ARCHITECTURE
B_ARCHITECTURE::CHUNKING_AND_IO: Chunking and Streaming IO — Architecture of bounded-memory streaming and random access IO.
C_DSL
C_DSL::MACROS_AND_VOLUMES: Compile-Time DSL and Volumes — Using Bakelite macros to embed and organize assets in code.
D_CONTAINERS
D_CONTAINERS::BINARY_CONTAINERS: Binary Containers and CLI Toolchain — Post-compile executable overlay and standalone archive manipulation.
E_SCALE
E_SCALE::LARGE_ASSET_STREAMING: **Large Asset Streaming and Scale (100MB & 1GB)** — Memory bounds, streaming architecture, and scale testing for massive assets.
F_CONCURRENCY
F_CONCURRENCY::THREAD_SAFETY: Concurrency and Thread Safety — Thread-safe container sharing, multi-fiber reads, and synchronized IO.