module Rubellite::Docs

Overview

The Rubellite::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
OVERVIEW Getting Started & System Architecture Introduction to Rubellite, the bidirectional Crystal <-> Ruby interop engine.
QUICKSTART Quickstart Guide & Usage Patterns Step-by-step tutorial on bootstrapping Rubellite, calling methods, and handling errors.
TYPE_SYSTEM Type Conversions & Value Marshaling Bidirectional marshaling between Crystal native types and CRuby VALUE handles.

2. Advanced features (B_ADVANCED_FEATURES)

Submodule Title Description
C_API_AND_MEMORY C API, Memory Management & GC Coordination Deep dive into LibRuby bindings, Win32 symbol collision isolation, and dual-GC lifecycles.
CHANNEL_CONCURRENCY Channel Concurrency & Fiber Interop Bridging Crystal CSP channels with Ruby scripts and managing the Global VM Lock (GVL).
SPINEL_AOT Spinel AOT Native Compilation Fast-Path High-performance Ahead-Of-Time and JIT kernel acceleration for compute-heavy algorithms.
R2_FORENSICS Binary Forensics & ABI Auditing via Radare2 Static and dynamic binary analysis of libruby exports, symbols, and ABI compatibility.

3. Versioning and releases (C_VERSIONING_AND_RELEASES)

Submodule Title Description
CARBON_VERSIONING Internal Versioning & Release Engineering with Carbon Automated commit-based versioning, zero-friction Git hooks, changelogs, and badge management.
RUBY_VERSION_TRACKING Upstream Ruby Compatibility Branches & Dual Versioning Managing 1-commit branches off main and tags to track specific Ruby releases.

Defined in:

rubellite/docs.cr
rubellite/docs/a_getting_started/overview.cr
rubellite/docs/a_getting_started/quickstart.cr
rubellite/docs/a_getting_started/type_system.cr
rubellite/docs/b_advanced_features/c_api_and_memory.cr
rubellite/docs/b_advanced_features/channel_concurrency.cr
rubellite/docs/b_advanced_features/r2_forensics.cr
rubellite/docs/b_advanced_features/spinel_aot.cr
rubellite/docs/c_versioning_and_releases/carbon_versioning.cr
rubellite/docs/c_versioning_and_releases/ruby_version_tracking.cr

Class Method Summary

Class Method Detail

def self.topic_01_quick_start : Nil #

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

Rubellite Commands:

shards install
crystal spec
bin/jasper build
crystal docs

[View source]
def self.topic_02_reading_paths : Nil #

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

Structured Learning Tracks

1. Getting started (A_GETTING_STARTED)
  • A_GETTING_STARTED::OVERVIEW: **Getting Started & System Architecture** &mdash; Introduction to Rubellite, the bidirectional Crystal <-> Ruby interop engine.
  • A_GETTING_STARTED::QUICKSTART: **Quickstart Guide & Usage Patterns** &mdash; Step-by-step tutorial on bootstrapping Rubellite, calling methods, and handling errors.
  • A_GETTING_STARTED::TYPE_SYSTEM: **Type Conversions & Value Marshaling** &mdash; Bidirectional marshaling between Crystal native types and CRuby VALUE handles.
2. Advanced features (B_ADVANCED_FEATURES)
  • B_ADVANCED_FEATURES::C_API_AND_MEMORY: **C API, Memory Management & GC Coordination** &mdash; Deep dive into LibRuby bindings, Win32 symbol collision isolation, and dual-GC lifecycles.
  • B_ADVANCED_FEATURES::CHANNEL_CONCURRENCY: **Channel Concurrency & Fiber Interop** &mdash; Bridging Crystal CSP channels with Ruby scripts and managing the Global VM Lock (GVL).
  • B_ADVANCED_FEATURES::SPINEL_AOT: Spinel AOT Native Compilation Fast-Path — High-performance Ahead-Of-Time and JIT kernel acceleration for compute-heavy algorithms.
  • B_ADVANCED_FEATURES::R2_FORENSICS: **Binary Forensics & ABI Auditing via Radare2** &mdash; Static and dynamic binary analysis of libruby exports, symbols, and ABI compatibility.
3. Versioning and releases (C_VERSIONING_AND_RELEASES)

[View source]
def self.topic_03_table_of_contents : Nil #

Master Table of Contents: Complete hierarchical topic index.

Complete Documentation Index

A_GETTING_STARTED
  • A_GETTING_STARTED::OVERVIEW: **Getting Started & System Architecture** &mdash; Introduction to Rubellite, the bidirectional Crystal <-> Ruby interop engine.
  • A_GETTING_STARTED::QUICKSTART: **Quickstart Guide & Usage Patterns** &mdash; Step-by-step tutorial on bootstrapping Rubellite, calling methods, and handling errors.
  • A_GETTING_STARTED::TYPE_SYSTEM: **Type Conversions & Value Marshaling** &mdash; Bidirectional marshaling between Crystal native types and CRuby VALUE handles.
B_ADVANCED_FEATURES
  • B_ADVANCED_FEATURES::C_API_AND_MEMORY: **C API, Memory Management & GC Coordination** &mdash; Deep dive into LibRuby bindings, Win32 symbol collision isolation, and dual-GC lifecycles.
  • B_ADVANCED_FEATURES::CHANNEL_CONCURRENCY: **Channel Concurrency & Fiber Interop** &mdash; Bridging Crystal CSP channels with Ruby scripts and managing the Global VM Lock (GVL).
  • B_ADVANCED_FEATURES::SPINEL_AOT: Spinel AOT Native Compilation Fast-Path — High-performance Ahead-Of-Time and JIT kernel acceleration for compute-heavy algorithms.
  • B_ADVANCED_FEATURES::R2_FORENSICS: **Binary Forensics & ABI Auditing via Radare2** &mdash; Static and dynamic binary analysis of libruby exports, symbols, and ABI compatibility.
C_VERSIONING_AND_RELEASES

[View source]