# ash_state_machine v0.2.13 - Table of Contents

The extension for building state machines with Ash resources.

## GUIDES

- [Home](readme.md)

- Tutorials
  - [Getting Started with State Machines](getting-started-with-ash-state-machine.md)

- Topics
  - [What is AshStateMachine?](what-is-ash-state-machine.md)
  - [Charts](charts.md)
  - [Working with Ash.can?](working-with-ash-can.md)

- DSLs
  - [AshStateMachine](dsl-ashstatemachine.md)

- About AshStateMachine
  - [Change Log](changelog.md)

## Modules

- Dsl
  - [AshStateMachine](AshStateMachine.md): Provides tools for defining and working with resource-backed state machines.

- Introspection
  - [AshStateMachine.Info](AshStateMachine.Info.md): Introspection helpers for `AshStateMachine`
  - [AshStateMachine.Transition](AshStateMachine.Transition.md): The configuration for an transition.

- Helpers
  - [AshStateMachine.BuiltinChanges](AshStateMachine.BuiltinChanges.md): Changes for working with AshStateMachine resources.

- Charts
  - [AshStateMachine.Charts](AshStateMachine.Charts.md): Returns a mermaid flow chart of a given state machine resource.

- Errors
  - [AshStateMachine.Errors.InvalidInitialState](AshStateMachine.Errors.InvalidInitialState.md): Used when an initial state is set that is not a valid initial state
  - [AshStateMachine.Errors.NoMatchingTransition](AshStateMachine.Errors.NoMatchingTransition.md): Used when a state change occurs in an action with no matching transition

- Internals
  - [AshStateMachine.Checks.ValidNextState](AshStateMachine.Checks.ValidNextState.md): A policy for pre_flight checking if a state transition is allowed.

## Mix Tasks

- Internals
  - [mix ash_state_machine.generate_flow_charts](Mix.Tasks.AshStateMachine.GenerateFlowCharts.md): Generates a Mermaid Flow Chart for each `Ash.Resource` with the `AshStateMachine`
extension alongside the resource.
  - [mix ash_state_machine.install](Mix.Tasks.AshStateMachine.Install.md): Installs AshStateMachine