Raxol.Docs.InteractiveTutorial (Raxol v0.5.0)

View Source

Interactive tutorial system for Raxol documentation.

This module provides a framework for creating and displaying interactive tutorials that guide users through Raxol features with hands-on examples and step-by-step instructions.

Features:

  • Step-by-step guides with interactive examples
  • Progress tracking and bookmarking
  • Exercise validation
  • Contextual hints and help
  • Integration with documentation

Summary

Functions

Gets the current position in the tutorial.

Gets a hint for the current step.

Gets the progress for a tutorial.

Initializes the tutorial system.

Jumps to a specific step in the current tutorial.

Returns a list of all available tutorials.

Goes to the next step in the current tutorial.

Goes to the previous step in the current tutorial.

Registers a new tutorial.

Renders the current step's content.

Renders interactive elements for the current step.

Starts a tutorial by ID.

Validates a solution for the current step.

Functions

get_current_position()

Gets the current position in the tutorial.

get_hint()

Gets a hint for the current step.

get_progress(tutorial_id)

Gets the progress for a tutorial.

init()

Initializes the tutorial system.

jump_to_step(step_id)

Jumps to a specific step in the current tutorial.

list_tutorials()

Returns a list of all available tutorials.

next_step()

Goes to the next step in the current tutorial.

previous_step()

Goes to the previous step in the current tutorial.

register_tutorial(tutorial, state \\ nil)

Registers a new tutorial.

render_current_step()

Renders the current step's content.

render_interactive_elements()

Renders interactive elements for the current step.

start_tutorial(tutorial_id)

Starts a tutorial by ID.

validate_exercise(solution)

Validates a solution for the current step.