Skip to content

generateWorkflowDocumentation

reference
1 min readUpdated

Kind: Function

Source: atloria-monorepo/libs/parser-core/src/generators/workflow-documentation.generator.ts

Generate workflow documentation from enhanced screenshot metadata

Takes a collection of screenshots with state machine context and creates comprehensive workflow documentation including state diagrams, actions, and guides.

Signature

ts
function generateWorkflowDocumentation(screenshots: EnhancedScreenshotMetadata[], options: WorkflowDocGenerationOptions): WorkflowDocumentation[]

Parameters

NameType
screenshotsEnhancedScreenshotMetadata[]
optionsWorkflowDocGenerationOptions

Returns: WorkflowDocumentation[]

Was this page helpful?

Download as PDF