# useDocumentationGenerator

**Kind:** Function

**Source:** [`atloria-monorepo/apps/web/src/hooks/useDocumentationGenerator.ts`](https://github.com/sherkety/atloria/blob/main/atloria-monorepo/apps/web/src/hooks/useDocumentationGenerator.ts#L94)

Custom hook for documentation generation

Manages the lifecycle of documentation generation jobs including:
- Starting new jobs
- Real-time progress updates via WebSocket
- Cancellation
- Error handling

## Signature

```ts
function useDocumentationGenerator(options: UseDocumentationGeneratorOptions): UseDocumentationGeneratorReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseDocumentationGeneratorOptions` |

**Returns:** `UseDocumentationGeneratorReturn`