module
Celestine::Docs
Overview
The Celestine::Docs module is the authoritative technical reference and documentation guide.
Learning Tracks & Topic Index
The documentation is paced into 1 distinct tracks:
1. Getting started (A_GETTING_STARTED)
| Submodule | Title | Description |
|---|---|---|
OVERVIEW |
Getting Started & System Overview | Introduction to Celestine SVG generation DSL and object model. |
Defined in:
docs.crdocs/a_getting_started/overview.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.
Docs Commands:
shards install
crystal spec
crystal docs
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 Overview** — Introduction to Celestine SVG generation DSL and object model.
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 Overview** — Introduction to Celestine SVG generation DSL and object model.