# WorkflowDocumentation

**Kind:** Interface

**Source:** [`atloria-monorepo/libs/parser-core/src/interfaces/workflow-documentation.interface.ts`](https://github.com/sherkety/atloria/blob/main/atloria-monorepo/libs/parser-core/src/interfaces/workflow-documentation.interface.ts#L18)

Complete workflow documentation for a component

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `component` | `string` |
| `componentPath` | `string` |
| `description` | `string` |
| `stateMachines` | `StateMachine[]` |
| `states` | `WorkflowStateDocumentation[]` |
| `diagram` | `string` |
| `metadata` | `{
    /**
     * When documentation was generated
     */
    generatedAt: Date;

    /**
     * Total number of screenshots
     */
    screenshotCount: number;

    /**
     * Total number of interactive elements
     */
    interactionCount: number;
  }` |