module Docs

Overview

The 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 & Crowbar Overview Complete introduction to Crowbar 2.0 data transformation and fuzzing architecture.
DSL_GUIDE Declarative DSL & Scoped Pipelines In-depth tutorial on composing targeted pipelines, scopes, and fixup hooks.
EVOLUTION_GUIDE Feedback-Driven Evolutionary Optimization Guide to the genetic algorithm, population corpus, and anti-stagnation mechanisms.
RULES_AND_SELECTORS Structure Rules & Advanced Selectors Reference guide for Crowbar's 10 format rules, advanced selectors, and combinator expressions.

Defined in:

docs.cr
docs/a_getting_started/dsl_guide.cr
docs/a_getting_started/evolution_guide.cr
docs/a_getting_started/overview.cr
docs/a_getting_started/rules_and_selectors.cr

Class Method Summary

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 & Crowbar Overview** — Complete introduction to Crowbar 2.0 data transformation and fuzzing architecture.
  • A_GETTING_STARTED::DSL_GUIDE: **Declarative DSL & Scoped Pipelines** — In-depth tutorial on composing targeted pipelines, scopes, and fixup hooks.
  • A_GETTING_STARTED::EVOLUTION_GUIDE: Feedback-Driven Evolutionary Optimization — Guide to the genetic algorithm, population corpus, and anti-stagnation mechanisms.
  • A_GETTING_STARTED::RULES_AND_SELECTORS: **Structure Rules & Advanced Selectors** — Reference guide for Crowbar's 10 format rules, advanced selectors, and combinator expressions.

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 & Crowbar Overview** — Complete introduction to Crowbar 2.0 data transformation and fuzzing architecture.
  • A_GETTING_STARTED::DSL_GUIDE: **Declarative DSL & Scoped Pipelines** — In-depth tutorial on composing targeted pipelines, scopes, and fixup hooks.
  • A_GETTING_STARTED::EVOLUTION_GUIDE: Feedback-Driven Evolutionary Optimization — Guide to the genetic algorithm, population corpus, and anti-stagnation mechanisms.
  • A_GETTING_STARTED::RULES_AND_SELECTORS: **Structure Rules & Advanced Selectors** — Reference guide for Crowbar's 10 format rules, advanced selectors, and combinator expressions.