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 3 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. |
USAGE_GUIDE |
Quickstart & Usage Guide | Comprehensive guide to drawing, DSL blocks, object models, and element reuse in Celestine. |
2. Spec reference (B_SPEC_REFERENCE)
| Submodule | Title | Description |
|---|---|---|
SVG_ELEMENTS |
SVG Elements & Spec Checklist | Comprehensive audit of SVG elements, current implementation status, and DSL method mappings. |
FILTERS_AND_EFFECTS |
Filters, Gradients & Visual Effects | Reference guide for SVG filter primitives, linear and radial gradients, masks, and SMIL animations. |
3. Dsl and creative (C_DSL_AND_CREATIVE)
| Submodule | Title | Description |
|---|---|---|
FLUENT_PATHS_AND_SHAPES |
Fluent Path Builders, Procedural Shapes & Turtle Graphics | Fluent command chaining, stars, polygons, arc sectors, rounded rects, and turtle graphics. |
ROUGH_SKETCHY_GRAPHICS |
Hand-Drawn Sketchy Vector Engine | Create organic, sketchy architectural and hand-drawn SVG vectors using Celestine::Rough. |
COLORS_PALETTES_AND_DATAVIZ |
Color Engine, Designer Palettes & Micro Data-Viz | Rich color manipulations, Nord/Dracula/Tailwind palettes, sparklines, progress rings, and Data URIs. |
Defined in:
docs.crdocs/a_getting_started/overview.cr
docs/a_getting_started/usage_guide.cr
docs/b_spec_reference/filters_and_effects.cr
docs/b_spec_reference/svg_elements.cr
docs/c_dsl_and_creative/colors_palettes_and_dataviz.cr
docs/c_dsl_and_creative/fluent_paths_and_shapes.cr
docs/c_dsl_and_creative/rough_sketchy_graphics.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.A_GETTING_STARTED::USAGE_GUIDE: **Quickstart & Usage Guide** — Comprehensive guide to drawing, DSL blocks, object models, and element reuse in Celestine.
2. Spec reference (B_SPEC_REFERENCE)
B_SPEC_REFERENCE::SVG_ELEMENTS: **SVG Elements & Spec Checklist** — Comprehensive audit of SVG elements, current implementation status, and DSL method mappings.B_SPEC_REFERENCE::FILTERS_AND_EFFECTS: **Filters, Gradients & Visual Effects** — Reference guide for SVG filter primitives, linear and radial gradients, masks, and SMIL animations.
3. Dsl and creative (C_DSL_AND_CREATIVE)
C_DSL_AND_CREATIVE::FLUENT_PATHS_AND_SHAPES: **Fluent Path Builders, Procedural Shapes & Turtle Graphics** — Fluent command chaining, stars, polygons, arc sectors, rounded rects, and turtle graphics.C_DSL_AND_CREATIVE::ROUGH_SKETCHY_GRAPHICS: Hand-Drawn Sketchy Vector Engine — Create organic, sketchy architectural and hand-drawn SVG vectors using Celestine::Rough.C_DSL_AND_CREATIVE::COLORS_PALETTES_AND_DATAVIZ: **Color Engine, Designer Palettes & Micro Data-Viz** — Rich color manipulations, Nord/Dracula/Tailwind palettes, sparklines, progress rings, and Data URIs.
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.A_GETTING_STARTED::USAGE_GUIDE: **Quickstart & Usage Guide** — Comprehensive guide to drawing, DSL blocks, object models, and element reuse in Celestine.
B_SPEC_REFERENCE
B_SPEC_REFERENCE::SVG_ELEMENTS: **SVG Elements & Spec Checklist** — Comprehensive audit of SVG elements, current implementation status, and DSL method mappings.B_SPEC_REFERENCE::FILTERS_AND_EFFECTS: **Filters, Gradients & Visual Effects** — Reference guide for SVG filter primitives, linear and radial gradients, masks, and SMIL animations.
C_DSL_AND_CREATIVE
C_DSL_AND_CREATIVE::FLUENT_PATHS_AND_SHAPES: **Fluent Path Builders, Procedural Shapes & Turtle Graphics** — Fluent command chaining, stars, polygons, arc sectors, rounded rects, and turtle graphics.C_DSL_AND_CREATIVE::ROUGH_SKETCHY_GRAPHICS: Hand-Drawn Sketchy Vector Engine — Create organic, sketchy architectural and hand-drawn SVG vectors using Celestine::Rough.C_DSL_AND_CREATIVE::COLORS_PALETTES_AND_DATAVIZ: **Color Engine, Designer Palettes & Micro Data-Viz** — Rich color manipulations, Nord/Dracula/Tailwind palettes, sparklines, progress rings, and Data URIs.