Raxol.Docs.InteractiveTutorial (Raxol v0.2.0)
View SourceInteractive 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
Bookmarks the current position in a tutorial.
Exports a user's progress for saving.
Gets the current tutorial and step.
Gets a hint for the current exercise.
Returns to a bookmarked position.
Imports saved progress.
Initializes the tutorial system.
Lists all bookmarks.
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.
Starts a tutorial by ID.
Validates the current exercise.
Types
Functions
Bookmarks the current position in a tutorial.
Exports a user's progress for saving.
Gets the current tutorial and step.
Gets a hint for the current exercise.
Returns to a bookmarked position.
Imports saved progress.
Initializes the tutorial system.
Lists all bookmarks.
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.
Starts a tutorial by ID.
Validates the current exercise.