# ProjectAutoDocConfig

**Kind:** Database Model

**Source:** [`atloria-monorepo/libs/database/prisma/schema.prisma`](https://github.com/sherkety/atloria/blob/main/atloria-monorepo/libs/database/prisma/schema.prisma#L1414)

## Fields

| Field | Type | Required | Key |
|---|---|---|---|
| `id` | `String` | ✓ | PK |
| `projectId` | `String` | ✓ | unique |
| `frontendPath` | `String` | - |  |
| `backendPath` | `String` | - |  |
| `siteUrl` | `String` | - |  |
| `siteLoginUrl` | `String` | - |  |
| `siteEmail` | `String` | - |  |
| `sitePassword` | `String` | - |  |
| `repoUsername` | `String` | - |  |
| `repoPassword` | `String` | - |  |
| `skeletonStructure` | `Json` | - |  |
| `includeApiDocs` | `Boolean` | ✓ |  |
| `includeDiagrams` | `Boolean` | ✓ |  |
| `includeScreenshots` | `Boolean` | ✓ |  |
| `includeVideo` | `Boolean` | ✓ |  |
| `maxPages` | `Int` | - |  |
| `aiEnhancement` | `Boolean` | ✓ |  |
| `outputFormat` | `String` | ✓ |  |
| `screenshotFormat` | `String` | ✓ |  |
| `screenshotQuality` | `Int` | ✓ |  |
| `maxConcurrency` | `Int` | ✓ |  |
| `timeout` | `Int` | ✓ |  |
| `excludePatterns` | `String[]` | ✓ |  |
| `targetAudience` | `String` | ✓ |  |
| `autoPublish` | `Boolean` | ✓ |  |
| `enableVersioning` | `Boolean` | ✓ |  |
| `screenshotCoverageThreshold` | `Int` | ✓ |  |
| `webhookSecret` | `String` | - |  |
| `sandboxAcknowledgedAt` | `DateTime` | - |  |
| `onTagCreate` | `Boolean` | ✓ |  |
| `onPush` | `Boolean` | ✓ |  |
| `onRelease` | `Boolean` | ✓ |  |
| `tagPattern` | `String` | - |  |
| `branchPattern` | `String` | - |  |
| `scheduleEnabled` | `Boolean` | ✓ |  |
| `scheduleCron` | `String` | - |  |
| `scheduleTimezone` | `String` | - |  |
| `requireApproval` | `Boolean` | ✓ |  |
| `retentionPolicy` | `Json` | - |  |

## Diagram

```mermaid
erDiagram
    ProjectAutoDocConfig {
        id String [PK]
        projectId String [UNIQUE]
        frontendPath String?
        backendPath String?
        siteUrl String?
        siteLoginUrl String?
        siteEmail String?
        sitePassword String?
        repoUsername String?
        repoPassword String?
        skeletonStructure Json?
        includeApiDocs Boolean
        includeDiagrams Boolean
        includeScreenshots Boolean
        includeVideo Boolean
        maxPages Int?
        aiEnhancement Boolean
        outputFormat String
        screenshotFormat String
        screenshotQuality Int
        maxConcurrency Int
        timeout Int
        excludePatterns String[]
        targetAudience String
        autoPublish Boolean
        enableVersioning Boolean
        screenshotCoverageThreshold Int
        webhookSecret String?
        sandboxAcknowledgedAt DateTime?
        onTagCreate Boolean
        onPush Boolean
        onRelease Boolean
        tagPattern String?
        branchPattern String?
        scheduleEnabled Boolean
        scheduleCron String?
        scheduleTimezone String?
        requireApproval Boolean
        retentionPolicy Json?
    }
```