# Atloria (self dogfood)

<!-- source: function-convertpreelement.md -->

# $convertPreElement

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/CodeBlockNode.tsx` (line 298)

Converts a <pre> HTML element into a CodeBlockNode.
Extracts the code content, language, and meta information from the element's attributes.
The language is determined from the class attribute (e.g., class="language-javascript") or
the data-language attribute if available.

## Signature

```ts
function $convertPreElement(element: Element): DOMConversionOutput
```

## Parameters

| Name | Type |
|---|---|
| `element` | `Element` |

**Returns:** `DOMConversionOutput`

<!-- source: constant-abort-conditions.md -->

# ABORT_CONDITIONS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 349)

<!-- source: api-endpoint-accept.md -->

# accept

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.controller.ts` (line 111)

## Endpoint

`POST /suggestions/:id/accept`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `SuggestionController` (MODULE_DECLARES)
- `SuggestionAliasController` (MODULE_DECLARES)

<!-- source: class-acceptinvitationbodydto.md -->

# AcceptInvitationBodyDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/invitation/invitation.controller.ts` (line 7)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `password` | `string` |

<!-- source: interface-acceptinvitationdto.md -->

# AcceptInvitationDto

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/invitation/invitation.service.ts` (line 29)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `password` | `string` |

<!-- source: interface-accessibilityresult.md -->

# AccessibilityResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/accessibility.ts` (line 28)

Accessibility check result

## Properties

| Property | Type |
|---|---|
| `violations` | `AccessibilityViolation[]` |
| `passes` | `number` |
| `incomplete` | `number` |

<!-- source: interface-accordionitemprops-2.md -->

# AccordionItemProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/accordion-item.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `questionKey` | `string` |
| `answerKey` | `string` |
| `defaultOpen` | `boolean` |

<!-- source: interface-accordionitemprops.md -->

# AccordionItemProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/accordion-item.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `questionKey` | `string` |
| `answerKey` | `string` |
| `defaultOpen` | `boolean` |

<!-- source: service-actionexecutorservice.md -->

# ActionExecutorService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/action-executor.service.ts` (line 57)

Service for executing pre-capture actions on Playwright pages

Supports 13 action types:
- click, dblclick: Click interactions
- type, fill: Text input
- press: Keyboard keys
- wait: Duration or selector waits
- scroll: Scroll to element or page bottom
- hover, focus, blur: Element state changes
- select: Dropdown selection
- navigate: Page navigation
- frame: Iframe context switching

And 5 wait condition types:
- selector, timeout, networkIdle, loadState, function

`ActionExecutorService` executes a configured list of **pre-capture actions** against a Playwright `Page` (or an active `Frame`) before a screenshot is taken. It provides a single, validated execution pipeline that maps high-level action definitions (click, type, wait, navigate, frame, etc.) into concrete Playwright calls. This service typically sits inside the screenshot worker flow, ensuring pages are in the desired state (navigation complete, elements ready, UI interacted with) prior to capture.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `executeActions` | `executeActions(page: Page, actions: ScreenshotActionDto[] | undefined)` | `Promise<void>` |
| `executeActionsWithHook` | `executeActionsWithHook(page: Page, actions: ScreenshotActionDto[] | undefined, onAfterEach: (action: ScreenshotActionDto, index: number) => Promise<void>)` | `Promise<void>` |
| `executeAction` | `executeAction(page: Page, action: ScreenshotActionDto, index: number, context: ActionContext)` | `Promise<ActionContext | void>` |
| `executeWaitFor` | `executeWaitFor(page: Page, waitFor: WaitForDto | undefined)` | `Promise<void>` |
| `validateAction` | `validateAction(action: ScreenshotActionDto)` | `void` |
| `captureDOMState` | `captureDOMState(page: Page)` | `Promise<CapturedDOMState>` |

## Diagram

```mermaid
sequenceDiagram
  participant Orchestrator as Screenshot Orchestrator
  participant Executor as ActionExecutorService
  participant Page as Playwright Page
  participant Frame as Playwright Frame

  Orchestrator->>Executor: execute(page, actions[])
  loop for each action
    alt action.type == "frame"
      Executor->>Page: frameLocator()/frame()
      Page-->>Executor: Frame context
      Executor->>Frame: set active context
    else action targets frame context
      Executor->>Frame: perform action (click/type/wait/etc.)
    else action targets page context
      Executor->>Page: perform action (navigate/wait/scroll/etc.)
    end
  end
  Executor-->>Orchestrator: done (page ready for capture)
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { chromium, type Page } from 'playwright';
import { ActionExecutorService } from './services/action-executor.service';

@Injectable()
export class ScreenshotJobRunner {
  constructor(private readonly actionExecutor: ActionExecutorService) {}

  async run() {
    const browser = await chromium.launch();
    const page: Page = await (await browser.newContext()).newPage();

    // Example action list (shape may vary slightly based on your DTOs)
    const actions = [
      { type: 'navigate', url: 'https://example.com' },
      { type: 'wait', condition: { type: 'loadState', state: 'networkidle' } },
      { type: 'click', selector: 'text=Sign in' },
      { type: 'fill', selector: 'input[name="email"]', value: 'user@example.com' },
      { type: 'press', selector: 'input[name="password"]', key: 'Tab' },
      { type: 'type', selector: 'input[name="password"]', value: 'correct horse battery staple' },
      { type: 'click', selector: 'button[type="submit"]' },
      { type: 'wait', condition: { type: 'selector', selector: '[data-testid="dashboard"]' } },
      { type: 'scroll', to: 'bottom' },
      // Switch into an iframe, then interact within it
      { type: 'frame', selector: 'iframe#billing' },
      { type: 'select', selector: 'select#plan', value: 'pro' },
      { type: 'hover', selector: '[data-testid="plan-details"]' },
    ];

    await this.actionExecutor.execute(page, actions);

    // Now page is prepared for capture
    const screenshot = await page.screenshot({ fullPage: true });

    await browser.close();
    return screenshot;
  }
}
```

## AI Coding Instructions

- Keep the action execution path **strictly deterministic**: validate action payloads up-front and route by `action.type` with a single dispatcher to avoid divergent behavior.
- When implementing waits, prefer explicit `wait` actions with supported condition types (`selector`, `timeout`, `networkIdle`, `loadState`, `function`) and avoid hidden implicit sleeps inside other actions.
- Be careful with **frame context**: `frame` actions should update the active execution target (Page vs Frame). Ensure subsequent selector-based actions operate in the intended context.
- Integrate new action types by mapping directly to Playwright primitives and preserving consistent error messages (include `action.type` and selector/url where applicable) to aid job debugging.

<!-- source: type-actiontype.md -->

# ActionType

**Kind:** Type

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 38)

## Definition

```ts
typeof ACTION_TYPES[number]
```

<!-- source: constant-action-types.md -->

# ACTION_TYPES

**Kind:** Constant

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 32)

<!-- source: controller-activitycontroller.md -->

# ActivityController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/activity/activity.controller.ts` (line 11)

## Relationships

- MODULE_DECLARES → `list`
- MODULE_DECLARES → `getDocumentActivities`
- MODULE_DECLARES → `getProjectActivities`
- MODULE_DECLARES → `getRecentProjects`
- MODULE_DECLARES → `getRecentDocuments`
- DEPENDS_ON → `activityservice`

<!-- source: module-activitymodule.md -->

# ActivityModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/activity/activity.module.ts` (line 8)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_DECLARES → `activitycontroller`
- MODULE_PROVIDES → `activityservice`
- MODULE_EXPORTS → `activityservice`

<!-- source: service-activityservice.md -->

# ActivityService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/activity/activity.service.ts` (line 8)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `log` | `log(dto: CreateActivityDto)` | `Promise<void>` |
| `getActivities` | `getActivities(user: JwtPayload, filters: ActivityFiltersDto)` | `unknown` |
| `getDocumentActivities` | `getDocumentActivities(user: JwtPayload, documentId: string)` | `unknown` |
| `getProjectActivities` | `getProjectActivities(user: JwtPayload, projectId: string)` | `unknown` |
| `trackActivity` | `trackActivity(userId: string, entityType: 'PROJECT' | 'DOCUMENT', entityId: string, actionType: 'VIEW' | 'EDIT' | 'CREATE')` | `unknown` |
| `getRecentProjects` | `getRecentProjects(userId: string, limit: unknown)` | `unknown` |
| `getRecentDocuments` | `getRecentDocuments(userId: string, limit: unknown)` | `unknown` |
| `getRecentDocumentsByProject` | `getRecentDocumentsByProject(userId: string, projectId: string, limit: unknown)` | `unknown` |
| `clearActivity` | `clearActivity(userId: string, entityType: 'PROJECT' | 'DOCUMENT')` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: interface-adaptivepromptoptions.md -->

# AdaptivePromptOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/adaptive-prompt.ts` (line 30)

## Properties

| Property | Type |
|---|---|
| `workspace` | `string` |
| `toolGuide` | `string` |
| `repoMap` | `string` |
| `projectContext` | `string` |
| `memoryContext` | `string` |
| `deferredToolsReminder` | `string` |
| `skillDescriptions` | `string` |
| `pluginCommands` | `string` |
| `domainRules` | `string[]` |
| `modelProfile` | `ModelCapabilityProfile` |
| `mode` | `TaskMode` |

<!-- source: function-addcodesamplestospec.md -->

# addCodeSamplesToSpec

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/code-samples.ts` (line 56)

Attach `x-codeSamples` to every operation in the spec (mutates + returns it). Requires the
full spec so `$ref` request/response schemas resolve into example payloads.

## Signature

```ts
function addCodeSamplesToSpec(spec: any, targets: string[]): any
```

## Parameters

| Name | Type |
|---|---|
| `spec` | `any` |
| `targets` | `string[]` |

**Returns:** `any`

<!-- source: graphql-mutation-addcomment.md -->

# addComment

**Kind:** Graphql Mutation

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Add comment to post

## Relationships

- TYPE_OF → `Comment`

## Referenced By

- `Mutation` (CALLS_API)

<!-- source: type-additionallexicalnode.md -->

# AdditionalLexicalNode

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 90)

## Definition

```ts
KlassConstructor<typeof LexicalNode> | LexicalNodeReplacement
```

<!-- source: type-afterturncallback.md -->

# AfterTurnCallback

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/autonomous-loop.ts` (line 210)

Callback fired after each model turn completes.
Use for live monitoring / progress logging.

## Definition

```ts
(event: {
  turnNumber: number;
  toolsUsed: string[];
  loopState: Readonly<LoopState>;
  /** Failing quality gate IDs (empty if all pass or no provider) */
  failingGates: string[];
}) => void
```

<!-- source: constant-agent-author.md -->

# AGENT_AUTHOR

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/docs-repo/docs-repo.service.ts` (line 35)

atloria-agent — behaviour-aware agent regeneration commits.

## Definition

```ts
CommitAuthor
```

<!-- source: function-agentcommand.md -->

# agentCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/agent.command.ts` (line 143)

## Signature

```ts
async function agentCommand(options: AgentCommandOptions): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `AgentCommandOptions` |

**Returns:** `Promise<void>`

<!-- source: interface-agentcommandoptions.md -->

# AgentCommandOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/commands/agent.command.ts` (line 93)

## Properties

| Property | Type |
|---|---|
| `model` | `string` |
| `workspace` | `string` |
| `maxTurns` | `string` |
| `autonomous` | `boolean` |
| `verbose` | `boolean` |
| `project` | `string` |
| `org` | `string` |
| `super` | `boolean` |
| `routingTable` | `string` |
| `continue` | `string | boolean` |
| `mode` | `string` |
| `remoteTriggers` | `boolean` |

<!-- source: service-agentcontextservice.md -->

# AgentContextService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/agent-context.service.ts` (line 1)

<!-- source: class-agentnotestore.md -->

# AgentNoteStore

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/autonomous-loop.ts` (line 233)

Store for session-scoped agent notes.
Shared between the note tool and the TurnHook.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `add` | `add(turn: number, content: string)` | `AgentNote` |
| `getAll` | `getAll()` | `AgentNote[]` |
| `count` | `count()` | `number` |
| `format` | `format()` | `string` |

<!-- source: function-aggregateresults.md -->

# aggregateResults

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 146)

Aggregate parse results for assertions

## Signature

```ts
function aggregateResults(results: ParseResult[]): {
  totalFiles: number;
  successfulFiles: number;
  failedFiles: number;
  skippedFiles: number;
  totalEntities: number;
  totalRelationships: number;
  totalErrors: number;
  totalWarnings: number;
  entitiesByType: Record<string, number>;
  relationshipsByType: Record<string, number>;
}
```

## Parameters

| Name | Type |
|---|---|
| `results` | `ParseResult[]` |

**Returns:** `{
  totalFiles: number;
  successfulFiles: number;
  failedFiles: number;
  skippedFiles: number;
  totalEntities: number;
  totalRelationships: number;
  totalErrors: number;
  totalWarnings: number;
  entitiesByType: Record<string, number>;
  relationshipsByType: Record<string, number>;
}`

<!-- source: interface-aienhancementoptions.md -->

# AIEnhancementOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ai-enhancement.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `enableCompetitorResearch` | `boolean` |
| `maxCompetitors` | `number` |
| `cacheResults` | `boolean` |

<!-- source: interface-aiprovider.md -->

# AIProvider

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/types/ai.ts` (line 7)

## Properties

| Property | Type |
|---|---|
| `name` | `AIProviderName` |
| `available` | `boolean` |
| `displayName` | `string` |
| `description` | `string` |

<!-- source: class-aiprovidererror.md -->

# AIProviderError

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/errors.ts` (line 118)

Error thrown when AI provider fails

**Extends:** `PipelineError`

## Properties

| Property | Type |
|---|---|
| `provider` | `'claude' | 'openai' | 'azure-responses'` |
| `statusCode` | `number` |

<!-- source: type-aiprovidername.md -->

# AIProviderName

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/types/ai.ts` (line 5)

AI Settings & Configuration Types

## Definition

```ts
'azure-claude' | 'azure-openai' | 'claude' | 'openai'
```

<!-- source: type-aiprovidername-2.md -->

# AIProviderName

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/ai/interfaces/ai-types.ts` (line 1)

## Definition

```ts
'azure-claude' | 'azure-openai' | 'azure-codex' | 'azure-gpt52' | 'claude' | 'openai' | 'codex'
```

<!-- source: constant-alt.md -->

# alt

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/opengraph-image.tsx` (line 8)

Site-wide OG share card (file convention — applies to every route without its own).
Deliberately font-free (ImageResponse's bundled default only): the prod pods sit behind
a strict egress policy, so no external font fetches.

<!-- source: function-always.md -->

# always

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/prompt-sections.ts` (line 86)

Always include

## Signature

```ts
function always(_ctx: SectionContext): boolean
```

## Parameters

| Name | Type |
|---|---|
| `_ctx` | `SectionContext` |

**Returns:** `boolean`

<!-- source: controller-analysiscontroller.md -->

# AnalysisController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/analysis/analysis.controller.ts` (line 5)

## Relationships

- MODULE_DECLARES → `startAnalysis`
- MODULE_DECLARES → `getJobStatus`
- MODULE_DECLARES → `getProjectJobs`
- DEPENDS_ON → `analysisservice`

<!-- source: module-analysismodule.md -->

# AnalysisModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/analysis/analysis.module.ts` (line 7)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `gitmodule`
- MODULE_DECLARES → `analysiscontroller`
- MODULE_PROVIDES → `analysisservice`
- MODULE_EXPORTS → `analysisservice`

<!-- source: service-analysisservice.md -->

# AnalysisService

**Kind:** Service

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/analysis/analysis.service.ts` (line 17)

Analysis orchestrator service

This service coordinates the entire code analysis pipeline:
1. Clone repository (with mono-repo support)
2. Analyze codebase using file optimization techniques
3. Generate UI documentation and element extraction
4. Create Playwright tests
5. Track progress in database
6. Cleanup after completion

## Methods

| Method | Signature | Returns |
|---|---|---|
| `startAnalysis` | `startAnalysis(dto: StartAnalysisDto)` | `Promise<string>` |
| `getJobStatus` | `getJobStatus(jobId: string)` | `unknown` |
| `getProjectJobs` | `getProjectJobs(projectId: string)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `gitservice`

<!-- source: class-angularparser-2.md -->

# AngularParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/frontend/angular.parser.ts` (line 91)

Angular Parser

Pure TypeScript class that parses Angular TypeScript files.
No NestJS dependencies required.

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `version` | `string` |
| `supportedPatterns` | `string[]` |

<!-- source: class-angularparser.md -->

# AngularParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/frontend-parser/src/parsers/angular.parser.ts` (line 61)

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `version` | `string` |
| `supportedPatterns` | `string[]` |

<!-- source: interface-apiendpointentity.md -->

# APIEndpointEntity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 453)

API Endpoint entity

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.API_ENDPOINT` |
| `method` | `'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD'` |
| `path` | `string` |
| `pathParams` | `ParameterDefinition[]` |
| `queryParams` | `ParameterDefinition[]` |
| `requestBody` | `SchemaDefinition` |
| `responses` | `ResponseDefinition[]` |
| `authentication` | `AuthenticationInfo` |
| `rateLimit` | `RateLimitInfo` |
| `middleware` | `string[]` |
| `controller` | `string` |
| `operationId` | `string` |

<!-- source: class-apierror.md -->

# ApiError

**Kind:** Class

**Source:** `atloria-monorepo/apps/web/src/lib/api-client.ts` (line 92)

API error carrying the HTTP status so callers can branch on it.
402 (out of credits) must render an upgrade CTA, never a blind Retry.

**Extends:** `Error`

<!-- source: type-apiexecfn.md -->

# ApiExecFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/mcp-toolset.ts` (line 43)

Optional live-API execution backend. Injected the same way as askFn so the toolset stays PURE
(no fetch/dns/Nest here) — all outbound HTTP, SSRF validation, method allow-listing and
server-side auth injection live in the executor the API layer builds (api-executor.ts). Present
only when the project has opted into a Live API target, which is what gates the `call_operation`
tool below.

## Definition

```ts
(input: {
  method: string;
  path: string;
  pathParams?: Record<string, string>;
  query?: Record<string, string>;
  body?: unknown;
}) => Promise<{ status: number; statusText: string; headers: Record<string, string>; body: unknown }>
```

<!-- source: class-apiexplorerpagegenerator.md -->

# APIExplorerPageGenerator

**Kind:** Class

**Source:** `atloria-monorepo/apps/cli/src/generators/api-explorer-page.generator.ts` (line 58)

API Explorer Page Generator

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generate` | `generate(entities: Entity[], _relationships: Relationship[])` | `Promise<void>` |

<!-- source: controller-appcontroller.md -->

# AppController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/app.controller.ts` (line 4)

## Relationships

- MODULE_DECLARES → `getHealth`
- MODULE_DECLARES → `getInfo`
- DEPENDS_ON → `appservice`

<!-- source: controller-appcontroller-3.md -->

# AppController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api-schema-parser/src/app.controller.ts` (line 14)

## Relationships

- MODULE_DECLARES → `getHealth`
- MODULE_DECLARES → `getParsers`
- DEPENDS_ON → `appservice`

<!-- source: function-applycardmove.md -->

# applyCardMove

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Boards/helpers.ts` (line 154)

Apply a card move to local board state for optimistic UI.
Returns a NEW board object — does not mutate.

## Signature

```ts
function applyCardMove(board: BoardData, cardId: string, toColumnId: string, position: number): BoardData
```

## Parameters

| Name | Type |
|---|---|
| `board` | `BoardData` |
| `cardId` | `string` |
| `toColumnId` | `string` |
| `position` | `number` |

**Returns:** `BoardData`

<!-- source: function-applycuration.md -->

# applyCuration

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/curation.ts` (line 79)

## Signature

```ts
function applyCuration(navMap: T, curation: TechdocsCuration): T
```

## Parameters

| Name | Type |
|---|---|
| `navMap` | `T` |
| `curation` | `TechdocsCuration` |

**Returns:** `T`

<!-- source: module-appmodule-2.md -->

# AppModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/app.module.ts` (line 13)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `playwrightmodule`
- MODULE_IMPORTS → `storagemodule`
- MODULE_IMPORTS → `screenshotmodule`
- MODULE_IMPORTS → `pdfmodule`
- MODULE_IMPORTS → `discoverymodule`
- MODULE_DECLARES → `appcontroller`
- MODULE_PROVIDES → `appservice`

<!-- source: module-appmodule.md -->

# AppModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/app.module.ts` (line 24)

## Relationships

- MODULE_IMPORTS → `queuemodule`
- MODULE_IMPORTS → `knowledgegraphmodule`
- MODULE_IMPORTS → `orchestratormodule`
- MODULE_IMPORTS → `integrationmodule`

<!-- source: module-appmodule-8.md -->

# AppModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/database-parser/src/app.module.ts` (line 7)

## Relationships

- MODULE_PROVIDES → `prismaparser`
- MODULE_PROVIDES → `typeormparser`
- MODULE_PROVIDES → `sequelizeparser`
- MODULE_PROVIDES → `migrationparser`
- MODULE_EXPORTS → `prismaparser`
- MODULE_EXPORTS → `typeormparser`
- MODULE_EXPORTS → `sequelizeparser`
- MODULE_EXPORTS → `migrationparser`

<!-- source: module-appmodule-5.md -->

# AppModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/backend-parser/src/app.module.ts` (line 16)

## Relationships

- MODULE_PROVIDES → `nestjsparser`
- MODULE_PROVIDES → `expressparser`
- MODULE_PROVIDES → `fastapiparser`
- MODULE_PROVIDES → `djangoparser`
- MODULE_PROVIDES → `backendparserservice`
- MODULE_EXPORTS → `nestjsparser`
- MODULE_EXPORTS → `expressparser`
- MODULE_EXPORTS → `fastapiparser`
- MODULE_EXPORTS → `djangoparser`
- MODULE_EXPORTS → `backendparserservice`

<!-- source: module-appmodule-9.md -->

# AppModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/frontend-parser/src/app.module.ts` (line 16)

## Relationships

- MODULE_PROVIDES → `reactparser`
- MODULE_PROVIDES → `nextjsparser`
- MODULE_PROVIDES → `vueparser`
- MODULE_PROVIDES → `angularparser`
- MODULE_EXPORTS → `reactparser`
- MODULE_EXPORTS → `nextjsparser`
- MODULE_EXPORTS → `vueparser`
- MODULE_EXPORTS → `angularparser`

<!-- source: module-appmodule-4.md -->

# AppModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api-schema-parser/src/app.module.ts` (line 17)

## Relationships

- MODULE_DECLARES → `appcontroller`
- MODULE_PROVIDES → `appservice`
- MODULE_PROVIDES → `openapiparser`
- MODULE_PROVIDES → `graphqlparser`
- MODULE_PROVIDES → `grpcparser`
- MODULE_EXPORTS → `openapiparser`
- MODULE_EXPORTS → `graphqlparser`
- MODULE_EXPORTS → `grpcparser`

<!-- source: module-appmodule-7.md -->

# AppModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/config-docs-parser/src/app.module.ts` (line 21)

## Relationships

- MODULE_DECLARES → `healthcontroller`
- MODULE_PROVIDES → `markdownparser`
- MODULE_PROVIDES → `mdxparser`
- MODULE_PROVIDES → `envparser`
- MODULE_PROVIDES → `yamlparser`
- MODULE_PROVIDES → `jsonconfigparser`
- MODULE_PROVIDES → `parserregistryservice`
- MODULE_EXPORTS → `markdownparser`
- MODULE_EXPORTS → `mdxparser`
- MODULE_EXPORTS → `envparser`
- MODULE_EXPORTS → `yamlparser`
- MODULE_EXPORTS → `jsonconfigparser`
- MODULE_EXPORTS → `parserregistryservice`

<!-- source: service-appservice-3.md -->

# AppService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api-schema-parser/src/app.service.ts` (line 13)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getHealth` | `getHealth()` | `{ status: string; parsers: string[]; version: string }` |
| `getSupportedParsers` | `getSupportedParsers()` | `Array<{
    name: string;
    version: string;
    patterns: string[];
  }>` |

<!-- source: function-assemblesite.md -->

# assembleSite

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/assembler.ts` (line 36)

Assemble a complete site from config.

## Signature

```ts
async function assembleSite(config: SiteAssemblyConfig, deps: AssemblerDeps): Promise<AssemblyResult>
```

## Parameters

| Name | Type |
|---|---|
| `config` | `SiteAssemblyConfig` |
| `deps` | `AssemblerDeps` |

**Returns:** `Promise<AssemblyResult>`

<!-- source: class-assemblyerror.md -->

# AssemblyError

**Kind:** Class

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/errors.ts` (line 9)

**Extends:** `Error`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `toJSON` | `toJSON()` | `void` |

<!-- source: type-assemblystage.md -->

# AssemblyStage

**Kind:** Type

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 87)

## Definition

```ts
| 'validate'
  | 'copy-template'
  | 'copy-sections'
  | 'generate-landing-page'
  | 'generate-main'
  | 'generate-app'
  | 'generate-i18n'
  | 'generate-locales'
  | 'verify'
```

<!-- source: function-assertnoaccessibilityviolations.md -->

# assertNoAccessibilityViolations

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/accessibility.ts` (line 99)

Assert no accessibility violations (WCAG AA by default)

## Signature

```ts
async function assertNoAccessibilityViolations(page: Page, options: {
    level?: WCAGLevel;
    include?: string[];
    exclude?: string[];
    disabledRules?: string[];
    allowedViolations?: string[];
  }): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |
| `options` | `{
    level?: WCAGLevel;
    include?: string[];
    exclude?: string[];
    disabledRules?: string[];
    allowedViolations?: string[];
  }` |

**Returns:** `Promise<void>`

<!-- source: module-atloria-csharpparser.md -->

# Atloria.CSharpParser

**Kind:** Module

**Source:** `atloria-monorepo/libs/parser-core/src/dotnet-bridge/Atloria.CSharpParser/Atloria.CSharpParser.csproj` (line 1)

.NET Exe project (C#)

## Relationships

- DEPENDS_ON → `Microsoft.CodeAnalysis.CSharp`
- DEPENDS_ON → `System.Text.Json`

<!-- source: enum-audience.md -->

# Audience

**Kind:** Enum

**Source:** `atloria-monorepo/packages/types/src/enums/index.ts` (line 45)

Audience types define who the documentation is intended for
Note: Matches Prisma schema exactly

## Values

- `TECHNICAL`
- `USER`
- `API`
- `INTERNAL`

<!-- source: interface-authconfig-2.md -->

# AuthConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.service.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `loginUrl` | `string` |
| `username` | `string` |
| `password` | `string` |
| `usernameSelector` | `string` |
| `passwordSelector` | `string` |
| `submitSelector` | `string` |
| `successSelector` | `string` |

<!-- source: component-avatar.md -->

# Avatar

**Kind:** Component

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/frontend/src/components/Avatar.tsx` (line 16)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `src` | `any` | ✓ | - |
| `alt` | `any` | ✓ | - |
| `size` | `any` | - | "medium" |
| `fallback` | `any` | - | "/default-avatar.png" |

## Diagram

```mermaid
graph TD
    component_Avatar_31a20b94["Avatar"]
    class component_Avatar_31a20b94 rootComponent
```

## Relationships

- USES_HOOK → `useState`

<!-- source: class-azureimageprovider.md -->

# AzureImageProvider

**Kind:** Class

**Source:** `atloria-monorepo/libs/pme-core/src/providers/azure-image.provider.ts` (line 30)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generate` | `generate(options: ImageGenerationOptions)` | `Promise<ImageGenerationResponse>` |

<!-- source: interface-azureimageproviderconfig.md -->

# AzureImageProviderConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/providers/azure-image.provider.ts` (line 8)

Azure Image Provider

Thin client for GPT-image-1.5 via Azure OpenAI.
Different API shape from text models — uses the images/generations endpoint.

## Properties

| Property | Type |
|---|---|
| `endpoint` | `string` |
| `apiKey` | `string` |
| `apiVersion` | `string` |
| `deploymentName` | `string` |
| `timeout` | `number` |

<!-- source: service-backendparserservice.md -->

# BackendParserService

**Kind:** Service

**Source:** `atloria-monorepo/apps/backend-parser/src/backend-parser.service.ts` (line 31)

Backend Parser Service

Provides a unified interface for all backend parsers.
Automatically selects the appropriate parser based on file type.

`BackendParserService` provides a single entry point for parsing backend source files in the Atloria monorepo. It detects the input file type, selects the matching backend parser, and returns a consistent parsing result for downstream consumers such as documentation, analysis, or code-generation workflows.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `Promise<void>` |
| `onModuleDestroy` | `onModuleDestroy()` | `Promise<void>` |
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `getParsers` | `getParsers()` | `IParser[]` |
| `getParser` | `getParser(name: string)` | `IParser | undefined` |
| `findParserForFile` | `findParserForFile(filePath: string)` | `IParser | undefined` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `parseFilesGrouped` | `parseFilesGrouped(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `getSupportedPatterns` | `getSupportedPatterns()` | `string[]` |
| `getParserMetadata` | `getParserMetadata()` | `Array<{
    name: string;
    version: string;
    supportedPatterns: string[];
  }>` |

## Diagram

```mermaid
sequenceDiagram
  participant Client as Calling Service
  participant ParserService as BackendParserService
  participant Selector as Parser Selection
  participant Parser as Backend-Specific Parser

  Client->>ParserService: parse(filePath, sourceCode)
  ParserService->>Selector: Determine parser from file type
  Selector-->>ParserService: Matching parser
  ParserService->>Parser: parse(sourceCode, filePath)
  Parser-->>ParserService: Parsed entity metadata
  ParserService-->>Client: Unified parse result
```

## Usage

```ts
import { BackendParserService } from './backend-parser.service';

async function parseBackendFile(
  parserService: BackendParserService,
  filePath: string,
  sourceCode: string,
) {
  const result = await parserService.parse(filePath, sourceCode);

  console.log(result);
  return result;
}

// In a NestJS service or controller, inject BackendParserService
// through the constructor and pass the target file contents.
```

## AI Coding Instructions

- Route all backend source parsing through `BackendParserService` rather than instantiating individual parsers directly.
- Add support for new backend file types by registering a dedicated parser and updating the service’s file-type selection logic.
- Keep parser outputs consistent so consumers can handle results without knowing which parser processed the file.
- Handle unsupported extensions and malformed source code explicitly; return actionable errors instead of silently selecting a fallback parser.
- Preserve NestJS dependency-injection patterns when adding parser dependencies or extending this service.

## Relationships

- DEPENDS_ON → `nestjsparser`
- DEPENDS_ON → `expressparser`
- DEPENDS_ON → `fastapiparser`
- DEPENDS_ON → `djangoparser`

<!-- source: constant-banned-phrases-list.md -->

# BANNED_PHRASES_LIST

**Kind:** Constant

**Source:** `atloria-monorepo/libs/pme-core/src/guardrails/brand-voice.guardrail.ts` (line 125)

<!-- source: class-basepage.md -->

# BasePage

**Kind:** Class

**Source:** `atloria-monorepo/apps/web-e2e/src/pages/base.page.ts` (line 6)

Base page object with common functionality

## Methods

| Method | Signature | Returns |
|---|---|---|
| `goto` | `goto()` | `Promise<void>` |
| `waitForPageLoad` | `waitForPageLoad()` | `Promise<void>` |
| `getURL` | `getURL()` | `string` |
| `isVisible` | `isVisible(selector: string)` | `Promise<boolean>` |
| `getToast` | `getToast()` | `Locator` |
| `waitForToast` | `waitForToast(expectedText: string)` | `Promise<string>` |
| `getModal` | `getModal()` | `Locator` |
| `closeModal` | `closeModal()` | `Promise<void>` |
| `waitForLoading` | `waitForLoading()` | `Promise<void>` |
| `getPageTitle` | `getPageTitle()` | `Promise<string>` |
| `takeScreenshot` | `takeScreenshot(name: string)` | `Promise<Buffer>` |

<!-- source: class-batchauthconfigdto.md -->

# BatchAuthConfigDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 499)

## Properties

| Property | Type |
|---|---|
| `loginUrl` | `string` |
| `username` | `string` |
| `password` | `string` |
| `usernameSelector` | `string` |
| `passwordSelector` | `string` |
| `submitSelector` | `string` |
| `successSelector` | `string` |
| `useSmartDetection` | `boolean` |
| `healthCheck` | `SessionHealthCheckDto` |

<!-- source: function-boxtoclip.md -->

# boxToClip

**Kind:** Function

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/crop.service.ts` (line 36)

Convert a percent box (0-100 of the natural image) into a Playwright clip rect
in PIXELS, framing the target with `padPct` of breathing room on every side and
clamped to the image bounds so the clip never runs off-canvas.

## Signature

```ts
function boxToClip(box: BoxPct, imgW: number, imgH: number, padPct): ClipRect
```

## Parameters

| Name | Type |
|---|---|
| `box` | `BoxPct` |
| `imgW` | `number` |
| `imgH` | `number` |
| `padPct` | `any` |

**Returns:** `ClipRect`

<!-- source: enum-browsertype.md -->

# BrowserType

**Kind:** Enum

**Source:** `atloria-monorepo/apps/api/src/screenshot/dto/capture-screenshot.dto.ts` (line 20)

## Values

- `CHROMIUM`
- `FIREFOX`
- `WEBKIT`

<!-- source: function-buildcontentgenerationprompt.md -->

# buildContentGenerationPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/coordinator.prompts.ts` (line 156)

## Signature

```ts
function buildContentGenerationPrompt(sectionType: SectionType, docContext: string, config: GenerationConfig): string
```

## Parameters

| Name | Type |
|---|---|
| `sectionType` | `SectionType` |
| `docContext` | `string` |
| `config` | `GenerationConfig` |

**Returns:** `string`

<!-- source: api-endpoint-canceljob.md -->

# cancelJob

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/orchestrator.controller.ts` (line 133)

Cancel a job

## Endpoint

`DELETE /api/orchestrator/jobs/:jobId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `jobId` | query | `string` | ✓ |

## Referenced By

- `OrchestratorController` (MODULE_DECLARES)

<!-- source: enum-changeseverity.md -->

# ChangeSeverity

**Kind:** Enum

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/version-diff.ts` (line 22)

Change severity

## Values

- `Major`
- `Minor`
- `Patch`

<!-- source: function-checkifexported.md -->

# checkIfExported

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 433)

Check if a name is exported

## Signature

```ts
function checkIfExported(name: string, exportedNames: Set<string>): boolean
```

## Parameters

| Name | Type |
|---|---|
| `name` | `string` |
| `exportedNames` | `Set<string>` |

**Returns:** `boolean`

<!-- source: constant-claude-profile.md -->

# CLAUDE_PROFILE

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-profiles.ts` (line 165)

Anthropic Claude (via Azure or direct API).
- No reasoning effort field
- No apply_patch format (uses edit_file natively)
- No tool persistence nudging needed

## Definition

```ts
ModelCapabilityProfile
```

<!-- source: interface-cloneoptions-2.md -->

# CloneOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/git/git.service.ts` (line 10)

## Properties

| Property | Type |
|---|---|
| `repoUrl` | `string` |
| `branch` | `string` |
| `folderPath` | `string` |
| `depth` | `number` |

<!-- source: type-contentgeneratefn.md -->

# ContentGenerateFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/tools/generate-content.tool.ts` (line 16)

Content generation function — wraps AzureResponsesProvider.generateJSON().
Injected at tool creation time.

## Definition

```ts
(
  prompt: string,
  systemPrompt: string,
  maxTokens?: number
) => Promise<{ content: string; inputTokens: number; outputTokens: number }>
```

<!-- source: api-endpoint-createbatchjob.md -->

# createBatchJob

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/batch-screenshot.controller.ts` (line 101)

Create and start a batch screenshot job

POST /api/screenshot/batch

Returns immediately with job ID for polling.
Processing happens asynchronously in the background.

## Endpoint

`POST /screenshot/batch`

## Referenced By

- `BatchScreenshotController` (MODULE_DECLARES)

<!-- source: function-createtenantbackstop.md -->

# createTenantBackstop

**Kind:** Function

**Source:** `atloria-monorepo/libs/database/src/lib/tenant-backstop.ts` (line 73)

Build the extension config object to pass to `prisma.$extends(...)`. Kept as a plain factory (no
Prisma import) so it is trivially unit-testable with a fake `query`.

## Signature

```ts
function createTenantBackstop(options: TenantBackstopOptions)
```

## Parameters

| Name | Type |
|---|---|
| `options` | `TenantBackstopOptions` |

<!-- source: module-databasemodule.md -->

# DatabaseModule

**Kind:** Module

**Source:** `atloria-monorepo/libs/database/src/lib/database.module.ts` (line 7)

## Relationships

- MODULE_IMPORTS → `configmodule`
- MODULE_PROVIDES → `prismaservice`
- MODULE_PROVIDES → `redisservice`
- MODULE_EXPORTS → `prismaservice`
- MODULE_EXPORTS → `redisservice`

<!-- source: component-datebadge.md -->

# DateBadge

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/social-proof/social-proof-timeline.tsx` (line 23)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `dateKey` | `string` | ✓ | - |
| `t` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DateBadge_7efe08da["DateBadge"]
    class component_DateBadge_7efe08da rootComponent
```

## Referenced By

- `MilestoneCard` (RENDERS)

<!-- source: type-datetime.md -->

# DateTime

**Kind:** Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Custom scalar for date-time

`DateTime` is a custom GraphQL scalar used to represent date-time values in a consistent, API-friendly format. It’s typically serialized as an ISO-8601 string in responses and parsed/validated on input to ensure clients and services exchange timestamps reliably across the system.

## Diagram

```mermaid
graph LR
  Client[GraphQL Client] -->|Query/Mutation with DateTime| API[GraphQL API]
  API -->|Parse & validate| Scalar[DateTime Scalar]
  Scalar -->|Convert to JS Date / internal representation| Resolvers[Resolvers]
  Resolvers -->|Return DateTime| Scalar
  Scalar -->|Serialize ISO-8601 string| Client
```

## Usage

```ts
import { GraphQLScalarType, Kind } from "graphql";

// Example DateTime scalar implementation (ISO-8601)
export const DateTime = new GraphQLScalarType({
  name: "DateTime",
  description: "Custom scalar for date-time",
  serialize(value: unknown): string {
    const date = value instanceof Date ? value : new Date(String(value));
    if (Number.isNaN(date.getTime())) throw new TypeError("DateTime cannot serialize invalid date");
    return date.toISOString();
  },
  parseValue(value: unknown): Date {
    const date = new Date(String(value));
    if (Number.isNaN(date.getTime())) throw new TypeError("DateTime cannot parse invalid date");
    return date;
  },
  parseLiteral(ast): Date {
    if (ast.kind !== Kind.STRING) throw new TypeError("DateTime must be a string literal");
    const date = new Date(ast.value);
    if (Number.isNaN(date.getTime())) throw new TypeError("DateTime cannot parse invalid date");
    return date;
  },
});

// Example usage in schema (SDL):
// scalar DateTime
// type Event { id: ID!, startsAt: DateTime! }

// Example resolver returning a JS Date (will serialize to ISO string)
export const resolvers = {
  DateTime,
  Query: {
    serverTime: () => new Date(),
  },
  Mutation: {
    createEvent: (_: unknown, args: { startsAt: Date }) => ({
      id: "evt_123",
      startsAt: args.startsAt, // parsed by DateTime.parseValue
    }),
  },
};
```

## AI Coding Instructions

- Treat `DateTime` values as ISO-8601 strings at the GraphQL boundary; convert to `Date` (or your internal time type) inside resolvers/services.
- Validate inputs aggressively (`Invalid Date` checks) to avoid silently accepting malformed timestamps and propagating bad data.
- Be explicit about timezone behavior: prefer `toISOString()` (UTC) for serialization to keep client/server consistent.
- When integrating with DB/ORM layers, standardize on one representation (e.g., store as UTC, return `Date` objects to GraphQL so the scalar can serialize).
- Avoid accepting non-string literals in `parseLiteral` unless you intentionally support them; mixed formats are a common source of client incompatibilities.

## Referenced By

- `User` (TYPE_OF)
- `User` (TYPE_OF)
- `Post` (TYPE_OF)
- `Post` (TYPE_OF)
- `Post` (TYPE_OF)
- `Comment` (TYPE_OF)
- `Comment` (TYPE_OF)
- `Like` (TYPE_OF)
- `Follow` (TYPE_OF)

<!-- source: constant-default-targets.md -->

# DEFAULT_TARGETS

**Kind:** Constant

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/code-samples.ts` (line 26)

<!-- source: constant-defaulttestuser.md -->

# defaultTestUser

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web-e2e/src/fixtures/base.fixture.ts` (line 16)

Default test user for authenticated tests

## Definition

```ts
TestUser
```

<!-- source: class-djangoparser.md -->

# DjangoParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/backend-parser/src/parsers/django.parser.ts` (line 51)

Django REST Framework Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: class-envparser.md -->

# EnvParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/config-docs-parser/src/parsers/env.parser.ts` (line 61)

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: constant-fixtures-path.md -->

# FIXTURES_PATH

**Kind:** Constant

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 22)

<!-- source: component-formatbutton.md -->

# FormatButton

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/BoldItalicUnderlineToggles.tsx` (line 18)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `format` | `any` | ✓ | - |
| `addTitle` | `any` | ✓ | - |
| `removeTitle` | `any` | ✓ | - |
| `icon` | `any` | ✓ | - |
| `formatName` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FormatButton_47bb73da["FormatButton"]
    class component_FormatButton_47bb73da rootComponent
```

## Relationships

- RENDERS → `ToggleSingleGroupWithItem`
- USES_HOOK → `useCellValues`
- USES_HOOK → `usePublisher`

## Referenced By

- `BoldItalicUnderlineToggles` (RENDERS)
- `StrikeThroughSupSubToggles` (RENDERS)

<!-- source: enum-framework.md -->

# Framework

**Kind:** Enum

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/analysis/dto/start-analysis.dto.ts` (line 3)

## Values

- `REACT`
- `ANGULAR`
- `VUE`
- `NEXT`
- `NEST`
- `AUTO`

<!-- source: function-generatecontenthash.md -->

# generateContentHash

**Kind:** Function

**Source:** `atloria-monorepo/apps/database-parser/src/utils/hash.util.ts` (line 8)

Generate a content hash for change detection

## Signature

```ts
function generateContentHash(content: string): string
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |

**Returns:** `string`

<!-- source: api-endpoint-gethealth-3.md -->

# getHealth

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api-schema-parser/src/app.controller.ts` (line 21)

Health check endpoint

## Endpoint

`GET /health`

## Referenced By

- `AppController` (MODULE_DECLARES)

<!-- source: api-endpoint-gethealth-4.md -->

# getHealth

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/app.controller.ts` (line 11)

Health check endpoint

## Endpoint

`GET /`

## Referenced By

- `AppController` (MODULE_DECLARES)

<!-- source: class-graphqlparser.md -->

# GraphQLParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/api-schema-parser/src/parsers/graphql.parser.ts` (line 57)

GraphQL Parser Implementation

Supports:
- GraphQL Schema Definition Language (SDL)
- Queries, Mutations, Subscriptions
- Object Types, Input Types, Enums, Interfaces, Unions
- Directives and field arguments

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: api-endpoint-health.md -->

# health

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/config-docs-parser/src/health.controller.ts` (line 5)

## Endpoint

`GET /health`

## Referenced By

- `HealthController` (MODULE_DECLARES)

<!-- source: controller-healthcontroller.md -->

# HealthController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/config-docs-parser/src/health.controller.ts` (line 3)

## Relationships

- MODULE_DECLARES → `health`

<!-- source: interface-hookinfo.md -->

# HookInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 42)

Information about a hook usage

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `'built-in' | 'custom'` |
| `location` | `string` |
| `dependencies` | `string[]` |

<!-- source: service-integrationservice.md -->

# IntegrationService

**Kind:** Service

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/integration/integration.service.ts` (line 23)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `registerParser` | `registerParser(parser: IParser)` | `Promise<void>` |
| `initializeParser` | `initializeParser(parserName: string, config: ParserConfig)` | `Promise<void>` |
| `getParser` | `getParser(parserName: string)` | `IParser | null` |
| `hasParser` | `hasParser(parserName: string)` | `boolean` |
| `getRegisteredParsers` | `getRegisteredParsers()` | `Array<{
    name: string;
    version: string;
    patterns: string[];
    initialized: boolean;
  }>` |
| `findParserForFile` | `findParserForFile(filePath: string)` | `string | null` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult | null>` |
| `parseFiles` | `parseFiles(files: string[])` | `Promise<ParseResult[]>` |
| `destroyParser` | `destroyParser(parserName: string)` | `Promise<void>` |
| `destroyAll` | `destroyAll()` | `Promise<void>` |
| `generateEntityId` | `generateEntityId(type: string, name: string, filePath: string)` | `string` |
| `generateRelationshipId` | `generateRelationshipId(sourceId: string, type: string, targetId: string)` | `string` |
| `validateEntity` | `validateEntity(entity: Partial<Entity>)` | `{ valid: boolean; errors: string[] }` |
| `validateRelationship` | `validateRelationship(relationship: Partial<Relationship>)` | `{ valid: boolean; errors: string[] }` |

<!-- source: constant-key-patterns.md -->

# KEY_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/pme-agent/test/discovery/ground-truth.ts` (line 139)

Key architectural patterns the agent should discover

<!-- source: service-microsoft-codeanalysis-csharp.md -->

# Microsoft.CodeAnalysis.CSharp

**Kind:** Service

**Source:** `atloria-monorepo/libs/parser-core/src/dotnet-bridge/Atloria.CSharpParser/Atloria.CSharpParser.csproj` (line 1)

NuGet package dependency

## Referenced By

- `Atloria.CSharpParser` (DEPENDS_ON)

<!-- source: class-migrationparser.md -->

# MigrationParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/database-parser/src/parsers/migration.parser.ts` (line 90)

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: graphql-subscription-newcomment.md -->

# newComment

**Kind:** Graphql Subscription

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Subscribe to new comments on a post

## Relationships

- TYPE_OF → `Comment`

## Referenced By

- `Subscription` (CALLS_API)

<!-- source: controller-orchestratorcontroller.md -->

# OrchestratorController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/orchestrator.controller.ts` (line 26)

## Relationships

- MODULE_DECLARES → `dispatchJob`
- MODULE_DECLARES → `parseProject`
- MODULE_DECLARES → `getJobStatus`
- MODULE_DECLARES → `getJobResult`
- MODULE_DECLARES → `cancelJob`
- MODULE_DECLARES → `getQueueMetrics`
- MODULE_DECLARES → `getKGStatistics`
- MODULE_DECLARES → `getAvailableParsers`
- MODULE_DECLARES → `detectParser`
- MODULE_DECLARES → `healthCheck`
- DEPENDS_ON → `orchestratorservice`

<!-- source: interface-parsefilerequest.md -->

# ParseFileRequest

**Kind:** Interface

**Source:** `atloria-monorepo/apps/config-docs-parser/src/services/parser-registry.service.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `content` | `string` |

<!-- source: class-parsejobdto.md -->

# ParseJobDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/dto/parse-job.dto.ts` (line 27)

DTO for dispatching a single parse job

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `files` | `string[]` |
| `parserType` | `string` |
| `config` | `Record<string, unknown>` |
| `priority` | `number` |

<!-- source: service-parserregistryservice.md -->

# ParserRegistryService

**Kind:** Service

**Source:** `atloria-monorepo/apps/config-docs-parser/src/services/parser-registry.service.ts` (line 30)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `Promise<void>` |
| `onModuleDestroy` | `onModuleDestroy()` | `Promise<void>` |
| `configure` | `configure(config: ParserRegistryConfig)` | `Promise<void>` |
| `getAllParsers` | `getAllParsers()` | `IParser[]` |
| `getParser` | `getParser(name: string)` | `IParser | undefined` |
| `hasParser` | `hasParser(name: string)` | `boolean` |
| `getParserNames` | `getParserNames()` | `string[]` |
| `findParsersForFile` | `findParsersForFile(filePath: string)` | `IParser[]` |
| `findBestParser` | `findBestParser(filePath: string)` | `IParser | undefined` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileRequest[])` | `Promise<ParseResult[]>` |
| `getAllSupportedPatterns` | `getAllSupportedPatterns()` | `string[]` |
| `getStats` | `getStats()` | `{
    parserCount: number;
    parsers: Array<{ name: string; version: string; patterns: string[] }>;
    totalPatterns: number;
  }` |
| `destroyAll` | `destroyAll()` | `Promise<void>` |
| `isInitialized` | `isInitialized()` | `boolean` |

## Relationships

- DEPENDS_ON → `markdownparser`
- DEPENDS_ON → `mdxparser`
- DEPENDS_ON → `envparser`
- DEPENDS_ON → `yamlparser`
- DEPENDS_ON → `jsonconfigparser`

<!-- source: module-pmeagentmodule.md -->

# PmeAgentModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/pme-agent/src/pme-agent.module.ts` (line 8)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `queuemodule`

<!-- source: interface-pmejobpayload.md -->

# PmeJobPayload

**Kind:** Interface

**Source:** `atloria-monorepo/apps/pme-agent/src/queue/pme.processor.ts` (line 62)

## Properties

| Property | Type |
|---|---|
| `jobId` | `string` |
| `projectId` | `string` |
| `userId` | `string` |
| `organizationId` | `string` |
| `config` | `GenerationConfig` |

<!-- source: class-pmeprocessor.md -->

# PmeProcessor

**Kind:** Class

**Source:** `atloria-monorepo/apps/pme-agent/src/queue/pme.processor.ts` (line 73)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `handleGenerate` | `handleGenerate(job: Job<PmeJobPayload>)` | `Promise<RunResult>` |
| `handleStrategy` | `handleStrategy(job: Job<PmeJobPayload>)` | `Promise<void>` |
| `handleFinalize` | `handleFinalize(job: Job<any>)` | `Promise<void>` |
| `handleSiteGen` | `handleSiteGen(job: Job<PmeJobPayload & { outputDir: string }>)` | `Promise<void>` |
| `onActive` | `onActive(job: Job<PmeJobPayload>)` | `void` |
| `onCompleted` | `onCompleted(job: Job<PmeJobPayload>)` | `void` |
| `onFailed` | `onFailed(job: Job<PmeJobPayload>, error: Error)` | `void` |

## Properties

| Property | Type |
|---|---|
| `progressEmitter` | `ProgressEmitter` |

<!-- source: graphql-query-post.md -->

# post

**Kind:** Graphql Query

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Get a post by ID

## Relationships

- TYPE_OF → `Post`

## Referenced By

- `Query` (CALLS_API)

<!-- source: component-previewshell.md -->

# PreviewShell

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/page.tsx` (line 376)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `url` | `string` | ✓ | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PreviewShell_be22912["PreviewShell"]
    class component_PreviewShell_be22912 rootComponent
```

## Referenced By

- `KbPanel` (RENDERS)
- `ManualPanel` (RENDERS)
- `ApiPanel` (RENDERS)
- `SupportPanel` (RENDERS)

<!-- source: service-prismaservice.md -->

# PrismaService

**Kind:** Service

**Source:** `atloria-monorepo/libs/database/src/lib/prisma.service.ts` (line 28)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `unknown` |
| `onModuleDestroy` | `onModuleDestroy()` | `unknown` |
| `enableQueryLogging` | `enableQueryLogging()` | `unknown` |

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: page-privacy.md -->

# privacy

**Kind:** Page

**Source:** `atloria-monorepo/templates/site-bootstrap/src/App.tsx`

<!-- source: type-progressemitter.md -->

# ProgressEmitter

**Kind:** Type

**Source:** `atloria-monorepo/apps/pme-agent/src/queue/pme.processor.ts` (line 71)

Progress callback for WebSocket emission (injected from outside).

## Definition

```ts
(event: PmeProgressEvent) => void
```

<!-- source: enum-role.md -->

# Role

**Kind:** Enum

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

User roles

## Referenced By

- `User` (TYPE_OF)

<!-- source: class-startanalysisdto.md -->

# StartAnalysisDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/analysis/dto/start-analysis.dto.ts` (line 12)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `repoUrl` | `string` |
| `branch` | `string` |
| `folderPath` | `string` |
| `framework` | `Framework` |
| `patterns` | `string[]` |
| `modules` | `string[]` |
| `tokenBudget` | `number` |
| `organizationId` | `string` |
| `triggeredBy` | `string` |

<!-- source: service-storagehelperservice.md -->

# StorageHelperService

**Kind:** Service

**Source:** `atloria-monorepo/apps/cli/src/services/storage-helper.service.ts` (line 1)

<!-- source: system-overview.md -->

# Atloria (self dogfood)

## Overview

Auto-generated technical documentation for **Atloria (self dogfood)** — 31113 entities (25277 doc comments, 1571 interfaces, 808 functions, 805 components).

## Architecture

```mermaid
flowchart LR
  service_StorageHelperService_751da417["StorageHelperService"]
  service_Crop_140a6041["Crop"]
  service_ParserService_5634fec["ParserService"]
  service_EntityMapper_2dd3ba0b["EntityMapper"]
  service_ParserCoreBridge_5f634fe8["ParserCoreBridge"]
  service_ChunkerService_36d48187["ChunkerService"]
  service_FeatureExtractorService_54b31c9a["FeatureExtractorService"]
  service_AnalyzerService_509b5604["AnalyzerService"]
  service_SynthesizerService_5be315["SynthesizerService"]
  service_StructureService_335fa54b["StructureService"]
  service_V4dStructureService_1c78148e["V4dStructureService"]
  service_PhaseService_465e9705["PhaseService"]
  service_SessionService_22a97883["SessionService"]
  service_DocPlannerService_224fae1["DocPlannerService"]
  service_AgentContextService_36c11d80["AgentContextService"]
  service_AgentWriterService_58c6015c["AgentWriterService"]
  service_DocVerifierService_6b28454a["DocVerifierService"]
  service_GeneratorService_252aea01["GeneratorService"]
  service_VerifierAgentService_acd24ae["VerifierAgentService"]
  service_OpenAIReviewerService_36f27c12["OpenAIReviewerService"]
  service_VerifierService_3e00a087["VerifierService"]
  service_HybridMapperService_54fe3fb9["HybridMapperService"]
  service_LoginSelectorDetectorService_32760a58["LoginSelectorDetectorService"]
  service_ScreenshotCapturerService_6ed39a45["ScreenshotCapturerService"]
```

## Modules

- **ActivityModule**
- **AgentModule**
- **AIModule**
- **AnalyticsModule**
- **AppModule**
- **AssetsModule**
- **AudienceModule**
- **AuditModule**
- **AuthModule**
- **SamlModule**
- **BillingModule**
- **BitbucketModule**
- **BoardsModule**
- **BrandingModule**
- **CaptureModule**
- **ChangeRequestModule**
- **CollaborationModule**
- **CommentModule**
- **ThrottlingModule**
- **DashboardModule**
- **DocVersionModule**
- **DocsPrModule**
- **DocsRepoModule**
- **DocumentModule**
- **DraftDocumentModule**
- **DocumentationModule**
- **EmailModule**
- **EventsModule**
- **GatewayModule**
- **GitHubModule**
- **GithubAppModule**
- **GitLabModule**
- **GraphModule**
- **InvitationModule**
- **IssuesModule**
- **ManualsInsightsModule**
- **NotificationModule**
- **OpsModule**
- **OrganizationModule**
- **ParserModule**
- **ParsingModule**
- **PmeModule**
- **ProjectModule**
- **ScreenshotModule**
- **SuggestionModule**
- **SupportAgentModule**
- **TechnicalDocsModule**
- **TemplateModule**
- **TrialModule**
- **WebhookModule**
- **WorkflowModule**
- **AppModule**
- **AppModule**
- **AnalysisModule**
- **AppModule**
- **GitModule**
- **AppModule**
- **AppModule**
- **AppModule**
- **AppModule**
- **IntegrationModule**
- **KnowledgeGraphModule**
- **OrchestratorModule**
- **QueueModule**
- **UsersModule**
- **PmeAgentModule**
- **QueueModule**
- **AppModule**
- **DiscoveryModule**
- **PdfModule**
- **PlaywrightModule**
- **ScreenshotModule**
- **StorageModule**
- **DatabaseModule**
- **Atloria.CSharpParser** — .NET Exe project (C#)

## Entry Points

- Controller: **ActivityController** (`atloria-monorepo/apps/api/src/activity/activity.controller.ts`)
- Controller: **AgentController** (`atloria-monorepo/apps/api/src/agent/agent.controller.ts`)
- Controller: **AIController** (`atloria-monorepo/apps/api/src/ai/ai.controller.ts`)
- Controller: **AnalyticsController** (`atloria-monorepo/apps/api/src/analytics/analytics.controller.ts`)
- Controller: **AnalyticsExportController** (`atloria-monorepo/apps/api/src/analytics/export/analytics-export.controller.ts`)
- Controller: **AppController** (`atloria-monorepo/apps/api/src/app/app.controller.ts`)
- Controller: **AssetsController** (`atloria-monorepo/apps/api/src/assets/assets.controller.ts`)
- Controller: **AudienceController** (`atloria-monorepo/apps/api/src/audience/audience.controller.ts`)
- Controller: **AuditController** (`atloria-monorepo/apps/api/src/audit/audit.controller.ts`)
- Controller: **AuthController** (`atloria-monorepo/apps/api/src/auth/auth.controller.ts`)
- Controller: **SamlController** (`atloria-monorepo/apps/api/src/auth/saml/saml.controller.ts`)
- Controller: **BillingController** (`atloria-monorepo/apps/api/src/billing/billing.controller.ts`)
- Controller: **BitbucketController** (`atloria-monorepo/apps/api/src/bitbucket/bitbucket.controller.ts`)
- Controller: **BoardsController** (`atloria-monorepo/apps/api/src/boards/boards.controller.ts`)
- Controller: **BrandingController** (`atloria-monorepo/apps/api/src/branding/branding.controller.ts`)
- Controller: **CaptureController** (`atloria-monorepo/apps/api/src/capture/capture.controller.ts`)
- Controller: **PublicCaptureController** (`atloria-monorepo/apps/api/src/capture/public-capture.controller.ts`)
- Controller: **ChangeRequestController** (`atloria-monorepo/apps/api/src/change-request/change-request.controller.ts`)
- Controller: **DocsConfigController** (`atloria-monorepo/apps/api/src/change-request/docs-config.controller.ts`)
- Controller: **CommentController** (`atloria-monorepo/apps/api/src/comment/comment.controller.ts`)
- `GET /activities` → list
- `GET /activities/documents/:id` → getDocumentActivities
- `GET /activities/projects/:id` → getProjectActivities
- `GET /activities/recent/projects` → getRecentProjects
- `GET /activities/recent/documents` → getRecentDocuments
- `GET /agent/status` → getStatus
- `GET /ai/usage/logs` → usageLogs
- `POST /ai/enhance` → enhance
- `POST /ai/outline` → generateOutline
- `POST /ai/improve` → improve
- `POST /ai/summarize` → summarize
- `GET /ai/providers` → listProviders
- `POST /analytics/track` → track
- `GET /analytics/:projectId/overview` → getOverview
- `GET /analytics/:projectId/versions` → getVersionTraffic
- `GET /analytics/:projectId/documents` → getTopDocuments
- `GET /analytics/:projectId/search-queries` → getTopSearchQueries
- `GET /analytics/:projectId/daily-traffic` → getDailyTraffic
- `GET /analytics/:projectId/devices` → getDeviceBreakdown
- `GET /analytics/:projectId/sources` → getSourceBreakdown
- `GET /analytics/:projectId/geo` → getGeoBreakdown
- `GET /analytics/:projectId/zero-result-searches` → getZeroResultSearches
- `GET /analytics/:projectId/ghost-docs` → getGhostDocs
- `GET /analytics/:projectId/trending-docs` → getTrendingDocs
- `GET /analytics/:projectId/scroll-histogram` → getScrollHistogram
- `POST /analytics/feedback` → submitFeedback
- `GET /analytics/:projectId/feedback-summary` → getFeedbackSummary
- `POST /analytics/:projectId/export` → exportNow
- `GET /analytics/:projectId/reports` → listReports
- `POST /analytics/:projectId/reports` → createReport

## Key Components

_The most-referenced entities — start here._

- **Description** (doc comment) — referenced 15×
- **Example Input** (doc comment) — referenced 15×
- **Example Output** (doc comment) — referenced 15×
- **DEVELOPER_STANDARDS.md** (doc comment) — referenced 12×
- **User** (graphql type) — referenced 11×
- **Your Prompt:** (doc comment) — referenced 11×
- **MANDATORY READING** (doc comment) — referenced 11×
- **Your Mission** (doc comment) — referenced 11×
- **Technology Stack** (doc comment) — referenced 11×
- **Code Location** (doc comment) — referenced 11×

<!-- source: type-templatecategory.md -->

# TemplateCategory

**Kind:** Type

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 146)

## Definition

```ts
| 'general'
  | 'api'
  | 'user-guide'
  | 'tutorial'
  | 'reference'
```

<!-- source: interface-tenantbackstopoptions.md -->

# TenantBackstopOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/database/src/lib/tenant-backstop.ts` (line 62)

## Properties

| Property | Type |
|---|---|
| `enforce` | `boolean` |
| `logger` | `{ warn: (msg: string) => void }` |

<!-- source: constant-tenant-models.md -->

# TENANT_MODELS

**Kind:** Constant

**Source:** `atloria-monorepo/libs/database/src/lib/tenant-backstop.ts` (line 22)

Tenant backstop — a Prisma client extension that guards against the cross-tenant bug class where a
service reads or mutates a row by id under a request context but forgets to scope it to the
caller's organization (the `_user`-ignored bug found in the SG red-team).

IMPORTANT: this is DEFENSE-IN-DEPTH. The primary control is ResourceOrgGuard at the controller
edge. This runs at the data layer as a second line.

It ships in LOG-ONLY (detect) mode: it never alters a query, it only records the distinct
(model, operation) shapes that ran unscoped under an org context — mapping the remaining surface
in real traffic with zero risk of breaking a query. Enforcement is opt-in per deployment (a flag)
and, even then, is applied ONLY to filter operations where injecting `AND organizationId` is
always valid Prisma — never to a unique-key op (findUnique/update/delete by id), where injecting a
non-unique field would be rejected, and never blindly over an intentional cross-org query (e.g.
`OR: [{ isPublic }, { organizationId }]`), which is why enforcement stays conservative and off by
default.

## Definition

```ts
ReadonlySet<string>
```

<!-- source: graphql-type-user.md -->

# User

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

User account

`User` is a GraphQL object type representing a user account in the API, including identity fields (id, email, name), authorization context (`role`), and social/content relationships (profile, posts, followers/following). It serves as the central node for querying user-centric data and derived counts (`followerCount`, `followingCount`) in the graph.

## Diagram

```mermaid
graph LR
  User[User]
  Role[Role]
  Profile[Profile]
  Post[Post]
  Follow[Follow]

  User -->|role: Role!| Role
  User -->|profile: Profile| Profile
  User -->|posts: [Post!]!| Post
  User -->|followers: [Follow!]!| Follow
  User -->|following: [Follow!]!| Follow
  User -->|followerCount: Int!| followerCount[(Int)]
  User -->|followingCount: Int!| followingCount[(Int)]
```

## Usage

```ts
import { gql, GraphQLClient } from "graphql-request";

const client = new GraphQLClient(process.env.API_URL!, {
  headers: { authorization: `Bearer ${process.env.API_TOKEN}` },
});

const GetUserWithRelations = gql`
  query GetUserWithRelations($id: ID!) {
    user(id: $id) {
      id
      email
      name
      role
      profile {
        id
        bio
      }
      posts {
        id
        title
      }
      followerCount
      followingCount
    }
  }
`;

type GetUserWithRelationsResult = {
  user: {
    id: string;
    email: string;
    name: string;
    role: "ADMIN" | "USER" | string;
    profile: { id: string; bio?: string | null } | null;
    posts: Array<{ id: string; title: string }>;
    followerCount: number;
    followingCount: number;
  } | null;
};

async function fetchUser(id: string) {
  const data = await client.request<GetUserWithRelationsResult>(GetUserWithRelations, { id });
  return data.user;
}

// Example call
fetchUser("user_123").then(console.log).catch(console.error);
```

## AI Coding Instructions

- Treat `User` as the hub type: keep resolver logic for `posts`, `profile`, `followers`, and `following` consistent with the underlying data model (IDs, join tables, pagination if applicable).
- Ensure `followerCount`/`followingCount` are derived efficiently (prefer aggregated queries over loading full `followers`/`following` lists just to count).
- Respect nullability: `profile` can be `null`, but list fields like `posts` are non-null lists of non-null items (`[Post!]!`) and should always resolve to an array.
- Avoid leaking sensitive fields: `email` is non-nullable, so enforce authorization checks in the `User` query resolver if email visibility is restricted.
- Keep `role` aligned with the `Role` enum values; validate and migrate consistently when adding new roles.

## Relationships

- TYPE_OF → `Role`
- TYPE_OF → `Profile`
- TYPE_OF → `Post`
- TYPE_OF → `Follow`
- TYPE_OF → `Follow`
- TYPE_OF → `DateTime`
- TYPE_OF → `DateTime`

## Referenced By

- `user` (TYPE_OF)
- `searchUsers` (TYPE_OF)
- `createUser` (TYPE_OF)
- `updateUser` (TYPE_OF)
- `Post` (TYPE_OF)
- `Comment` (TYPE_OF)
- `Like` (TYPE_OF)
- `Follow` (TYPE_OF)
- `Follow` (TYPE_OF)
- `UserConnection` (TYPE_OF)
- `AuthPayload` (TYPE_OF)

<!-- source: api-schema-user-management-api.md -->

# User Management API

**Kind:** API Schema

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

RESTful API for user management operations

## Relationships

- IMPLEMENTS_API → `getUsers`
- IMPLEMENTS_API → `createUser`
- IMPLEMENTS_API → `getUserById`
- IMPLEMENTS_API → `updateUser`
- IMPLEMENTS_API → `deleteUser`
- IMPLEMENTS_API → `login`
- TYPE_OF → `User`
- TYPE_OF → `UserWithProfile`
- TYPE_OF → `Profile`
- TYPE_OF → `CreateUser`
- TYPE_OF → `UpdateUser`
- TYPE_OF → `LoginRequest`
- TYPE_OF → `AuthResponse`
- TYPE_OF → `Error`

<!-- source: function-createcodeblocknode.md -->

# $createCodeBlockNode

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/CodeBlockNode.tsx` (line 275)

## Signature

```ts
function $createCodeBlockNode(options: Partial<CreateCodeBlockNodeOptions>): CodeBlockNode
```

## Parameters

| Name | Type |
|---|---|
| `options` | `Partial<CreateCodeBlockNodeOptions>` |

**Returns:** `CodeBlockNode`

<!-- source: api-endpoint-accept-2.md -->

# accept

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.controller.ts` (line 111)

## Endpoint

`POST /suggestions/:id/accept`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `SuggestionController` (MODULE_DECLARES)
- `SuggestionAliasController` (MODULE_DECLARES)

<!-- source: interface-accessibilityviolation.md -->

# AccessibilityViolation

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/accessibility.ts` (line 12)

Accessibility violation

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `description` | `string` |
| `help` | `string` |
| `helpUrl` | `string` |
| `impact` | `'minor' | 'moderate' | 'serious' | 'critical'` |
| `nodes` | `{
    html: string;
    target: string[];
    failureSummary?: string;
  }[]` |

<!-- source: interface-accuracyreport.md -->

# AccuracyReport

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-11.types.ts` (line 28)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `title` | `string` |
| `accuracyScore` | `number` |
| `claims` | `{
    total: number;
    verified: number;
    flagged: number;
    uncertain: number;
  }` |
| `issues` | `VerificationIssue[]` |
| `passesThreshold` | `boolean` |
| `requiredActions` | `string[]` |

<!-- source: constant-activeeditor.md -->

# activeEditor$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 129)

Holds a reference to the current Lexical editor instance - can be the root editor or a nested editor.

<!-- source: class-activityfiltersdto.md -->

# ActivityFiltersDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/activity/dto/activity-filters.dto.ts` (line 3)

## Properties

| Property | Type |
|---|---|
| `organizationId` | `string` |
| `projectId` | `string` |
| `userId` | `string` |
| `entityType` | `string` |
| `entityId` | `string` |
| `startDate` | `string` |
| `endDate` | `string` |

<!-- source: service-agentadapterservice.md -->

# AgentAdapterService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/support-agent/agent-adapter.service.ts` (line 40)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `execute` | `execute(message: string, executionConfig: AgentExecutionConfig)` | `Promise<AgentExecutionResult>` |
| `executeStream` | `executeStream(message: string, executionConfig: AgentExecutionConfig)` | `AsyncGenerator<string, void, unknown>` |

## Relationships

- DEPENDS_ON → `configservice`
- DEPENDS_ON → `prismaservice`

<!-- source: controller-agentanalyticscontroller.md -->

# AgentAnalyticsController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/events/agent-analytics.controller.ts` (line 12)

Agent-native analytics — "who/what AI is reading your docs". Authed, org-scoped
read model over the agent_read events the public agent surfaces record. Guard/scope
pattern mirrors ManualsInsightsController.

## Relationships

- MODULE_DECLARES → `traffic`
- DEPENDS_ON → `agentanalyticsservice`

<!-- source: interface-agentconfig.md -->

# AgentConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 14)

Agent Core Runtime Types

Our interfaces for agent configuration, tool definitions, and run results.
These are the contracts that domain layers (PME, doc-automation, etc.) code against.
The SDK's types are mapped to these in agent-runtime.ts — if the SDK changes,
only that file needs updating.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `instructions` | `string | ((context: RunContext<TContext>) => string | Promise<string>)` |
| `model` | `string` |
| `modelSettings` | `AgentModelSettings` |
| `tools` | `ToolDefinition<TContext>[]` |
| `handoffs` | `AgentConfig<TContext>[]` |
| `handoffDescription` | `string` |
| `inputGuardrails` | `GuardrailDefinition[]` |
| `outputGuardrails` | `OutputGuardrailDefinition[]` |
| `outputType` | `'text' | JsonSchemaOutput` |
| `maxTurns` | `number` |

<!-- source: interface-agentendedevent.md -->

# AgentEndedEvent

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/agent/agent.types.ts` (line 151)

## Properties

| Property | Type |
|---|---|
| `totalUsage` | `{
    inputTokens: number;
    outputTokens: number;
    totalTokens: number;
  }` |
| `turnCount` | `number` |

<!-- source: type-agentfactory.md -->

# AgentFactory

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/tools/spawn-agent.tool.ts` (line 33)

Factory function that creates sub-agent configs on demand.
Domain layers implement this to control what instructions, model,
and tools sub-agents receive.

The `model` in options is already resolved by the router — factory
should use it as-is when provided.

## Definition

```ts
(
  name: string,
  task: string,
  tools?: string[],
  options?: { rootDir?: string; model?: string },
) => import('../runtime/types').AgentConfig<TContext>
```

<!-- source: module-agentmodule.md -->

# AgentModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/agent/agent.module.ts` (line 6)

## Relationships

- MODULE_DECLARES → `agentcontroller`
- MODULE_PROVIDES → `agentservice`
- MODULE_PROVIDES → `agentgateway`
- MODULE_EXPORTS → `agentservice`
- MODULE_EXPORTS → `agentgateway`

<!-- source: class-agentruntime.md -->

# AgentRuntime

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/agent-runtime.ts` (line 45)

AgentRuntime — the SDK-based agent loop implementation.
Wraps

**Implements:** `IAgentLoop`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `run` | `run(config: AgentConfig<TContext>, input: string, options: RunOptions<TContext>)` | `Promise<RunResult>` |
| `runStreamed` | `runStreamed(config: AgentConfig<TContext>, input: string | AgentInputItem[], options: RunOptions<TContext>)` | `Promise<StreamedRunHandle>` |

<!-- source: service-agentwriterservice.md -->

# AgentWriterService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/agent-writer.service.ts` (line 1)

<!-- source: interface-aiprovidersresponse.md -->

# AIProvidersResponse

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/types/ai.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `providers` | `AIProvider[]` |
| `default` | `AIProviderName` |

<!-- source: type-aiprovidertype.md -->

# AIProviderType

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/ai-provider.interface.ts` (line 98)

AI Provider type selection

## Definition

```ts
'claude' | 'openai' | 'azure-responses'
```

<!-- source: function-analyzeangulartemplate.md -->

# analyzeAngularTemplate

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/template-analyzer.ts` (line 599)

Analyze Angular template file

## Signature

```ts
function analyzeAngularTemplate(templateContent: string): TemplateAnalysis
```

## Parameters

| Name | Type |
|---|---|
| `templateContent` | `string` |

**Returns:** `TemplateAnalysis`

<!-- source: function-analyzeauthfailurewithai.md -->

# analyzeAuthFailureWithAI

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/utils/ai-auth-debugger.ts` (line 127)

Ask AI to analyze authentication failure and suggest fixes

## Signature

```ts
async function analyzeAuthFailureWithAI(diagnostics: AuthDiagnostics, config: AuthConfig, debugGuideContent: string): Promise<{
  analysis: string;
  suggestedFixes: Array<{
    type: 'alert-handling' | 'selector-change' | 'timing-adjustment' | 'method-change';
    description: string;
    code?: string;
  }>;
}>
```

## Parameters

| Name | Type |
|---|---|
| `diagnostics` | `AuthDiagnostics` |
| `config` | `AuthConfig` |
| `debugGuideContent` | `string` |

**Returns:** `Promise<{
  analysis: string;
  suggestedFixes: Array<{
    type: 'alert-handling' | 'selector-change' | 'timing-adjustment' | 'method-change';
    description: string;
    code?: string;
  }>;
}>`

<!-- source: class-angulardetector.md -->

# AngularDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/angular-detector.ts` (line 77)

Angular Detector

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectComponents` | `detectComponents(entities: Entity[])` | `DetectedAngularComponent[]` |
| `detectServices` | `detectServices(entities: Entity[])` | `DetectedAngularService[]` |
| `getComponentSummary` | `getComponentSummary(component: DetectedAngularComponent)` | `string` |

<!-- source: service-annotationemitterservice.md -->

# AnnotationEmitterService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/annotation-emitter.service.ts` (line 59)

TS port of the atlorix Python annotation producer
(tools/capture_annotations.py + tools/emit_annotations.py).

Locates a step's target element on the LIVE page, converts it to percent-of-
natural-image coordinates, and builds the non-destructive overlay payload +
the `#atloria-annotations=` URL fragment the web viewer consumes. Coordinates
only — the screenshot pixels are never touched (moat intact).

## Methods

| Method | Signature | Returns |
|---|---|---|
| `recomputeTargetBoxPct` | `recomputeTargetBoxPct(page: Page, selector: string, opts: { fullPage: boolean })` | `Promise<BoxPct | null>` |
| `buildStepAnnotations` | `buildStepAnnotations(boxPct: BoxPct, stepIndex: number)` | `Annotation[]` |
| `toFragment` | `toFragment(annotations: Annotation[])` | `string` |

<!-- source: constant-apiauthenticationtemplate.md -->

# apiAuthenticationTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/api-authentication.template.ts` (line 3)

<!-- source: interface-apiendpointentity-2.md -->

# APIEndpointEntity

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 536)

API Endpoint entity

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.API_ENDPOINT` |
| `method` | `'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD'` |
| `path` | `string` |
| `pathParams` | `ParameterDefinition[]` |
| `queryParams` | `ParameterDefinition[]` |
| `requestBody` | `SchemaDefinition` |
| `responses` | `ResponseDefinition[]` |
| `authentication` | `AuthenticationInfo` |
| `rateLimit` | `RateLimitInfo` |
| `middleware` | `string[]` |
| `controller` | `string` |
| `operationId` | `string` |

<!-- source: interface-apiflow.md -->

# APIFlow

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/relationship.interface.ts` (line 391)

API flow showing component → API → service → model chain

## Properties

| Property | Type |
|---|---|
| `endpoint` | `{
    id: string;
    name: string;
    path: string;
    method: string;
  }` |
| `callers` | `Array<{
    id: string;
    name: string;
    type: string;
    filePath: string;
  }>` |
| `services` | `Array<{
    id: string;
    name: string;
    filePath: string;
  }>` |
| `models` | `Array<{
    id: string;
    name: string;
    tableName: string;
  }>` |
| `relationships` | `Relationship[]` |

<!-- source: class-apiprovider.md -->

# ApiProvider

**Kind:** Class

**Source:** `atloria-monorepo/apps/cli/src/providers/api.provider.ts` (line 54)

API data provider
Fetches from Atloria REST API

**Implements:** `DataProvider`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: DataProviderConfig)` | `Promise<void>` |
| `getProjectMetadata` | `getProjectMetadata()` | `Promise<ProjectMetadata>` |
| `getEntities` | `getEntities()` | `Promise<Entity[]>` |
| `getEntitiesByType` | `getEntitiesByType(type: string)` | `Promise<Entity[]>` |
| `getEntityById` | `getEntityById(id: string)` | `Promise<Entity | null>` |
| `getRelationships` | `getRelationships()` | `Promise<Relationship[]>` |
| `getRelationshipsForEntity` | `getRelationshipsForEntity(entityId: string)` | `Promise<Relationship[]>` |
| `saveParseResults` | `saveParseResults(results: ParseResult[], project: DetectedProject, workflowSignals: WorkflowSignals, workflowOptions: {
      enableAiWorkflows?: boolean;
      aiModel?: string;
      forceWorkflowDiscovery?: boolean;
    }, businessContextText: string)` | `Promise<void>` |
| `saveDocumentation` | `saveDocumentation(pages: Array<{
      slug: string;
      title: string;
      description: string;
      type: string;
      content: string;
      order: number;
      parentSlug?: string;
      entityId?: string;
    }>, _navigation: Array<{
      title: string;
      href: string;
      children?: Array<{ title: string; href: string }>;
    }>)` | `Promise<void>` |
| `destroy` | `destroy()` | `Promise<void>` |

<!-- source: constant-api-url.md -->

# API_URL

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 16)

Shared types + design tokens for the Support Desk shell.

The desk codes against the parallel backend contract:
  GET  desk/:projectId/counts
  GET  desk/:projectId/threads?bucket=...&limit=50
  GET  desk/:projectId/threads/:id
  POST desk/:projectId/threads/:id/transition {action, snoozedUntil?}
  POST desk/:projectId/threads/:id/reply {body, internal?, andDone?}
  POST desk/:projectId/threads/:id/duplicate {intoTicketNumber}

Chip palettes intentionally mirror apps/web/src/app/app/settings/issues/all/page.tsx
so tickets look identical across the Issues pages and the Desk.

<!-- source: controller-appcontroller-4.md -->

# AppController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/app.controller.ts` (line 4)

## Relationships

- MODULE_DECLARES → `getHealth`
- MODULE_DECLARES → `getInfo`
- DEPENDS_ON → `appservice`

<!-- source: function-applyfilterstoboard.md -->

# applyFiltersToBoard

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 86)

Filter a whole board (returns a new board with filtered cards per column)

## Signature

```ts
function applyFiltersToBoard(board: BoardData, f: BoardFiltersState): BoardData
```

## Parameters

| Name | Type |
|---|---|
| `board` | `BoardData` |
| `f` | `BoardFiltersState` |

**Returns:** `BoardData`

<!-- source: function-applyhunks.md -->

# applyHunks

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/edit-file.tool.ts` (line 625)

Apply parsed hunks to file content with fuzzy line offset matching.
Hunks are applied in reverse order (bottom-to-top) to preserve line numbers.

## Signature

```ts
function applyHunks(content: string, hunks: DiffHunk[], fuzzLines): { success: boolean; content?: string; error?: string; lastNewText?: string }
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |
| `hunks` | `DiffHunk[]` |
| `fuzzLines` | `any` |

**Returns:** `{ success: boolean; content?: string; error?: string; lastNewText?: string }`

<!-- source: module-appmodule-6.md -->

# AppModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/app.module.ts` (line 9)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `gitmodule`
- MODULE_IMPORTS → `analysismodule`
- MODULE_DECLARES → `appcontroller`
- MODULE_PROVIDES → `appservice`

<!-- source: service-appservice-4.md -->

# AppService

**Kind:** Service

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/app.service.ts` (line 4)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getHealth` | `getHealth()` | `unknown` |
| `getInfo` | `getInfo()` | `unknown` |

## Relationships

- DEPENDS_ON → `gitservice`

<!-- source: function-areparsersinitialized.md -->

# areParsersInitialized

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/queue/processors/parser-registry.ts` (line 165)

Check if parsers are initialized

## Signature

```ts
function areParsersInitialized(): boolean
```

**Returns:** `boolean`

<!-- source: type-askfn.md -->

# AskFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/mcp-toolset.ts` (line 34)

Optional grounded-QA backend (LLM). Injected so the toolset stays pure/testable.

## Definition

```ts
(question: string, context: DocSearchHit[]) => Promise<{ answer: string; citations: string[] }>
```

<!-- source: interface-assemblerdeps.md -->

# AssemblerDeps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/assembler.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `templateDir` | `string` |
| `componentLibraryDir` | `string` |

<!-- source: function-assertperformancemetrics.md -->

# assertPerformanceMetrics

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/performance.ts` (line 126)

Assert performance metrics meet thresholds

## Signature

```ts
async function assertPerformanceMetrics(page: Page, thresholds: Partial<{
    ttfb: number;
    fcp: number;
    lcp: number;
    cls: number;
    domContentLoaded: number;
    load: number;
    resourceCount: number;
    totalSize: number;
    domNodes: number;
  }>): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |
| `thresholds` | `Partial<{
    ttfb: number;
    fcp: number;
    lcp: number;
    cls: number;
    domContentLoaded: number;
    load: number;
    resourceCount: number;
    totalSize: number;
    domNodes: number;
  }>` |

**Returns:** `Promise<void>`

<!-- source: function-assertpublichttpurl.md -->

# assertPublicHttpUrl

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/ssrf.ts` (line 26)

Validate that a URL is http(s) and does not point at a private address
(by hostname pattern or DNS resolution). Throws BadRequestException.

## Signature

```ts
async function assertPublicHttpUrl(rawUrl: string): Promise<URL>
```

## Parameters

| Name | Type |
|---|---|
| `rawUrl` | `string` |

**Returns:** `Promise<URL>`

<!-- source: class-atloriawebsocketclient.md -->

# AtloriaWebSocketClient

**Kind:** Class

**Source:** `atloria-monorepo/apps/web/src/lib/websocket-client.ts` (line 30)

AtloriaWebSocketClient

Manages WebSocket connections for real-time updates.
Supports multiple namespaces (comments, documents) and channel subscriptions.

**Implements:** `WebSocketClient`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `setToken` | `setToken(token: string | null)` | `void` |
| `joinDocument` | `joinDocument(documentId: string, namespace: NamespaceType)` | `void` |
| `leaveDocument` | `leaveDocument(documentId: string, namespace: NamespaceType)` | `void` |
| `subscribe` | `subscribe(channel: string, handler: SubscriptionHandler)` | `() => void` |
| `on` | `on(event: string, handler: SubscriptionHandler)` | `void` |
| `off` | `off(event: string, handler: SubscriptionHandler)` | `void` |
| `emit` | `emit(event: string, data: any)` | `void` |
| `disconnect` | `disconnect()` | `void` |
| `isConnected` | `isConnected()` | `boolean` |

<!-- source: interface-authconfig.md -->

# AuthConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/utils/ai-auth-debugger.ts` (line 12)

## Properties

| Property | Type |
|---|---|
| `loginUrl` | `string` |
| `credentials` | `{
    usernameSelector: string;
    passwordSelector: string;
    submitSelector: string;
    username: string;
    password: string;
  }` |
| `waitAfterLogin` | `number` |
| `testUrl` | `string` |

<!-- source: interface-authenticatedscreenshotoptions.md -->

# AuthenticatedScreenshotOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/playwright/playwright.service.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `targetUrl` | `string` |
| `loginUrl` | `string` |
| `username` | `string` |
| `password` | `string` |
| `usernameSelector` | `string` |
| `passwordSelector` | `string` |
| `submitSelector` | `string` |
| `successSelector` | `string` |
| `browserType` | `BrowserType` |
| `viewport` | `{
    width: number;
    height: number;
  }` |
| `fullPage` | `boolean` |
| `waitForSelector` | `string` |
| `waitForTimeout` | `number` |

<!-- source: component-backdrop.md -->

# Backdrop

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/DeskDialogs.tsx` (line 19)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onClose` | `Function` | ✓ | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Backdrop_3d5e3532["Backdrop"]
    class component_Backdrop_3d5e3532 rootComponent
```

## Referenced By

- `SnoozeMenu` (RENDERS)
- `DuplicateDialog` (RENDERS)
- `ShortcutOverlay` (RENDERS)

<!-- source: class-batchconfigdto.md -->

# BatchConfigDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 555)

Batch configuration DTO

Controls batch-level settings:
- Concurrency and parallelism
- Browser selection
- Retry behavior
- Screenshot format and quality
- Deduplication

## Properties

| Property | Type |
|---|---|
| `maxConcurrency` | `number` |
| `browser` | `Browser` |
| `maxRetries` | `number` |
| `retryDelayMs` | `number` |
| `screenshotTimeout` | `number` |
| `defaultViewport` | `ViewportDto` |
| `format` | `Format` |
| `quality` | `number` |
| `checkDuplicates` | `boolean` |

<!-- source: controller-batchscreenshotcontroller.md -->

# BatchScreenshotController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/batch-screenshot.controller.ts` (line 41)

Controller for batch screenshot operations

Endpoints:
- POST /screenshot/batch - Create and start a batch job
- GET /screenshot/batch/:jobId/status - Get job status and results
- POST /screenshot/validate-selectors - Validate selectors exist on a page

`BatchScreenshotController` exposes HTTP endpoints for creating and running screenshot batch jobs, querying their status/results, and validating CSS/XPath selectors against a target page. It acts as the API boundary for the screenshot-worker service, delegating orchestration to underlying services/queues and returning job progress and artifacts to callers.

## Diagram

```mermaid
graph LR
  Client[Client / API Consumer] -->|POST /screenshot/batch| C[BatchScreenshotController]
  Client -->|GET /screenshot/batch/:jobId/status| C
  Client -->|POST /screenshot/validate-selectors| C

  C --> S[Batch Screenshot Service]
  S --> Q[(Job Queue / Worker)]
  Q --> W[Browser Runner (Playwright/Puppeteer)]
  W --> R[(Storage: screenshots & metadata)]
  S --> R
  C -->|status/results| Client
```

## Usage

```ts
// Example: calling the controller endpoints from a Node client (e.g., another service)
import axios from "axios";

const baseURL = process.env.SCREENSHOT_WORKER_URL ?? "http://localhost:3000";

async function runBatch() {
  // 1) Create/start a batch screenshot job
  const createRes = await axios.post(`${baseURL}/screenshot/batch`, {
    // Shape depends on your DTOs; adjust to match your API contract.
    pages: [
      { url: "https://example.com", selectors: ["header", "#main"] },
      { url: "https://example.com/about", selectors: ["h1", ".content"] },
    ],
    viewport: { width: 1280, height: 720 },
    fullPage: true,
  });

  const jobId: string = createRes.data.jobId;
  console.log("Created job:", jobId);

  // 2) Poll for job status/results
  while (true) {
    const statusRes = await axios.get(
      `${baseURL}/screenshot/batch/${encodeURIComponent(jobId)}/status`,
    );

    const { status, progress, results, error } = statusRes.data;
    console.log({ status, progress });

    if (status === "completed") {
      // results commonly include screenshot URLs/paths and per-page metadata
      console.log("Batch results:", results);
      break;
    }

    if (status === "failed") {
      throw new Error(error ?? "Batch screenshot job failed");
    }

    await new Promise((r) => setTimeout(r, 1000));
  }
}

async function validateSelectors() {
  const res = await axios.post(`${baseURL}/screenshot/validate-selectors`, {
    url: "https://example.com",
    selectors: ["#main", ".does-not-exist"],
  });

  // Example response: { valid: ["#main"], invalid: [".does-not-exist"] }
  console.log("Selector validation:", res.data);
}

runBatch()
  .then(validateSelectors)
  .catch((e) => {
    console.error(e);
    process.exit(1);
  });
```

## AI Coding Instructions

- Keep controller methods thin: perform input validation/DTO parsing and delegate orchestration to a service/queue layer; avoid embedding browser/screenshot logic in the controller.
- Preserve idempotency and clarity for `GET /screenshot/batch/:jobId/status`: never mutate job state on reads; return a stable schema for `status`, `progress`, and `results`.
- Normalize and validate all external inputs (URLs, selectors, viewport/fullPage flags) to prevent SSRF-like issues and to avoid expensive browser launches for obviously invalid requests.
- Treat job IDs as opaque: always `encodeURIComponent` in routing/clients and avoid assumptions about format when adding logging or storage keys.
- When adding new endpoints, align with existing NestJS patterns (DTOs, validation pipes, consistent HTTP status codes) and ensure integration points (queue, storage, runner) are injected and testable.

## Relationships

- MODULE_DECLARES → `createBatchJob`
- MODULE_DECLARES → `createFlowJob`
- MODULE_DECLARES → `reshootFlowStep`
- MODULE_DECLARES → `reshootFlowLocales`
- MODULE_DECLARES → `getJobStatus`
- MODULE_DECLARES → `getPageHtml`
- MODULE_DECLARES → `validateSelectors`
- DEPENDS_ON → `batchscreenshotservice`
- DEPENDS_ON → `flowreplayservice`
- DEPENDS_ON → `playwrightservice`

<!-- source: type-billingplankey.md -->

# BillingPlanKey

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/billing/billing.constants.ts` (line 31)

## Definition

```ts
'pro' | 'business'
```

<!-- source: interface-brandvoiceconfig.md -->

# BrandVoiceConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/guardrails/brand-voice.guardrail.ts` (line 42)

## Properties

| Property | Type |
|---|---|
| `brandVoice` | `string` |
| `additionalBannedTerms` | `string[]` |
| `allowSuperlatives` | `boolean` |

<!-- source: type-browser.md -->

# Browser

**Kind:** Type

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 540)

## Definition

```ts
typeof BROWSERS[number]
```

<!-- source: constant-browsers.md -->

# BROWSERS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 539)

<!-- source: type-bucketkey.md -->

# BucketKey

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 85)

## Definition

```ts
| 'triage'
  | 'needs_first'
  | 'needs_next'
  | 'investigating'
  | 'waiting'
  | 'paused'
  | 'done'
  | 'mine'
  | 'unassigned'
```

<!-- source: function-buildcoordinatorsystemprompt.md -->

# buildCoordinatorSystemPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/coordinator.prompts.ts` (line 21)

## Signature

```ts
function buildCoordinatorSystemPrompt(config: GenerationConfig): string
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |

**Returns:** `string`

<!-- source: function-buildsitegensystemprompt.md -->

# buildSiteGenSystemPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/agents/site-gen.prompts.ts` (line 16)

## Signature

```ts
function buildSiteGenSystemPrompt(config: SiteGenPromptConfig): string
```

## Parameters

| Name | Type |
|---|---|
| `config` | `SiteGenPromptConfig` |

**Returns:** `string`

<!-- source: function-burnredactions.md -->

# burnRedactions

**Kind:** Function

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/crop.service.ts` (line 72)

Burn opaque BLACK rectangles into an image, destroying the underlying pixels.

Boxes are percent (0-100) of the natural image; each is converted to a clamped
pixel rect and composited as a filled black overlay. Unlike an annotation
overlay (coordinates on a URL fragment), this is DESTRUCTIVE by design — a
redacted region can never be recovered from the stored asset. Degenerate boxes
(sub-pixel or off-canvas) are skipped. No boxes → the original buffer is returned
untouched (no re-encode).

## Signature

```ts
async function burnRedactions(buffer: Buffer, boxes: BoxPct[], imgW: number, imgH: number): Promise<Buffer>
```

## Parameters

| Name | Type |
|---|---|
| `buffer` | `Buffer` |
| `boxes` | `BoxPct[]` |
| `imgW` | `number` |
| `imgH` | `number` |

**Returns:** `Promise<Buffer>`

<!-- source: enum-changetype.md -->

# ChangeType

**Kind:** Enum

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/version-diff.ts` (line 13)

Change type

## Values

- `Added`
- `Removed`
- `Modified`

<!-- source: interface-cloneresult-2.md -->

# CloneResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/git/git.service.ts` (line 17)

## Properties

| Property | Type |
|---|---|
| `clonePath` | `string` |
| `targetPath` | `string` |
| `repoUrl` | `string` |
| `branch` | `string` |
| `folderPath` | `string` |

<!-- source: class-cloudstorageprovider.md -->

# CloudStorageProvider

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/storage/cloud-storage.provider.ts` (line 26)

Cloud storage provider implementation

**Implements:** `IStorageProvider`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getMode` | `getMode()` | `StorageMode` |
| `saveScreenshot` | `saveScreenshot(buffer: Buffer, metadata: ScreenshotMetadata)` | `Promise<ScreenshotSaveResult>` |
| `findExistingScreenshot` | `findExistingScreenshot(metadata: Partial<ScreenshotMetadata>)` | `Promise<ScreenshotSaveResult | null>` |
| `saveDocument` | `saveDocument(document: DocumentMetadata)` | `Promise<DocumentSaveResult>` |
| `documentExists` | `documentExists(projectId: string, categoryPath: string[], slug: string)` | `Promise<boolean>` |
| `listDocuments` | `listDocuments(projectId: string, categoryPath: string[])` | `Promise<Array<{ id: string; title: string; slug: string; url: string }>>` |

<!-- source: class-collaborationpage.md -->

# CollaborationPage

**Kind:** Class

**Source:** `atloria-monorepo/apps/web-e2e/src/pages/collaboration.page.ts` (line 7)

Collaboration feature page object

**Extends:** `BasePage`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `goto` | `goto()` | `Promise<void>` |
| `getUserCursors` | `getUserCursors()` | `Locator` |
| `getCursorCount` | `getCursorCount()` | `Promise<number>` |
| `getPresenceIndicators` | `getPresenceIndicators()` | `Locator` |
| `getCollaboratorCount` | `getCollaboratorCount()` | `Promise<number>` |
| `getConnectionStatus` | `getConnectionStatus()` | `Promise<'connected' | 'connecting' | 'disconnected'>` |
| `waitForConnection` | `waitForConnection()` | `Promise<void>` |
| `getUserByName` | `getUserByName(name: string)` | `Locator` |
| `isUserPresent` | `isUserPresent(name: string)` | `Promise<boolean>` |
| `openShareDialog` | `openShareDialog()` | `Promise<void>` |
| `getCursorPosition` | `getCursorPosition(userName: string)` | `Promise<{ x: number; y: number } | null>` |
| `getCollaboratorColor` | `getCollaboratorColor(userName: string)` | `Promise<string | null>` |
| `isStatusBarVisible` | `isStatusBarVisible()` | `Promise<boolean>` |
| `getStatusBarText` | `getStatusBarText()` | `Promise<string>` |
| `simulateDisconnection` | `simulateDisconnection()` | `Promise<void>` |
| `waitForReconnection` | `waitForReconnection()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `statusBar` | `Locator` |
| `userCursors` | `Locator` |
| `presenceIndicators` | `Locator` |
| `connectionStatus` | `Locator` |
| `userList` | `Locator` |
| `shareButton` | `Locator` |

<!-- source: constant-compaction-summary-schema.md -->

# COMPACTION_SUMMARY_SCHEMA

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/context/compaction-types.ts` (line 165)

JSON Schema definition for CompactionSummary.
Passed to the model via `response_format: { type: 'json_schema', json_schema: ... }`
to guarantee structured output.

<!-- source: enum-comparetype.md -->

# CompareType

**Kind:** Enum

**Source:** `atloria-monorepo/apps/api/src/document/dto/compare-document.dto.ts` (line 4)

## Values

- `VERSION`
- `REVISION`

<!-- source: api-endpoint-create.md -->

# create

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/src/users/users.controller.ts` (line 49)

## Endpoint

`POST /users`

## Referenced By

- `UsersController` (MODULE_DECLARES)

<!-- source: api-endpoint-createflowjob.md -->

# createFlowJob

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/batch-screenshot.controller.ts` (line 123)

Create and start a flow-replay job (WS-A)

POST /api/screenshot/flow

Replays a recorded flow (start URL + ordered actions) in ONE browser context,
shooting a screenshot after each action. Returns immediately with a job ID;
poll GET /api/screenshot/batch/:jobId/status?organizationId=… — the status
payload carries a `flowSteps` array ({ flowStepId, blobUrl, annotationsFragment }).

`auth` is OPTIONAL — a PUBLIC startUrl needs none, which makes the endpoint
smoke-testable without customer credentials. `capturedBy` (a real user UUID)
IS required so the job and Screenshot rows satisfy their DB foreign keys.

## Endpoint

`POST /screenshot/flow`

## Referenced By

- `BatchScreenshotController` (MODULE_DECLARES)

<!-- source: graphql-mutation-createpost.md -->

# createPost

**Kind:** Graphql Mutation

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Create a new post

## Relationships

- TYPE_OF → `Post`
- TYPE_OF → `CreatePostInput`

## Referenced By

- `Mutation` (CALLS_API)

<!-- source: type-ctalayout.md -->

# CtaLayout

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 19)

## Definition

```ts
'banner' | 'split-form'
```

<!-- source: function-database.md -->

# database

**Kind:** Function

**Source:** `atloria-monorepo/libs/database/src/lib/database.ts` (line 1)

## Signature

```ts
function database(): string
```

**Returns:** `string`

<!-- source: module-discoverymodule.md -->

# DiscoveryModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/discovery/discovery.module.ts` (line 7)

## Relationships

- MODULE_IMPORTS → `playwrightmodule`
- MODULE_DECLARES → `discoverycontroller`
- MODULE_PROVIDES → `discoveryservice`
- MODULE_PROVIDES → `pageprofilerservice`
- MODULE_EXPORTS → `discoveryservice`
- MODULE_EXPORTS → `pageprofilerservice`

<!-- source: enum-documentsource.md -->

# DocumentSource

**Kind:** Enum

**Source:** `atloria-monorepo/packages/types/src/enums/index.ts` (line 33)

Document source indicates how the document was created

## Values

- `AI`
- `PARSER`
- `USER`
- `FLOW`
- `API`

<!-- source: enum-entitytype.md -->

# EntityType

**Kind:** Enum

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 15)

Entity Interfaces

Defines all entity types discovered by parsers.
Entities represent code constructs like components, services, models, etc.

## Values

- `COMPONENT`
- `HOOK`
- `PAGE`
- `LAYOUT`
- `ROUTE`
- `CONTEXT`
- `PROVIDER`
- `STORE`
- `CONTROLLER`
- `SERVICE`
- `REPOSITORY`
- `MIDDLEWARE`
- `GUARD`
- `INTERCEPTOR`
- `PIPE`
- `MODULE`
- `EVENT_HANDLER`
- `JOB_PROCESSOR`
- `API_ENDPOINT`
- `GRAPHQL_QUERY`
- `GRAPHQL_MUTATION`
- `GRAPHQL_SUBSCRIPTION`
- `GRAPHQL_TYPE`
- `RPC_METHOD`
- `WEBSOCKET_ENDPOINT`
- `DATABASE_MODEL`
- `DATABASE_MIGRATION`
- `DATABASE_SEED`
- `DATABASE_VIEW`
- `DATABASE_PROCEDURE`
- `DOCKER_SERVICE`
- `K8S_DEPLOYMENT`
- `K8S_SERVICE`
- `K8S_CONFIGMAP`
- `TERRAFORM_RESOURCE`
- `CI_WORKFLOW`
- `MARKDOWN_DOC`
- `API_SCHEMA`
- `DOC_COMMENT`
- `ENV_VARIABLE`
- `CONFIG_FILE`
- `FEATURE_FLAG`
- `CLASS`
- `FUNCTION`
- `INTERFACE`
- `TYPE`
- `ENUM`
- `CONSTANT`
- `VARIABLE`
- `DECORATOR`

<!-- source: class-expressparser.md -->

# ExpressParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/backend-parser/src/parsers/express.parser.ts` (line 42)

Express Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: function-extractcomponentnamefrompath.md -->

# extractComponentNameFromPath

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 483)

Extract the component name from a file path

## Signature

```ts
function extractComponentNameFromPath(filePath: string): string
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string` |

**Returns:** `string`

<!-- source: type-fetchaudiencesfn.md -->

# FetchAudiencesFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/tools/query-product-knowledge.tool.ts` (line 60)

Fetch target audiences defined for this project.

## Definition

```ts
(
  projectId: string,
) => Promise<ProductAudience[]>
```

<!-- source: constant-fixtures-path-2.md -->

# FIXTURES_PATH

**Kind:** Constant

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/setup.ts` (line 18)

<!-- source: function-generateentityid.md -->

# generateEntityId

**Kind:** Function

**Source:** `atloria-monorepo/apps/database-parser/src/utils/hash.util.ts` (line 19)

Generate a unique entity ID

## Signature

```ts
function generateEntityId(filePath: string, entityType: string, name: string): string
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string` |
| `entityType` | `string` |
| `name` | `string` |

**Returns:** `string`

<!-- source: api-endpoint-getinfo-2.md -->

# getInfo

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/app.controller.ts` (line 19)

Service info endpoint

## Endpoint

`GET /info`

## Referenced By

- `AppController` (MODULE_DECLARES)

<!-- source: api-endpoint-getparsers.md -->

# getParsers

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api-schema-parser/src/app.controller.ts` (line 29)

List supported parsers

## Endpoint

`GET /parsers`

## Referenced By

- `AppController` (MODULE_DECLARES)

<!-- source: class-grpcparser.md -->

# GrpcParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/api-schema-parser/src/parsers/grpc.parser.ts` (line 37)

gRPC Parser Implementation

Supports:
- Protocol Buffers syntax (proto2 and proto3)
- Services and RPCs
- Messages and nested types
- Enums
- Options and comments

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: interface-importinfo.md -->

# ImportInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 17)

Information about an import statement

## Properties

| Property | Type |
|---|---|
| `source` | `string` |
| `importType` | `'default' | 'named' | 'namespace' | 'side-effect'` |
| `imported` | `string` |
| `local` | `string` |

<!-- source: module-integrationmodule.md -->

# IntegrationModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/integration/integration.module.ts` (line 14)

## Relationships

- MODULE_PROVIDES → `integrationservice`
- MODULE_EXPORTS → `integrationservice`

<!-- source: class-jsonconfigparser.md -->

# JsonConfigParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/config-docs-parser/src/parsers/json-config.parser.ts` (line 63)

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: constant-key-tech-facts.md -->

# KEY_TECH_FACTS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/pme-agent/test/discovery/ground-truth.ts` (line 119)

Key tech stack facts the agent should mention (from READING dependency files)

<!-- source: service-kgsyncservice.md -->

# KGSyncService

**Kind:** Service

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/knowledge-graph/sync/kg-sync.service.ts` (line 23)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `sync` | `sync(parseResult: ParseResult)` | `Promise<SyncResult>` |
| `syncBatch` | `syncBatch(parseResults: ParseResult[])` | `Promise<SyncResult>` |
| `syncProject` | `syncProject(projectResult: ProjectParseResult)` | `Promise<SyncResult>` |
| `resyncProject` | `resyncProject(projectId: string, parseResults: ParseResult[])` | `Promise<SyncResult>` |
| `getSyncStatus` | `getSyncStatus(projectId: string)` | `Promise<{
    totalEntities: number;
    totalRelationships: number;
    lastSyncedAt?: Date;
  }>` |

## Relationships

- DEPENDS_ON → `knowledgegraphservice`

<!-- source: component-milestonecard.md -->

# MilestoneCard

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/social-proof/social-proof-timeline.tsx` (line 50)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `milestone` | `Milestone` | ✓ | - |
| `t` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_MilestoneCard_150ebeb1["MilestoneCard"]
    class component_MilestoneCard_150ebeb1 rootComponent
```

## Relationships

- RENDERS → `DateBadge`

## Referenced By

- `SocialProofTimeline` (RENDERS)

<!-- source: graphql-subscription-newfollower.md -->

# newFollower

**Kind:** Graphql Subscription

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Subscribe to new followers

## Relationships

- TYPE_OF → `Follow`

## Referenced By

- `Subscription` (CALLS_API)

<!-- source: class-nextjsparser.md -->

# NextjsParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/frontend-parser/src/parsers/nextjs.parser.ts` (line 53)

**Extends:** `ReactParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `version` | `string` |
| `supportedPatterns` | `string[]` |

<!-- source: class-parseprocessor.md -->

# ParseProcessor

**Kind:** Class

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/queue/processors/parse.processor.ts` (line 68)

**Implements:** `OnModuleInit`, `OnModuleDestroy`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `Promise<void>` |
| `onModuleDestroy` | `onModuleDestroy()` | `Promise<void>` |
| `handleParse` | `handleParse(job: Job<ParseJobPayload>)` | `Promise<ParseResult[]>` |
| `onActive` | `onActive(job: Job<ParseJobPayload>)` | `void` |
| `onCompleted` | `onCompleted(job: Job<ParseJobPayload>, result: ParseResult[])` | `void` |
| `onFailed` | `onFailed(job: Job<ParseJobPayload>, error: Error)` | `void` |
| `onProgress` | `onProgress(job: Job<ParseJobPayload>, progress: number)` | `void` |

<!-- source: interface-parserregistryconfig.md -->

# ParserRegistryConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/config-docs-parser/src/services/parser-registry.service.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `enabledParsers` | `string[]` |
| `parserOptions` | `Record<string, unknown>` |

<!-- source: class-pmecompactionstrategy.md -->

# PmeCompactionStrategy

**Kind:** Class

**Source:** `atloria-monorepo/libs/pme-core/src/context/pme-compaction-strategy.ts` (line 31)

**Implements:** `CompactionStrategy`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `shouldPreserve` | `shouldPreserve(item: ContextItem)` | `boolean` |
| `summarize` | `summarize(items: ContextItem[])` | `string` |

<!-- source: graphql-type-post.md -->

# Post

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Blog post

`Post` is a GraphQL object type representing a blog post in the backend API, including its core content (`title`, `content`) and publication state (`published`, `publishedAt`). It acts as an aggregate root that links to related entities like `author`, `comments`, `likes`, and `tags`, while also exposing derived data such as `commentCount`. This type is typically returned by post-related queries and mutations and drives client rendering of post detail and list views.

## Diagram

```mermaid
graph LR
  Post[Post]
  User[User]
  Comment[Comment]
  Like[Like]
  Tag[Tag]

  Post -->|author: User!| User
  Post -->|comments: [Comment!]!| Comment
  Post -->|likes: [Like!]!| Like
  Post -->|tags: [Tag!]!| Tag

  Post -->|id: ID!| ID[(ID)]
  Post -->|title: String!| String[(String)]
  Post -->|content: String!| String2[(String)]
  Post -->|published: Boolean!| Bool[(Boolean)]
  Post -->|publishedAt: DateTime| DateTime[(DateTime)]
  Post -->|commentCount: Int!| Int[(Int)]
```

## Usage

```ts
// Example using graphql-request in a Next.js/NestJS-compatible setup.
import { GraphQLClient, gql } from "graphql-request";

const client = new GraphQLClient(process.env.API_URL!, {
  headers: {
    // e.g. Authorization: `Bearer ${token}`,
  },
});

const GET_POST = gql`
  query GetPost($id: ID!) {
    post(id: $id) {
      id
      title
      content
      published
      publishedAt
      commentCount
      author {
        id
        name
      }
      tags {
        id
        name
      }
      comments {
        id
        content
        author {
          id
          name
        }
      }
      likes {
        id
        user {
          id
          name
        }
      }
    }
  }
`;

type GetPostResult = {
  post: {
    id: string;
    title: string;
    content: string;
    published: boolean;
    publishedAt: string | null;
    commentCount: number;
    author: { id: string; name: string };
    tags: Array<{ id: string; name: string }>;
    comments: Array<{ id: string; content: string; author: { id: string; name: string } }>;
    likes: Array<{ id: string; user: { id: string; name: string } }>;
  };
};

export async function fetchPost(id: string) {
  const data = await client.request<GetPostResult>(GET_POST, { id });
  return data.post;
}

// Usage:
// const post = await fetchPost("post_123");
// console.log(post.title, post.commentCount);
```

## AI Coding Instructions

- Treat `Post` as an aggregate: keep `author`, `comments`, `likes`, and `tags` resolved consistently (avoid partial resolver behavior that returns `null` for non-nullable fields).
- Ensure `commentCount: Int!` stays in sync with `comments` (compute via DB aggregation where possible; avoid N+1 counting per post).
- Respect publication semantics: if `published` is `false`, `publishedAt` should typically be `null` (enforce in mutations and resolvers).
- When adding fields, keep GraphQL nullability intentional: only mark as non-null (`!`) if the resolver/data layer can guarantee it under all conditions.

## Relationships

- TYPE_OF → `DateTime`
- TYPE_OF → `User`
- TYPE_OF → `Comment`
- TYPE_OF → `Like`
- TYPE_OF → `Tag`
- TYPE_OF → `DateTime`
- TYPE_OF → `DateTime`

## Referenced By

- `post` (TYPE_OF)
- `createPost` (TYPE_OF)
- `updatePost` (TYPE_OF)
- `newPost` (TYPE_OF)
- `User` (TYPE_OF)
- `Comment` (TYPE_OF)
- `Like` (TYPE_OF)
- `Tag` (TYPE_OF)
- `PostConnection` (TYPE_OF)

<!-- source: graphql-query-posts.md -->

# posts

**Kind:** Graphql Query

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Get posts with filters

## Relationships

- TYPE_OF → `PostConnection`

## Referenced By

- `Query` (CALLS_API)

<!-- source: class-prismaparser.md -->

# PrismaParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/database-parser/src/parsers/prisma.parser.ts` (line 67)

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: component-profilepage.md -->

# ProfilePage

**Kind:** Component

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/frontend/src/pages/profile/[id].tsx` (line 21)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `initialUser` | `unknown` | - | - |

## Diagram

```mermaid
graph TD
    component_ProfilePage_560b332b["ProfilePage"]
    class component_ProfilePage_560b332b rootComponent
```

## Relationships

- RENDERS → `Layout`
- RENDERS → `Head`
- RENDERS → `UserProfile`
- USES_HOOK → `useRouter`

<!-- source: interface-projectinfo.md -->

# ProjectInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/pme-agent/test/discovery/ground-truth.ts` (line 12)

Ground Truth — Amlak Project

Known facts about the amlak repo that we score the agent's output against.
Built from manual inspection on 2026-03-22, updated with agent discoveries.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `path` | `string` |
| `tech` | `string` |
| `description` | `string` |
| `language` | `'typescript' | 'python' | 'mixed'` |

<!-- source: module-queuemodule-2.md -->

# QueueModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/pme-agent/src/queue/queue.module.ts` (line 6)

## Relationships

- MODULE_PROVIDES → `pmeprocessor`
- MODULE_EXPORTS → `bullmodule`

<!-- source: service-redisservice.md -->

# RedisService

**Kind:** Service

**Source:** `atloria-monorepo/libs/database/src/lib/redis.service.ts` (line 7)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `unknown` |
| `onModuleDestroy` | `onModuleDestroy()` | `unknown` |
| `getClient` | `getClient()` | `Redis | null` |
| `isAvailable` | `isAvailable()` | `boolean` |
| `get` | `get(key: string)` | `Promise<string | null>` |
| `set` | `set(key: string, value: string, ttlSeconds: number)` | `Promise<void>` |
| `del` | `del(key: string)` | `Promise<void>` |
| `exists` | `exists(key: string)` | `Promise<boolean>` |
| `setJson` | `setJson(key: string, value: T, ttlSeconds: number)` | `Promise<void>` |
| `getJson` | `getJson(key: string)` | `Promise<T | null>` |
| `cached` | `cached(key: string, fetchFn: () => Promise<T>, ttlSeconds: unknown)` | `Promise<T>` |
| `invalidatePattern` | `invalidatePattern(pattern: string)` | `Promise<void>` |

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: component-renderrecursivewrappers.md -->

# RenderRecursiveWrappers

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/MDXEditor.tsx` (line 179)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `wrappers` | `any` | ✓ | - |
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_RenderRecursiveWrappers_4c55724f["RenderRecursiveWrappers"]
    class component_RenderRecursiveWrappers_4c55724f rootComponent
```

## Relationships

- RENDERS → `Wrapper`
- RENDERS → `RenderRecursiveWrappers`

## Referenced By

- `RichTextEditor` (RENDERS)
- `RenderRecursiveWrappers` (RENDERS)

<!-- source: page-root.md -->

# Root

**Kind:** Page

**Source:** `atloria-monorepo/templates/site-bootstrap/src/App.tsx`

<!-- source: constant-superlatives-list.md -->

# SUPERLATIVES_LIST

**Kind:** Constant

**Source:** `atloria-monorepo/libs/pme-core/src/guardrails/brand-voice.guardrail.ts` (line 124)

Exported for testing — the list of superlatives the guardrail checks.

<!-- source: service-system-text-json.md -->

# System.Text.Json

**Kind:** Service

**Source:** `atloria-monorepo/libs/parser-core/src/dotnet-bridge/Atloria.CSharpParser/Atloria.CSharpParser.csproj` (line 1)

NuGet package dependency

## Referenced By

- `Atloria.CSharpParser` (DEPENDS_ON)

<!-- source: interface-tenantcontext.md -->

# TenantContext

**Kind:** Interface

**Source:** `atloria-monorepo/libs/database/src/lib/tenant-context.ts` (line 15)

Per-request tenant context, propagated via AsyncLocalStorage.

WHY: the cross-tenant fix is enforced primarily by ResourceOrgGuard at the controller edge. This
context powers a defense-in-depth BACKSTOP in PrismaService (see tenant-backstop.ts) that detects
(and, once enabled, can enforce) tenant scoping on database queries — catching the bug class where
a service loads a row by id and forgets to check its organization.

The context is set by an HTTP middleware from the authenticated JWT. Background work (BullMQ
workers, cron, seeds, the boot-time audience seed) runs with NO context — the backstop treats an
absent context as "system" and does nothing, so it can never break a background query.

## Properties

| Property | Type |
|---|---|
| `organizationId` | `string` |
| `userId` | `string` |
| `bypass` | `boolean` |

<!-- source: constant-test.md -->

# test

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web-e2e/src/fixtures/base.fixture.ts` (line 75)

Extended test with custom fixtures

<!-- source: type-testfixtures.md -->

# TestFixtures

**Kind:** Type

**Source:** `atloria-monorepo/apps/web-e2e/src/fixtures/base.fixture.ts` (line 25)

Extended test fixtures for Atloria E2E tests

## Definition

```ts
{
  /**
   * Authenticated page - user is logged in
   */
  authenticatedPage: Page;

  /**
   * Run accessibility checks on the page
   */
  checkAccessibility: (page: Page, options?: AccessibilityOptions) => Promise<void>;

  /**
   * Test user credentials
   */
  testUser: TestUser;

  /**
   * S…
```

<!-- source: type-user.md -->

# User

**Kind:** Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `email` | `string` |
| `name` | `string` |
| `role` | `string` |
| `createdAt` | `string` |

## Referenced By

- `createUser` (REFERENCES)
- `updateUser` (REFERENCES)
- `User Management API` (TYPE_OF)
- `UserWithProfile` (EXTENDS)
- `AuthResponse` (TYPE_OF)

<!-- source: controller-userscontroller.md -->

# UsersController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/src/users/users.controller.ts` (line 29)

## Relationships

- MODULE_DECLARES → `findAll`
- MODULE_DECLARES → `findOne`
- MODULE_DECLARES → `create`
- MODULE_DECLARES → `update`
- MODULE_DECLARES → `remove`
- MODULE_DECLARES → `getUserPosts`
- MODULE_DECLARES → `getFollowers`
- DEPENDS_ON → `usersservice`

<!-- source: function-createdirectivenode.md -->

# $createDirectiveNode

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/directives/DirectiveNode.tsx` (line 147)

## Signature

```ts
function $createDirectiveNode(mdastNode: Directives, key: NodeKey): DirectiveNode
```

## Parameters

| Name | Type |
|---|---|
| `mdastNode` | `Directives` |
| `key` | `NodeKey` |

**Returns:** `DirectiveNode`

<!-- source: constant-activeeditorsubscriptions.md -->

# activeEditorSubscriptions$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 464)

<!-- source: class-addcardsdto.md -->

# AddCardsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/boards/dto/card.dto.ts` (line 3)

## Properties

| Property | Type |
|---|---|
| `issueIds` | `string[]` |
| `columnId` | `string` |

<!-- source: service-agentanalyticsservice.md -->

# AgentAnalyticsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/events/agent-analytics.service.ts` (line 28)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `agentTraffic` | `agentTraffic(projectId: string, organizationId: string, days: unknown)` | `Promise<AgentTraffic>` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: interface-agentcontextresult.md -->

# AgentContextResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/agent-context.service.ts` (line 36)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `contextSummary` | `string` |
| `userWorkflow` | `string` |
| `uiElements` | `string[]` |
| `validations` | `string[]` |
| `errorStates` | `string[]` |
| `relatedFeatures` | `string[]` |

<!-- source: controller-agentcontroller.md -->

# AgentController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/agent/agent.controller.ts` (line 12)

## Relationships

- MODULE_DECLARES → `getStatus`
- DEPENDS_ON → `agentservice`

<!-- source: interface-agentdefinition.md -->

# AgentDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/plugins/plugin-types.ts` (line 62)

A sub-agent definition contributed by a plugin.

Each `.md` file in a plugin's `agents/` directory produces one
AgentDefinition.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `instructions` | `string` |
| `tools` | `string[]` |
| `model` | `string` |

<!-- source: interface-agenterrorevent.md -->

# AgentErrorEvent

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/agent/agent.types.ts` (line 139)

## Properties

| Property | Type |
|---|---|
| `message` | `string` |
| `recoverable` | `boolean` |

<!-- source: type-agentinputitem.md -->

# AgentInputItem

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 246)

Opaque SDK input item — domain layers pass these through without interpreting.
The actual type is determined by the underlying SDK.

## Definition

```ts
unknown
```

<!-- source: class-agentsession.md -->

# AgentSession

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/session/agent-session.ts` (line 80)

Interactive agent session.

Usage:
```typescript
const session = new AgentSession(runtime, agentConfig, { maxTurns: 30 });
session.on('tool_start', (e) => console.log(`Using ${e.toolName}...`));
session.on('agent_message', (e) => console.log(e.text));

const result = await session.send('Build a login page');
const result2 = await session.send('Add password validation');
```

**Extends:** `EventEmitter`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `on` | `on(event: K, listener: (data: SessionEventMap[K]) => void)` | `this` |
| `off` | `off(event: K, listener: (data: SessionEventMap[K]) => void)` | `this` |
| `emit` | `emit(event: K, data: SessionEventMap[K])` | `boolean` |
| `send` | `send(message: string)` | `Promise<RunResult>` |
| `inject` | `inject(message: string)` | `void` |
| `cancel` | `cancel()` | `void` |
| `getState` | `getState()` | `SessionState` |
| `getHistory` | `getHistory()` | `AgentHistoryItem[]` |
| `getUsage` | `getUsage()` | `TokenUsage` |
| `getSendCount` | `getSendCount()` | `number` |
| `getTurnCount` | `getTurnCount()` | `number` |
| `getSnapshot` | `getSnapshot()` | `{ conversationHistory: AgentHistoryItem[]; sdkHistory: unknown[] }` |
| `loadHistory` | `loadHistory(conversationHistory: AgentHistoryItem[], sdkHistory: unknown[])` | `void` |
| `end` | `end()` | `void` |
| `setVerbose` | `setVerbose(enabled: boolean)` | `void` |
| `isVerbose` | `isVerbose()` | `boolean` |
| `isPlanMode` | `isPlanMode()` | `boolean` |
| `getActiveModel` | `getActiveModel()` | `string | undefined` |
| `approvePlan` | `approvePlan(feedback: string)` | `Promise<RunResult>` |
| `revisePlan` | `revisePlan(feedback: string)` | `Promise<RunResult>` |
| `fork` | `fork(branchName: string)` | `AgentSession<TContext>` |

<!-- source: module-aimodule.md -->

# AIModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/ai/ai.module.ts` (line 20)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `configmodule`
- MODULE_DECLARES → `aicontroller`
- MODULE_PROVIDES → `aiservice`
- MODULE_PROVIDES → `aiusageservice`
- MODULE_PROVIDES → `azureclaudeprovider`
- MODULE_PROVIDES → `azureopenaiprovider`
- MODULE_PROVIDES → `ratelimitguard`
- MODULE_PROVIDES → `filecontextservice`
- MODULE_PROVIDES → `codeanalysisservice`
- MODULE_PROVIDES → `uianalyzerservice`
- MODULE_PROVIDES → `playwrightgeneratorservice`
- MODULE_PROVIDES → `businesscontextparserservice`
- MODULE_EXPORTS → `aiservice`
- MODULE_EXPORTS → `aiusageservice`
- MODULE_EXPORTS → `azureclaudeprovider`
- MODULE_EXPORTS → `azureopenaiprovider`
- MODULE_EXPORTS → `filecontextservice`
- MODULE_EXPORTS → `codeanalysisservice`
- MODULE_EXPORTS → `uianalyzerservice`
- MODULE_EXPORTS → `playwrightgeneratorservice`
- MODULE_EXPORTS → `businesscontextparserservice`

<!-- source: interface-airequestlog.md -->

# AIRequestLog

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/types/ai.ts` (line 42)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `timestamp` | `Date` |
| `provider` | `AIProviderName` |
| `operation` | `'enhance' | 'outline' | 'improve' | 'summarize' | 'complete'` |
| `status` | `'success' | 'error' | 'pending'` |
| `tokensUsed` | `number` |
| `duration` | `number` |
| `errorMessage` | `string` |

<!-- source: type-analyticsprovider.md -->

# AnalyticsProvider

**Kind:** Type

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/analytics.ts` (line 8)

Analytics Engine

Config-driven analytics — supports Azure Application Insights (default),
Google Analytics 4, and Meta Pixel. No tracking until cookie consent.

## Definition

```ts
| 'azure-app-insights'
  | 'google-analytics'
  | 'meta-pixel'
  | 'none'
```

<!-- source: service-analyzerservice.md -->

# AnalyzerService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-04-analysis/analyzer.service.ts` (line 1)

<!-- source: function-analyzestatemachine.md -->

# analyzeStateMachine

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/state-machine-analyzer.ts` (line 225)

Analyze complete state machine from code

Combines enum parsing and transition extraction to build a complete
state machine definition.

## Signature

```ts
function analyzeStateMachine(code: string, enumName: string, filePath: string): StateMachine
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string` |
| `enumName` | `string` |
| `filePath` | `string` |

**Returns:** `StateMachine`

<!-- source: class-angularselectorextractor.md -->

# AngularSelectorExtractor

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/angular-selector-extractor.ts` (line 18)

Angular Selector Extractor

## Methods

| Method | Signature | Returns |
|---|---|---|
| `extractFromTemplate` | `extractFromTemplate(template: string)` | `ExtractedSelectors` |

<!-- source: constant-apidocumentationtemplate.md -->

# apiDocumentationTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/api-documentation.template.ts` (line 3)

<!-- source: interface-apiflow-2.md -->

# APIFlow

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/relationship.interface.ts` (line 406)

API flow showing component → API → service → model chain

## Properties

| Property | Type |
|---|---|
| `endpoint` | `{
    id: string;
    name: string;
    path: string;
    method: string;
  }` |
| `callers` | `Array<{
    id: string;
    name: string;
    type: string;
    filePath: string;
  }>` |
| `services` | `Array<{
    id: string;
    name: string;
    filePath: string;
  }>` |
| `models` | `Array<{
    id: string;
    name: string;
    tableName: string;
  }>` |
| `relationships` | `Relationship[]` |

<!-- source: interface-appconfig.md -->

# AppConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/config.interface.ts` (line 14)

Configuration Interfaces

Defines configuration types for the parser orchestrator system.

## Properties

| Property | Type |
|---|---|
| `port` | `number` |
| `host` | `string` |
| `environment` | `'development' | 'staging' | 'production'` |
| `debug` | `boolean` |
| `logLevel` | `'debug' | 'info' | 'warn' | 'error'` |

<!-- source: service-appservice.md -->

# AppService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/app.service.ts` (line 4)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getHealth` | `getHealth()` | `unknown` |
| `getInfo` | `getInfo()` | `unknown` |

## Relationships

- DEPENDS_ON → `storageservice`

<!-- source: interface-assemblyresult.md -->

# AssemblyResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 98)

## Properties

| Property | Type |
|---|---|
| `success` | `boolean` |
| `outputDir` | `string` |
| `filesWritten` | `string[]` |
| `errors` | `Array<{ stage: AssemblyStage; message: string; context?: Record<string, unknown> }>` |
| `warnings` | `string[]` |
| `durationMs` | `number` |

<!-- source: function-audienceslugtoscope.md -->

# audienceSlugToScope

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/project/audience-scope.util.ts` (line 21)

Map a public audience slug to its doc-set scope.
'api' → 'api' (styled API reference set); 'technical' | 'developer' → 'technical'
(code/entity reference); everything else → 'user' (end-user manual).

## Signature

```ts
function audienceSlugToScope(audienceSlug: string | null): DocAudienceScope
```

## Parameters

| Name | Type |
|---|---|
| `audienceSlug` | `string | null` |

**Returns:** `DocAudienceScope`

<!-- source: interface-authdiagnostics.md -->

# AuthDiagnostics

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/utils/ai-auth-debugger.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `phase` | `string` |
| `timestamp` | `number` |
| `screenshots` | `string[]` |
| `pageState` | `{
    url: string;
    title: string;
    hasLoginForm: boolean;
    hasPasswordField: boolean;
    errors: string[];
    alerts: Array<{ text: string; role: string }>;
    formInputsFilled: number;
    localStorageKeys: string[];
    cookieCount: number;
    pendingRequests: number;
  }` |
| `attemptLog` | `Array<{
    action: string;
    method: string;
    success: boolean;
    error?: string;
  }>` |

<!-- source: function-authenticatewithai.md -->

# authenticateWithAI

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/utils/ai-auth-debugger.ts` (line 274)

Main entry point: AI-driven authentication with automatic debugging

## Signature

```ts
async function authenticateWithAI(page: any, _context: any, config: AuthConfig, maxRetries: number): Promise<{
  success: boolean;
  diagnostics: AuthDiagnostics[];
  aiAnalysis?: any;
}>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `any` |
| `_context` | `any` |
| `config` | `AuthConfig` |
| `maxRetries` | `number` |

**Returns:** `Promise<{
  success: boolean;
  diagnostics: AuthDiagnostics[];
  aiAnalysis?: any;
}>`

<!-- source: constant-authoptions.md -->

# authOptions

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/lib/auth.ts` (line 93)

NextAuth configuration

## Definition

```ts
NextAuthOptions
```

<!-- source: function-azureruntimeconfig.md -->

# azureRuntimeConfig

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/runtime-config.ts` (line 79)

Helper: create a RuntimeConfig with defaults for Azure GPT-5.4.
Uses DEFAULT_LOOP_ENGINE (env-switchable).

## Signature

```ts
function azureRuntimeConfig(azureConfig: AzureModelProviderConfig): RuntimeConfig
```

## Parameters

| Name | Type |
|---|---|
| `azureConfig` | `AzureModelProviderConfig` |

**Returns:** `RuntimeConfig`

<!-- source: function-baselang.md -->

# baseLang

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/uiStrings.ts` (line 522)

Normalize a language code ('ar', 'ar-SA', 'AR') to its base lowercase form.

## Signature

```ts
function baseLang(lang: string | null): string
```

## Parameters

| Name | Type |
|---|---|
| `lang` | `string | null` |

**Returns:** `string`

<!-- source: class-batchrequestbuilder.md -->

# BatchRequestBuilder

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/test/helpers/batch-builder.ts` (line 19)

Builder for constructing test batch screenshot requests

Usage:
  const batch = new BatchRequestBuilder()
    .withProjectId('test-project')
    .withScreenshot({ url: 'http://localhost:3000', description: 'Test' })
    .build();

## Methods

| Method | Signature | Returns |
|---|---|---|
| `withProjectId` | `withProjectId(projectId: string)` | `this` |
| `withOrganizationId` | `withOrganizationId(organizationId: string)` | `this` |
| `withCapturedBy` | `withCapturedBy(capturedBy: string)` | `this` |
| `withName` | `withName(name: string)` | `this` |
| `withDescription` | `withDescription(description: string)` | `this` |
| `withConfig` | `withConfig(config: Partial<BatchConfigDto>)` | `this` |
| `withAuth` | `withAuth(auth: Partial<BatchAuthConfigDto>)` | `this` |
| `withScreenshot` | `withScreenshot(screenshot: Partial<BatchScreenshotItemDto>)` | `this` |
| `withScreenshots` | `withScreenshots(screenshots: Partial<BatchScreenshotItemDto>[])` | `this` |
| `build` | `build()` | `TakeBatchScreenshotsDto` |

<!-- source: interface-batchtask.md -->

# BatchTask

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/batch-screenshot.service.ts` (line 33)

Task representation for parallel execution

## Properties

| Property | Type |
|---|---|
| `index` | `number` |
| `item` | `BatchScreenshotItemDto` |
| `priority` | `number` |

<!-- source: type-boardtemplate.md -->

# BoardTemplate

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/boards/dto/create-board.dto.ts` (line 3)

## Definition

```ts
'default' | 'simple' | 'empty'
```

<!-- source: type-browsertype.md -->

# BrowserType

**Kind:** Type

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/playwright/playwright.service.ts` (line 4)

## Definition

```ts
'chromium' | 'firefox' | 'webkit'
```

<!-- source: function-buildcopywritersystemprompt.md -->

# buildCopywriterSystemPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/copywriter.prompts.ts` (line 20)

System prompt for the copywriter agent.
Establishes tone, constraints, and self-critique loop.

## Signature

```ts
function buildCopywriterSystemPrompt(config: GenerationConfig): string
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |

**Returns:** `string`

<!-- source: function-checkarialabels.md -->

# checkAriaLabels

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/accessibility.ts` (line 259)

Check ARIA labels

## Signature

```ts
async function checkAriaLabels(page: Page): Promise<{
  elementsWithoutLabels: string[];
  elementsWithLabels: number;
}>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |

**Returns:** `Promise<{
  elementsWithoutLabels: string[];
  elementsWithLabels: number;
}>`

<!-- source: component-code.md -->

# Code

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/entity/[entityId]/page.tsx` (line 51)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Code_5a818399["Code"]
    class component_Code_5a818399 rootComponent
```

## Referenced By

- `MethodsTable` (RENDERS)
- `FieldsTable` (RENDERS)
- `EntityDetailPage` (RENDERS)

<!-- source: graphql-type-comment.md -->

# Comment

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Comment on a post

## Relationships

- TYPE_OF → `User`
- TYPE_OF → `Post`
- TYPE_OF → `Comment`
- TYPE_OF → `Comment`
- TYPE_OF → `DateTime`
- TYPE_OF → `DateTime`

## Referenced By

- `addComment` (TYPE_OF)
- `newComment` (TYPE_OF)
- `Post` (TYPE_OF)
- `Comment` (TYPE_OF)
- `Comment` (TYPE_OF)

<!-- source: class-commentsidebarpage.md -->

# CommentSidebarPage

**Kind:** Class

**Source:** `atloria-monorepo/apps/web-e2e/src/pages/comments.page.ts` (line 7)

Comment sidebar page object

**Extends:** `BasePage`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `goto` | `goto()` | `Promise<void>` |
| `isVisible` | `isVisible()` | `Promise<boolean>` |
| `waitForLoad` | `waitForLoad()` | `Promise<void>` |
| `getCommentThreads` | `getCommentThreads()` | `Locator` |
| `getCommentByContent` | `getCommentByContent(content: string)` | `Locator` |
| `getCommentCount` | `getCommentCount()` | `Promise<number>` |
| `addComment` | `addComment(content: string)` | `Promise<void>` |
| `replyToComment` | `replyToComment(commentContent: string, replyContent: string)` | `Promise<void>` |
| `resolveComment` | `resolveComment(commentContent: string)` | `Promise<void>` |
| `unresolveComment` | `unresolveComment(commentContent: string)` | `Promise<void>` |
| `deleteComment` | `deleteComment(commentContent: string)` | `Promise<void>` |
| `isCommentResolved` | `isCommentResolved(commentContent: string)` | `Promise<boolean>` |
| `getActiveCommentCount` | `getActiveCommentCount()` | `Promise<number>` |
| `getResolvedCommentCount` | `getResolvedCommentCount()` | `Promise<number>` |
| `hasNoComments` | `hasNoComments()` | `Promise<boolean>` |
| `addCommentWithMention` | `addCommentWithMention(content: string, mentionUsername: string)` | `Promise<void>` |
| `getReplies` | `getReplies(commentContent: string)` | `Locator` |
| `getReplyCount` | `getReplyCount(commentContent: string)` | `Promise<number>` |

## Properties

| Property | Type |
|---|---|
| `sidebar` | `Locator` |
| `header` | `Locator` |
| `commentList` | `Locator` |
| `newCommentForm` | `Locator` |
| `commentInput` | `Locator` |
| `submitButton` | `Locator` |
| `emptyState` | `Locator` |
| `activeCount` | `Locator` |
| `resolvedCount` | `Locator` |
| `loadingSpinner` | `Locator` |

<!-- source: type-configformat.md -->

# ConfigFormat

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/storybook/types.ts` (line 14)

Configuration format detected

## Definition

```ts
'storybook' | 'ladle' | 'atloria' | 'none'
```

<!-- source: type-connectionstatus.md -->

# ConnectionStatus

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/hooks/useCollaboration.ts` (line 59)

Connection status for the collaboration session

## Definition

```ts
'connecting' | 'connected' | 'disconnected' | 'error'
```

<!-- source: interface-contentsafetyconfig.md -->

# ContentSafetyConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/guardrails/content-safety.guardrail.ts` (line 43)

## Properties

| Property | Type |
|---|---|
| `checkFabricatedStats` | `boolean` |
| `checkDefamation` | `boolean` |
| `checkLegalClaims` | `boolean` |
| `checkFakeTestimonials` | `boolean` |

<!-- source: function-copysections.md -->

# copySections

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/copy.ts` (line 35)

Copy selected section .tsx files and their shared component dependencies
to the output directory.

## Signature

```ts
async function copySections(resolvedSections: ManifestSection[], componentLibraryDir: string, outputDir: string): Promise<string[]>
```

## Parameters

| Name | Type |
|---|---|
| `resolvedSections` | `ManifestSection[]` |
| `componentLibraryDir` | `string` |
| `outputDir` | `string` |

**Returns:** `Promise<string[]>`

<!-- source: api-endpoint-create-2.md -->

# create

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.controller.ts` (line 101)

## Endpoint

`POST /suggestions`

## Referenced By

- `SuggestionController` (MODULE_DECLARES)
- `SuggestionAliasController` (MODULE_DECLARES)

<!-- source: function-createauthenticatedbatch.md -->

# createAuthenticatedBatch

**Kind:** Function

**Source:** `atloria-monorepo/apps/screenshot-worker/test/helpers/batch-builder.ts` (line 323)

Helper function to create an authenticated batch request

## Signature

```ts
function createAuthenticatedBatch(urls: string[], auth: {
    loginUrl: string;
    username: string;
    password: string;
    usernameSelector?: string;
    passwordSelector?: string;
    submitSelector?: string;
  }, options: {
    projectId?: string;
    organizationId?: string;
  }): TakeBatchScreenshotsDto
```

## Parameters

| Name | Type |
|---|---|
| `urls` | `string[]` |
| `auth` | `{
    loginUrl: string;
    username: string;
    password: string;
    usernameSelector?: string;
    passwordSelector?: string;
    submitSelector?: string;
  }` |
| `options` | `{
    projectId?: string;
    organizationId?: string;
  }` |

**Returns:** `TakeBatchScreenshotsDto`

<!-- source: function-createmockparser.md -->

# createMockParser

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 92)

Create a mock parser for testing

## Signature

```ts
function createMockParser(name: string, patterns: string[], parseResult: Partial<ParseResult>): IParser
```

## Parameters

| Name | Type |
|---|---|
| `name` | `string` |
| `patterns` | `string[]` |
| `parseResult` | `Partial<ParseResult>` |

**Returns:** `IParser`

<!-- source: graphql-mutation-createuser.md -->

# createUser

**Kind:** Graphql Mutation

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Create a new user

## Relationships

- TYPE_OF → `User`
- TYPE_OF → `CreateUserInput`

## Referenced By

- `Mutation` (CALLS_API)

<!-- source: api-endpoint-createuser.md -->

# createUser

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

Create a new user

## Endpoint

`POST /users`

## Relationships

- REFERENCES → `CreateUser`
- REFERENCES → `User`
- REFERENCES → `Error`
- REFERENCES → `Error`

## Referenced By

- `User Management API` (IMPLEMENTS_API)

<!-- source: constant-default-blocked-patterns.md -->

# DEFAULT_BLOCKED_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/tools/bash.tool.ts` (line 55)

## Definition

```ts
RegExp[]
```

<!-- source: constant-default-retry-config.md -->

# DEFAULT_RETRY_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/retry-handler.service.ts` (line 22)

Default retry configuration

## Definition

```ts
RetryConfig
```

<!-- source: enum-diffchangetype.md -->

# DiffChangeType

**Kind:** Enum

**Source:** `atloria-monorepo/apps/api/src/document/dto/compare-document.dto.ts` (line 44)

Diff change types emitted by the document comparison service.

NOTE: `MODIFIED` is retained for backward compatibility with older clients
but is no longer produced by `calculateTextDiff`. The new LCS-based diff
emits every edited line as a paired `REMOVED` + `ADDED` entry so the old
and new content are both preserved on the response.

## Values

- `ADDED`
- `REMOVED`
- `UNCHANGED`
- `MODIFIED`

<!-- source: controller-discoverycontroller.md -->

# DiscoveryController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/discovery/discovery.controller.ts` (line 5)

## Relationships

- MODULE_DECLARES → `scan`
- DEPENDS_ON → `discoveryservice`

<!-- source: class-djangoparser-2.md -->

# DjangoParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/backend/django.parser.ts` (line 48)

Django REST Framework Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: type-docsearchfn.md -->

# DocSearchFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/tools/query-docs.tool.ts` (line 15)

Search function signature — matches AzureSearchService.search() shape.
Injected at tool creation time.

## Definition

```ts
(
  query: string,
  projectId: string,
  maxResults?: number
) => Promise<DocSearchResult[]>
```

<!-- source: enum-documentstate.md -->

# DocumentState

**Kind:** Enum

**Source:** `atloria-monorepo/packages/types/src/enums/index.ts` (line 55)

Document state tracks the lifecycle stage of a document

## Values

- `DRAFT`
- `REVIEW`
- `PUBLISHED`
- `OUTDATED`

<!-- source: enum-entitytype-3.md -->

# EntityType

**Kind:** Enum

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 16)

Entity types that can be discovered by parsers

## Values

- `COMPONENT`
- `HOOK`
- `PAGE`
- `LAYOUT`
- `ROUTE`
- `CONTEXT`
- `PROVIDER`
- `STORE`
- `STATE_ACTION`
- `STATE_REDUCER`
- `STATE_SELECTOR`
- `STATE_MIDDLEWARE`
- `STATE_EFFECT`
- `STATE_STORE`
- `CONTROLLER`
- `SERVICE`
- `REPOSITORY`
- `MIDDLEWARE`
- `GUARD`
- `INTERCEPTOR`
- `PIPE`
- `MODULE`
- `EVENT_HANDLER`
- `JOB_PROCESSOR`
- `API_ENDPOINT`
- `GRAPHQL_QUERY`
- `GRAPHQL_MUTATION`
- `GRAPHQL_SUBSCRIPTION`
- `GRAPHQL_TYPE`
- `RPC_METHOD`
- `WEBSOCKET_ENDPOINT`
- `DATABASE_MODEL`
- `DATABASE_MIGRATION`
- `DATABASE_SEED`
- `DATABASE_VIEW`
- `DATABASE_PROCEDURE`
- `DOCKER_SERVICE`
- `K8S_DEPLOYMENT`
- `K8S_SERVICE`
- `K8S_CONFIGMAP`
- `TERRAFORM_RESOURCE`
- `CI_WORKFLOW`
- `MARKDOWN_DOC`
- `API_SCHEMA`
- `DOC_COMMENT`
- `ENV_VARIABLE`
- `CONFIG_FILE`
- `FEATURE_FLAG`
- `CLASS`
- `FUNCTION`

<!-- source: type-error.md -->

# Error

**Kind:** Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

## Properties

| Property | Type |
|---|---|
| `statusCode` | `integer` |
| `message` | `string` |
| `error` | `string` |

## Referenced By

- `createUser` (REFERENCES)
- `createUser` (REFERENCES)
- `getUserById` (REFERENCES)
- `User Management API` (TYPE_OF)

<!-- source: function-extractdefaultvalue.md -->

# extractDefaultValue

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 258)

Extract default value as a string representation

## Signature

```ts
function extractDefaultValue(node: t.Node): string
```

## Parameters

| Name | Type |
|---|---|
| `node` | `t.Node` |

**Returns:** `string`

<!-- source: class-fastapiparser.md -->

# FastAPIParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/backend-parser/src/parsers/fastapi.parser.ts` (line 41)

FastAPI Parser implementation

Uses regex-based parsing for Python files since we can't use Python AST directly in Node.js

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: type-fetchcategoriesfn.md -->

# FetchCategoriesFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/tools/query-product-knowledge.tool.ts` (line 43)

Fetch the document category tree for a project.

## Definition

```ts
(
  projectId: string,
) => Promise<ProductCategory[]>
```

<!-- source: class-filesystemprovider.md -->

# FileSystemProvider

**Kind:** Class

**Source:** `atloria-monorepo/apps/cli/src/providers/filesystem.provider.ts` (line 19)

File system data provider
Reads from local JSON files in outputDir

**Implements:** `DataProvider`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: DataProviderConfig)` | `Promise<void>` |
| `getProjectMetadata` | `getProjectMetadata()` | `Promise<ProjectMetadata>` |
| `getEntities` | `getEntities()` | `Promise<Entity[]>` |
| `getEntitiesByType` | `getEntitiesByType(type: string)` | `Promise<Entity[]>` |
| `getEntityById` | `getEntityById(id: string)` | `Promise<Entity | null>` |
| `getRelationships` | `getRelationships()` | `Promise<Relationship[]>` |
| `getRelationshipsForEntity` | `getRelationshipsForEntity(entityId: string)` | `Promise<Relationship[]>` |
| `saveParseResults` | `saveParseResults(results: ParseResult[], project: DetectedProject)` | `Promise<void>` |
| `destroy` | `destroy()` | `Promise<void>` |

<!-- source: function-generaterelationshipid.md -->

# generateRelationshipId

**Kind:** Function

**Source:** `atloria-monorepo/apps/database-parser/src/utils/hash.util.ts` (line 35)

Generate a relationship ID

## Signature

```ts
function generateRelationshipId(sourceId: string, type: string, targetId: string): string
```

## Parameters

| Name | Type |
|---|---|
| `sourceId` | `string` |
| `type` | `string` |
| `targetId` | `string` |

**Returns:** `string`

<!-- source: api-endpoint-gethealth.md -->

# getHealth

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/app.controller.ts` (line 11)

Health check endpoint

## Endpoint

`GET /`

## Referenced By

- `AppController` (MODULE_DECLARES)

<!-- source: api-endpoint-getjobstatus-4.md -->

# getJobStatus

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/analysis/analysis.controller.ts` (line 62)

Get analysis job status

GET /api/analysis/:jobId

Returns:
{
  "id": "uuid",
  "status": "analyzing" | "completed" | "failed",
  "progress": 75,
  "repoUrl": "...",
  "branch": "main",
  "folderPath": "packages/frontend",
  "framework": "react",
  "routesFound": 25,
  "componentsFound": 150,
  "modalsFound": 12,
  "createdAt": "2024-01-01T00:00:00Z",
  "completedAt": "2024-01-01T00:05:00Z"
}

## Endpoint

`GET /analysis/:jobId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `jobId` | query | `string` | ✓ |

## Referenced By

- `AnalysisController` (MODULE_DECLARES)

<!-- source: function-gettenantcontext.md -->

# getTenantContext

**Kind:** Function

**Source:** `atloria-monorepo/libs/database/src/lib/tenant-context.ts` (line 35)

The current request's tenant context, or undefined when running outside a request (system).

## Signature

```ts
function getTenantContext(): TenantContext | undefined
```

**Returns:** `TenantContext | undefined`

<!-- source: module-gitmodule.md -->

# GitModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/git/git.module.ts` (line 4)

## Relationships

- MODULE_PROVIDES → `gitservice`
- MODULE_EXPORTS → `gitservice`

<!-- source: service-gitservice.md -->

# GitService

**Kind:** Service

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/git/git.service.ts` (line 35)

Git service for cloning repositories with mono-repo support

Features:
- Shallow clones for speed (depth=1 by default)
- Support for specific branches
- Mono-repo folder path support
- Automatic cleanup of old clones
- Git authentication via tokens (for private repos)

`GitService` is a NestJS backend service responsible for cloning Git repositories to a local workspace for analysis, with built-in support for mono-repo subfolder targeting. It optimizes cloning via shallow clones (default `depth=1`), supports selecting specific branches, and handles authentication for private repositories via tokens. It also manages lifecycle concerns like cleaning up old clones to keep disk usage under control.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `clone` | `clone(options: CloneOptions)` | `Promise<CloneResult>` |
| `cleanup` | `cleanup(clonePath: string)` | `Promise<void>` |
| `cleanupOld` | `cleanupOld()` | `Promise<void>` |
| `checkGitInstalled` | `checkGitInstalled()` | `Promise<boolean>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  actor Caller as Analyzer/Controller
  participant GitService as GitService
  participant FS as Local FS
  participant Git as Git CLI/Library
  participant Cleanup as Cleanup Job

  Caller->>GitService: clone({ repoUrl, branch?, token?, depth=1, monoRepoPath? })
  GitService->>Cleanup: cleanupOldClones()
  Cleanup->>FS: delete stale clone dirs
  GitService->>Git: git clone --depth=1 (--branch <branch>) <repoUrl> <targetDir>
  alt Private repo (token provided)
    GitService->>Git: inject auth (token in URL/headers)
  end
  Git->>FS: write working tree to <targetDir>
  alt monoRepoPath provided
    GitService->>FS: resolve <targetDir>/<monoRepoPath>
    GitService-->>Caller: return path to mono-repo subfolder
  else
    GitService-->>Caller: return path to repo root
  end
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { GitService } from './git.service';

@Injectable()
export class RepoAnalysisService {
  constructor(private readonly git: GitService) {}

  async analyze() {
    const localPath = await this.git.clone({
      repoUrl: 'https://github.com/acme/atloria-monorepo.git',
      branch: 'main',
      depth: 1, // shallow clone for speed (default behavior)
      monoRepoPath: 'apps/code-analyzer', // optional: target subfolder within a mono-repo
      token: process.env.GITHUB_TOKEN, // optional: required for private repos
    });

    // Use localPath as the root for scanning/analysis
    // e.g., await this.scanner.scan(localPath);
    return { localPath };
  }
}
```

## AI Coding Instructions

- Prefer shallow clones (`depth=1`) unless the feature explicitly needs history; increasing depth can dramatically impact performance and disk usage.
- When adding auth changes, ensure tokens are never logged and are not written to disk (avoid persisting tokenized URLs in config files).
- Treat `monoRepoPath` as a resolved, validated subdirectory of the clone target to avoid path traversal or accidental analysis of the wrong folder.
- Keep cleanup idempotent and safe: only delete within the managed clones directory, and never remove user-provided paths outside that root.
- Integration point: callers should rely on the returned local path (repo root or mono-repo subfolder) and avoid assuming directory structure before `clone()` resolves it.

<!-- source: module-knowledgegraphmodule.md -->

# KnowledgeGraphModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/knowledge-graph/kg.module.ts` (line 16)

## Relationships

- MODULE_IMPORTS → `configmodule`
- MODULE_PROVIDES → `knowledgegraphservice`
- MODULE_PROVIDES → `kgsyncservice`
- MODULE_EXPORTS → `knowledgegraphservice`
- MODULE_EXPORTS → `kgsyncservice`

<!-- source: service-knowledgegraphservice.md -->

# KnowledgeGraphService

**Kind:** Service

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/knowledge-graph/kg.service.ts` (line 24)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `isConnected` | `isConnected()` | `boolean` |
| `onModuleInit` | `onModuleInit()` | `unknown` |
| `onModuleDestroy` | `onModuleDestroy()` | `unknown` |
| `upsertEntity` | `upsertEntity(entity: Entity)` | `Promise<void>` |
| `upsertBatch` | `upsertBatch(entities: Entity[])` | `Promise<void>` |
| `getEntity` | `getEntity(id: string)` | `Promise<Entity | null>` |
| `getEntitiesByType` | `getEntitiesByType(type: EntityType, limit: unknown)` | `Promise<Entity[]>` |
| `deleteEntity` | `deleteEntity(id: string)` | `Promise<void>` |
| `createRelationship` | `createRelationship(relationship: Relationship)` | `Promise<void>` |
| `createRelationshipsBatch` | `createRelationshipsBatch(relationships: Relationship[])` | `Promise<void>` |
| `getRelationships` | `getRelationships(entityId: string)` | `Promise<Relationship[]>` |
| `deleteRelationship` | `deleteRelationship(relationshipId: string)` | `Promise<void>` |
| `getComponentDependencies` | `getComponentDependencies(componentId: string, depth: unknown)` | `Promise<DependencyTree | null>` |
| `getAPIFlow` | `getAPIFlow(endpointId: string)` | `Promise<APIFlow | null>` |
| `query` | `query(cypher: string, params: Record<string, unknown>)` | `Promise<any[]>` |
| `clearAll` | `clearAll()` | `Promise<void>` |
| `getStatistics` | `getStatistics()` | `Promise<{
    totalNodes: number;
    totalRelationships: number;
    nodesByLabel: Record<string, number>;
    relationshipsByType: Record<string, number>;
  }>` |

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: constant-known-projects.md -->

# KNOWN_PROJECTS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/pme-agent/test/discovery/ground-truth.ts` (line 25)

## Definition

```ts
ProjectInfo[]
```

<!-- source: class-markdownparser.md -->

# MarkdownParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/config-docs-parser/src/parsers/markdown.parser.ts` (line 62)

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: graphql-subscription-newpost.md -->

# newPost

**Kind:** Graphql Subscription

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Subscribe to new posts from followed users

## Relationships

- TYPE_OF → `Post`

## Referenced By

- `Subscription` (CALLS_API)

<!-- source: class-openapiparser.md -->

# OpenAPIParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/api-schema-parser/src/parsers/openapi.parser.ts` (line 38)

OpenAPI Parser Implementation

Supports:
- OpenAPI 3.0.x and 3.1.x
- Swagger 2.0
- JSON and YAML formats

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: class-parseprojectdto.md -->

# ParseProjectDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/dto/parse-job.dto.ts` (line 75)

DTO for parsing an entire project

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `parsers` | `string[]` |
| `includePatterns` | `string[]` |
| `excludePatterns` | `string[]` |
| `incremental` | `boolean` |
| `maxFiles` | `number` |
| `parallel` | `boolean` |
| `metadata` | `Record<string, unknown>` |

<!-- source: constant-parse-queue-name.md -->

# PARSE_QUEUE_NAME

**Kind:** Constant

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/queue/constants.ts` (line 7)

Queue Constants

<!-- source: enum-parsercategory.md -->

# ParserCategory

**Kind:** Enum

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/parser.interface.ts` (line 118)

Parser category for grouping

## Values

- `FRONTEND`
- `BACKEND`
- `DATABASE`
- `API_SCHEMA`
- `CONFIG`
- `DOCUMENTATION`
- `INFRASTRUCTURE`

<!-- source: module-pdfmodule.md -->

# PdfModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/pdf/pdf.module.ts` (line 6)

## Relationships

- MODULE_IMPORTS → `playwrightmodule`
- MODULE_DECLARES → `pdfcontroller`
- MODULE_PROVIDES → `pdfservice`
- MODULE_EXPORTS → `pdfservice`

<!-- source: interface-performancemetrics.md -->

# PerformanceMetrics

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/performance.ts` (line 24)

Performance metrics result

## Properties

| Property | Type |
|---|---|
| `ttfb` | `number` |
| `fcp` | `number` |
| `domContentLoaded` | `number` |
| `load` | `number` |
| `lcp` | `number` |
| `cls` | `number` |
| `resourceCount` | `number` |
| `totalSize` | `number` |
| `jsHeapSize` | `number` |
| `domNodes` | `number` |

<!-- source: class-pmemetricscollector.md -->

# PmeMetricsCollector

**Kind:** Class

**Source:** `atloria-monorepo/libs/pme-core/src/tracing/pme-metrics.ts` (line 33)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `recordJob` | `recordJob(status: string)` | `void` |
| `recordQaScore` | `recordQaScore(sectionType: string, score: number)` | `void` |
| `recordVariantSelection` | `recordVariantSelection(variantKey: string)` | `void` |
| `recordGenerationTime` | `recordGenerationTime(durationMs: number)` | `void` |
| `recordSectionType` | `recordSectionType(sectionType: string)` | `void` |
| `recordTokenUsage` | `recordTokenUsage(inputTokens: number, outputTokens: number)` | `void` |
| `getMetrics` | `getMetrics()` | `PmeMetrics` |
| `toPrometheus` | `toPrometheus()` | `string` |

<!-- source: interface-propinfo.md -->

# PropInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 31)

Information about a prop definition

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `required` | `boolean` |
| `defaultValue` | `string` |
| `description` | `string` |

<!-- source: class-reactparser.md -->

# ReactParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/frontend-parser/src/parsers/react.parser.ts` (line 76)

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `version` | `string` |
| `supportedPatterns` | `string[]` |

<!-- source: graphql-query-searchusers.md -->

# searchUsers

**Kind:** Graphql Query

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Search users by name or email

## Relationships

- TYPE_OF → `User`

## Referenced By

- `Query` (CALLS_API)

<!-- source: class-sequelizeparser.md -->

# SequelizeParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/database-parser/src/parsers/sequelize.parser.ts` (line 25)

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: component-statcard.md -->

# StatCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/frontend/src/components/StatCard.tsx` (line 15)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `label` | `any` | ✓ | - |
| `value` | `any` | ✓ | - |
| `icon` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StatCard_b56783e["StatCard"]
    class component_StatCard_b56783e rootComponent
```

<!-- source: component-stepcard.md -->

# StepCard

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/how-it-works/how-it-works-timeline.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `step` | `Step` | ✓ | - |
| `t` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StepCard_3fd6c6ab["StepCard"]
    class component_StepCard_3fd6c6ab rootComponent
```

## Relationships

- RENDERS → `Icon`

## Referenced By

- `HowItWorksTimeline` (RENDERS)

<!-- source: interface-targetingtask.md -->

# TargetingTask

**Kind:** Interface

**Source:** `atloria-monorepo/apps/pme-agent/test/discovery/ground-truth.ts` (line 152)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `task` | `string` |
| `expectedProjects` | `string[]` |
| `expectedFiles` | `string[]` |
| `expectedKeywords` | `string[]` |

<!-- source: page-terms.md -->

# terms

**Kind:** Page

**Source:** `atloria-monorepo/templates/site-bootstrap/src/App.tsx`

<!-- source: constant-theme-presets-3.md -->

# THEME_PRESETS

**Kind:** Constant

**Source:** `atloria-monorepo/libs/pme-core/src/tools/theme.ts` (line 93)

## Definition

```ts
Record<ThemeMode, ThemeVars>
```

<!-- source: component-treeitem.md -->

# TreeItem

**Kind:** Component

**Source:** `atloria-monorepo/packages/ui-react/src/components/NavigationTree.tsx` (line 59)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `node` | `DocumentTreeNode` | ✓ | - |
| `level` | `number` | ✓ | - |
| `activeId` | `string` | - | - |
| `expandedIds` | `string[]` | ✓ | - |
| `onToggleExpand` | `Function` | ✓ | - |
| `onItemClick` | `Function` | - | - |
| `showStateIndicator` | `boolean` | - | - |
| `focusedId` | `string | null` | ✓ | - |
| `onFocusChange` | `Function` | ✓ | - |
| `onKeyDown` | `Function` | ✓ | - |
| `itemRefs` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TreeItem_636541b4["TreeItem"]
    class component_TreeItem_636541b4 rootComponent
```

## Relationships

- RENDERS → `TreeItem`
- USES_HOOK → `useCallback`

## Referenced By

- `TreeItem` (RENDERS)
- `NavigationTree` (RENDERS)

<!-- source: type-wcaglevel.md -->

# WCAGLevel

**Kind:** Type

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/accessibility.ts` (line 7)

WCAG conformance levels

## Definition

```ts
'A' | 'AA' | 'AAA'
```

<!-- source: constant-web-vitals-thresholds.md -->

# WEB_VITALS_THRESHOLDS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/performance.ts` (line 6)

Web Vitals thresholds (based on Google's guidelines)

<!-- source: function-createlexicaljsxnode.md -->

# $createLexicalJsxNode

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/LexicalJsxNode.tsx` (line 144)

## Signature

```ts
function $createLexicalJsxNode(mdastNode: MdastJsx, importStatement: ImportStatement): LexicalJsxNode
```

## Parameters

| Name | Type |
|---|---|
| `mdastNode` | `MdastJsx` |
| `importStatement` | `ImportStatement` |

**Returns:** `LexicalJsxNode`

<!-- source: constant-activeplugins.md -->

# activePlugins$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 911)

The names of the plugins that are currently active.

<!-- source: class-addmemberdto.md -->

# AddMemberDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/add-member.dto.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `userId` | `string` |
| `role` | `UserRole` |

<!-- source: interface-agentexecutionconfig.md -->

# AgentExecutionConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/support-agent/agent-adapter.service.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `organizationId` | `string` |
| `projectName` | `string` |
| `agentName` | `string` |
| `systemPrompt` | `string` |
| `workspace` | `string` |
| `language` | `string` |
| `conversationHistory` | `Array<{ role: string; content: string }>` |

<!-- source: interface-agenthistoryitem.md -->

# AgentHistoryItem

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 148)

## Properties

| Property | Type |
|---|---|
| `role` | `'user' | 'assistant' | 'tool'` |
| `content` | `string` |
| `agentName` | `string` |
| `toolName` | `string` |

<!-- source: type-agentprotocoleventhandler.md -->

# AgentProtocolEventHandler

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/protocol/agent-protocol.ts` (line 92)

Handler signature used by SessionEventBridge listeners

## Definition

```ts
(
  event: AgentProtocolEvent<T>,
) => void
```

<!-- source: service-agentregenservice.md -->

# AgentRegenService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/docs-pr/agent-regen.service.ts` (line 37)

Rung-2 — behavior-aware regeneration. For a change that alters BEHAVIOR without altering the
public signature (a new guard clause → 409, a changed default, a new error path) — which the
deterministic Rung-1 renderer can't see — an autonomous agent reads the actual changed code and
rewrites the page to reflect current behavior; a verifier then scores confidence.

Guardrails (this writes behavioral claims into real PRs, so it is conservative):
 - OFF by default (env `DOCS_PR_RUNG2` !== 'true') → returns null, caller uses Rung-1.
 - confidence below τ, empty output, or ANY error → returns null (fall back to Rung-1).
Mirrors the proven doc-automation agent-writer/verifier pattern (agent-core AgentSession).

NOT yet wired into the live docs-pr path — that needs Phase A (escalation trigger + a
clone at PR time) and the Phase C eval before turn-on. See docs/rung-2-investigate-spec.md.

`AgentRegenService` provides conservative, behavior-aware documentation regeneration for pull requests. When enabled, it uses an autonomous agent to inspect changed implementation code and rewrite documentation for behavior changes that deterministic rendering cannot detect, then validates the result with a confidence score. It returns `null` for disabled execution, low-confidence output, empty results, or errors so callers can safely fall back to the Rung-1 renderer.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `regenerate` | `regenerate(input: AgentRegenInput, optedIn: unknown)` | `Promise<AgentRegenResult | null>` |

## Diagram

```mermaid
sequenceDiagram
  participant Caller as Docs PR Pipeline
  participant Regen as AgentRegenService
  participant Agent as AgentSession
  participant Verifier as Confidence Verifier
  participant Rung1 as Deterministic Rung-1 Renderer

  Caller->>Regen: regenerate(change context)
  Regen->>Regen: Check DOCS_PR_RUNG2

  alt Rung-2 disabled
    Regen-->>Caller: null
    Caller->>Rung1: Render deterministic documentation
  else Rung-2 enabled
    Regen->>Agent: Read changed code and rewrite page
    Agent-->>Regen: Proposed documentation

    alt Empty output or agent error
      Regen-->>Caller: null
      Caller->>Rung1: Render deterministic documentation
    else Documentation generated
      Regen->>Verifier: Score behavioral accuracy/confidence
      Verifier-->>Regen: Confidence score

      alt Confidence below threshold
        Regen-->>Caller: null
        Caller->>Rung1: Render deterministic documentation
      else Confidence accepted
        Regen-->>Caller: Regenerated documentation
      end
    end
  end
```

## Usage

```ts
import { AgentRegenService } from './agent-regen.service';

async function regenerateDocs(
  agentRegenService: AgentRegenService,
  changeContext: {
    existingPage: string;
    changedFiles: string[];
    diff: string;
  },
) {
  const rung2Page = await agentRegenService.regenerate(changeContext);

  // Rung-2 intentionally returns null when disabled, uncertain, or unsuccessful.
  if (rung2Page === null) {
    return renderWithRung1(changeContext);
  }

  return rung2Page;
}

function renderWithRung1(context: { existingPage: string }) {
  return context.existingPage;
}
```

## AI Coding Instructions

- Keep Rung-2 opt-in: preserve the `DOCS_PR_RUNG2 === 'true'` gate and treat all other values as disabled.
- Return `null` for every unsafe outcome, including agent failures, verifier failures, empty generated content, and confidence scores below the configured threshold.
- Do not let agent-generated documentation bypass verification; behavioral claims must be confidence-scored before they can be used in a PR.
- Callers must handle `null` as an expected result and fall back to the deterministic Rung-1 renderer.
- This service is not yet connected to the live docs-PR path; integrate it only after adding the Phase A escalation trigger/PR-time clone flow and completing the Phase C evaluation.

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: interface-agentscreenshotspec.md -->

# AgentScreenshotSpec

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/agent-screenshot-mapper.ts` (line 74)

Screenshot spec produced by agent analysis — ready for worker

## Properties

| Property | Type |
|---|---|
| `placeholderId` | `string` |
| `description` | `string` |
| `url` | `string` |
| `confidence` | `'exact' | 'inferred'` |
| `matchedRoute` | `string` |
| `actions` | `ScreenshotAction[]` |
| `waitForSelector` | `string` |
| `viewport` | `{ width: number; height: number }` |
| `stateType` | `'default' | 'hover' | 'modal' | 'error' | 'success'` |
| `category` | `string` |

<!-- source: controller-aicontroller.md -->

# AIController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/ai/ai.controller.ts` (line 29)

## Relationships

- MODULE_DECLARES → `usageLogs`
- MODULE_DECLARES → `enhance`
- MODULE_DECLARES → `generateOutline`
- MODULE_DECLARES → `improve`
- MODULE_DECLARES → `summarize`
- MODULE_DECLARES → `listProviders`
- DEPENDS_ON → `aiservice`
- DEPENDS_ON → `aiusageservice`

<!-- source: class-aiderpolyglotadapter.md -->

# AiderPolyglotAdapter

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/aider-adapter.ts` (line 49)

**Implements:** `BenchmarkAdapter`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `loadTasks` | `loadTasks(config: BenchmarkRunConfig)` | `Promise<BenchmarkTask[]>` |
| `setupTask` | `setupTask(task: BenchmarkTask, workDir: string)` | `Promise<void>` |
| `buildPrompt` | `buildPrompt(task: BenchmarkTask)` | `string` |
| `evaluate` | `evaluate(task: BenchmarkTask, workDir: string)` | `Promise<{ passed: boolean; details: string }>` |
| `cleanup` | `cleanup(_task: BenchmarkTask, workDir: string)` | `Promise<void>` |

<!-- source: interface-aisettings.md -->

# AISettings

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/types/ai.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `defaultProvider` | `AIProviderName` |
| `maxTokens` | `number` |
| `temperature` | `number` |
| `enableStreaming` | `boolean` |
| `autoSave` | `boolean` |

<!-- source: module-analyticsmodule.md -->

# AnalyticsModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.module.ts` (line 13)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `emailmodule`
- MODULE_DECLARES → `analyticscontroller`
- MODULE_DECLARES → `analyticsexportcontroller`
- MODULE_PROVIDES → `analyticsservice`
- MODULE_PROVIDES → `feedbackservice`
- MODULE_PROVIDES → `analyticsexportservice`
- MODULE_PROVIDES → `scheduledreportsservice`
- MODULE_EXPORTS → `analyticsservice`
- MODULE_EXPORTS → `feedbackservice`
- MODULE_EXPORTS → `analyticsexportservice`
- MODULE_EXPORTS → `scheduledreportsservice`

<!-- source: function-analyzetemplate.md -->

# analyzeTemplate

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/template-analyzer.ts` (line 41)

Main entry point: Analyze a template and extract structured data

## Signature

```ts
function analyzeTemplate(templateContent: string, framework: 'angular' | 'vue' | 'react'): TemplateAnalysis
```

## Parameters

| Name | Type |
|---|---|
| `templateContent` | `string` |
| `framework` | `'angular' | 'vue' | 'react'` |

**Returns:** `TemplateAnalysis`

<!-- source: class-apicallmapper.md -->

# APICallMapper

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/api-call-mapper.ts` (line 80)

API Call Mapper

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectAPICalls` | `detectAPICalls(entities: Entity[])` | `DetectedAPICall[]` |
| `detectEndpoints` | `detectEndpoints(entities: Entity[])` | `DetectedEndpoint[]` |
| `mapCallsToEndpoints` | `mapCallsToEndpoints(calls: DetectedAPICall[], endpoints: DetectedEndpoint[])` | `APIMapping[]` |

<!-- source: interface-apiflowdiagramoptions.md -->

# APIFlowDiagramOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/api-flow-diagram.generator.ts` (line 21)

Options for API flow diagram generation

## Properties

| Property | Type |
|---|---|
| `diagramType` | `'flowchart' | 'sequence'` |
| `showHttpMethods` | `boolean` |
| `showParameters` | `boolean` |
| `showMiddleware` | `boolean` |
| `direction` | `'LR' | 'TD' | 'RL' | 'BT'` |
| `maxDepth` | `number` |
| `includeTheme` | `boolean` |

<!-- source: constant-apiratelimitingtemplate.md -->

# apiRateLimitingTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/api-rate-limiting.template.ts` (line 3)

<!-- source: type-astnode.md -->

# ASTNode

**Kind:** Type

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 82)

Union type of all AST nodes

## Definition

```ts
TextNode | AudienceNode | VariantNode | BlockDefinitionNode | IncludeNode
```

<!-- source: service-authcontextservice.md -->

# AuthContextService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/auth-context.service.ts` (line 15)

Service for authenticated browser-context lifecycle.

Extracted verbatim from BatchScreenshotService so that batch capture,
flow-replay (WS-A) and clip capture (WS-B) can all share ONE implementation
of login / session-loss detection / re-auth without forking it.

`AuthContextService` owns the lifecycle of authenticated browser contexts for screenshot-worker capture jobs. It centralizes login, session validation, session-loss detection, and re-authentication so batch screenshots, flow replay, and clip capture use the same authentication behavior without duplicating browser-session logic.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createAuthenticatedContext` | `createAuthenticatedContext(browser: Browser, auth: BatchAuthConfigDto, config: Required<BatchConfigDto>, locale: string)` | `Promise<BrowserContext>` |
| `isSessionLost` | `isSessionLost(page: Page, auth: BatchAuthConfigDto, targetUrl: string)` | `Promise<boolean>` |
| `reAuthenticate` | `reAuthenticate(context: BrowserContext, auth: BatchAuthConfigDto, config: Required<BatchConfigDto>)` | `Promise<void>` |

## Diagram

```mermaid
sequenceDiagram
    participant Caller as Capture Service
    participant Auth as AuthContextService
    participant Browser as Browser Context
    participant App as Target Application

    Caller->>Auth: acquireAuthenticatedContext(credentials)
    Auth->>Browser: Create or reuse browser context
    Auth->>App: Check existing session

    alt Session is valid
        App-->>Auth: Authenticated session detected
    else Session missing or expired
        Auth->>App: Perform login flow
        App-->>Auth: Session established
    end

    Auth-->>Caller: Authenticated browser context
    Caller->>App: Run screenshot / replay / clip capture

    alt Session loss detected during capture
        Caller->>Auth: Re-authenticate context
        Auth->>App: Perform login flow again
        Auth-->>Caller: Refreshed authenticated context
    end
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { AuthContextService } from './services/auth-context.service';

@Injectable()
export class BatchCaptureService {
  constructor(
    private readonly authContextService: AuthContextService,
  ) {}

  async captureScreenshot(job: ScreenshotJob) {
    const context = await this.authContextService.acquireAuthenticatedContext({
      loginUrl: job.loginUrl,
      username: job.username,
      password: job.password,
    });

    try {
      const page = await context.newPage();

      await page.goto(job.targetUrl, { waitUntil: 'networkidle' });

      // Re-authenticate when the target application redirects to login
      // or otherwise indicates that the session has expired.
      if (await this.authContextService.isSessionLost(page)) {
        await this.authContextService.reauthenticate(context, job.credentials);
        await page.goto(job.targetUrl, { waitUntil: 'networkidle' });
      }

      return await page.screenshot({ fullPage: true });
    } finally {
      await context.close();
    }
  }
}
```

## AI Coding Instructions

- Use `AuthContextService` for every authenticated browser workflow; do not implement login or session-expiry handling independently in batch, flow-replay, or clip services.
- Check for session loss after navigation and before capture-sensitive actions, especially when target applications can redirect to a login page.
- Keep browser-context ownership clear: callers should close contexts/pages they acquire unless the service explicitly manages pooled or reused contexts.
- Preserve the shared authentication contract when adding new capture modes so login credentials, session checks, and re-authentication remain consistent.
- Avoid treating a successful page load as proof of authentication; use the service’s session-detection logic for application-specific validation.

<!-- source: interface-authenticationinfo.md -->

# AuthenticationInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 570)

Authentication information

## Properties

| Property | Type |
|---|---|
| `type` | `'jwt' | 'oauth' | 'api-key' | 'basic' | 'bearer' | 'none'` |
| `scopes` | `string[]` |
| `optional` | `boolean` |

<!-- source: type-authresponse.md -->

# AuthResponse

**Kind:** Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

## Properties

| Property | Type |
|---|---|
| `accessToken` | `string` |
| `refreshToken` | `string` |
| `user` | `User` |

## Relationships

- TYPE_OF → `User`

## Referenced By

- `login` (REFERENCES)
- `User Management API` (TYPE_OF)

<!-- source: class-batchscreenshotitemdto.md -->

# BatchScreenshotItemDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 346)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `description` | `string` |
| `url` | `string` |
| `expectedState` | `string` |
| `viewport` | `ViewportDto` |
| `fullPage` | `boolean` |
| `waitFor` | `WaitForDto` |
| `waitForSelector` | `string` |
| `waitForTimeout` | `number` |
| `actions` | `ScreenshotActionDto[]` |
| `stateType` | `StateType` |
| `category` | `string` |
| `clip` | `ClipDto` |
| `metadata` | `Record<string, unknown>` |
| `timing` | `TimingConfigDto` |
| `data` | `DataConfigDto` |
| `interaction` | `InteractionConfigDto` |
| `error` | `ErrorConfigDto` |
| `componentHints` | `ComponentHintsDto` |
| `flowStepId` | `string` |
| `priority` | `number` |
| `stateResolution` | `StateResolutionConfigDto` |
| `parentPlaceholderId` | `string` |
| `sequenceOrder` | `number` |

<!-- source: function-benchreportcommand.md -->

# benchReportCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/bench.command.ts` (line 198)

## Signature

```ts
async function benchReportCommand(reportPath: string): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `reportPath` | `string` |

**Returns:** `Promise<void>`

<!-- source: interface-benchrunoptions.md -->

# BenchRunOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/commands/bench.command.ts` (line 32)

## Properties

| Property | Type |
|---|---|
| `preset` | `'starter' | 'full'` |
| `tasks` | `string` |
| `maxTasks` | `string` |
| `parallel` | `string` |
| `maxTurns` | `string` |
| `timeout` | `string` |
| `output` | `string` |
| `model` | `string` |
| `repoDir` | `string` |
| `costLimit` | `string` |
| `attempts` | `string` |
| `provider` | `'azure' | 'anthropic'` |

<!-- source: interface-boxpct.md -->

# BoxPct

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/crop.service.ts` (line 11)

Pure geometry + image helpers shared by the clip-capture (WS-B) flow.

These are intentionally framework-free pure functions (no Playwright, no Nest
DI) so they can be unit-tested in isolation and reused by any workstream.

## Properties

| Property | Type |
|---|---|
| `x` | `number` |
| `y` | `number` |
| `w` | `number` |
| `h` | `number` |

<!-- source: function-breachof.md -->

# breachOf

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 242)

## Signature

```ts
function breachOf(v: CountValue | undefined): number
```

## Parameters

| Name | Type |
|---|---|
| `v` | `CountValue | undefined` |

**Returns:** `number`

<!-- source: function-buildadaptiveprompt.md -->

# buildAdaptivePrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/adaptive-prompt.ts` (line 52)

## Signature

```ts
function buildAdaptivePrompt(options: AdaptivePromptOptions): string
```

## Parameters

| Name | Type |
|---|---|
| `options` | `AdaptivePromptOptions` |

**Returns:** `string`

<!-- source: function-buildapiexecutor.md -->

# buildApiExecutor

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/mcp/api-executor.ts` (line 44)

## Signature

```ts
function buildApiExecutor(cfg: ApiExecutorConfig): ApiExecFn
```

## Parameters

| Name | Type |
|---|---|
| `cfg` | `ApiExecutorConfig` |

**Returns:** `ApiExecFn`

<!-- source: function-buildlayoutsystemprompt.md -->

# buildLayoutSystemPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/layout.prompts.ts` (line 10)

## Signature

```ts
function buildLayoutSystemPrompt(): string
```

**Returns:** `string`

<!-- source: type-captureaction.md -->

# CaptureAction

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/capture/dto/create-flow.dto.ts` (line 16)

## Definition

```ts
(typeof CAPTURE_ACTIONS)[number]
```

<!-- source: constant-category-labels.md -->

# CATEGORY_LABELS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/components/Boards/helpers.ts` (line 36)

## Definition

```ts
Record<string, string>
```

<!-- source: interface-categorymeta.md -->

# CategoryMeta

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 115)

## Properties

| Property | Type |
|---|---|
| `required` | `boolean` |
| `maxPick` | `number` |

<!-- source: component-cell.md -->

# Cell

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/table/TableEditor.tsx` (line 319)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `align` | `any` | ✓ | - |
| `...props` | `object` | - | - |

## Diagram

```mermaid
graph TD
    component_Cell_6cdf5d6c["Cell"]
    class component_Cell_6cdf5d6c rootComponent
```

## Relationships

- RENDERS → `CellElement`
- RENDERS → `CellEditor`

## Referenced By

- `TableEditor` (RENDERS)

<!-- source: function-checkcolorcontrast.md -->

# checkColorContrast

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/accessibility.ts` (line 200)

Check color contrast

## Signature

```ts
async function checkColorContrast(page: Page, selector: string): Promise<{
  foreground: string;
  background: string;
  ratio: number;
  passes: boolean;
}>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |
| `selector` | `string` |

**Returns:** `Promise<{
  foreground: string;
  background: string;
  ratio: number;
  passes: boolean;
}>`

<!-- source: service-chunkerservice.md -->

# ChunkerService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-02-chunking/chunker.service.ts` (line 1)

<!-- source: type-connectiontype.md -->

# ConnectionType

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/deployment-diagram.generator.ts` (line 57)

Connection types between deployment nodes

## Definition

```ts
'http' | 'https' | 'grpc' | 'tcp' | 'websocket' | 'database' | 'message-queue'
```

<!-- source: interface-coordinatordependencies.md -->

# CoordinatorDependencies

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/agents/coordinator.agent.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `searchFn` | `DocSearchFn` |
| `generateFn` | `ContentGenerateFn` |
| `storeFn` | `StoreAssetFn` |
| `generateImageFn` | `ImageGenerateFn` |
| `findScreenshotsFn` | `FindScreenshotsFn` |

<!-- source: function-copytemplate.md -->

# copyTemplate

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/copy.ts` (line 18)

Copy the entire site-bootstrap template to outputDir,
excluding node_modules and other non-essential files.

## Signature

```ts
async function copyTemplate(templateDir: string, outputDir: string): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `templateDir` | `string` |
| `outputDir` | `string` |

**Returns:** `Promise<void>`

<!-- source: type-countvalue.md -->

# CountValue

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 71)

counts values are numbers per contract; we tolerate {count, breach} if the backend enriches later

## Definition

```ts
number | { count: number; breach?: number }
```

<!-- source: api-endpoint-create-3.md -->

# create

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.controller.ts` (line 101)

## Endpoint

`POST /suggestions`

## Referenced By

- `SuggestionController` (MODULE_DECLARES)
- `SuggestionAliasController` (MODULE_DECLARES)

<!-- source: function-createsimplebatch.md -->

# createSimpleBatch

**Kind:** Function

**Source:** `atloria-monorepo/apps/screenshot-worker/test/helpers/batch-builder.ts` (line 295)

Helper function to create a simple batch request

## Signature

```ts
function createSimpleBatch(urls: string[], options: {
    projectId?: string;
    organizationId?: string;
    config?: Partial<BatchConfigDto>;
  }): TakeBatchScreenshotsDto
```

## Parameters

| Name | Type |
|---|---|
| `urls` | `string[]` |
| `options` | `{
    projectId?: string;
    organizationId?: string;
    config?: Partial<BatchConfigDto>;
  }` |

**Returns:** `TakeBatchScreenshotsDto`

<!-- source: constant-default-loop-engine.md -->

# DEFAULT_LOOP_ENGINE

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/runtime-config.ts` (line 72)

Default loop engine. Set to 'live-swe' to use the Live-SWE-agent loop
(79% SWE-bench) by default, or 'openai-sdk' for the SDK-based loop.

Can be overridden per-call via RuntimeConfig.loop.engine or via
ATLORIA_LOOP_ENGINE environment variable.

## Definition

```ts
LoopConfig['engine']
```

<!-- source: graphql-mutation-deletepost.md -->

# deletePost

**Kind:** Graphql Mutation

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Delete a post

## Referenced By

- `Mutation` (CALLS_API)

<!-- source: api-endpoint-deleteuser.md -->

# deleteUser

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

Delete user

## Endpoint

`DELETE /users/{id}`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `User Management API` (IMPLEMENTS_API)

<!-- source: function-destroyallparsers.md -->

# destroyAllParsers

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/queue/processors/parser-registry.ts` (line 146)

Cleanup all parser instances

## Signature

```ts
async function destroyAllParsers(): Promise<void>
```

**Returns:** `Promise<void>`

<!-- source: class-djangotemplateparser.md -->

# DjangoTemplateParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/backend/django-template.parser.ts` (line 71)

Django Template Parser

Extracts entities and relationships from Django template files.

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: { rootDir: string })` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: class-documenteditpage.md -->

# DocumentEditPage

**Kind:** Class

**Source:** `atloria-monorepo/apps/web-e2e/src/pages/documents.page.ts` (line 141)

Document edit page object

**Extends:** `BasePage`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `goto` | `goto(documentId: string)` | `Promise<void>` |
| `setTitle` | `setTitle(title: string)` | `Promise<void>` |
| `getTitle` | `getTitle()` | `Promise<string>` |
| `setContent` | `setContent(content: string)` | `Promise<void>` |
| `getContent` | `getContent()` | `Promise<string>` |
| `waitForSave` | `waitForSave()` | `Promise<void>` |
| `clickDone` | `clickDone()` | `Promise<void>` |
| `setType` | `setType(type: string)` | `Promise<void>` |
| `setSlug` | `setSlug(slug: string)` | `Promise<void>` |
| `toggleAudience` | `toggleAudience(audience: string)` | `Promise<void>` |
| `openSettings` | `openSettings()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `titleInput` | `Locator` |
| `editor` | `Locator` |
| `saveStatus` | `Locator` |
| `doneButton` | `Locator` |
| `settingsButton` | `Locator` |
| `typeSelect` | `Locator` |
| `slugInput` | `Locator` |

<!-- source: enum-documenttype.md -->

# DocumentType

**Kind:** Enum

**Source:** `atloria-monorepo/packages/types/src/enums/index.ts` (line 20)

Document types define the nature of the documentation

## Values

- `MANUAL`
- `GENERATED`
- `HYBRID`
- `WIKI`
- `API_GUIDE`
- `USER_MANUAL`
- `SOP`

<!-- source: enum-entitytype-2.md -->

# EntityType

**Kind:** Enum

**Source:** `atloria-monorepo/apps/api/src/graph/interfaces/entity.interface.ts` (line 1)

## Values

- `FEATURE`
- `API`
- `COMPONENT`
- `USER_STORY`
- `BUG`
- `REQUIREMENT`
- `FUNCTION`
- `CLASS`
- `MODULE`

<!-- source: function-extractexportednamesfromdeclaration.md -->

# extractExportedNamesFromDeclaration

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 386)

Extract exported names from export declarations

## Signature

```ts
function extractExportedNamesFromDeclaration(path: NodePath<t.ExportNamedDeclaration | t.ExportDefaultDeclaration>): Set<string>
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath<t.ExportNamedDeclaration | t.ExportDefaultDeclaration>` |

**Returns:** `Set<string>`

<!-- source: type-faqlayout.md -->

# FaqLayout

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 18)

## Definition

```ts
'accordion' | 'two-column'
```

<!-- source: type-fetchfeaturesfn.md -->

# FetchFeaturesFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/tools/query-product-knowledge.tool.ts` (line 31)

Fetch user-facing features for a project (from doc-automation Stage 3 output or KG).

## Definition

```ts
(
  projectId: string,
  options?: { limit?: number; minConfidence?: number },
) => Promise<ProductFeature[]>
```

<!-- source: constant-fixture-pages.md -->

# FIXTURE_PAGES

**Kind:** Constant

**Source:** `atloria-monorepo/apps/screenshot-worker/test/fixtures/pages/index.ts` (line 9)

Test fixture pages for screenshot testing

<!-- source: type-flowaction.md -->

# FlowAction

**Kind:** Type

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/flow-replay.dto.ts` (line 42)

## Definition

```ts
(typeof FLOW_ACTIONS)[number]
```

<!-- source: graphql-type-follow.md -->

# Follow

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Follow relationship

## Relationships

- TYPE_OF → `User`
- TYPE_OF → `User`
- TYPE_OF → `DateTime`

## Referenced By

- `followUser` (TYPE_OF)
- `newFollower` (TYPE_OF)
- `User` (TYPE_OF)
- `User` (TYPE_OF)

<!-- source: api-endpoint-getinfo.md -->

# getInfo

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/app.controller.ts` (line 19)

Service info endpoint

## Endpoint

`GET /info`

## Referenced By

- `AppController` (MODULE_DECLARES)

<!-- source: api-endpoint-getprojectjobs-2.md -->

# getProjectJobs

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/analysis/analysis.controller.ts` (line 74)

Get all analysis jobs for a project

GET /api/analysis/project/:projectId

Returns: [ { ...job }, { ...job } ]

## Endpoint

`GET /analysis/project/:projectId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `AnalysisController` (MODULE_DECLARES)

<!-- source: class-mdxgenerator.md -->

# MdxGenerator

**Kind:** Class

**Source:** `atloria-monorepo/apps/cli/src/generators/mdx.generator.ts` (line 82)

MDX Generator class
Generates MDX documentation from entities

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generate` | `generate()` | `Promise<void>` |
| `generateContent` | `generateContent()` | `Promise<{ pages: DocPage[]; navigation: NavItem[] }>` |

<!-- source: class-mdxparser.md -->

# MdxParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/config-docs-parser/src/parsers/mdx.parser.ts` (line 60)

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: class-nestjsparser.md -->

# NestjsParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/backend-parser/src/parsers/nestjs.parser.ts` (line 67)

NestJS Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: module-orchestratormodule.md -->

# OrchestratorModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/orchestrator.module.ts` (line 17)

## Relationships

- MODULE_IMPORTS → `queuemodule`
- MODULE_IMPORTS → `knowledgegraphmodule`
- MODULE_DECLARES → `orchestratorcontroller`
- MODULE_PROVIDES → `orchestratorservice`
- MODULE_EXPORTS → `orchestratorservice`

<!-- source: service-orchestratorservice.md -->

# OrchestratorService

**Kind:** Service

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/orchestrator.service.ts` (line 43)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `dispatchParseJob` | `dispatchParseJob(options: {
    projectId: string;
    files: string[];
    parserType: string;
    config?: Record<string, unknown>;
    priority?: number;
  })` | `Promise<string>` |
| `parseProject` | `parseProject(config: ParseProjectConfig)` | `Promise<ProjectParseResult>` |
| `getJobStatus` | `getJobStatus(jobId: string)` | `Promise<JobStatus | null>` |
| `getResult` | `getResult(jobId: string)` | `Promise<ParseResult[] | null>` |
| `cancelJob` | `cancelJob(jobId: string)` | `Promise<boolean>` |
| `getQueueMetrics` | `getQueueMetrics()` | `unknown` |
| `getKGStatistics` | `getKGStatistics()` | `unknown` |
| `determineParser` | `determineParser(filePath: string)` | `string | null` |
| `getAvailableParsers` | `getAvailableParsers()` | `string[]` |
| `getParserPatterns` | `getParserPatterns(parser: string)` | `string[] | null` |

## Relationships

- DEPENDS_ON → `configservice`
- DEPENDS_ON → `queueservice`
- DEPENDS_ON → `knowledgegraphservice`
- DEPENDS_ON → `kgsyncservice`

<!-- source: enum-parsercategory-2.md -->

# ParserCategory

**Kind:** Enum

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/parser.interface.ts` (line 117)

Parser category for grouping

## Values

- `FRONTEND`
- `BACKEND`
- `DATABASE`
- `API_SCHEMA`
- `CONFIG`
- `DOCUMENTATION`
- `INFRASTRUCTURE`

<!-- source: class-parseresultdto.md -->

# ParseResultDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/dto/parse-job.dto.ts` (line 147)

DTO for parse result response

## Properties

| Property | Type |
|---|---|
| `jobId` | `string` |
| `status` | `string` |
| `entitiesCount` | `number` |
| `relationshipsCount` | `number` |
| `duration` | `number` |

<!-- source: enum-parsestatus.md -->

# ParseStatus

**Kind:** Enum

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/parse-result.interface.ts` (line 18)

Status of a parse operation

## Values

- `SUCCESS`
- `PARTIAL`
- `FAILED`
- `SKIPPED`
- `IN_PROGRESS`
- `QUEUED`

<!-- source: controller-pdfcontroller.md -->

# PdfController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/pdf/pdf.controller.ts` (line 16)

## Relationships

- MODULE_DECLARES → `renderPdf`
- DEPENDS_ON → `pdfservice`

<!-- source: module-playwrightmodule.md -->

# PlaywrightModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/playwright/playwright.module.ts` (line 4)

## Relationships

- MODULE_PROVIDES → `playwrightservice`
- MODULE_EXPORTS → `playwrightservice`

<!-- source: constant-pme-job-options.md -->

# PME_JOB_OPTIONS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/pme-agent/src/queue/constants.ts` (line 3)

<!-- source: class-pmeturnhook.md -->

# PmeTurnHook

**Kind:** Class

**Source:** `atloria-monorepo/libs/pme-core/src/context/pme-turn-hook.ts` (line 127)

**Implements:** `TurnHook`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `beforeModelCall` | `beforeModelCall(args: TurnHookArgs<PmeContext>)` | `Promise<{ instructions?: string; input?: unknown[] }>` |

## Properties

| Property | Type |
|---|---|
| `compactionLog` | `Array<{
    turn: number;
    beforeTokens: number;
    afterTokens: number;
    truncatedResults: number;
  }>` |

<!-- source: constant-project-fixtures.md -->

# PROJECT_FIXTURES

**Kind:** Constant

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 28)

Project fixture paths

<!-- source: function-runwithtenantbypass.md -->

# runWithTenantBypass

**Kind:** Function

**Source:** `atloria-monorepo/libs/database/src/lib/tenant-context.ts` (line 43)

Run `fn` with tenant scoping explicitly bypassed. Use for a deliberate cross-org read inside a
request. If there is no active context this is a no-op passthrough.

## Signature

```ts
function runWithTenantBypass(fn: () => T): T
```

## Parameters

| Name | Type |
|---|---|
| `fn` | `() => T` |

**Returns:** `T`

<!-- source: component-stepcircle.md -->

# StepCircle

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/how-it-works/how-it-works-timeline.tsx` (line 43)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `num` | `number` | ✓ | - |
| `variant` | `unknown | unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StepCircle_5a4f7255["StepCircle"]
    class component_StepCircle_5a4f7255 rootComponent
```

## Referenced By

- `HowItWorksTimeline` (RENDERS)

<!-- source: interface-testcollaborationsession.md -->

# TestCollaborationSession

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 202)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `documentId` | `string` |
| `users` | `{
    id: string;
    name: string;
    color: string;
    cursor?: { x: number; y: number };
  }[]` |
| `createdAt` | `string` |

<!-- source: class-typeormparser.md -->

# TypeORMParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/database-parser/src/parsers/typeorm.parser.ts` (line 25)

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: graphql-query-user.md -->

# user

**Kind:** Graphql Query

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Get a user by ID

## Relationships

- TYPE_OF → `User`

## Referenced By

- `Query` (CALLS_API)

<!-- source: component-userprofile.md -->

# UserProfile

**Kind:** Component

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/frontend/src/components/UserProfile.tsx` (line 33)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `userId` | `any` | ✓ | - |
| `showStats` | `any` | - | true |
| `onProfileLoad` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_UserProfile_131907c4["UserProfile"]
    class component_UserProfile_131907c4 rootComponent
```

## Relationships

- RENDERS → `LoadingSpinner`
- RENDERS → `Avatar`
- RENDERS → `StatCard`
- USES_HOOK → `useAuth`
- USES_HOOK → `useState`
- USES_HOOK → `useQuery`
- USES_HOOK → `useEffect`

<!-- source: constant-variant-styles.md -->

# VARIANT_STYLES

**Kind:** Constant

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/variant.prompts.ts` (line 18)

## Definition

```ts
VariantStyle[]
```

<!-- source: component-videoembed.md -->

# VideoEmbed

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 471)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `embedUrl` | `string` | ✓ | - |
| `provider` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_VideoEmbed_432f8f5f["VideoEmbed"]
    class component_VideoEmbed_432f8f5f rootComponent
```

## Referenced By

- `CustomDiv` (RENDERS)
- `CustomLink` (RENDERS)
- `CustomImage` (RENDERS)

<!-- source: class-vueparser.md -->

# VueParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/frontend-parser/src/parsers/vue.parser.ts` (line 76)

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `version` | `string` |
| `supportedPatterns` | `string[]` |

<!-- source: function-iscodeblocknode.md -->

# $isCodeBlockNode

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/CodeBlockNode.tsx` (line 284)

## Signature

```ts
function $isCodeBlockNode(node: LexicalNode | null | undefined): node is CodeBlockNode
```

## Parameters

| Name | Type |
|---|---|
| `node` | `LexicalNode | null | undefined` |

**Returns:** `node is CodeBlockNode`

<!-- source: component-actionbutton.md -->

# ActionButton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/common/ErrorState.tsx` (line 84)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `href` | `string` | ✓ | - |
| `label` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ActionButton_9f189["ActionButton"]
    class component_ActionButton_9f189 rootComponent
```

## Relationships

- USES_HOOK → `useRouter`

## Referenced By

- `ErrorContent` (RENDERS)
- `ErrorState` (RENDERS)

<!-- source: constant-addactiveplugin.md -->

# addActivePlugin$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 917)

Add a plugin name to the list of active plugins.

<!-- source: interface-agentexecutionresult.md -->

# AgentExecutionResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/support-agent/agent-adapter.service.ts` (line 35)

## Properties

| Property | Type |
|---|---|
| `response` | `string` |
| `toolCalls` | `Array<{ tool: string; input: any; result: any }>` |

<!-- source: interface-agentmodelsettings.md -->

# AgentModelSettings

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 35)

## Properties

| Property | Type |
|---|---|
| `temperature` | `number` |
| `topP` | `number` |
| `maxTokens` | `number` |
| `frequencyPenalty` | `number` |
| `presencePenalty` | `number` |
| `toolChoice` | `'auto' | 'required' | 'none'` |
| `parallelToolCalls` | `boolean` |
| `reasoningEffort` | `'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh'` |

<!-- source: type-agentprotocoleventtype.md -->

# AgentProtocolEventType

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/protocol/agent-protocol.ts` (line 82)

All canonical protocol event names

## Definition

```ts
keyof AgentProtocolEventMap
```

<!-- source: service-agentservice.md -->

# AgentService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/agent/agent.service.ts` (line 84)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createSession` | `createSession(socketId: string, payload: AgentStartPayload)` | `Promise<ManagedSession>` |
| `getSession` | `getSession(socketId: string)` | `ManagedSession | undefined` |
| `destroySession` | `destroySession(socketId: string)` | `void` |
| `getActiveSessionCount` | `getActiveSessionCount()` | `number` |

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: interface-aggregatedresult.md -->

# AggregatedResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/batched-screenshot-processor.ts` (line 56)

## Properties

| Property | Type |
|---|---|
| `totalCaptured` | `number` |
| `totalFailed` | `number` |
| `totalReplaced` | `number` |
| `totalDocumentsUpdated` | `number` |
| `batchesCompleted` | `number` |
| `totalBatches` | `number` |
| `cancelled` | `boolean` |

<!-- source: interface-aiusagestats.md -->

# AIUsageStats

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/types/ai.ts` (line 27)

## Properties

| Property | Type |
|---|---|
| `totalRequests` | `number` |
| `requestsToday` | `number` |
| `requestsThisWeek` | `number` |
| `requestsThisMonth` | `number` |
| `tokenUsage` | `{
    total: number;
    today: number;
    thisWeek: number;
    thisMonth: number;
  }` |
| `topProvider` | `AIProviderName` |
| `lastRequestAt` | `Date` |

<!-- source: controller-analyticscontroller.md -->

# AnalyticsController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 9)

## Relationships

- MODULE_DECLARES → `track`
- MODULE_DECLARES → `getOverview`
- MODULE_DECLARES → `getVersionTraffic`
- MODULE_DECLARES → `getTopDocuments`
- MODULE_DECLARES → `getTopSearchQueries`
- MODULE_DECLARES → `getDailyTraffic`
- MODULE_DECLARES → `getDeviceBreakdown`
- MODULE_DECLARES → `getSourceBreakdown`
- MODULE_DECLARES → `getGeoBreakdown`
- MODULE_DECLARES → `getZeroResultSearches`
- MODULE_DECLARES → `getGhostDocs`
- MODULE_DECLARES → `getTrendingDocs`
- MODULE_DECLARES → `getScrollHistogram`
- MODULE_DECLARES → `submitFeedback`
- MODULE_DECLARES → `getFeedbackSummary`
- DEPENDS_ON → `analyticsservice`
- DEPENDS_ON → `feedbackservice`

<!-- source: function-analyzevuetemplate.md -->

# analyzeVueTemplate

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/template-analyzer.ts` (line 609)

Analyze Vue template section

## Signature

```ts
function analyzeVueTemplate(templateContent: string): TemplateAnalysis
```

## Parameters

| Name | Type |
|---|---|
| `templateContent` | `string` |

**Returns:** `TemplateAnalysis`

<!-- source: class-anthropicmodel.md -->

# AnthropicModel

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/anthropic-adapter.ts` (line 107)

**Implements:** `Model`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getResponse` | `getResponse(request: ModelRequest)` | `Promise<ModelResponse>` |
| `getStreamedResponse` | `getStreamedResponse(request: ModelRequest)` | `AsyncIterable<import('@openai/agents').ResponseStreamEvent>` |
| `getRetryAdvice` | `getRetryAdvice(args: ModelRetryAdviceRequest)` | `ModelRetryAdvice | undefined` |

<!-- source: class-apierror-2.md -->

# APIError

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/types/errors.ts` (line 4)

Base API error class

**Extends:** `Error`

<!-- source: interface-apiflowdiagramresult.md -->

# APIFlowDiagramResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/api-flow-diagram.generator.ts` (line 68)

Result of API flow diagram generation

## Properties

| Property | Type |
|---|---|
| `mermaidCode` | `string` |
| `stats` | `{
    /** Number of frontend callers */
    callerCount: number;
    /** Number of services involved */
    serviceCount: number;
    /** Number of database models accessed */
    modelCount: number;
    /** Total nodes in diagram */
    totalNodes: number;
    /** Total edges/relationships */
    totalEdges: number;
  }` |
| `cssClasses` | `string[]` |

<!-- source: constant-apiversioningtemplate.md -->

# apiVersioningTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/api-versioning.template.ts` (line 3)

<!-- source: module-appmodule-3.md -->

# AppModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/app/app.module.ts` (line 60)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `throttlingmodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `githubmodule`
- MODULE_IMPORTS → `gitlabmodule`
- MODULE_IMPORTS → `bitbucketmodule`
- MODULE_IMPORTS → `gatewaymodule`
- MODULE_IMPORTS → `collaborationmodule`
- MODULE_IMPORTS → `activitymodule`
- MODULE_IMPORTS → `notificationmodule`
- MODULE_IMPORTS → `assetsmodule`
- MODULE_IMPORTS → `audiencemodule`
- MODULE_IMPORTS → `commentmodule`
- MODULE_IMPORTS → `suggestionmodule`
- MODULE_IMPORTS → `documentmodule`
- MODULE_IMPORTS → `documentationmodule`
- MODULE_IMPORTS → `templatemodule`
- MODULE_IMPORTS → `projectmodule`
- MODULE_IMPORTS → `organizationmodule`
- MODULE_IMPORTS → `invitationmodule`
- MODULE_IMPORTS → `dashboardmodule`
- MODULE_IMPORTS → `aimodule`
- MODULE_IMPORTS → `billingmodule`
- MODULE_IMPORTS → `parsermodule`
- MODULE_IMPORTS → `parsingmodule`
- MODULE_IMPORTS → `graphmodule`
- MODULE_IMPORTS → `screenshotmodule`
- MODULE_IMPORTS → `technicaldocsmodule`
- MODULE_IMPORTS → `docsprtriggermodule`
- MODULE_IMPORTS → `docsprmodule`
- MODULE_IMPORTS → `eventsmodule`
- MODULE_IMPORTS → `githubappmodule`
- MODULE_IMPORTS → `trialmodule`
- MODULE_IMPORTS → `opsmodule`
- MODULE_IMPORTS → `supportagentmodule`
- MODULE_IMPORTS → `pmemodule`
- MODULE_IMPORTS → `agentmodule`
- MODULE_IMPORTS → `docversionmodule`
- MODULE_IMPORTS → `webhookmodule`
- MODULE_IMPORTS → `analyticsmodule`
- MODULE_IMPORTS → `auditmodule`
- MODULE_IMPORTS → `brandingmodule`
- MODULE_IMPORTS → `issuesmodule`
- MODULE_IMPORTS → `boardsmodule`
- MODULE_IMPORTS → `manualsinsightsmodule`
- MODULE_IMPORTS → `capturemodule`
- MODULE_IMPORTS → `docsrepomodule`
- MODULE_IMPORTS → `changerequestmodule`
- MODULE_DECLARES → `appcontroller`
- MODULE_PROVIDES → `appservice`

<!-- source: type-audiencelogictree.md -->

# AudienceLogicTree

**Kind:** Type

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 98)

Audience logic expression tree
Used for evaluating complex audience conditions

## Definition

```ts
AudienceLeaf | AudienceNotNode | AudienceAndNode | AudienceOrNode
```

<!-- source: graphql-type-authpayload.md -->

# AuthPayload

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Authentication payload

## Relationships

- TYPE_OF → `User`

## Referenced By

- `login` (TYPE_OF)
- `refreshToken` (TYPE_OF)

<!-- source: class-authresponsedto.md -->

# AuthResponseDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/auth/dto/auth-response.dto.ts` (line 50)

## Properties

| Property | Type |
|---|---|
| `accessToken` | `string` |
| `refreshToken` | `string` |
| `tokenType` | `any` |
| `expiresIn` | `number` |
| `user` | `UserResponseDto` |

<!-- source: interface-authstate.md -->

# AuthState

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/frontend/src/hooks/useAuth.ts` (line 10)

## Properties

| Property | Type |
|---|---|
| `isAuthenticated` | `boolean` |
| `user` | `{ id: string; email: string } | null` |
| `token` | `string | null` |

<!-- source: class-batchscreenshotjobresponsedto.md -->

# BatchScreenshotJobResponseDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 673)

Initial response after creating a batch screenshot job

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `status` | `JobStatus` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `name` | `string` |
| `totalUrls` | `number` |
| `capturedUrls` | `number` |
| `failedUrls` | `number` |
| `progress` | `number` |
| `createdAt` | `Date` |
| `updatedAt` | `Date` |
| `completedAt` | `Date` |
| `error` | `string` |

<!-- source: service-batchscreenshotservice.md -->

# BatchScreenshotService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/batch-screenshot.service.ts` (line 87)

Service for batch screenshot processing

Orchestrates:
- Parallel task execution with concurrency limits
- Authentication session management
- Retry logic with exponential backoff
- Progress tracking and caching
- Content deduplication

`BatchScreenshotService` coordinates batch screenshot generation in the screenshot worker. It manages authenticated browser sessions, executes screenshot tasks with bounded concurrency, retries transient failures using exponential backoff, and records cached progress while deduplicating equivalent content.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createJob` | `createJob(request: TakeBatchScreenshotsDto)` | `Promise<BatchScreenshotJobResponseDto>` |
| `processBatch` | `processBatch(request: TakeBatchScreenshotsDto)` | `Promise<BatchScreenshotJobResponseDto>` |
| `getJobStatus` | `getJobStatus(jobId: string, organizationId: string)` | `Promise<BatchScreenshotStatusDto | null>` |

## Diagram

```mermaid
sequenceDiagram
  participant Client
  participant Service as BatchScreenshotService
  participant Cache as Progress/Cache Store
  participant Auth as Authentication Session
  participant Worker as Screenshot Worker
  participant Browser as Browser/Page

  Client->>Service: processBatch(tasks)
  Service->>Cache: Load batch progress and cached results
  Service->>Service: Deduplicate content/tasks
  Service->>Auth: Create or reuse authenticated session

  loop Until all unique tasks are processed
    Service->>Worker: Start task (within concurrency limit)
    Worker->>Browser: Navigate and capture screenshot

    alt Screenshot succeeds
      Browser-->>Worker: Screenshot result
      Worker-->>Service: Completed result
      Service->>Cache: Store result and update progress
    else Transient failure
      Browser-->>Worker: Error
      Worker-->>Service: Failed attempt
      Service->>Service: Wait with exponential backoff
      Service->>Worker: Retry task
    else Retries exhausted
      Worker-->>Service: Final failure
      Service->>Cache: Record failed progress state
    end
  end

  Service-->>Client: Batch processing summary
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { BatchScreenshotService } from './screenshot/services/batch-screenshot.service';

@Injectable()
export class ScreenshotJobProcessor {
  constructor(
    private readonly batchScreenshotService: BatchScreenshotService,
  ) {}

  async processScreenshots() {
    const result = await this.batchScreenshotService.processBatch([
      {
        id: 'homepage',
        url: 'https://example.com',
        viewport: { width: 1440, height: 900 },
      },
      {
        id: 'dashboard',
        url: 'https://example.com/dashboard',
        viewport: { width: 1440, height: 900 },
      },
    ]);

    return {
      completed: result.completed,
      failed: result.failed,
      cached: result.cached,
    };
  }
}
```

## AI Coding Instructions

- Preserve bounded concurrency when adding new task types; do not create unbounded `Promise.all()` workloads for large batches.
- Reuse the service's authentication-session lifecycle rather than creating a new browser login session per screenshot.
- Treat retryable browser, navigation, and network errors separately from permanent validation errors; retain exponential backoff behavior.
- Update progress/cache state for successful, cached, and terminally failed tasks so interrupted batches can be resumed safely.
- Ensure deduplication keys include all screenshot-affecting inputs, such as URL, viewport, authentication context, and rendering options.

## Relationships

- DEPENDS_ON → `playwrightservice`
- DEPENDS_ON → `storageservice`
- DEPENDS_ON → `screenshotmetadataservice`
- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `redisservice`
- DEPENDS_ON → `retryhandlerservice`
- DEPENDS_ON → `actionexecutorservice`
- DEPENDS_ON → `stateresolverservice`
- DEPENDS_ON → `authcontextservice`
- DEPENDS_ON → `pagesettleservice`
- DEPENDS_ON → `configservice`
- DEPENDS_ON → `discoveryservice`

<!-- source: function-benchruncommand.md -->

# benchRunCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/bench.command.ts` (line 49)

## Signature

```ts
async function benchRunCommand(options: BenchRunOptions): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `BenchRunOptions` |

**Returns:** `Promise<void>`

<!-- source: interface-boxpct-2.md -->

# BoxPct

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/annotation-emitter.service.ts` (line 6)

Target box as PERCENT (0-100) of the natural image, top-left origin.

## Properties

| Property | Type |
|---|---|
| `x` | `number` |
| `y` | `number` |
| `w` | `number` |
| `h` | `number` |

<!-- source: function-buildautonomousinstructions.md -->

# buildAutonomousInstructions

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/autonomous-loop.ts` (line 94)

Build the autonomous investigation-verify loop instructions.

This generates a system prompt section — not a complete system prompt.
Domain layers combine it with their own base instructions + tool usage guide.

The prompt teaches the agent to:
1. Investigate before acting (read files, explore structure, check config)
2. Prefer existing tools/scripts over writing from scratch
3. Plan based on what it discovers (not on assumptions)
4. Verify after every significant action
5. Loop until quality gates pass

## Signature

```ts
function buildAutonomousInstructions(options: AutonomousInstructionsOptions): string
```

## Parameters

| Name | Type |
|---|---|
| `options` | `AutonomousInstructionsOptions` |

**Returns:** `string`

<!-- source: function-buildcollectionurl.md -->

# buildCollectionUrl

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/url-utils.ts` (line 66)

Build a collection URL from components

## Signature

```ts
function buildCollectionUrl(slug: string, urlId: string): string
```

## Parameters

| Name | Type |
|---|---|
| `slug` | `string` |
| `urlId` | `string` |

**Returns:** `string`

<!-- source: function-buildcompleteprompt.md -->

# buildCompletePrompt

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/support-agent/prompts/rag-context-formatter.ts` (line 159)

Builds the complete prompt for the AI

## Signature

```ts
function buildCompletePrompt(systemPrompt: string, ragContext: FormattedRagContext, conversationHistory: Array<{ role: string; content: string }>, userMessage: string, projectName: string): string
```

## Parameters

| Name | Type |
|---|---|
| `systemPrompt` | `string` |
| `ragContext` | `FormattedRagContext` |
| `conversationHistory` | `Array<{ role: string; content: string }>` |
| `userMessage` | `string` |
| `projectName` | `string` |

**Returns:** `string`

<!-- source: function-buildlayouttaskprompt.md -->

# buildLayoutTaskPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/layout.prompts.ts` (line 36)

## Signature

```ts
function buildLayoutTaskPrompt(sectionType: SectionType, contentJson: string): string
```

## Parameters

| Name | Type |
|---|---|
| `sectionType` | `SectionType` |
| `contentJson` | `string` |

**Returns:** `string`

<!-- source: constant-categoryfulllabels.md -->

# categoryFullLabels

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/constants/templateCategories.ts` (line 31)

Full labels for detailed views (preview modal, etc.)

## Definition

```ts
Record<TemplateCategory, string>
```

<!-- source: component-celleditor.md -->

# CellEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/table/TableEditor.tsx` (line 340)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `focus` | `any` | ✓ | - |
| `setActiveCell` | `any` | ✓ | - |
| `parentEditor` | `any` | ✓ | - |
| `lexicalTable` | `any` | ✓ | - |
| `contents` | `any` | ✓ | - |
| `colIndex` | `any` | ✓ | - |
| `rowIndex` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CellEditor_79b7a9f9["CellEditor"]
    class component_CellEditor_79b7a9f9 rootComponent
```

## Relationships

- RENDERS → `LexicalNestedComposer`
- RENDERS → `RichTextPlugin`
- RENDERS → `ContentEditable`
- RENDERS → `Child`
- RENDERS → `HistoryPlugin`
- USES_HOOK → `useCellValues`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

## Referenced By

- `Cell` (RENDERS)

<!-- source: type-changetype.md -->

# ChangeType

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/document/services/document-revision.service.ts` (line 17)

## Definition

```ts
'CREATE' | 'UPDATE' | 'RESTORE'
```

<!-- source: function-checkfocusvisibility.md -->

# checkFocusVisibility

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/accessibility.ts` (line 154)

Check focus visibility

## Signature

```ts
async function checkFocusVisibility(page: Page): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |

**Returns:** `Promise<void>`

<!-- source: interface-comparisonfeaturetableprops.md -->

# ComparisonFeatureTableProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/comparison/comparison-feature-table.tsx` (line 14)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `columns` | `{ nameKey: string; highlighted?: boolean }[]` |
| `features` | `{ featureKey: string; values: (boolean | string)[] }[]` |

<!-- source: interface-copywriterdependencies.md -->

# CopywriterDependencies

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/agents/copywriter.agent.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `searchFn` | `DocSearchFn` |
| `generateFn` | `ContentGenerateFn` |

<!-- source: function-createassemblesitetool.md -->

# createAssembleSiteTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/tools/assemble-site.tool.ts` (line 13)

## Signature

```ts
function createAssembleSiteTool(templateDir: string, componentLibraryDir: string): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `templateDir` | `string` |
| `componentLibraryDir` | `string` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: type-createuser.md -->

# CreateUser

**Kind:** Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

## Properties

| Property | Type |
|---|---|
| `email` | `string` |
| `password` | `string` |
| `name` | `string` |

## Referenced By

- `createUser` (REFERENCES)
- `User Management API` (TYPE_OF)

<!-- source: function-cropbuffer.md -->

# cropBuffer

**Kind:** Function

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/crop.service.ts` (line 111)

Extract a pixel region from an encoded image buffer using sharp.
Returns the cropped image as a new buffer (original untouched).

## Signature

```ts
async function cropBuffer(buffer: Buffer, clip: ClipRect): Promise<Buffer>
```

## Parameters

| Name | Type |
|---|---|
| `buffer` | `Buffer` |
| `clip` | `ClipRect` |

**Returns:** `Promise<Buffer>`

<!-- source: type-csfversion.md -->

# CSFVersion

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/storybook/types.ts` (line 9)

TypeScript types for Component Story Format (CSF) parsing
Supports both CSF 2.0 (Ladle) and CSF 3.0 (Storybook 7+)

## Definition

```ts
'2.0' | '3.0' | 'unknown'
```

<!-- source: interface-dataprovider.md -->

# DataProvider

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/providers/data-provider.interface.ts` (line 47)

Data provider interface
Abstracts fetching entities from file system or API

<!-- source: api-endpoint-delete.md -->

# delete

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.controller.ts` (line 131)

## Endpoint

`DELETE /suggestions/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `SuggestionController` (MODULE_DECLARES)
- `SuggestionAliasController` (MODULE_DECLARES)

<!-- source: graphql-mutation-deleteuser.md -->

# deleteUser

**Kind:** Graphql Mutation

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Delete a user (admin only)

## Referenced By

- `Mutation` (CALLS_API)

<!-- source: type-deskaction.md -->

# DeskAction

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 96)

## Definition

```ts
| 'accept'
  | 'investigating'
  | 'waiting'
  | 'snooze'
  | 'wake'
  | 'done'
  | 'reopen'
  | 'decline'
```

<!-- source: api-endpoint-detectparser.md -->

# detectParser

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/orchestrator.controller.ts` (line 200)

Determine parser for a file

## Endpoint

`GET /api/orchestrator/parsers/detect`

| Parameter | In | Type | Required |
|---|---|---|---|
| `filePath` | query | `string` | ✓ |

## Referenced By

- `OrchestratorController` (MODULE_DECLARES)

<!-- source: service-docplannerservice.md -->

# DocPlannerService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-09-planning/doc-planner.service.ts` (line 1)

<!-- source: class-docsmcptoolset.md -->

# DocsMcpToolset

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/mcp-toolset.ts` (line 53)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `toolDefinitions` | `toolDefinitions()` | `McpToolDef[]` |
| `call` | `call(name: string, args: Record<string, any>)` | `Promise<unknown>` |
| `searchDocs` | `searchDocs(query: string, limit: undefined)` | `DocSearchHit[]` |
| `readPage` | `readPage(path: string)` | `{ title: string; path: string; markdown: string } | null` |
| `listPages` | `listPages(section: string)` | `Array<{ title: string; path: string; section?: string }>` |
| `getEntity` | `getEntity(nameOrId: string)` | `{ entity: Entity; relationships: Array<{ direction: 'out' | 'in'; type: string; entity: string }>; source?: string } | null` |
| `searchEntities` | `searchEntities(query: string, kind: string)` | `Array<{ id: string; name: string; type: string }>` |
| `listEndpoints` | `listEndpoints(tag: string)` | `Array<{ method: string; path: string; summary: string }>` |
| `askQuestion` | `askQuestion(question: string)` | `Promise<{ answer: string; citations: string[] }>` |
| `callOperation` | `callOperation(args: Record<string, any>)` | `Promise<unknown>` |

<!-- source: class-documentspage.md -->

# DocumentsPage

**Kind:** Class

**Source:** `atloria-monorepo/apps/web-e2e/src/pages/documents.page.ts` (line 7)

Documents list page object

**Extends:** `BasePage`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `goto` | `goto()` | `Promise<void>` |
| `getDocumentCards` | `getDocumentCards()` | `Locator` |
| `getDocumentByTitle` | `getDocumentByTitle(title: string)` | `Locator` |
| `search` | `search(query: string)` | `Promise<void>` |
| `clearSearch` | `clearSearch()` | `Promise<void>` |
| `clickNewDocument` | `clickNewDocument()` | `Promise<void>` |
| `openDocument` | `openDocument(title: string)` | `Promise<void>` |
| `editDocument` | `editDocument(title: string)` | `Promise<void>` |
| `deleteDocument` | `deleteDocument(title: string)` | `Promise<void>` |
| `getDocumentCount` | `getDocumentCount()` | `Promise<number>` |
| `isEmpty` | `isEmpty()` | `Promise<boolean>` |
| `filterByType` | `filterByType(type: string)` | `Promise<void>` |
| `sortBy` | `sortBy(option: string)` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `newDocumentButton` | `Locator` |
| `searchInput` | `Locator` |
| `documentList` | `Locator` |
| `filterDropdown` | `Locator` |
| `sortDropdown` | `Locator` |
| `emptyState` | `Locator` |

<!-- source: enum-entitytype-4.md -->

# EntityType

**Kind:** Enum

**Source:** `atloria-monorepo/packages/types/src/enums/index.ts` (line 74)

Entity types in the Knowledge Graph

## Values

- `SCREEN`
- `COMPONENT`
- `API`
- `FLOW`
- `DB_ENTITY`
- `ROUTE`

<!-- source: function-extracthooksfrompath.md -->

# extractHooksFromPath

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 273)

Extract hooks used within a function path

## Signature

```ts
function extractHooksFromPath(path: NodePath): HookInfo[]
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath` |

**Returns:** `HookInfo[]`

<!-- source: type-featureslayout.md -->

# FeaturesLayout

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 13)

## Definition

```ts
'grid' | 'alternating' | 'bento' | 'compact'
```

<!-- source: type-fetchscreenshotsfn.md -->

# FetchScreenshotsFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/tools/query-product-knowledge.tool.ts` (line 65)

Fetch product screenshots, optionally filtered.

## Definition

```ts
(
  projectId: string,
  options?: {
    featureArea?: string;
    pageType?: string;
    viewport?: string;
    limit?: number;
  },
) => Promise<ProductScreenshot[]>
```

<!-- source: constant-flow-actions.md -->

# FLOW_ACTIONS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/flow-replay.dto.ts` (line 41)

Recorded actions (mirror api `CAPTURE_ACTIONS` in create-flow.dto.ts).
These are mapped to Playwright actions by the FlowReplayService.

<!-- source: type-format.md -->

# Format

**Kind:** Type

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 543)

## Definition

```ts
typeof FORMATS[number]
```

<!-- source: function-generatelargeprismaschema.md -->

# generateLargePrismaSchema

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 292)

Generate large Prisma schema for testing

## Signature

```ts
function generateLargePrismaSchema(modelCount: number): string
```

## Parameters

| Name | Type |
|---|---|
| `modelCount` | `number` |

**Returns:** `string`

<!-- source: api-endpoint-getjobstatus-2.md -->

# getJobStatus

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/batch-screenshot.controller.ts` (line 239)

Get batch job status and results

GET /api/screenshot/batch/:jobId/status?organizationId=uuid

Poll this endpoint to track progress and retrieve results.

## Endpoint

`GET /screenshot/batch/:jobId/status`

| Parameter | In | Type | Required |
|---|---|---|---|
| `jobId` | query | `string` | ✓ |
| `organizationId` | query | `string` | ✓ |

## Referenced By

- `BatchScreenshotController` (MODULE_DECLARES)

<!-- source: constant-gpt4-standard-profile.md -->

# GPT4_STANDARD_PROFILE

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-profiles.ts` (line 145)

GPT-4.x family (gpt-4o, gpt-4-turbo, gpt-4.1, etc.)
Standard OpenAI models — no reasoning effort, temperature supported.

## Definition

```ts
ModelCapabilityProfile
```

<!-- source: enum-parsejobstatus.md -->

# ParseJobStatus

**Kind:** Enum

**Source:** `atloria-monorepo/apps/api/src/parsing/dto/parse-status.dto.ts` (line 3)

## Values

- `QUEUED`
- `CLONING`
- `PARSING`
- `SYNCING`
- `COMPLETED`
- `FAILED`

<!-- source: enum-parsestatus-2.md -->

# ParseStatus

**Kind:** Enum

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/parse-result.interface.ts` (line 18)

Status of a parse operation

## Values

- `SUCCESS`
- `PARTIAL`
- `FAILED`
- `SKIPPED`
- `IN_PROGRESS`
- `QUEUED`

<!-- source: constant-pme-queue-name.md -->

# PME_QUEUE_NAME

**Kind:** Constant

**Source:** `atloria-monorepo/apps/pme-agent/src/queue/constants.ts` (line 1)

<!-- source: module-queuemodule.md -->

# QueueModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/queue/queue.module.ts` (line 19)

## Relationships

- MODULE_PROVIDES → `queueservice`
- MODULE_PROVIDES → `parseprocessor`
- MODULE_EXPORTS → `queueservice`

<!-- source: service-queueservice.md -->

# QueueService

**Kind:** Service

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/queue/queue.service.ts` (line 18)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `addParseJob` | `addParseJob(payload: Omit<ParseJobPayload, 'jobId' | 'createdAt'>, priority: unknown)` | `Promise<string>` |
| `addParseJobsBulk` | `addParseJobsBulk(payloads: Array<Omit<ParseJobPayload, 'jobId' | 'createdAt'>>)` | `Promise<string[]>` |
| `getJobStatus` | `getJobStatus(jobId: string)` | `Promise<JobStatus | null>` |
| `getJobResult` | `getJobResult(jobId: string)` | `Promise<T | null>` |
| `waitForJob` | `waitForJob(jobId: string, timeout: unknown)` | `Promise<T>` |
| `cancelJob` | `cancelJob(jobId: string)` | `Promise<boolean>` |
| `getMetrics` | `getMetrics()` | `Promise<QueueMetrics>` |
| `getWaitingJobs` | `getWaitingJobs(start: unknown, end: unknown)` | `Promise<Job<ParseJobPayload>[]>` |
| `getActiveJobs` | `getActiveJobs()` | `Promise<Job<ParseJobPayload>[]>` |
| `getFailedJobs` | `getFailedJobs(start: unknown, end: unknown)` | `Promise<Job<ParseJobPayload>[]>` |
| `retryJob` | `retryJob(jobId: string)` | `Promise<void>` |
| `cleanCompleted` | `cleanCompleted(grace: unknown)` | `Promise<void>` |
| `cleanFailed` | `cleanFailed(grace: unknown)` | `Promise<void>` |
| `pause` | `pause()` | `Promise<void>` |
| `resume` | `resume()` | `Promise<void>` |
| `isPaused` | `isPaused()` | `Promise<boolean>` |

## Relationships

- DEPENDS_ON → `queue`

<!-- source: enum-relationshiptype.md -->

# RelationshipType

**Kind:** Enum

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/relationship.interface.ts` (line 15)

Relationship Interfaces

Defines all relationship types between entities.
Relationships describe how code entities connect and interact.

## Values

- `RENDERS`
- `USES_HOOK`
- `USES_CONTEXT`
- `PROVIDES_CONTEXT`
- `USES_STORE`
- `DISPATCHES_ACTION`
- `CALLS_API`
- `IMPLEMENTS_API`
- `DEPENDS_ON`
- `USES_SERVICE`
- `INJECTS`
- `QUERIES_MODEL`
- `HAS_ONE`
- `HAS_MANY`
- `BELONGS_TO`
- `MANY_TO_MANY`
- `REFERENCES_MODEL`
- `IMPORTS`
- `EXTENDS`
- `IMPLEMENTS`
- `TYPE_OF`
- `CALLS`
- `EXPORTS`
- `RE_EXPORTS`
- `MODULE_IMPORTS`
- `MODULE_PROVIDES`
- `MODULE_EXPORTS`
- `MODULE_DECLARES`
- `DOCUMENTS`
- `REFERENCES`
- `LINKS_TO`
- `DEPLOYED_TO`
- `CONNECTS_TO`
- `CONTAINER_DEPENDS_ON`
- `EXPOSES_PORT`
- `USES_ENV`
- `USES_CONFIG`
- `REQUIRES_FEATURE`
- `TESTS`
- `MOCKS`

<!-- source: function-runwithtenantcontext.md -->

# runWithTenantContext

**Kind:** Function

**Source:** `atloria-monorepo/libs/database/src/lib/tenant-context.ts` (line 30)

Run `fn` with the given tenant context bound for the duration of its async execution.

## Signature

```ts
function runWithTenantContext(context: TenantContext, fn: () => T): T
```

## Parameters

| Name | Type |
|---|---|
| `context` | `TenantContext` |
| `fn` | `() => T` |

**Returns:** `T`

<!-- source: constant-sample-projects-path.md -->

# SAMPLE_PROJECTS_PATH

**Kind:** Constant

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 23)

<!-- source: controller-screenshotcontroller.md -->

# ScreenshotController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.controller.ts` (line 176)

## Relationships

- MODULE_DECLARES → `takeScreenshot`
- MODULE_DECLARES → `takeResponsiveScreenshots`
- MODULE_DECLARES → `takeAuthenticatedScreenshot`
- MODULE_DECLARES → `takeSmartAuthenticatedScreenshot`
- DEPENDS_ON → `screenshotservice`

<!-- source: module-screenshotmodule.md -->

# ScreenshotModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.module.ts` (line 20)

## Relationships

- MODULE_IMPORTS → `playwrightmodule`
- MODULE_IMPORTS → `storagemodule`
- MODULE_IMPORTS → `discoverymodule`
- MODULE_DECLARES → `screenshotcontroller`
- MODULE_DECLARES → `batchscreenshotcontroller`
- MODULE_PROVIDES → `screenshotservice`
- MODULE_PROVIDES → `screenshotmetadataservice`
- MODULE_PROVIDES → `retryhandlerservice`
- MODULE_PROVIDES → `actionexecutorservice`
- MODULE_PROVIDES → `stateresolverservice`
- MODULE_PROVIDES → `authcontextservice`
- MODULE_PROVIDES → `pagesettleservice`
- MODULE_PROVIDES → `annotationemitterservice`
- MODULE_PROVIDES → `batchscreenshotservice`
- MODULE_PROVIDES → `flowreplayservice`
- MODULE_EXPORTS → `screenshotservice`
- MODULE_EXPORTS → `screenshotmetadataservice`
- MODULE_EXPORTS → `batchscreenshotservice`
- MODULE_EXPORTS → `flowreplayservice`

<!-- source: class-sitegenerator.md -->

# SiteGenerator

**Kind:** Class

**Source:** `atloria-monorepo/apps/cli/src/generators/site.generator.ts` (line 54)

Static Site Generator

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generate` | `generate(metadata: ProjectMetadata, entities: Entity[], relationships: Relationship[])` | `Promise<void>` |

<!-- source: api-endpoint-startanalysis.md -->

# startAnalysis

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/code-analyzer/src/app/analysis/analysis.controller.ts` (line 30)

Start a new code analysis job

POST /api/analysis

Body:
{
  "projectId": "uuid",
  "repoUrl": "https://github.com/user/repo.git",
  "branch": "main",
  "folderPath": "packages/frontend",  // Optional: for mono-repos
  "framework": "react",               // Optional: auto-detect if not provided
  "patterns": ["src/**\/*.tsx"],       // Optional: custom file patterns
  "modules": ["auth", "dashboard"],   // Optional: specific modules to analyze
  "tokenBudget": 150000,              // Optional: token budget for analysis
  "organizationId": "uuid",
  "triggeredBy": "user-uuid"
}

Returns: { jobId: "uuid" }

## Endpoint

`POST /analysis`

## Referenced By

- `AnalysisController` (MODULE_DECLARES)

<!-- source: interface-testcommentdata.md -->

# TestCommentData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 93)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `documentId` | `string` |
| `content` | `string` |
| `authorId` | `string` |
| `authorName` | `string` |
| `resolved` | `boolean` |
| `parentCommentId` | `string` |
| `createdAt` | `string` |
| `updatedAt` | `string` |

<!-- source: component-timelinedot.md -->

# TimelineDot

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/social-proof/social-proof-timeline.tsx` (line 37)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `variant` | `unknown | unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TimelineDot_18ef7c67["TimelineDot"]
    class component_TimelineDot_18ef7c67 rootComponent
```

## Referenced By

- `SocialProofTimeline` (RENDERS)

<!-- source: graphql-query-users.md -->

# users

**Kind:** Graphql Query

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Get all users with pagination

## Relationships

- TYPE_OF → `UserConnection`

## Referenced By

- `Query` (CALLS_API)

<!-- source: class-yamlparser.md -->

# YamlParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/config-docs-parser/src/parsers/yaml.parser.ts` (line 81)

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: function-isdirectivenode.md -->

# $isDirectiveNode

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/directives/DirectiveNode.tsx` (line 155)

## Signature

```ts
function $isDirectiveNode(node: LexicalNode | null | undefined): node is DirectiveNode
```

## Parameters

| Name | Type |
|---|---|
| `node` | `LexicalNode | null | undefined` |

**Returns:** `node is DirectiveNode`

<!-- source: component-accordionitem-2.md -->

# AccordionItem

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/accordion-item.tsx` (line 19)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `questionKey` | `string` | ✓ | - |
| `answerKey` | `string` | ✓ | - |
| `defaultOpen` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_AccordionItem_6bd6a70f["AccordionItem"]
    class component_AccordionItem_6bd6a70f rootComponent
```

## Relationships

- RENDERS → `ChevronDown`
- RENDERS → `AnimatePresence`
- RENDERS → `motion-div`
- USES_HOOK → `useTranslation`
- USES_HOOK → `useState`

<!-- source: constant-addbottomareachild.md -->

# addBottomAreaChild$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 755)

Lets you add React components below the editor.

<!-- source: interface-agentinjectpayload.md -->

# AgentInjectPayload

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/agent/agent.types.ts` (line 84)

## Properties

| Property | Type |
|---|---|
| `message` | `string` |

<!-- source: interface-agentnote.md -->

# AgentNote

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/autonomous-loop.ts` (line 222)

A session-scoped note/learning the agent records as it works.
Injected into every subsequent turn so the agent builds up context.

## Properties

| Property | Type |
|---|---|
| `turn` | `number` |
| `content` | `string` |

<!-- source: interface-aiassistedconfig.md -->

# AIAssistedConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 158)

AI-assisted capture configuration

## Properties

| Property | Type |
|---|---|
| `verifyAfterActions` | `boolean` |
| `recoveryEnabled` | `boolean` |
| `enrichMetadata` | `boolean` |

<!-- source: service-aicostratelimitguard.md -->

# AiCostRateLimitGuard

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/guards/ai-cost-rate-limit.guard.ts` (line 14)

Rate limit for COST-BEARING AI endpoints (/ask, /mcp, /assist, /rag/index, /enrich).
Each request spends real money (embedding + gpt-5.6-terra), and /ask + /mcp are reachable
ANONYMOUSLY on public projects — so unlike the per-user AI guard this one:
 - keys by userId when authenticated, else by client IP (anonymous still limited)
 - never fails open to unlimited: when Redis is unavailable it falls back to a
   per-instance in-memory window (weaker, but bounded) instead of waving traffic through.

`AiCostRateLimitGuard` is a NestJS guard that rate-limits **cost-bearing AI endpoints** (e.g. `/ask`, `/mcp`, `/assist`, `/rag/index`, `/enrich`) to control real spend from embeddings and LLM calls. It keys limits by `userId` when authenticated, otherwise by **client IP** so anonymous access on public projects is still bounded. If Redis is unavailable, it **does not fail open**—it falls back to a per-instance in-memory window to keep traffic limited.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `canActivate` | `canActivate(context: ExecutionContext)` | `Promise<boolean>` |
| `onModuleDestroy` | `onModuleDestroy()` | `unknown` |

## Diagram

```mermaid
sequenceDiagram
  participant Client
  participant Controller
  participant Guard as AiCostRateLimitGuard
  participant Redis
  participant Memory as InMemoryWindow
  participant AI as AI Provider (Embeddings/LLM)

  Client->>Controller: HTTP request to cost-bearing endpoint
  Controller->>Guard: canActivate(context)

  alt Authenticated
    Guard->>Guard: key = userId
  else Anonymous (public project)
    Guard->>Guard: key = client IP
  end

  Guard->>Redis: increment/check window(key)
  alt Redis available + under limit
    Redis-->>Guard: allow
    Guard-->>Controller: proceed
    Controller->>AI: perform embedding/LLM call
    AI-->>Controller: response
    Controller-->>Client: 200 OK
  else Redis available + over limit
    Redis-->>Guard: deny
    Guard-->>Client: 429 Too Many Requests
  else Redis unavailable
    Guard->>Memory: increment/check window(key)
    alt under limit
      Memory-->>Guard: allow
      Guard-->>Controller: proceed
      Controller->>AI: perform embedding/LLM call
      AI-->>Controller: response
      Controller-->>Client: 200 OK
    else over limit
      Memory-->>Guard: deny
      Guard-->>Client: 429 Too Many Requests
    end
  end
```

## Usage

```ts
import { Controller, Post, UseGuards, Body } from '@nestjs/common';
import { AiCostRateLimitGuard } from '../technical-docs/guards/ai-cost-rate-limit.guard';

@Controller()
export class AskController {
  // Apply guard to a cost-bearing endpoint
  @Post('/ask')
  @UseGuards(AiCostRateLimitGuard)
  async ask(@Body() body: { prompt: string }) {
    // If this runs, the request has passed rate limiting.
    // Perform your embedding + LLM call here.
    return { answer: `You asked: ${body.prompt}` };
  }
}

// Alternatively, apply at the controller level:
// @UseGuards(AiCostRateLimitGuard)
// @Controller('/mcp')
// export class McpController { ... }
```

## AI Coding Instructions

- Preserve the **keying strategy**: use `userId` when authenticated; otherwise fall back to **client IP** so anonymous usage is still rate-limited.
- Never change behavior to **fail open** on Redis errors; keep the **in-memory fallback** bounded to prevent unlimited spend during outages.
- Ensure the guard is applied only to **cost-bearing** routes; don’t blanket-apply to non-AI endpoints unless you intend to throttle them too.
- When integrating behind proxies/CDNs, confirm the **true client IP extraction** is correct (e.g., trusted proxy headers) to avoid mis-keying or over-throttling.

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: controller-analyticsexportcontroller.md -->

# AnalyticsExportController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/analytics/export/analytics-export.controller.ts` (line 34)

## Relationships

- MODULE_DECLARES → `exportNow`
- MODULE_DECLARES → `listReports`
- MODULE_DECLARES → `createReport`
- MODULE_DECLARES → `updateReport`
- MODULE_DECLARES → `deleteReport`
- MODULE_DECLARES → `runReport`
- MODULE_DECLARES → `listExportHistory`
- DEPENDS_ON → `analyticsexportservice`
- DEPENDS_ON → `scheduledreportsservice`

<!-- source: class-anthropicmodelprovider.md -->

# AnthropicModelProvider

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/anthropic-adapter.ts` (line 630)

**Implements:** `ModelProvider`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getProfile` | `getProfile()` | `ModelCapabilityProfile` |
| `getModel` | `getModel(modelName: string)` | `AnthropicModel` |

<!-- source: constant-architecturedecisionrecordtemplate.md -->

# architectureDecisionRecordTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/architecture-decision-record.template.ts` (line 3)

<!-- source: interface-argtype.md -->

# ArgType

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/storybook/types.ts` (line 19)

Arg type definition

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `type` | `{
    name: string;
    required?: boolean;
  }` |
| `defaultValue` | `unknown` |
| `control` | `{
    type: string;
    [key: string]: unknown;
  }` |
| `table` | `{
    type?: { summary: string };
    defaultValue?: { summary: string };
    category?: string;
  }` |
| `options` | `unknown[]` |

<!-- source: module-assetsmodule.md -->

# AssetsModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/assets/assets.module.ts` (line 9)

## Relationships

- MODULE_IMPORTS → `configmodule`
- MODULE_IMPORTS → `databasemodule`
- MODULE_DECLARES → `assetscontroller`
- MODULE_PROVIDES → `assetsservice`
- MODULE_PROVIDES → `azureblobservice`
- MODULE_EXPORTS → `assetsservice`
- MODULE_EXPORTS → `azureblobservice`

<!-- source: class-atloriaapiclient.md -->

# AtloriaAPIClient

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/AtloriaAPIClient.ts` (line 21)

Main Atloria API client
Provides a unified interface for all API operations

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getInterceptors` | `getInterceptors()` | `InterceptorManager` |
| `setToken` | `setToken(token: string)` | `void` |
| `getToken` | `getToken()` | `string` |
| `initWebSocket` | `initWebSocket(url: string, config: WebSocketConfig)` | `WebSocketClient` |
| `getWebSocket` | `getWebSocket()` | `WebSocketClient | null` |
| `disconnectWebSocket` | `disconnectWebSocket()` | `void` |
| `login` | `login(email: string, password: string)` | `Promise<void>` |
| `logout` | `logout()` | `Promise<void>` |
| `refreshToken` | `refreshToken()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `audiences` | `AudienceEndpoints` |
| `auth` | `AuthEndpoints` |
| `changeRequests` | `ChangeRequestEndpoints` |
| `comments` | `CommentEndpoints` |
| `docsConfig` | `DocsConfigEndpoints` |
| `documents` | `DocumentEndpoints` |
| `projects` | `ProjectEndpoints` |
| `suggestions` | `SuggestionEndpoints` |
| `users` | `UserEndpoints` |

<!-- source: interface-audienceblockprops.md -->

# AudienceBlockProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Editor/AudienceBlock.tsx` (line 10)

Props for the AudienceBlock component

## Properties

| Property | Type |
|---|---|
| `audience` | `Audience` |
| `audienceLogic` | `string` |
| `children` | `React.ReactNode` |
| `onEdit` | `() => void` |
| `onDelete` | `() => void` |
| `isNested` | `boolean` |

<!-- source: component-avatar-2.md -->

# Avatar

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Comments/CommentThread.tsx` (line 293)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `user` | `unknown` | ✓ | - |
| `size` | `unknown | unknown | unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Avatar_6ab6d3d7["Avatar"]
    class component_Avatar_6ab6d3d7 rootComponent
```

## Referenced By

- `CommentThread` (RENDERS)
- `CommentReply` (RENDERS)

<!-- source: type-avatarshape.md -->

# AvatarShape

**Kind:** Type

**Source:** `atloria-monorepo/packages/ui-core/src/components/avatar/Avatar.ts` (line 6)

## Definition

```ts
'circle' | 'square'
```

<!-- source: class-azureclaudeprovider.md -->

# AzureClaudeProvider

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/ai/providers/azure-claude.provider.ts` (line 48)

Azure AI Foundry Claude Provider
Uses native Anthropic Messages API endpoint through Azure AI Foundry
Endpoint: /anthropic/v1/messages

Authentication priority:
1. API Key (ANTHROPIC_FOUNDRY_API_KEY) - simplest, no az login needed
2. Azure AD (DefaultAzureCredential/AzureCliCredential) - fallback

**Implements:** `AIProvider`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getAzureAIConfig` | `getAzureAIConfig()` | `Promise<{ endpoint: string; accessToken?: string; apiKey?: string; modelName: string } | null>` |
| `isAvailable` | `isAvailable()` | `Promise<boolean>` |
| `generateText` | `generateText(prompt: string, options: GenerateOptions)` | `Promise<string>` |
| `generateTextWithUsage` | `generateTextWithUsage(prompt: string, options: GenerateOptions)` | `Promise<AIResponse>` |
| `generateStream` | `generateStream(prompt: string, options: GenerateOptions)` | `AsyncIterableIterator<string>` |
| `analyze` | `analyze(content: string, type: AnalysisType)` | `Promise<AnalysisResult>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |

<!-- source: function-batchenrichscreenshots.md -->

# batchEnrichScreenshots

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/screenshot-metadata-enricher.ts` (line 321)

Batch enrich multiple screenshots

## Signature

```ts
function batchEnrichScreenshots(screenshots: Array<{ url: string; route: string; title?: string }>, entities: Entity[]): EnhancedScreenshotMetadata[]
```

## Parameters

| Name | Type |
|---|---|
| `screenshots` | `Array<{ url: string; route: string; title?: string }>` |
| `entities` | `Entity[]` |

**Returns:** `EnhancedScreenshotMetadata[]`

<!-- source: class-batchscreenshotstatusdto.md -->

# BatchScreenshotStatusDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 732)

Full batch status response for polling

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `status` | `JobStatus` |
| `progress` | `number` |
| `totalUrls` | `number` |
| `capturedUrls` | `number` |
| `failedUrls` | `number` |
| `currentItem` | `string` |
| `currentStage` | `string` |
| `stageProgress` | `number` |
| `screenshots` | `ScreenshotResultDto[]` |
| `failures` | `ScreenshotFailureDto[]` |
| `flowSteps` | `{ flowStepId: number; blobUrl: string; annotationsFragment: string }[]` |
| `error` | `string` |
| `timestamps` | `{
    createdAt: Date;
    updatedAt: Date;
    startedAt?: Date;
    completedAt?: Date;
  }` |
| `estimatedCompletion` | `Date` |
| `stats` | `{
    averageCaptureTimeMs: number;
    successRate: number;
    retryCount: number;
  }` |

<!-- source: type-benchmarkevent.md -->

# BenchmarkEvent

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/types.ts` (line 274)

Typed events emitted by BenchmarkRunner for monitoring.

## Definition

```ts
| { type: 'run_start';    totalTasks: number; suite: string; model: string }
  | { type: 'task_start';   taskId: string; difficulty?: string; index: number; total: number }
  | { type: 'tool_call';    taskId: string; toolName: string; inputPreview: string }
  | { type: 'tool_result';  taskId: string…
```

<!-- source: function-buildbashenv.md -->

# buildBashEnv

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/agent-hardening.ts` (line 56)

Build bash environment with pager-disabling variables.

Pattern from SWE-agent: Disable all interactive pagers and progress bars
to prevent the agent's bash commands from hanging on user input prompts.

Merges with existing env, overriding pager-related vars.

## Signature

```ts
function buildBashEnv(existingEnv: Record<string, string | undefined>): Record<string, string>
```

## Parameters

| Name | Type |
|---|---|
| `existingEnv` | `Record<string, string | undefined>` |

**Returns:** `Record<string, string>`

<!-- source: function-buildcomposerinsert.md -->

# buildComposerInsert

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/copilotUtils.ts` (line 69)

## Signature

```ts
function buildComposerInsert(answer: string, sources: CopilotAskSource[]): string
```

## Parameters

| Name | Type |
|---|---|
| `answer` | `string` |
| `sources` | `CopilotAskSource[]` |

**Returns:** `string`

<!-- source: function-buildmockupanimationscss.md -->

# buildMockupAnimationsCss

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/mockups.ts` (line 103)

## Signature

```ts
function buildMockupAnimationsCss(): string
```

**Returns:** `string`

<!-- source: function-buildpagesmanifest.md -->

# buildPagesManifest

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/docs-repo/sidecar.ts` (line 114)

Build the pages manifest as a deterministic string. Pages are emitted sorted by path so the
output is a pure function of the served set (no insertion-order dependence). Section order is
PRESERVED (reading order carries meaning); screen slugs are sorted+deduped (a provenance set).

## Signature

```ts
function buildPagesManifest(normalizerVersion: string, pages: PageIdentity[]): string
```

## Parameters

| Name | Type |
|---|---|
| `normalizerVersion` | `string` |
| `pages` | `PageIdentity[]` |

**Returns:** `string`

<!-- source: interface-captureddomstate.md -->

# CapturedDOMState

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/action-executor.service.ts` (line 13)

DOM state captured from a page

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `html` | `string` |
| `hasModal` | `boolean` |
| `hasError` | `boolean` |
| `errorMessages` | `string[]` |
| `visibleButtons` | `{ selector: string; text: string; isEnabled: boolean }[]` |
| `visibleInputs` | `{ selector: string; type: string; placeholder: string }[]` |
| `isLoading` | `boolean` |
| `pageTitle` | `string` |

<!-- source: function-capturediagnostics.md -->

# captureDiagnostics

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/utils/ai-auth-debugger.ts` (line 52)

Capture comprehensive diagnostics about current page state

## Signature

```ts
async function captureDiagnostics(page: any, phase: string, attemptLog: any[]): Promise<AuthDiagnostics>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `any` |
| `phase` | `string` |
| `attemptLog` | `any[]` |

**Returns:** `Promise<AuthDiagnostics>`

<!-- source: constant-categorylabels.md -->

# categoryLabels

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/constants/templateCategories.ts` (line 7)

Human-readable labels for template categories
Used across template components for consistent display

## Definition

```ts
Record<TemplateCategory, string>
```

<!-- source: function-checkheadinghierarchy.md -->

# checkHeadingHierarchy

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/accessibility.ts` (line 317)

Check heading hierarchy

## Signature

```ts
async function checkHeadingHierarchy(page: Page): Promise<{ valid: boolean; issues: string[] }>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |

**Returns:** `Promise<{ valid: boolean; issues: string[] }>`

<!-- source: component-child.md -->

# Child

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/realm-plugin.tsx` (line 25)

## Diagram

```mermaid
graph TD
    component_Child_3b902d1a["Child"]
    class component_Child_3b902d1a rootComponent
```

## Relationships

- USES_HOOK → `useCellValue`

## Referenced By

- `Example` (RENDERS)

<!-- source: interface-codeblockinfo.md -->

# CodeBlockInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 889)

Code block information

## Properties

| Property | Type |
|---|---|
| `language` | `string` |
| `line` | `number` |
| `lines` | `number` |

<!-- source: interface-comparisonrowprops.md -->

# ComparisonRowProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/comparison-row.tsx` (line 11)

## Properties

| Property | Type |
|---|---|
| `featureKey` | `string` |
| `values` | `(boolean | string)[]` |

<!-- source: interface-copywriterinput.md -->

# CopywriterInput

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/copywriter.prompts.ts` (line 10)

## Properties

| Property | Type |
|---|---|
| `sectionType` | `SectionType` |
| `docContext` | `string` |
| `config` | `GenerationConfig` |

<!-- source: function-createqueryproductknowledgetool.md -->

# createQueryProductKnowledgeTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/tools/query-product-knowledge.tool.ts` (line 105)

## Signature

```ts
function createQueryProductKnowledgeTool(deps: ProductKnowledgeDeps): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `deps` | `ProductKnowledgeDeps` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: type-crkind.md -->

# CrKind

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/change-request/dto/change-request.dto.ts` (line 6)

## Definition

```ts
(typeof CR_KINDS)[number]
```

<!-- source: service-crop.md -->

# Crop

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/crop.service.ts` (line 1)

<!-- source: interface-dataproviderconfig.md -->

# DataProviderConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/providers/data-provider.interface.ts` (line 33)

Data provider configuration

## Properties

| Property | Type |
|---|---|
| `mode` | `'static' | 'dynamic'` |
| `outputDir` | `string` |
| `apiUrl` | `string` |
| `apiKey` | `string` |
| `projectId` | `string` |

<!-- source: api-endpoint-delete-2.md -->

# delete

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.controller.ts` (line 131)

## Endpoint

`DELETE /suggestions/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `SuggestionController` (MODULE_DECLARES)
- `SuggestionAliasController` (MODULE_DECLARES)

<!-- source: type-deploymentnodetype.md -->

# DeploymentNodeType

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/deployment-diagram.generator.ts` (line 22)

Types of deployment nodes

## Definition

```ts
| 'container'
  | 'service'
  | 'database'
  | 'cache'
  | 'queue'
  | 'api-gateway'
  | 'load-balancer'
  | 'external-service'
```

<!-- source: type-deskstate.md -->

# DeskState

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 137)

## Definition

```ts
'needs_first' | 'needs_next' | 'investigating' | 'waiting' | 'paused' | 'done'
```

<!-- source: api-endpoint-dispatchjob.md -->

# dispatchJob

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/orchestrator.controller.ts` (line 34)

Dispatch a parse job

## Endpoint

`POST /api/orchestrator/jobs`

## Referenced By

- `OrchestratorController` (MODULE_DECLARES)

<!-- source: service-docverifierservice.md -->

# DocVerifierService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/doc-verifier.service.ts` (line 1)

<!-- source: class-dotnetparser.md -->

# DotNetParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/backend/dotnet.parser.ts` (line 34)

.NET Parser implementation using Roslyn bridge

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `parseProject` | `parseProject(rootDir: string)` | `Promise<ParseResult>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: function-extractimportsfromdeclaration.md -->

# extractImportsFromDeclaration

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 98)

Extract imports from an ImportDeclaration node

## Signature

```ts
function extractImportsFromDeclaration(path: NodePath<t.ImportDeclaration>): ImportInfo[]
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath<t.ImportDeclaration>` |

**Returns:** `ImportInfo[]`

<!-- source: type-fetchstatsfn.md -->

# FetchStatsFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/tools/query-product-knowledge.tool.ts` (line 55)

Fetch aggregate product stats from the knowledge graph.

## Definition

```ts
(
  projectId: string,
) => Promise<ProductStats>
```

<!-- source: type-findscreenshotsfn.md -->

# FindScreenshotsFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/tools/find-screenshots.tool.ts` (line 15)

Function signature for querying screenshots.
Injected at creation time — wraps PrismaService.screenshot.findMany().

## Definition

```ts
(
  projectId: string,
  options?: {
    urlPattern?: string;
    featureArea?: string;
    pageType?: string;
    viewport?: string;
    limit?: number;
  }
) => Promise<ScreenshotInfo[]>
```

<!-- source: function-flowkey.md -->

# flowKey

**Kind:** Function

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/crop.service.ts` (line 134)

Deterministic storage key for a flow step screenshot.

Naming scheme (WS-A flow-replay):
  flowKey('abc', 0)          => 'flows/abc/step-0.png'      (initial state, full page)
  flowKey('abc', 2)          => 'flows/abc/step-2.png'      (state after step 2, full page)
  flowKey('abc', 2, 'crop')  => 'flows/abc/step-2-crop.png' (tight crop around the target)

The no-variant key is the canonical FULL-PAGE image the docs reference (it is
the one the annotation fragment's coordinates are computed against). 'crop' is
an auxiliary tight close-up. 'full' is retained for backward compat.

## Signature

```ts
function flowKey(flowId: string, stepOrder: number, variant: 'full' | 'crop'): string
```

## Parameters

| Name | Type |
|---|---|
| `flowId` | `string` |
| `stepOrder` | `number` |
| `variant` | `'full' | 'crop'` |

**Returns:** `string`

<!-- source: graphql-mutation-followuser.md -->

# followUser

**Kind:** Graphql Mutation

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Follow a user

## Relationships

- TYPE_OF → `Follow`

## Referenced By

- `Mutation` (CALLS_API)

<!-- source: constant-formats.md -->

# FORMATS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 542)

<!-- source: type-frameaction.md -->

# FrameAction

**Kind:** Type

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 41)

## Definition

```ts
typeof FRAME_ACTIONS[number]
```

<!-- source: function-generatelargereactfile.md -->

# generateLargeReactFile

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 248)

Generate large file content for performance testing

## Signature

```ts
function generateLargeReactFile(componentCount: number): string
```

## Parameters

| Name | Type |
|---|---|
| `componentCount` | `number` |

**Returns:** `string`

<!-- source: api-endpoint-getpagehtml.md -->

# getPageHtml

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/batch-screenshot.controller.ts` (line 308)

Validate selectors exist on a page

POST /api/screenshot/validate-selectors

Loads the page and checks if all provided selectors exist.
Use this to verify login form selectors before batch processing.

## Endpoint

`POST /screenshot/page-html`

## Referenced By

- `BatchScreenshotController` (MODULE_DECLARES)

<!-- source: constant-gpt5-flagship-profile.md -->

# GPT5_FLAGSHIP_PROFILE

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-profiles.ts` (line 125)

GPT-5.4 (Azure Responses API) — the Atloria primary model.
Key quirks:
  - reasoning_effort defaults to 'none' → skips tool calls
  - temperature is unsupported when reasoning is active
  - tool_choice: 'required' needed on turn 1 to force at least one call

## Definition

```ts
ModelCapabilityProfile
```

<!-- source: graphql-type-like.md -->

# Like

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Like on a post

## Relationships

- TYPE_OF → `User`
- TYPE_OF → `Post`
- TYPE_OF → `DateTime`

## Referenced By

- `likePost` (TYPE_OF)
- `Post` (TYPE_OF)

<!-- source: class-loginpage.md -->

# LoginPage

**Kind:** Class

**Source:** `atloria-monorepo/apps/web-e2e/src/pages/auth.page.ts` (line 7)

Login page object

**Extends:** `BasePage`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `goto` | `goto()` | `Promise<void>` |
| `login` | `login(email: string, password: string)` | `Promise<void>` |
| `loginAndWait` | `loginAndWait(email: string, password: string)` | `Promise<void>` |
| `hasError` | `hasError()` | `Promise<boolean>` |
| `getErrorMessage` | `getErrorMessage()` | `Promise<string>` |
| `toggleRememberMe` | `toggleRememberMe()` | `Promise<void>` |
| `goToRegister` | `goToRegister()` | `Promise<void>` |
| `goToForgotPassword` | `goToForgotPassword()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `emailInput` | `Locator` |
| `passwordInput` | `Locator` |
| `submitButton` | `Locator` |
| `errorMessage` | `Locator` |
| `forgotPasswordLink` | `Locator` |
| `registerLink` | `Locator` |
| `rememberMeCheckbox` | `Locator` |

<!-- source: type-loginrequest.md -->

# LoginRequest

**Kind:** Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

## Properties

| Property | Type |
|---|---|
| `email` | `string` |
| `password` | `string` |

## Referenced By

- `login` (REFERENCES)
- `User Management API` (TYPE_OF)

<!-- source: enum-notificationtype.md -->

# NotificationType

**Kind:** Enum

**Source:** `atloria-monorepo/packages/types/src/enums/index.ts` (line 86)

Notification types

## Values

- `MENTION`
- `COMMENT`
- `SUGGESTION`
- `DOCUMENT_SHARED`
- `REVIEW_REQUEST`
- `SYSTEM`

<!-- source: enum-relationshiptype-2.md -->

# RelationshipType

**Kind:** Enum

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/relationship.interface.ts` (line 14)

Relationship Interfaces

Defines all relationship types between entities.
Relationships describe how code entities connect and interact.

## Values

- `RENDERS`
- `USES_HOOK`
- `USES_CONTEXT`
- `PROVIDES_CONTEXT`
- `USES_STORE`
- `DISPATCHES_ACTION`
- `SELECTS_STATE`
- `REDUCES`
- `TRIGGERS_EFFECT`
- `UPDATES_STORE`
- `CALLS_API`
- `IMPLEMENTS_API`
- `DEPENDS_ON`
- `USES_SERVICE`
- `INJECTS`
- `QUERIES_MODEL`
- `HAS_ONE`
- `HAS_MANY`
- `BELONGS_TO`
- `MANY_TO_MANY`
- `REFERENCES_MODEL`
- `IMPORTS`
- `EXTENDS`
- `IMPLEMENTS`
- `TYPE_OF`
- `CALLS`
- `EXPORTS`
- `RE_EXPORTS`
- `MODULE_IMPORTS`
- `MODULE_PROVIDES`
- `MODULE_EXPORTS`
- `MODULE_DECLARES`
- `DOCUMENTS`
- `REFERENCES`
- `LINKS_TO`
- `DEPLOYED_TO`
- `CONNECTS_TO`
- `CONTAINER_DEPENDS_ON`
- `EXPOSES_PORT`
- `USES_ENV`
- `USES_CONFIG`
- `REQUIRES_FEATURE`
- `TESTS`
- `MOCKS`

<!-- source: enum-relationtype.md -->

# RelationType

**Kind:** Enum

**Source:** `atloria-monorepo/apps/api/src/graph/interfaces/entity.interface.ts` (line 13)

## Values

- `IMPLEMENTS`
- `DEPENDS_ON`
- `RELATES_TO`
- `REFERENCES`
- `BLOCKS`
- `CONTAINS`
- `USES`

<!-- source: constant-required-project-roots.md -->

# REQUIRED_PROJECT_ROOTS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/pme-agent/test/discovery/ground-truth.ts` (line 110)

Major project roots the agent MUST identify

<!-- source: constant-sample-projects-path-2.md -->

# SAMPLE_PROJECTS_PATH

**Kind:** Constant

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/setup.ts` (line 19)

<!-- source: class-stdiotransport.md -->

# StdioTransport

**Kind:** Class

**Source:** `atloria-monorepo/apps/cli/src/stdio-transport.ts` (line 34)

**Implements:** `AgentTransport`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `handleEvent` | `handleEvent(event: AgentProtocolEvent)` | `void` |

<!-- source: module-storagemodule.md -->

# StorageModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/storage/storage.module.ts` (line 4)

## Relationships

- MODULE_PROVIDES → `storageservice`
- MODULE_EXPORTS → `storageservice`

<!-- source: interface-testdocumentdata.md -->

# TestDocumentData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 52)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `slug` | `string` |
| `content` | `string` |
| `type` | `'MANUAL' | 'GENERATED' | 'HYBRID' | 'WIKI' | 'API_GUIDE'` |
| `audiences` | `('TECHNICAL' | 'USER' | 'API' | 'INTERNAL')[]` |
| `createdAt` | `string` |
| `updatedAt` | `string` |

<!-- source: module-usersmodule.md -->

# UsersModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/src/users/users.module.ts` (line 13)

## Relationships

- MODULE_IMPORTS → `prismamodule`
- MODULE_IMPORTS → `eventemittermodule`
- MODULE_DECLARES → `userscontroller`
- MODULE_PROVIDES → `usersservice`
- MODULE_EXPORTS → `usersservice`

<!-- source: service-usersservice.md -->

# UsersService

**Kind:** Service

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/src/users/users.service.ts` (line 15)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `findAll` | `findAll(paginationQuery: PaginationQueryDto)` | `unknown` |
| `findOne` | `findOne(id: string)` | `unknown` |
| `findByEmail` | `findByEmail(email: string)` | `unknown` |
| `create` | `create(createUserDto: CreateUserDto)` | `unknown` |
| `update` | `update(id: string, updateUserDto: UpdateUserDto)` | `unknown` |
| `remove` | `remove(id: string)` | `unknown` |
| `getUserPosts` | `getUserPosts(userId: string)` | `unknown` |
| `getFollowers` | `getFollowers(userId: string)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `eventemitter2`

<!-- source: function-wherehasorgscope.md -->

# whereHasOrgScope

**Kind:** Function

**Source:** `atloria-monorepo/libs/database/src/lib/tenant-backstop.ts` (line 50)

True if `organizationId` appears anywhere in the where tree (top level or inside AND/OR/NOT),
meaning the developer scoped the query intentionally. Presence — not value — is what we check;
this is what keeps an intentional `OR: [{ isPublic }, { organizationId }]` from being flagged.

## Signature

```ts
function whereHasOrgScope(where: unknown): boolean
```

## Parameters

| Name | Type |
|---|---|
| `where` | `unknown` |

**Returns:** `boolean`

<!-- source: function-islexicaljsxnode.md -->

# $isLexicalJsxNode

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/LexicalJsxNode.tsx` (line 151)

## Signature

```ts
function $isLexicalJsxNode(node: LexicalNode | null | undefined): node is LexicalJsxNode
```

## Parameters

| Name | Type |
|---|---|
| `node` | `LexicalNode | null | undefined` |

**Returns:** `node is LexicalJsxNode`

<!-- source: constant-addcomposerchild.md -->

# addComposerChild$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 737)

<!-- source: interface-agentmessageevent.md -->

# AgentMessageEvent

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/agent/agent.types.ts` (line 107)

## Properties

| Property | Type |
|---|---|
| `text` | `string` |
| `agentName` | `string` |
| `delta` | `boolean` |

<!-- source: interface-agentprotocolevent.md -->

# AgentProtocolEvent

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/protocol/agent-protocol.ts` (line 85)

A fully typed protocol event — the unit flowing through transports

## Properties

| Property | Type |
|---|---|
| `type` | `T` |
| `timestamp` | `number` |
| `data` | `AgentProtocolEventMap[T]` |

<!-- source: interface-aigenerateoptions.md -->

# AIGenerateOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/ai-provider.interface.ts` (line 23)

## Properties

| Property | Type |
|---|---|
| `maxTokens` | `number` |
| `temperature` | `number` |
| `systemPrompt` | `string` |
| `messages` | `AIMessage[]` |
| `stopSequences` | `string[]` |
| `responseFormat` | `'text' | 'json_object'` |
| `timeout` | `number` |
| `images` | `string[]` |

<!-- source: service-aiservice.md -->

# AIService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/ai/ai.service.ts` (line 13)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getProvider` | `getProvider(name: string)` | `AIProvider` |
| `listProviders` | `listProviders()` | `unknown` |
| `enhanceDocument` | `enhanceDocument(documentId: string, providerName: string)` | `Promise<any>` |
| `generateOutline` | `generateOutline(topic: string, audience: string, providerName: string)` | `Promise<string>` |
| `improveWriting` | `improveWriting(text: string, providerName: string)` | `Promise<string>` |
| `summarizeDocument` | `summarizeDocument(documentId: string, providerName: string)` | `Promise<string>` |
| `streamCompletion` | `streamCompletion(prompt: string, providerName: string)` | `AsyncIterableIterator<string>` |
| `generateText` | `generateText(prompt: string, providerName: string)` | `Promise<string>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `configservice`
- DEPENDS_ON → `azureclaudeprovider`
- DEPENDS_ON → `azureopenaiprovider`
- DEPENDS_ON → `azureresponsesprovider`
- DEPENDS_ON → `azureresponsesprovider`

<!-- source: controller-appcontroller-2.md -->

# AppController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/app/app.controller.ts` (line 5)

## Relationships

- MODULE_DECLARES → `getData`
- MODULE_DECLARES → `getPublicStats`
- MODULE_DECLARES → `healthCheck`
- DEPENDS_ON → `appservice`

<!-- source: constant-ask-credit-cost.md -->

# ASK_CREDIT_COST

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/billing/billing.constants.ts` (line 22)

<!-- source: interface-asyncstatepattern.md -->

# AsyncStatePattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-management.interface.ts` (line 266)

Async state pattern (for React Query, SWR, async Redux)

## Properties

| Property | Type |
|---|---|
| `states` | `{
    idle: boolean;
    loading: boolean;
    success: boolean;
    error: boolean;
  }` |
| `dataField` | `string` |
| `errorField` | `string` |
| `loadingField` | `string` |
| `queryKey` | `string` |
| `mutationFn` | `string` |
| `endpoint` | `string` |
| `hasRetry` | `boolean` |
| `hasOptimisticUpdate` | `boolean` |

<!-- source: class-atloriaapiexplorer.md -->

# AtloriaAPIExplorer

**Kind:** Class

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/APIExplorer.ts` (line 63)

**Extends:** `LitElement`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `willUpdate` | `willUpdate(changed: Map<string | number | symbol, unknown>)` | `void` |
| `connectedCallback` | `connectedCallback()` | `void` |
| `disconnectedCallback` | `disconnectedCallback()` | `void` |
| `render` | `render()` | `void` |

## Properties

| Property | Type |
|---|---|
| `styles` | `any` |
| `spec` | `OpenAPISpec` |
| `endpoints` | `APIEndpoint[]` |
| `environments` | `Environment[]` |
| `mode` | `'explorer' | 'documentation'` |
| `defaultEndpoint` | `string` |
| `proxyUrl` | `string` |
| `presetBearerToken` | `string` |

<!-- source: module-audiencemodule.md -->

# AudienceModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/audience/audience.module.ts` (line 9)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_DECLARES → `audiencecontroller`
- MODULE_PROVIDES → `audienceservice`
- MODULE_EXPORTS → `audienceservice`

<!-- source: interface-audienceselectormodalprops.md -->

# AudienceSelectorModalProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Editor/AudienceSelectorModal.tsx` (line 11)

Props for the AudienceSelectorModal component

## Properties

| Property | Type |
|---|---|
| `open` | `boolean` |
| `onClose` | `() => void` |
| `onApply` | `(logic: string) => void` |
| `audiences` | `Audience[]` |
| `initialSelection` | `string[]` |

<!-- source: class-autonomousturnhook.md -->

# AutonomousTurnHook

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/autonomous-loop.ts` (line 612)

TurnHook that drives autonomous agent behavior.

It watches what the agent is doing (via tool calls in input items)
and injects nudges when the agent skips investigation or verification.

Usage:
```typescript
const hook = new AutonomousTurnHook({
  maxTurns: 40,
  qualityGateProvider: async () => [
    { id: 'tests_pass', description: 'All tests pass', passed: false },
  ],
});
```

**Implements:** `TurnHook`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `updateTokenUsage` | `updateTokenUsage(inputTokens: number)` | `void` |
| `getCircleDetector` | `getCircleDetector()` | `CircleDetector | null` |
| `beforeModelCall` | `beforeModelCall(args: TurnHookArgs<TContext>)` | `Promise<{ instructions?: string; input?: AgentInputItem[] }>` |
| `getState` | `getState()` | `Readonly<LoopState>` |
| `getRecentFiles` | `getRecentFiles()` | `readonly string[]` |

## Properties

| Property | Type |
|---|---|
| `onPreCompact` | `(data: { turnNumber: number; tokenCount: number; recentFiles: string[] }) => void` |
| `onPostCompact` | `(data: { turnNumber: number; summaryInjected: boolean }) => void` |

<!-- source: type-avatarsize.md -->

# AvatarSize

**Kind:** Type

**Source:** `atloria-monorepo/packages/ui-core/src/components/avatar/Avatar.ts` (line 5)

## Definition

```ts
'xs' | 'sm' | 'md' | 'lg' | 'xl'
```

<!-- source: class-azureopenaiprovider.md -->

# AzureOpenAIProvider

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/ai/providers/azure-openai.provider.ts` (line 47)

**Implements:** `AIProvider`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `isAvailable` | `isAvailable()` | `Promise<boolean>` |
| `generateText` | `generateText(prompt: string, options: GenerateOptions)` | `Promise<string>` |
| `generateTextWithUsage` | `generateTextWithUsage(prompt: string, options: GenerateOptions)` | `Promise<AIResponse>` |
| `generateStream` | `generateStream(prompt: string, options: GenerateOptions)` | `AsyncIterableIterator<string>` |
| `analyze` | `analyze(content: string, type: AnalysisType)` | `Promise<AnalysisResult>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |

<!-- source: function-buildbenchmarkprompt.md -->

# buildBenchmarkPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/adaptive-prompt.ts` (line 229)

Build a benchmark-optimized system prompt.

Unlike `buildAdaptivePrompt` (which has a 5-phase workflow including
"run baseline tests first"), this prompt is action-first:

  1. Read the issue → identify the source file and function
  2. Call edit_file immediately with the fix
  3. Run the targeted test to verify

The "establish baseline first" step is intentionally omitted because:
  - Baselines consume 50-80% of the turn budget on analysis
  - The model then produces text describing its plan instead of calling edit_file
  - Azure Responses API expires previous_response_id on completion → no second turn
  - SWE-bench eval applies the diff, not the agent's text response

Used by BenchmarkRunner instead of buildAdaptivePrompt.

## Signature

```ts
function buildBenchmarkPrompt(options: {
  workspace: string;
  toolGuide: string;
  repoMap?: string;
  domainRules?: string[];
  /** Specific test names that must pass (from SWE-bench FAIL_TO_PASS metadata) */
  failToPassTests?: string[];
}): string
```

## Parameters

| Name | Type |
|---|---|
| `options` | `{
  workspace: string;
  toolGuide: string;
  repoMap?: string;
  domainRules?: string[];
  /** Specific test names that must pass (from SWE-bench FAIL_TO_PASS metadata) */
  failToPassTests?: string[];
}` |

**Returns:** `string`

<!-- source: function-builddocumenturl.md -->

# buildDocumentUrl

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/url-utils.ts` (line 52)

Build a document URL from components

## Signature

```ts
function buildDocumentUrl(slug: string, urlId: string, audience: string): string
```

## Parameters

| Name | Type |
|---|---|
| `slug` | `string` |
| `urlId` | `string` |
| `audience` | `string` |

**Returns:** `string`

<!-- source: function-buildentitypageindexes.md -->

# buildEntityPageIndexes

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/entity-page.ts` (line 228)

Build the shared indexes renderEntityPage can consume, ONCE, for callers that render many
pages from the same graph. Turns per-page O(entities+relationships) work into O(deg) lookups.

## Signature

```ts
function buildEntityPageIndexes(entities: Entity[], relationships: Relationship[]): {
  nameResolver: (id: string) => string;
  outgoingBySource: Map<string, Relationship[]>;
  incomingByTarget: Map<string, Relationship[]>;
}
```

## Parameters

| Name | Type |
|---|---|
| `entities` | `Entity[]` |
| `relationships` | `Relationship[]` |

**Returns:** `{
  nameResolver: (id: string) => string;
  outgoingBySource: Map<string, Relationship[]>;
  incomingByTarget: Map<string, Relationship[]>;
}`

<!-- source: function-buildqasystemprompt.md -->

# buildQaSystemPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/qa.prompts.ts` (line 7)

QA Agent Prompts

Prompts for visual QA evaluation of generated marketing pages.

## Signature

```ts
function buildQaSystemPrompt(): string
```

**Returns:** `string`

<!-- source: function-buildsearchindex.md -->

# buildSearchIndex

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/search-index.ts` (line 178)

Pure transform: corpus pages + entity graph → a compact static search index.
Deterministic for identical inputs (stable order, stable ids).

## Signature

```ts
function buildSearchIndex(slugWithId: string, pages: RawIndexPage[], entities: GraphEntity[], relationships: GraphRelationship[], generatedAt: Date): StaticSearchIndex
```

## Parameters

| Name | Type |
|---|---|
| `slugWithId` | `string` |
| `pages` | `RawIndexPage[]` |
| `entities` | `GraphEntity[]` |
| `relationships` | `GraphRelationship[]` |
| `generatedAt` | `Date` |

**Returns:** `StaticSearchIndex`

<!-- source: constant-categorylabelswithall.md -->

# categoryLabelsWithAll

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/constants/templateCategories.ts` (line 23)

Extended labels including "All" option for filter components

## Definition

```ts
Record<TemplateCategory | 'ALL', string>
```

<!-- source: function-checkkeyboardnavigation.md -->

# checkKeyboardNavigation

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/accessibility.ts` (line 137)

Check keyboard navigation

## Signature

```ts
async function checkKeyboardNavigation(page: Page, expectedFocusOrder: string[]): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |
| `expectedFocusOrder` | `string[]` |

**Returns:** `Promise<void>`

<!-- source: class-clipdto.md -->

# ClipDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 190)

Clip region DTO for partial page screenshots

## Properties

| Property | Type |
|---|---|
| `x` | `number` |
| `y` | `number` |
| `width` | `number` |
| `height` | `number` |

<!-- source: interface-cliprect.md -->

# ClipRect

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/crop.service.ts` (line 19)

A Playwright clip rect, in PIXELS.

## Properties

| Property | Type |
|---|---|
| `x` | `number` |
| `y` | `number` |
| `width` | `number` |
| `height` | `number` |

<!-- source: component-code-2.md -->

# Code

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/technical/entity/[entityId]/page.tsx` (line 37)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Code_3887f2e4["Code"]
    class component_Code_3887f2e4 rootComponent
```

## Referenced By

- `MethodsTable` (RENDERS)
- `FieldsTable` (RENDERS)

<!-- source: component-codeblockeditorcontextprovider.md -->

# CodeBlockEditorContextProvider

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/CodeBlockNode.tsx` (line 191)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `parentEditor` | `any` | ✓ | - |
| `lexicalNode` | `any` | ✓ | - |
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CodeBlockEditorContextProvider_799537f6["CodeBlockEditorContextProvider"]
    class component_CodeBlockEditorContextProvider_799537f6 rootComponent
```

## Relationships

- RENDERS → `CodeBlockEditorContext-Provider`
- USES_HOOK → `useMemo`

## Referenced By

- `CodeBlockEditorContainer` (RENDERS)

<!-- source: component-comparisonfeaturetable.md -->

# ComparisonFeatureTable

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/comparison/comparison-feature-table.tsx` (line 21)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `columns` | `unknown[]` | ✓ | - |
| `features` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ComparisonFeatureTable_3ab2c8e0["ComparisonFeatureTable"]
    class component_ComparisonFeatureTable_3ab2c8e0 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `ComparisonRow`
- USES_HOOK → `useTranslation`

<!-- source: interface-componententity.md -->

# ComponentEntity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 296)

Component entity (React, Vue, Angular)

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.COMPONENT` |
| `componentType` | `'functional' | 'class'` |
| `props` | `PropDefinition[]` |
| `hooks` | `HookUsage[]` |
| `events` | `EventDefinition[]` |
| `slots` | `SlotDefinition[]` |
| `childComponents` | `string[]` |
| `stateManagement` | `StateManagementInfo` |
| `exports` | `ExportInfo` |

<!-- source: function-configcommand.md -->

# configCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/config.command.ts` (line 99)

Config command handler

## Signature

```ts
async function configCommand(options: ConfigOptions): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `ConfigOptions` |

**Returns:** `Promise<void>`

<!-- source: graphql-type-createpostinput.md -->

# CreatePostInput

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Input for creating a post

## Referenced By

- `createPost` (TYPE_OF)

<!-- source: function-createreadmanifesttool.md -->

# createReadManifestTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/tools/read-manifest.tool.ts` (line 11)

## Signature

```ts
function createReadManifestTool(componentLibraryDir: string): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `componentLibraryDir` | `string` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: type-crstatus.md -->

# CrStatus

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/change-request/dto/change-request.dto.ts` (line 9)

## Definition

```ts
(typeof CR_STATUSES)[number]
```

<!-- source: interface-ctacardprops.md -->

# CtaCardProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/cta/cta-card.tsx` (line 14)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `primaryCtaKey` | `string` |
| `primaryCtaUrl` | `string` |
| `secondaryCtaKey` | `string` |
| `secondaryCtaUrl` | `string` |
| `icon` | `LucideIcon` |

<!-- source: service-discoveryservice.md -->

# DiscoveryService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/discovery/discovery.service.ts` (line 48)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `scan` | `scan(dto: DiscoveryScanRequestDto)` | `Promise<SiteMap>` |
| `scanWithPage` | `scanWithPage(page: Page, baseUrl: string, dto: DiscoveryScanRequestDto, startTime: unknown)` | `Promise<SiteMap>` |

## Relationships

- DEPENDS_ON → `playwrightservice`
- DEPENDS_ON → `pageprofilerservice`

<!-- source: interface-docpage.md -->

# DocPage

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/generators/mdx.generator.ts` (line 40)

Documentation page content for API sync

## Properties

| Property | Type |
|---|---|
| `slug` | `string` |
| `title` | `string` |
| `description` | `string` |
| `type` | `string` |
| `content` | `string` |
| `order` | `number` |
| `parentSlug` | `string` |
| `entityId` | `string` |

<!-- source: interface-docsearchresult.md -->

# DocSearchResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 137)

Document search result from Azure AI Search.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `content` | `string` |
| `moduleId` | `string` |
| `score` | `number` |

<!-- source: type-domainstatus.md -->

# DomainStatus

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/lib/api-client.ts` (line 42)

## Definition

```ts
| 'pending_dns'
  | 'verifying'
  | 'issuing_certificate'
  | 'live'
  | 'verification_failed'
  | 'certificate_failed'
  | 'offline'
  | 'removed'
```

<!-- source: service-entitymapper.md -->

# EntityMapper

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/services/entity-mapper.service.ts` (line 1)

<!-- source: class-envparser-2.md -->

# EnvParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/config-docs/env.parser.ts` (line 64)

Environment Variable Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: function-extractjsdocdescription.md -->

# extractJSDocDescription

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 493)

Extract JSDoc description from leading comments

## Signature

```ts
function extractJSDocDescription(path: NodePath): string | undefined
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath` |

**Returns:** `string | undefined`

<!-- source: type-failurecategory.md -->

# FailureCategory

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/types.ts` (line 47)

Classified reason for task failure.

## Definition

```ts
| 'timeout'           // Task exceeded time limit
  | 'no_changes'        // Agent didn't modify any files
  | 'test_failure'      // Changes made but tests still fail
  | 'setup_error'       // Workspace setup failed (clone, patch, install)
  | 'agent_error'       // Agent runtime error
  | 'wrong_…
```

<!-- source: type-fetchworkflowsfn.md -->

# FetchWorkflowsFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/tools/query-product-knowledge.tool.ts` (line 37)

Fetch user workflows (state machines, journeys) discovered from code.

## Definition

```ts
(
  projectId: string,
  options?: { featureId?: string; limit?: number },
) => Promise<ProductWorkflow[]>
```

<!-- source: api-endpoint-findall.md -->

# findAll

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/src/users/users.controller.ts` (line 34)

## Endpoint

`GET /users`

| Parameter | In | Type | Required |
|---|---|---|---|
| `paginationQuery` | query | `PaginationQueryDto` | ✓ |

## Referenced By

- `UsersController` (MODULE_DECLARES)

<!-- source: function-flowstepskey.md -->

# flowStepsKey

**Kind:** Function

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/flow-replay.service.ts` (line 34)

Redis key holding the ordered per-step results for a flow-replay job.

## Signature

```ts
function flowStepsKey(jobId: string)
```

## Parameters

| Name | Type |
|---|---|
| `jobId` | `string` |

<!-- source: constant-frame-actions.md -->

# FRAME_ACTIONS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 40)

<!-- source: function-getallparserinstances.md -->

# getAllParserInstances

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/queue/processors/parser-registry.ts` (line 139)

Get all parser instances

## Signature

```ts
function getAllParserInstances(): Map<string, IParser>
```

**Returns:** `Map<string, IParser>`

<!-- source: api-endpoint-getbyid.md -->

# getById

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.controller.ts` (line 137)

## Endpoint

`GET /suggestions/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `SuggestionController` (MODULE_DECLARES)
- `SuggestionAliasController` (MODULE_DECLARES)

<!-- source: constant-gpt54-family-routing-table.md -->

# GPT54_FAMILY_ROUTING_TABLE

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-router.ts` (line 80)

Production routing table for atlas-docs-resource (East US 2).
Use this when all three GPT-5.4 family models are deployed.

Cost profile vs using gpt-5.6-terra for everything:
  - 60-70% of calls (explore/analyze/tool_dispatch) → nano/mini → ~15-6x cheaper
  - plan/implement (quality-critical) → gpt-5.6-terra full

## Definition

```ts
ModelRoutingTable
```

<!-- source: type-herolayout.md -->

# HeroLayout

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 12)

PME Core Types

Domain types for the Product Marketing Engine.
These are PME-specific — not generic agent types.

## Definition

```ts
'centered' | 'split-left' | 'split-right' | 'minimal'
```

<!-- source: type-jobstatus-2.md -->

# JobStatus

**Kind:** Type

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 668)

## Definition

```ts
'pending' | 'running' | 'completed' | 'failed'
```

<!-- source: graphql-mutation-likepost.md -->

# likePost

**Kind:** Graphql Mutation

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Like a post

## Relationships

- TYPE_OF → `Like`

## Referenced By

- `Mutation` (CALLS_API)

<!-- source: type-llmcomplete.md -->

# LlmComplete

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/grounded-ask.ts` (line 13)

## Definition

```ts
(prompt: string) => Promise<string>
```

<!-- source: class-newdocumentpage.md -->

# NewDocumentPage

**Kind:** Class

**Source:** `atloria-monorepo/apps/web-e2e/src/pages/documents.page.ts` (line 254)

New document page object

**Extends:** `BasePage`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `goto` | `goto()` | `Promise<void>` |
| `createBlankDocument` | `createBlankDocument(title: string)` | `Promise<void>` |
| `createFromTemplate` | `createFromTemplate(templateName: string)` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `titleInput` | `Locator` |
| `createButton` | `Locator` |
| `templateGallery` | `Locator` |

<!-- source: api-endpoint-renderpdf.md -->

# renderPdf

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/pdf/pdf.controller.ts` (line 30)

Render composed HTML to a PDF binary.

POST /api/screenshot/pdf
Body: { "html": "<!DOCTYPE html>…", "options": { "format": "A4" } }
Returns: application/pdf bytes.

The HTML may use CSS `page-break-after`/`page-break-before` to control
per-page breaks (the API's doc export puts one doc page per printed page).

## Endpoint

`POST /screenshot/pdf`

## Referenced By

- `PdfController` (MODULE_DECLARES)

<!-- source: enum-repositoryprovider.md -->

# RepositoryProvider

**Kind:** Enum

**Source:** `atloria-monorepo/apps/api/src/parsing/dto/parse-project.dto.ts` (line 5)

## Values

- `GITHUB`
- `AZURE_DEVOPS`
- `GITLAB`

<!-- source: enum-suggestionstatus.md -->

# SuggestionStatus

**Kind:** Enum

**Source:** `atloria-monorepo/packages/types/src/enums/index.ts` (line 65)

Suggestion status tracks the review state of document suggestions

## Values

- `PENDING`
- `ACCEPTED`
- `REJECTED`

<!-- source: constant-targeting-tasks.md -->

# TARGETING_TASKS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/pme-agent/test/discovery/ground-truth.ts` (line 164)

## Definition

```ts
TargetingTask[]
```

<!-- source: interface-testtemplatedata.md -->

# TestTemplateData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 153)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `category` | `TemplateCategory` |
| `content` | `string` |
| `thumbnail` | `string` |
| `createdAt` | `string` |
| `updatedAt` | `string` |

<!-- source: type-updateuser.md -->

# UpdateUser

**Kind:** Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `email` | `string` |

## Referenced By

- `updateUser` (REFERENCES)
- `User Management API` (TYPE_OF)

<!-- source: enum-userjourneynodetype.md -->

# UserJourneyNodeType

**Kind:** Enum

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/user-journey.interface.ts` (line 18)

User Journey Interfaces

Defines data structures for representing user journeys and flows
that will be converted into Mermaid flowchart diagrams.

User journeys differ from state machines:
- State machines focus on system states and transitions
- User journeys focus on user actions, screens, and navigation paths

## Values

- `START`
- `END`
- `SCREEN`
- `ACTION`
- `DECISION`
- `MODAL`
- `PROCESS`
- `NAVIGATION`
- `SUBFLOW`

<!-- source: constant-addeditorwrapper.md -->

# addEditorWrapper$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 764)

Lets you add React components as wrappers around the editor.

<!-- source: function-admonitionlabelsmap.md -->

# admonitionLabelsMap

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/ChangeAdmonitionType.tsx` (line 9)

## Signature

```ts
function admonitionLabelsMap(t: Translation): Record<(typeof ADMONITION_TYPES)[number], string>
```

## Parameters

| Name | Type |
|---|---|
| `t` | `Translation` |

**Returns:** `Record<(typeof ADMONITION_TYPES)[number], string>`

<!-- source: interface-agentprotocoleventmap.md -->

# AgentProtocolEventMap

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/protocol/agent-protocol.ts` (line 36)

## Properties

| Property | Type |
|---|---|
| `'agent:thinking'` | `{ agentName: string }` |
| `'agent:tool_start'` | `{ toolName: string; input: string }` |
| `'agent:tool_end'` | `{ toolName: string; outputPreview: string; durationMs: number }` |
| `'agent:message'` | `{ text: string; agentName: string; delta: boolean }` |
| `'agent:turn_done'` | `{ turnNumber: number; usage: TokenUsage }` |
| `'agent:error'` | `{ message: string; recoverable: boolean }` |
| `'agent:status_update'` | `{ code: string; message: string }` |
| `'agent:input_queued'` | `{ message: string; position: number }` |
| `'agent:verbose'` | `{ category: string; message: string; data?: Record<string, unknown>; timestamp: number }` |
| `'agent:ended'` | `{ totalUsage: TokenUsage; turnCount: number }` |
| `'agent:todo'` | `{ items: ReadonlyArray<TodoItem>; stats: TodoStats }` |
| `'agent:plan_ready'` | `{ plan: string }` |
| `'agent:plan_approved'` | `Record<string, never>` |
| `'agent:model_switched'` | `{ from: string; to: string; reason: string }` |
| `'agent:session_start'` | `{ model: string; workspace?: string }` |
| `'agent:session_end'` | `{ totalUsage: TokenUsage; turnCount: number; reason: 'completed' | 'error' | 'cancelled' }` |
| `'agent:pre_compact'` | `{ turnNumber: number; tokenCount: number; recentFiles: string[] }` |
| `'agent:post_compact'` | `{ turnNumber: number; summaryInjected: boolean }` |
| `'agent:subagent_start'` | `{ agentName: string; task: string }` |
| `'agent:subagent_end'` | `{ agentName: string; output: string; durationMs: number }` |
| `'agent:user_prompt_submit'` | `{ message: string }` |

<!-- source: interface-agentregeninput.md -->

# AgentRegenInput

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-pr/agent-regen.service.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `clonePath` | `string` |
| `entityName` | `string` |
| `entityFile` | `string` |
| `diff` | `string` |
| `before` | `string` |

<!-- source: interface-aimessage-2.md -->

# AIMessage

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/ai-provider.interface.ts` (line 10)

## Properties

| Property | Type |
|---|---|
| `role` | `'system' | 'user' | 'assistant'` |
| `content` | `string` |

<!-- source: service-aiusageservice.md -->

# AIUsageService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/ai/ai-usage.service.ts` (line 112)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `calculateCost` | `calculateCost(model: string, usage: TokenUsage)` | `UsageCost` |
| `trackUsage` | `trackUsage(params: TrackUsageParams)` | `Promise<UsageCost>` |
| `deductCredits` | `deductCredits(organizationId: string, amount: number, transaction: {
      referenceType: string;
      referenceId: string;
      description: string;
      userId: string;
    })` | `Promise<{ balance: number }>` |
| `getOrganizationUsage` | `getOrganizationUsage(organizationId: string, startDate: Date, endDate: Date)` | `unknown` |
| `queryLogs` | `queryLogs(opts: {
    organizationId: string;
    projectId?: string;
    userId?: string;
    provider?: string;
    model?: string;
    operationType?: string;
    startDate?: string;
    endDate?: string;
    limit?: number;
    offset?: number;
  })` | `unknown` |
| `getOrganizationBalance` | `getOrganizationBalance(organizationId: string)` | `unknown` |
| `addCredits` | `addCredits(organizationId: string, amount: number, userId: string, description: string, reference: { type: string; id: string })` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: controller-assetscontroller.md -->

# AssetsController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/assets/assets.controller.ts` (line 21)

## Relationships

- MODULE_DECLARES → `uploadImage`
- MODULE_DECLARES → `listAssets`
- MODULE_DECLARES → `getAsset`
- MODULE_DECLARES → `deleteAsset`
- DEPENDS_ON → `assetsservice`

<!-- source: constant-assist-credit-cost.md -->

# ASSIST_CREDIT_COST

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/billing/billing.constants.ts` (line 23)

<!-- source: class-atloriaavatar.md -->

# AtloriaAvatar

**Kind:** Class

**Source:** `atloria-monorepo/packages/ui-core/src/components/avatar/Avatar.ts` (line 17)

An avatar component that displays images or initials

**Extends:** `LitElement`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `render` | `render()` | `void` |

## Properties

| Property | Type |
|---|---|
| `styles` | `any` |
| `src` | `any` |
| `alt` | `any` |
| `name` | `any` |
| `initials` | `any` |
| `size` | `AvatarSize` |
| `shape` | `AvatarShape` |
| `status` | `'online' | 'offline' | 'busy' | 'away'` |
| `ring` | `any` |
| `clickable` | `any` |
| `group` | `any` |

<!-- source: module-auditmodule.md -->

# AuditModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/audit/audit.module.ts` (line 7)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_DECLARES → `auditcontroller`
- MODULE_PROVIDES → `auditservice`
- MODULE_EXPORTS → `auditservice`

<!-- source: interface-authconfigdiscovery.md -->

# AuthConfigDiscovery

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/permission-extractor.ts` (line 40)

Authentication configuration discovered in source code

## Properties

| Property | Type |
|---|---|
| `loginRoute` | `string` |
| `roles` | `string[]` |
| `roleSource` | `RoleSourceType` |
| `templatePermissions` | `string[]` |
| `guardNames` | `string[]` |

<!-- source: interface-awarenessstate.md -->

# AwarenessState

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useCollaboration.ts` (line 48)

Awareness state for a user

## Properties

| Property | Type |
|---|---|
| `userId` | `string` |
| `userName` | `string` |
| `color` | `string` |
| `cursor` | `CursorPosition` |
| `selection` | `SelectionRange` |

<!-- source: class-azuremodelprovider.md -->

# AzureModelProvider

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-adapter.ts` (line 663)

Azure Model Provider — factory that returns AzureResponsesModel instances.
Passed to the SDK Runner as the modelProvider.

Supports model fallback: if a fallbackModel is configured, the provider
wraps the primary model with automatic failover. When the primary model
fails with a non-transient error (e.g., model unavailable, quota exceeded),
it transparently switches to the fallback model for the rest of the run.

Inspired by Claude Code's FallbackTriggeredError → switch models pattern.

**Implements:** `ModelProvider`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getProfile` | `getProfile()` | `ModelCapabilityProfile` |
| `getModel` | `getModel(modelName: string)` | `AzureResponsesModel` |

<!-- source: class-azureresponsesprovider.md -->

# AzureResponsesProvider

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/ai/providers/azure-responses.provider.ts` (line 34)

Azure Responses API Provider

Implements the NestJS AIProvider interface using the Azure OpenAI Responses API.
This is a fundamentally different API format from Chat Completions:
- Request: `input` (not `messages`), `instructions` (not system role), `max_output_tokens`
- Response: `output_text`, `usage.input_tokens`/`output_tokens`
- Streaming: typed `event:` + `data:` pairs with `response.output_text.delta` events

**Implements:** `AIProvider`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `isAvailable` | `isAvailable()` | `Promise<boolean>` |
| `generateText` | `generateText(prompt: string, options: GenerateOptions)` | `Promise<string>` |
| `generateTextWithUsage` | `generateTextWithUsage(prompt: string, options: GenerateOptions)` | `Promise<AIResponse>` |
| `generateStream` | `generateStream(prompt: string, options: GenerateOptions)` | `AsyncIterableIterator<string>` |
| `analyze` | `analyze(content: string, type: AnalysisType)` | `Promise<AnalysisResult>` |

## Properties

| Property | Type |
|---|---|
| `name` | `string` |

<!-- source: type-backendframework.md -->

# BackendFramework

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/framework.types.ts` (line 30)

Detected backend framework

## Definition

```ts
| 'dotnet'
  | 'express'
  | 'nestjs'
  | 'fastify'
  | 'koa'
  | 'hono'
  | 'fastapi'
  | 'django'
  | 'flask'
  | 'spring'
  | 'rails'
  | 'laravel'
  | 'unknown'
```

<!-- source: function-buildcodereviewplan.md -->

# buildCodeReviewPlan

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/workflows/code-review.ts` (line 59)

Build a code review orchestration plan.

Launches 3 parallel reviewers with different focuses and applies
confidence-based filtering to produce a deduplicated, prioritized
issue list.

## Signature

```ts
function buildCodeReviewPlan(options: {
  diffContext?: string;
  guidelines?: string;
  confidenceThreshold?: number;
}): OrchestrationPlan
```

## Parameters

| Name | Type |
|---|---|
| `options` | `{
  diffContext?: string;
  guidelines?: string;
  confidenceThreshold?: number;
}` |

**Returns:** `OrchestrationPlan`

<!-- source: function-buildgroundedprompt.md -->

# buildGroundedPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/grounded-ask.ts` (line 18)

Build the grounded prompt: each source leads with its citable [path] id.

## Signature

```ts
function buildGroundedPrompt(question: string, context: DocSearchHit[]): string
```

## Parameters

| Name | Type |
|---|---|
| `question` | `string` |
| `context` | `DocSearchHit[]` |

**Returns:** `string`

<!-- source: function-buildmcpsnippets.md -->

# buildMcpSnippets

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/McpInstallBlock.tsx` (line 44)

Build the copy-paste snippet + optional deeplink for each client.

## Signature

```ts
function buildMcpSnippets({
  mcpUrl,
  serverName,
  authToken,
}: {
  mcpUrl: string;
  serverName: string;
  authToken?: string;
})
```

## Parameters

| Name | Type |
|---|---|
| `{
  mcpUrl,
  serverName,
  authToken,
}` | `{
  mcpUrl: string;
  serverName: string;
  authToken?: string;
}` |

<!-- source: function-buildqataskprompt.md -->

# buildQaTaskPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/qa.prompts.ts` (line 73)

## Signature

```ts
function buildQaTaskPrompt(pageUrl: string, viewport: string): string
```

## Parameters

| Name | Type |
|---|---|
| `pageUrl` | `string` |
| `viewport` | `string` |

**Returns:** `string`

<!-- source: function-buildsystemprompt.md -->

# buildSystemPrompt

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/support-agent/prompts/system-prompt-layers.ts` (line 239)

Assembles all prompt layers into a complete system prompt

## Signature

```ts
function buildSystemPrompt(context: PromptContext): string
```

## Parameters

| Name | Type |
|---|---|
| `context` | `PromptContext` |

**Returns:** `string`

<!-- source: constant-categoryvariants.md -->

# categoryVariants

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/constants/templateCategories.ts` (line 47)

Badge variants for each category

## Definition

```ts
Record<
  TemplateCategory,
  'primary' | 'secondary' | 'info' | 'success' | 'warning' | 'error' | 'default'
>
```

<!-- source: function-checkmemoryleaks.md -->

# checkMemoryLeaks

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/performance.ts` (line 253)

Check for memory leaks by monitoring heap size

## Signature

```ts
async function checkMemoryLeaks(page: Page, action: () => Promise<void>, iterations): Promise<{
  hasLeak: boolean;
  heapGrowth: number;
  initialHeap: number;
  finalHeap: number;
}>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |
| `action` | `() => Promise<void>` |
| `iterations` | `any` |

**Returns:** `Promise<{
  hasLeak: boolean;
  heapGrowth: number;
  initialHeap: number;
  finalHeap: number;
}>`

<!-- source: component-colorstoolbar.md -->

# ColorsToolbar

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/colors.tsx` (line 27)

## Diagram

```mermaid
graph TD
    component_ColorsToolbar_3f580f2a["ColorsToolbar"]
    class component_ColorsToolbar_3f580f2a rootComponent
```

## Relationships

- USES_HOOK → `useCellValues`
- USES_HOOK → `useMemo`

## Referenced By

- `SpanWithColor` (RENDERS)

<!-- source: component-comparisonrow.md -->

# ComparisonRow

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/comparison-row.tsx` (line 16)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `featureKey` | `string` | ✓ | - |
| `values` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ComparisonRow_2fc9e457["ComparisonRow"]
    class component_ComparisonRow_2fc9e457 rootComponent
```

## Relationships

- RENDERS → `Check`
- RENDERS → `X`
- USES_HOOK → `useTranslation`

<!-- source: class-componenthintsdto.md -->

# ComponentHintsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 293)

Component library hints

## Properties

| Property | Type |
|---|---|
| `componentLibrary` | `'devextreme' | 'mui' | 'antd' | 'primeng'` |
| `componentHints` | `string` |

<!-- source: interface-controllerentity.md -->

# ControllerEntity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 790)

Controller entity

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.CONTROLLER` |
| `basePath` | `string` |
| `guards` | `string[]` |
| `interceptors` | `string[]` |
| `endpoints` | `string[]` |
| `dependencies` | `DependencyInfo[]` |

<!-- source: component-copybutton.md -->

# CopyButton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Domains/DomainTab.tsx` (line 124)

Small copy-to-clipboard button used in every DNS table cell.

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `value` | `string` | ✓ | - |
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_CopyButton_308f90ac["CopyButton"]
    class component_CopyButton_308f90ac rootComponent
```

## Relationships

- RENDERS → `CheckIcon`
- RENDERS → `ClipboardDocumentIcon`
- USES_HOOK → `useState`

## Referenced By

- `SubdomainCard` (RENDERS)
- `CustomDomainCard` (RENDERS)

<!-- source: function-createdataprovider.md -->

# createDataProvider

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/providers/index.ts` (line 19)

Create a data provider based on mode

## Signature

```ts
function createDataProvider(config: DataProviderConfig): DataProvider
```

## Parameters

| Name | Type |
|---|---|
| `config` | `DataProviderConfig` |

**Returns:** `DataProvider`

<!-- source: function-createsitegenagent.md -->

# createSiteGenAgent

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/agents/site-gen.agent.ts` (line 74)

Create the site generation agent config.

Usage:
```typescript
const agent = createSiteGenAgent(config, deps);
const result = await runtime.run(agent, {
  data: { projectId, userId, outputDir },
  input: 'Generate a marketing site for this project.',
});
```

## Signature

```ts
function createSiteGenAgent(config: SiteGenConfig, deps: SiteGenDependencies): AgentConfig<SiteGenContext>
```

## Parameters

| Name | Type |
|---|---|
| `config` | `SiteGenConfig` |
| `deps` | `SiteGenDependencies` |

**Returns:** `AgentConfig<SiteGenContext>`

<!-- source: graphql-type-createuserinput.md -->

# CreateUserInput

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Input for creating a user

## Referenced By

- `createUser` (TYPE_OF)

<!-- source: type-deskbucket.md -->

# DeskBucket

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/issues/dto/desk.dto.ts` (line 25)

## Definition

```ts
(typeof DESK_BUCKETS)[number]
```

<!-- source: type-emptystatetype.md -->

# EmptyStateType

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/components/common/EmptyState.tsx` (line 14)

## Definition

```ts
| 'no-projects'
  | 'no-categories'
  | 'no-documents'
  | 'no-search-results'
  | 'no-templates'
  | 'no-versions'
```

<!-- source: interface-existingscreenshot.md -->

# ExistingScreenshot

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot-metadata.service.ts` (line 26)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `assetId` | `string` |
| `url` | `string` |
| `version` | `number` |
| `contentHash` | `string` |
| `stateType` | `string` |
| `flowStepId` | `string` |

<!-- source: class-expressparser-2.md -->

# ExpressParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/backend/express.parser.ts` (line 41)

Express Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: function-extractpropsfromparameter.md -->

# extractPropsFromParameter

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 147)

Extract props from a function component's first parameter

## Signature

```ts
function extractPropsFromParameter(param: t.Node | null | undefined): PropInfo[]
```

## Parameters

| Name | Type |
|---|---|
| `param` | `t.Node | null | undefined` |

**Returns:** `PropInfo[]`

<!-- source: service-featureextractorservice.md -->

# FeatureExtractorService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-03-features/extractor.service.ts` (line 1)

<!-- source: interface-featureiconprops.md -->

# FeatureIconProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/feature-icon.tsx` (line 11)

## Properties

| Property | Type |
|---|---|
| `icon` | `LucideIcon` |
| `size` | `number` |
| `className` | `string` |

<!-- source: api-endpoint-findone.md -->

# findOne

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/src/users/users.controller.ts` (line 41)

## Endpoint

`GET /users/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `UsersController` (MODULE_DECLARES)

<!-- source: service-flowreplayservice.md -->

# FlowReplayService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/flow-replay.service.ts` (line 51)

FlowReplayService (WS-A) — the sequential single-context walk.

Replays a recorded flow in ONE browser context / ONE page, shooting a
screenshot after each action (plus one for the initial state). The first shot
is uploaded immediately ("first shot fast") so the reader sees something while
the rest of the walk runs. Every step is best-effort: a failed step is logged
and the walk continues, mirroring the batch service's resilience.

All heavy lifting reuses the Phase-0 foundation (AuthContextService,
PageSettleService, ActionExecutorService, AnnotationEmitterService, crop
helpers, StorageService, ScreenshotMetadataService) — nothing is forked.

`FlowReplayService` replays a recorded user flow sequentially in a single browser context and single page, capturing a screenshot for the initial state and after each action. It prioritizes uploading the first screenshot immediately (“first shot fast”) so consumers see early feedback while the remaining steps continue. Each step is executed best-effort: failures are logged and the replay continues, reusing the shared Phase-0 services (auth, settle, action execution, annotations, cropping, storage, metadata).

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createFlowJob` | `createFlowJob(dto: FlowReplayRequestDto)` | `Promise<BatchScreenshotJobResponseDto>` |
| `replayFlow` | `replayFlow(jobId: string, dto: FlowReplayRequestDto)` | `Promise<void>` |
| `getFlowSteps` | `getFlowSteps(jobId: string)` | `Promise<FlowStepResult[] | undefined>` |
| `reshootStep` | `reshootStep(dto: FlowReshootRequestDto)` | `Promise<FlowStepResult | null>` |
| `replayForLocales` | `replayForLocales(dto: FlowLocalesRequestDto)` | `Promise<LocaleFlowResult[]>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant Caller
  participant FlowReplayService as FlowReplayService
  participant Auth as AuthContextService
  participant PageSettle as PageSettleService
  participant Exec as ActionExecutorService
  participant Annot as AnnotationEmitterService
  participant Shot as ScreenshotMetadataService
  participant Storage as StorageService

  Caller->>FlowReplayService: replay(flowRecording, options)
  FlowReplayService->>Auth: init single browser context + page
  FlowReplayService->>PageSettle: settle initial state
  FlowReplayService->>Annot: emit annotations (initial)
  FlowReplayService->>Shot: capture + build metadata (initial)
  FlowReplayService->>Storage: upload(initial) (first shot fast)
  FlowReplayService-->>Caller: emit/return initial result (early)

  loop each recorded action
    FlowReplayService->>Exec: execute(action)
    alt action fails
      FlowReplayService->>FlowReplayService: log error, continue
    end
    FlowReplayService->>PageSettle: settle after action
    FlowReplayService->>Annot: emit annotations (step)
    FlowReplayService->>Shot: capture + build metadata (step)
    FlowReplayService->>Storage: upload(step)
  end

  FlowReplayService->>Auth: dispose/cleanup context
  FlowReplayService-->>Caller: final replay result
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { FlowReplayService } from './screenshot/services/flow-replay.service';

@Injectable()
export class FlowReplayRunner {
  constructor(private readonly flowReplay: FlowReplayService) {}

  async runRecordedFlow(flowRecording: any) {
    // Typical call shape: pass the recorded flow + any replay options.
    // (Exact DTOs/options depend on your app; this illustrates usage.)
    const result = await this.flowReplay.replay(flowRecording, {
      // e.g. storagePrefix, viewport, crop, annotations, etc.
      firstShotFast: true,
    });

    // result usually includes per-step screenshot refs/metadata
    // and any logged step errors (best-effort execution).
    return result;
  }
}
```

## AI Coding Instructions

- Keep replays strictly single-context / single-page; do not introduce parallel pages here—use the batch/parallel service for that.
- Preserve the “first shot fast” behavior: upload/emit the initial screenshot as early as possible before executing the rest of the steps.
- Treat each action as best-effort: catch and log step failures, then continue; avoid failing the entire replay unless setup/teardown is broken.
- Reuse Phase-0 integration points (AuthContextService, PageSettleService, ActionExecutorService, AnnotationEmitterService, crop helpers, StorageService, ScreenshotMetadataService) instead of duplicating logic.
- Always run settle + annotation emission before capturing screenshots to avoid flakey, mid-transition images and inconsistent overlays.

## Relationships

- DEPENDS_ON → `playwrightservice`
- DEPENDS_ON → `storageservice`
- DEPENDS_ON → `screenshotmetadataservice`
- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `redisservice`
- DEPENDS_ON → `actionexecutorservice`
- DEPENDS_ON → `authcontextservice`
- DEPENDS_ON → `pagesettleservice`
- DEPENDS_ON → `annotationemitterservice`
- DEPENDS_ON → `configservice`

<!-- source: interface-generatedimageresult.md -->

# GeneratedImageResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 177)

Generated image result from GPT-image-1.5.

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `cdnUrl` | `string` |
| `width` | `number` |
| `height` | `number` |
| `format` | `string` |
| `sizeBytes` | `number` |

<!-- source: api-endpoint-getbyid-2.md -->

# getById

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.controller.ts` (line 137)

## Endpoint

`GET /suggestions/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `SuggestionController` (MODULE_DECLARES)
- `SuggestionAliasController` (MODULE_DECLARES)

<!-- source: function-getfixtureurl.md -->

# getFixtureUrl

**Kind:** Function

**Source:** `atloria-monorepo/apps/screenshot-worker/test/fixtures/pages/index.ts` (line 20)

Get file:// URL for a fixture page

## Signature

```ts
function getFixtureUrl(page: keyof typeof FIXTURE_PAGES): string
```

## Parameters

| Name | Type |
|---|---|
| `page` | `keyof typeof FIXTURE_PAGES` |

**Returns:** `string`

<!-- source: function-getparserinstance.md -->

# getParserInstance

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/queue/processors/parser-registry.ts` (line 132)

Get a parser instance by name

## Signature

```ts
function getParserInstance(name: string): IParser | undefined
```

## Parameters

| Name | Type |
|---|---|
| `name` | `string` |

**Returns:** `IParser | undefined`

<!-- source: type-hookableevent.md -->

# HookableEvent

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/session/hook-registry.ts` (line 36)

Events that can have external command hooks

## Definition

```ts
| 'session_start'
  | 'session_end'
  | 'pre_tool_use'
  | 'post_tool_use'
  | 'pre_compact'
  | 'post_compact'
  | 'subagent_start'
  | 'subagent_end'
  | 'user_prompt_submit'
```

<!-- source: type-howitworkslayout.md -->

# HowItWorksLayout

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 14)

## Definition

```ts
'horizontal' | 'vertical-timeline' | 'cards'
```

<!-- source: constant-image-extensions.md -->

# IMAGE_EXTENSIONS

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/tools/read-file.tool.ts` (line 14)

Supported image file extensions for base64 encoding

<!-- source: type-loadstate.md -->

# LoadState

**Kind:** Type

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 111)

## Definition

```ts
typeof LOAD_STATES[number]
```

<!-- source: constant-load-states.md -->

# LOAD_STATES

**Kind:** Constant

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 110)

<!-- source: graphql-mutation-login.md -->

# login

**Kind:** Graphql Mutation

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Login user

## Relationships

- TYPE_OF → `AuthPayload`

## Referenced By

- `Mutation` (CALLS_API)

<!-- source: interface-mdxgeneratoroptions.md -->

# MdxGeneratorOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/generators/mdx.generator.ts` (line 71)

MDX generator options

## Properties

| Property | Type |
|---|---|
| `outputDir` | `string` |
| `includeSourceCode` | `boolean` |
| `includeRelationships` | `boolean` |
| `customTemplates` | `Record<string, string>` |

<!-- source: type-modalclosemethod.md -->

# ModalCloseMethod

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/utils/modal-extractor.ts` (line 22)

How a modal should be closed

## Definition

```ts
'button-text' | 'data-dismiss' | 'escape' | 'backdrop' | 'auto'
```

<!-- source: type-productknowledgemode.md -->

# ProductKnowledgeMode

**Kind:** Type

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 145)

## Definition

```ts
| 'features'
  | 'workflows'
  | 'categories'
  | 'search'
  | 'stats'
  | 'audiences'
  | 'screenshots'
```

<!-- source: class-registerpage.md -->

# RegisterPage

**Kind:** Class

**Source:** `atloria-monorepo/apps/web-e2e/src/pages/auth.page.ts` (line 89)

Register page object

**Extends:** `BasePage`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `goto` | `goto()` | `Promise<void>` |
| `register` | `register(name: string, email: string, password: string, confirmPassword: string)` | `Promise<void>` |
| `registerAndWait` | `registerAndWait(name: string, email: string, password: string)` | `Promise<void>` |
| `hasError` | `hasError()` | `Promise<boolean>` |
| `getErrorMessage` | `getErrorMessage()` | `Promise<string>` |
| `goToLogin` | `goToLogin()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `nameInput` | `Locator` |
| `emailInput` | `Locator` |
| `passwordInput` | `Locator` |
| `confirmPasswordInput` | `Locator` |
| `termsCheckbox` | `Locator` |
| `submitButton` | `Locator` |
| `errorMessage` | `Locator` |
| `loginLink` | `Locator` |

<!-- source: api-endpoint-reshootflowlocales.md -->

# reshootFlowLocales

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/batch-screenshot.controller.ts` (line 174)

Locale-fanned reshoot (F2 SUPERIOR, synchronous)

POST /api/screenshot/flow/locales

Replays the WHOLE recipe once per locale, emitting a localized screenshot set
per locale under a locale-namespaced blob key. Returns one entry per locale.

## Endpoint

`POST /screenshot/flow/locales`

## Referenced By

- `BatchScreenshotController` (MODULE_DECLARES)

<!-- source: enum-symboltype.md -->

# SymbolType

**Kind:** Enum

**Source:** `atloria-monorepo/apps/api/src/parser/interfaces/code-parser.interface.ts` (line 33)

## Values

- `FUNCTION`
- `CLASS`
- `INTERFACE`
- `TYPE`
- `VARIABLE`
- `CONSTANT`
- `METHOD`
- `PROPERTY`

<!-- source: enum-templatecategory.md -->

# TemplateCategory

**Kind:** Enum

**Source:** `atloria-monorepo/packages/types/src/enums/index.ts` (line 98)

Template categories for organizing document templates

## Values

- `API_DOCUMENTATION`
- `USER_GUIDES`
- `TECHNICAL_SPECS`
- `MEETING_NOTES`
- `REQUIREMENTS`
- `ARCHITECTURE`
- `RELEASE_NOTES`
- `TROUBLESHOOTING`
- `ONBOARDING`
- `GENERAL`

<!-- source: interface-testuser.md -->

# TestUser

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web-e2e/src/fixtures/base.fixture.ts` (line 7)

Test user credentials

## Properties

| Property | Type |
|---|---|
| `email` | `string` |
| `password` | `string` |
| `name` | `string` |

<!-- source: type-userwithprofile.md -->

# UserWithProfile

**Kind:** Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

## Relationships

- EXTENDS → `User`

## Referenced By

- `getUserById` (REFERENCES)
- `User Management API` (TYPE_OF)

<!-- source: enum-versioncomparison.md -->

# VersionComparison

**Kind:** Enum

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/version-config.ts` (line 55)

Version comparison result

## Values

- `Less`
- `Equal`
- `Greater`
- `Invalid`

<!-- source: constant-addexportvisitor.md -->

# addExportVisitor$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 366)

Adds an export visitor to be used when exporting markdown from the Lexical tree.

<!-- source: interface-agentregenresult.md -->

# AgentRegenResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-pr/agent-regen.service.ts` (line 16)

## Properties

| Property | Type |
|---|---|
| `after` | `string` |
| `confidence` | `number` |

<!-- source: interface-agentresult.md -->

# AgentResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/orchestrator.ts` (line 57)

Result from a single sub-agent execution

## Properties

| Property | Type |
|---|---|
| `agentName` | `string` |
| `focus` | `string` |
| `output` | `string` |
| `usage` | `TokenUsage` |
| `durationMs` | `number` |
| `success` | `boolean` |
| `error` | `string` |

<!-- source: interface-aiprovider-3.md -->

# AIProvider

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/ai-provider.interface.ts` (line 40)

Unified AI Provider Interface
All providers must implement this interface for plug-and-play switching.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |

<!-- source: function-always-2.md -->

# always

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/fp.ts` (line 62)

returns a function which when called always returns the passed value

## Signature

```ts
function always(value: T)
```

## Parameters

| Name | Type |
|---|---|
| `value` | `T` |

<!-- source: service-analyticsexportservice.md -->

# AnalyticsExportService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/analytics/export/analytics-export.service.ts` (line 46)

Generates analytics exports in PDF and CSV format.

PDF: built with pdfkit, branded cover page + KPIs grid + top tables.
     Returns a Buffer so the controller can stream it as a download or
     attach it to an email without writing to disk.

CSV: streams rows directly from Postgres via a Readable wrapper so we
     can export 100k+ row datasets without loading them into memory.

`AnalyticsExportService` generates analytics exports as branded PDF reports and high-volume CSV files for download or email delivery. It builds PDFs in-memory using `pdfkit` (cover page, KPI grid, and top tables) and returns a `Buffer` so callers can stream without touching disk. For CSV, it streams rows directly from Postgres through a `Readable` wrapper to handle 100k+ rows without loading results into memory.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generatePDF` | `generatePDF(opts: {
    projectId: string;
    period: number;
    sections?: ExportSection[];
  })` | `Promise<{ buffer: Buffer; filename: string }>` |
| `generateCSV` | `generateCSV(opts: {
    projectId: string;
    period: number;
    table: 'pageviews' | 'searches';
  })` | `Promise<{ stream: Readable; filename: string }>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant Client
  participant Controller as AnalyticsExportController
  participant Service as AnalyticsExportService
  participant DB as Postgres
  participant PDF as pdfkit
  participant Stream as Readable Stream

  Client->>Controller: Request export (format=pdf|csv, filters)
  Controller->>Service: generateExport(params)

  alt PDF export
    Service->>PDF: Build branded cover + KPI grid + top tables
    PDF-->>Service: Buffer (in-memory)
    Service-->>Controller: Buffer
    Controller-->>Client: Stream Buffer as download / email attachment
  else CSV export
    Service->>DB: Execute query with cursor/streaming
    DB-->>Service: Row stream
    Service->>Stream: Wrap rows into Readable (CSV lines)
    Stream-->>Controller: Stream<CSV>
    Controller-->>Client: Stream CSV download (no buffering)
  end
```

## Usage

```ts
import { Controller, Get, Query, Res } from '@nestjs/common';
import type { Response } from 'express';
import { AnalyticsExportService } from './analytics-export.service';

@Controller('/analytics/exports')
export class AnalyticsExportController {
  constructor(private readonly exports: AnalyticsExportService) {}

  @Get()
  async export(
    @Query('format') format: 'pdf' | 'csv',
    @Query('from') from: string,
    @Query('to') to: string,
    @Res() res: Response,
  ) {
    const params = { from, to }; // add any filters/grouping required by your service

    if (format === 'pdf') {
      const pdfBuffer = await this.exports.generatePdf(params);

      res.setHeader('Content-Type', 'application/pdf');
      res.setHeader('Content-Disposition', `attachment; filename="analytics-${from}-to-${to}.pdf"`);
      res.send(pdfBuffer);
      return;
    }

    const csvStream = await this.exports.generateCsvStream(params);

    res.setHeader('Content-Type', 'text/csv; charset=utf-8');
    res.setHeader('Content-Disposition', `attachment; filename="analytics-${from}-to-${to}.csv"`);

    // Pipe directly to response to avoid buffering large datasets
    csvStream.pipe(res);
  }
}
```

## AI Coding Instructions

- Keep PDF generation fully in-memory (`Buffer` output); do not write temporary files—controllers should stream the buffer to HTTP or attach it to email.
- For CSV, preserve true streaming from Postgres through a `Readable`/pipe chain; avoid `.map()`/array accumulation or `await`-ing full result sets.
- Ensure headers and backpressure are handled correctly when piping streams; always set `Content-Type`/`Content-Disposition` before piping to the response.
- When adding new fields/tables to exports, update both the PDF layout (cover/KPI grid/top tables) and CSV column order/escaping consistently; test with large datasets (100k+ rows) for memory safety.
- Integration points: controller for HTTP streaming, email sender for PDF attachments, and DB query layer for cursor/streaming access—changes in query shape can impact both formats.

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `analyticsservice`

<!-- source: class-atloriabadge.md -->

# AtloriaBadge

**Kind:** Class

**Source:** `atloria-monorepo/packages/ui-core/src/components/badge/Badge.ts` (line 17)

A badge component for displaying status, counts, or labels

**Extends:** `LitElement`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `render` | `render()` | `void` |

## Properties

| Property | Type |
|---|---|
| `styles` | `any` |
| `variant` | `BadgeVariant` |
| `size` | `BadgeSize` |
| `solid` | `any` |
| `outline` | `any` |
| `pill` | `any` |
| `dot` | `any` |
| `removable` | `any` |

<!-- source: controller-audiencecontroller.md -->

# AudienceController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/audience/audience.controller.ts` (line 22)

## Relationships

- MODULE_DECLARES → `list`
- MODULE_DECLARES → `get`
- MODULE_DECLARES → `create`
- MODULE_DECLARES → `update`
- MODULE_DECLARES → `delete`
- DEPENDS_ON → `audienceservice`

<!-- source: interface-authenticationinfo-2.md -->

# AuthenticationInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 653)

Authentication information

## Properties

| Property | Type |
|---|---|
| `type` | `'jwt' | 'oauth' | 'api-key' | 'basic' | 'bearer' | 'none'` |
| `scopes` | `string[]` |
| `optional` | `boolean` |

<!-- source: constant-auth-login-throttle.md -->

# AUTH_LOGIN_THROTTLE

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/common/throttling.module.ts` (line 19)

<!-- source: module-authmodule.md -->

# AuthModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/auth/auth.module.ts` (line 15)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `emailmodule`
- MODULE_IMPORTS → `samlmodule`
- MODULE_DECLARES → `authcontroller`
- MODULE_PROVIDES → `authservice`
- MODULE_PROVIDES → `jwtstrategy`
- MODULE_PROVIDES → `jwtauthguard`
- MODULE_PROVIDES → `rolesguard`
- MODULE_PROVIDES → `organizationguard`
- MODULE_EXPORTS → `authservice`
- MODULE_EXPORTS → `jwtauthguard`
- MODULE_EXPORTS → `rolesguard`
- MODULE_EXPORTS → `organizationguard`

<!-- source: class-azureresponsesmodel.md -->

# AzureResponsesModel

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-adapter.ts` (line 29)

Azure OpenAI Model — implements the SDK's Model interface using Azure Responses API.

**Implements:** `Model`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getResponse` | `getResponse(request: ModelRequest)` | `Promise<ModelResponse>` |
| `getStreamedResponse` | `getStreamedResponse(request: ModelRequest)` | `AsyncIterable<import('@openai/agents').ResponseStreamEvent>` |
| `getRetryAdvice` | `getRetryAdvice(args: ModelRetryAdviceRequest)` | `ModelRetryAdvice | undefined` |

<!-- source: type-badgesize.md -->

# BadgeSize

**Kind:** Type

**Source:** `atloria-monorepo/packages/ui-core/src/components/badge/Badge.ts` (line 6)

## Definition

```ts
'sm' | 'md' | 'lg'
```

<!-- source: interface-batchfileprocessorprops.md -->

# BatchFileProcessorProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Parser/BatchFileProcessor.tsx` (line 9)

## Properties

| Property | Type |
|---|---|
| `onComplete` | `(results: BatchProcessResult[]) => void` |
| `className` | `string` |

<!-- source: class-boundingboxdto.md -->

# BoundingBoxDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/capture/dto/create-flow.dto.ts` (line 19)

Percentage-of-viewport bounding box, for annotation seeding.

## Properties

| Property | Type |
|---|---|
| `x` | `number` |
| `y` | `number` |
| `w` | `number` |
| `h` | `number` |

<!-- source: function-buildevalcommand.md -->

# buildEvalCommand

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/swebench-evaluator.ts` (line 112)

Build the CLI command for running the official SWE-bench evaluation harness.

Requires:
- Docker installed and running
- `swebench` Python package installed (`pip install swebench`)
- Pre-built Docker images available (auto-pulled by harness)

## Signature

```ts
function buildEvalCommand(options: EvalCommandOptions): string
```

## Parameters

| Name | Type |
|---|---|
| `options` | `EvalCommandOptions` |

**Returns:** `string`

<!-- source: function-buildllmsfulltxt.md -->

# buildLlmsFullTxt

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/llms-txt.ts` (line 120)

## Signature

```ts
function buildLlmsFullTxt(doc: LlmsDoc): string
```

## Parameters

| Name | Type |
|---|---|
| `doc` | `LlmsDoc` |

**Returns:** `string`

<!-- source: function-buildprojecturl.md -->

# buildProjectUrl

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/url-utils.ts` (line 122)

Build a project URL from components

In production with NEXT_PUBLIC_DOCS_DOMAIN set, returns the subdomain URL.
Locally (no env var), falls back to the /p/ path.

## Signature

```ts
function buildProjectUrl(slug: string, urlId: string): string
```

## Parameters

| Name | Type |
|---|---|
| `slug` | `string` |
| `urlId` | `string` |

**Returns:** `string`

<!-- source: function-buildsectiontaskprompt.md -->

# buildSectionTaskPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/copywriter.prompts.ts` (line 55)

Section-specific task prompts — each section type gets a tailored brief.

## Signature

```ts
function buildSectionTaskPrompt(sectionType: SectionType, docContext: string): string
```

## Parameters

| Name | Type |
|---|---|
| `sectionType` | `SectionType` |
| `docContext` | `string` |

**Returns:** `string`

<!-- source: function-certsecretname.md -->

# certSecretName

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/project/k8s-ingress.service.ts` (line 21)

## Signature

```ts
function certSecretName(domain: string): string
```

## Parameters

| Name | Type |
|---|---|
| `domain` | `string` |

**Returns:** `string`

<!-- source: function-clearandtype.md -->

# clearAndType

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 30)

Clear input field and type new value

## Signature

```ts
async function clearAndType(locator: Locator, text: string): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `locator` | `Locator` |
| `text` | `string` |

**Returns:** `Promise<void>`

<!-- source: component-columneditor-2.md -->

# ColumnEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/table/TableEditor.tsx` (line 490)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `parentEditor` | `any` | ✓ | - |
| `highlightedCoordinates` | `any` | ✓ | - |
| `align` | `any` | ✓ | - |
| `lexicalTable` | `any` | ✓ | - |
| `colIndex` | `any` | ✓ | - |
| `setActiveCellWithBoundaries` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ColumnEditor_594d93["ColumnEditor"]
    class component_ColumnEditor_594d93 rootComponent
```

## Relationships

- RENDERS → `RadixPopover-Root`
- RENDERS → `RadixPopover-PopoverTrigger`
- RENDERS → `RadixPopover-Portal`
- RENDERS → `RadixPopover-PopoverContent`
- RENDERS → `RadixToolbar-Root`
- RENDERS → `RadixToolbar-ToggleGroup`
- RENDERS → `RadixToolbar-ToggleItem`
- RENDERS → `RadixToolbar-Separator`
- RENDERS → `RadixToolbar-Button`
- RENDERS → `RadixPopover-Arrow`
- USES_HOOK → `useCellValues`
- USES_HOOK → `useCallback`
- USES_HOOK → `useTranslation`

## Referenced By

- `TableEditor` (RENDERS)

<!-- source: component-comparisonsidebyside.md -->

# ComparisonSideBySide

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/comparison/comparison-side-by-side.tsx` (line 24)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `before` | `ComparisonColumn` | ✓ | - |
| `after` | `ComparisonColumn` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ComparisonSideBySide_4551bff3["ComparisonSideBySide"]
    class component_ComparisonSideBySide_4551bff3 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `X`
- RENDERS → `Check`
- USES_HOOK → `useTranslation`

<!-- source: constant-config.md -->

# config

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/middleware.ts` (line 104)

<!-- source: function-createvalidateconfigtool.md -->

# createValidateConfigTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/tools/validate-config.tool.ts` (line 12)

## Signature

```ts
function createValidateConfigTool(componentLibraryDir: string): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `componentLibraryDir` | `string` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: interface-databasemodelentity.md -->

# DatabaseModelEntity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 620)

Database Model entity

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.DATABASE_MODEL` |
| `tableName` | `string` |
| `fields` | `FieldDefinition[]` |
| `indexes` | `IndexDefinition[]` |
| `relations` | `RelationDefinition[]` |
| `orm` | `'prisma' | 'typeorm' | 'sequelize' | 'mongoose' | 'drizzle' | 'raw'` |
| `primaryKey` | `string[]` |
| `uniqueConstraints` | `UniqueConstraint[]` |

<!-- source: class-dataconfigdto.md -->

# DataConfigDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 232)

Data state configuration

## Properties

| Property | Type |
|---|---|
| `dataState` | `'empty' | 'populated' | 'error'` |
| `prerequisite` | `string` |
| `mockResponse` | `string` |
| `seedData` | `string` |
| `resetAfter` | `boolean` |

<!-- source: type-desktransition.md -->

# DeskTransition

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/issues/dto/desk.dto.ts` (line 37)

## Definition

```ts
(typeof DESK_TRANSITIONS)[number]
```

<!-- source: component-entityicon.md -->

# EntityIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/EntityTree.tsx` (line 95)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `type` | `string` | - | - |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_EntityIcon_25c38ad2["EntityIcon"]
    class component_EntityIcon_25c38ad2 rootComponent
```

## Relationships

- RENDERS → `CogIcon`
- RENDERS → `CommandLineIcon`
- RENDERS → `CircleStackIcon`
- RENDERS → `CubeIcon`
- RENDERS → `ShieldCheckIcon`
- RENDERS → `PuzzlePieceIcon`
- RENDERS → `CodeBracketIcon`
- RENDERS → `DocumentTextIcon`

## Referenced By

- `AppSection` (RENDERS)
- `EntityTree` (RENDERS)

<!-- source: function-extractpropsfromtypeannotation.md -->

# extractPropsFromTypeAnnotation

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 194)

Extract props from TypeScript type annotation

## Signature

```ts
function extractPropsFromTypeAnnotation(typeNode: t.TSType): PropInfo[]
```

## Parameters

| Name | Type |
|---|---|
| `typeNode` | `t.TSType` |

**Returns:** `PropInfo[]`

<!-- source: class-fastapiparser-2.md -->

# FastAPIParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/backend/fastapi.parser.ts` (line 35)

FastAPI Parser implementation

Uses regex-based parsing for Python files since we can't use Python AST directly in Node.js

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: interface-featureshorizontalflowprops.md -->

# FeaturesHorizontalFlowProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/features/features-horizontal-flow.tsx` (line 19)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `features` | `Feature[]` |

<!-- source: interface-flowstepresult.md -->

# FlowStepResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/flow-replay.dto.ts` (line 172)

Per-step replay result, surfaced through the batch status endpoint so the api
stitcher can place each screenshot as it becomes available.

`flowStepId`:   0 = initial state (before any action); N = state AFTER step N.
`blobUrl`:      the canonical FULL-PAGE image (flowKey without variant).
`annotationsFragment`: `#atloria-annotations=…` overlay fragment, or '' if the
                step's target could not be located.

## Properties

| Property | Type |
|---|---|
| `flowStepId` | `number` |
| `blobUrl` | `string` |
| `annotationsFragment` | `string` |

<!-- source: type-gapdraftstate.md -->

# GapDraftState

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/ThreadList.tsx` (line 25)

## Definition

```ts
| { phase: 'drafting' }
  | { phase: 'drafted'; documentId: string }
  | { phase: 'error'; message: string }
```

<!-- source: function-generatejson.md -->

# generateJson

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/generators/json.generator.ts` (line 67)

Generate JSON output files

## Signature

```ts
async function generateJson(results: ParseResult[], project: DetectedProject, outputDir: string): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `results` | `ParseResult[]` |
| `project` | `DetectedProject` |
| `outputDir` | `string` |

**Returns:** `Promise<void>`

<!-- source: interface-generationconfig.md -->

# GenerationConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 59)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `userId` | `string` |
| `targetAudience` | `string` |
| `brandVoice` | `string` |
| `language` | `string` |
| `additionalLanguages` | `string[]` |
| `pageType` | `PageType` |
| `sections` | `SectionType[]` |
| `model` | `string` |
| `theme` | `ThemeConfig` |
| `visuals` | `VisualConfig` |
| `enableVariants` | `boolean` |
| `enableThemeToggle` | `boolean` |
| `enableImageGeneration` | `boolean` |

<!-- source: service-generatorservice.md -->

# GeneratorService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/generator.service.ts` (line 1)

<!-- source: api-endpoint-getavailableparsers.md -->

# getAvailableParsers

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/orchestrator.controller.ts` (line 182)

Get available parsers

## Endpoint

`GET /api/orchestrator/parsers`

## Referenced By

- `OrchestratorController` (MODULE_DECLARES)

<!-- source: function-getparsersbycategory.md -->

# getParsersByCategory

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/queue/processors/parser-registry.ts` (line 173)

Get parser names by category
Note: API Schema parsers (openapi, graphql) are handled by the api-schema-parser microservice

## Signature

```ts
function getParsersByCategory(): Record<string, string[]>
```

**Returns:** `Record<string, string[]>`

<!-- source: type-hooksconfig.md -->

# HooksConfig

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/session/hook-registry.ts` (line 64)

The top-level hooks configuration object

## Definition

```ts
Partial<Record<HookableEvent, HookDefinition[]>>
```

<!-- source: type-imagegeneratefn.md -->

# ImageGenerateFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/tools/generate-image.tool.ts` (line 18)

Function signature for image generation.
Injected at creation time — keeps tool code framework-agnostic.

## Definition

```ts
(
  prompt: string,
  options?: {
    width?: number;
    height?: number;
    background?: 'transparent' | 'opaque' | 'auto';
    quality?: 'low' | 'medium' | 'high';
  }
) => Promise<GeneratedImageResult>
```

<!-- source: api-endpoint-list.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.controller.ts` (line 95)

## Endpoint

`GET /suggestions`

| Parameter | In | Type | Required |
|---|---|---|---|
| `documentId` | query | `string` | ✓ |

## Referenced By

- `SuggestionController` (MODULE_DECLARES)
- `SuggestionAliasController` (MODULE_DECLARES)

<!-- source: type-modaltriggertype.md -->

# ModalTriggerType

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/utils/modal-extractor.ts` (line 19)

Modal/Popup/Dialog Extractor

Extracts modal, popup, and dialog definitions from source code and templates
across multiple frontend frameworks. Finds:
- Angular: openPopup(), MatDialog.open(), modalService.show(), app-shared-popup
- React: useState modal patterns, <Modal>, <Dialog>
- Vue: v-model dialogs, $modal.show(), $bvModal.show()
- DevExtreme: dx-popup, dxPopupOptions
- Generic: Bootstrap modals, jQuery .modal() calls

Validated against real-world patterns from PAMS (Angular + DevExtreme).

## Definition

```ts
'direct' | 'programmatic' | 'navigation'
```

<!-- source: interface-navitem.md -->

# NavItem

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/generators/mdx.generator.ts` (line 62)

Navigation structure for API sync

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `href` | `string` |
| `children` | `NavItem[]` |

<!-- source: constant-no-routing-table.md -->

# NO_ROUTING_TABLE

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-router.ts` (line 99)

Single-model routing table (no routing).
All categories use the default model.
This is the implicit behavior when no routing table is configured.

## Definition

```ts
ModelRoutingTable
```

<!-- source: service-pageprofilerservice.md -->

# PageProfilerService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/discovery/page-profiler.service.ts` (line 50)

Profiles a page's interactive elements using a single page.evaluate() call.
ARIA-first selectors with framework-specific fallbacks.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `profilePage` | `profilePage(page: Page)` | `Promise<RawPageProfile>` |

<!-- source: graphql-type-postconnection.md -->

# PostConnection

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Paginated post list

## Relationships

- TYPE_OF → `Post`

## Referenced By

- `posts` (TYPE_OF)

<!-- source: type-profile.md -->

# Profile

**Kind:** Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `bio` | `string` |
| `avatarUrl` | `string` |
| `website` | `string` |
| `location` | `string` |

## Referenced By

- `User Management API` (TYPE_OF)

<!-- source: graphql-mutation-refreshtoken.md -->

# refreshToken

**Kind:** Graphql Mutation

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Refresh access token

## Relationships

- TYPE_OF → `AuthPayload`

## Referenced By

- `Mutation` (CALLS_API)

<!-- source: api-endpoint-reshootflowstep.md -->

# reshootFlowStep

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/batch-screenshot.controller.ts` (line 152)

Re-shoot ONE step of a recipe (F2, synchronous)

POST /api/screenshot/flow/reshoot

Walks the recipe up to `targetStepId` in a single context and re-captures just
that step — optionally at a new viewport / UI locale — burning any per-step
redactions into the fresh asset. Overwrites the canonical blob key and returns
the fresh { flowStepId, blobUrl, annotationsFragment } so the api can respond.

## Endpoint

`POST /screenshot/flow/reshoot`

## Referenced By

- `BatchScreenshotController` (MODULE_DECLARES)

<!-- source: class-saveastemplatemodal.md -->

# SaveAsTemplateModal

**Kind:** Class

**Source:** `atloria-monorepo/apps/web-e2e/src/pages/templates.page.ts` (line 216)

Save as template modal page object

**Extends:** `BasePage`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `goto` | `goto()` | `Promise<void>` |
| `fillDetails` | `fillDetails(name: string, description: string, category: string)` | `Promise<void>` |
| `save` | `save()` | `Promise<void>` |
| `cancel` | `cancel()` | `Promise<void>` |
| `isVisible` | `isVisible()` | `Promise<boolean>` |

## Properties

| Property | Type |
|---|---|
| `modal` | `Locator` |
| `nameInput` | `Locator` |
| `descriptionInput` | `Locator` |
| `categorySelect` | `Locator` |
| `saveButton` | `Locator` |
| `cancelButton` | `Locator` |

<!-- source: type-screenshotconfig.md -->

# ScreenshotConfig

**Kind:** Type

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/config/screenshot.config.ts` (line 55)

Type for screenshot configuration

## Definition

```ts
ReturnType<typeof screenshotConfig>
```

<!-- source: constant-screenshot-config-key.md -->

# SCREENSHOT_CONFIG_KEY

**Kind:** Constant

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/config/screenshot.config.ts` (line 60)

Configuration keys for injection

<!-- source: type-searchdocsfn.md -->

# SearchDocsFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/tools/query-product-knowledge.tool.ts` (line 48)

Full-text search across generated documentation.

## Definition

```ts
(
  projectId: string,
  query: string,
  options?: { limit?: number; documentType?: string; audience?: string },
) => Promise<ProductDocument[]>
```

<!-- source: enum-syncjobscope.md -->

# SyncJobScope

**Kind:** Enum

**Source:** `atloria-monorepo/apps/api/src/project/dto/sync-job.dto.ts` (line 17)

Sync job scope

## Values

- `ORGANIZATION`
- `PROJECT`

<!-- source: interface-testuserdata.md -->

# TestUserData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `email` | `string` |
| `name` | `string` |
| `password` | `string` |
| `avatar` | `string` |

<!-- source: enum-userrole.md -->

# UserRole

**Kind:** Enum

**Source:** `atloria-monorepo/packages/types/src/enums/index.ts` (line 10)

Enums for Atloria
These enums match the Prisma schema and are used throughout the application
Note: These are maintained separately from

## Values

- `ADMIN`
- `MAINTAINER`
- `CONTRIBUTOR`
- `VIEWER`

<!-- source: constant-addimportvisitor.md -->

# addImportVisitor$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 348)

Registers a visitor to be used when importing markdown.

<!-- source: interface-agentruntimeoptions.md -->

# AgentRuntimeOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 290)

Options for the AgentRuntime constructor.
These configure Runner-level behavior that applies to all runs.

## Properties

| Property | Type |
|---|---|
| `tracingDisabled` | `boolean` |
| `handoffInputFilter` | `(data: {
    inputHistory: unknown;
    preHandoffItems: unknown[];
    newItems: unknown[];
  }) => { inputHistory: unknown; preHandoffItems: unknown[]; newItems: unknown[] }` |

<!-- source: interface-agentsendpayload.md -->

# AgentSendPayload

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/agent/agent.types.ts` (line 80)

## Properties

| Property | Type |
|---|---|
| `message` | `string` |

<!-- source: interface-airesponse-2.md -->

# AIResponse

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/ai-provider.interface.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `content` | `string` |
| `inputTokens` | `number` |
| `outputTokens` | `number` |
| `model` | `string` |
| `stopReason` | `string` |

<!-- source: service-analyticsservice.md -->

# AnalyticsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.service.ts` (line 15)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `trackPageView` | `trackPageView(data: {
    projectId: string;
    docVersionId?: string;
    documentId?: string;
    documentSlug: string;
    sessionId: string;
    referrer?: string;
    userAgent?: string;
    country?: string;
    timeOnPage?: number;
    scrollDepth?: number;
    fingerprint?: string;
    pathname?: string;
    timestamp?: string;
    type?: string;
  }, req: any)` | `unknown` |
| `trackSearch` | `trackSearch(data: {
    projectId: string;
    docVersionId?: string;
    query: string;
    resultsCount: number;
    clickedDocId?: string;
    sessionId: string;
  })` | `unknown` |
| `getOverview` | `getOverview(projectId: string, days: unknown)` | `unknown` |
| `getVersionTraffic` | `getVersionTraffic(projectId: string, days: unknown)` | `unknown` |
| `getTopDocuments` | `getTopDocuments(projectId: string, days: unknown, limit: unknown)` | `unknown` |
| `getTopSearchQueries` | `getTopSearchQueries(projectId: string, days: unknown, limit: unknown)` | `unknown` |
| `getDailyTraffic` | `getDailyTraffic(projectId: string, days: unknown)` | `unknown` |
| `getDeviceBreakdown` | `getDeviceBreakdown(projectId: string, days: unknown)` | `unknown` |
| `getSourceBreakdown` | `getSourceBreakdown(projectId: string, days: unknown)` | `unknown` |
| `getGeoBreakdown` | `getGeoBreakdown(projectId: string, days: unknown)` | `unknown` |
| `getZeroResultSearches` | `getZeroResultSearches(projectId: string, days: unknown, limit: unknown)` | `unknown` |
| `getGhostDocs` | `getGhostDocs(projectId: string, days: unknown, limit: unknown)` | `unknown` |
| `getTrendingDocs` | `getTrendingDocs(projectId: string, days: unknown, limit: unknown)` | `unknown` |
| `getScrollDepthHistogram` | `getScrollDepthHistogram(projectId: string, days: unknown)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: function-analyzechunkrelationships.md -->

# analyzeChunkRelationships

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-02-chunking/chunk-relationship-graph.ts` (line 244)

Analyze chunk relationships for documentation purposes

## Signature

```ts
function analyzeChunkRelationships(graph: ChunkRelationshipGraph): ChunkRelationshipSummary
```

## Parameters

| Name | Type |
|---|---|
| `graph` | `ChunkRelationshipGraph` |

**Returns:** `ChunkRelationshipSummary`

<!-- source: class-atloriabutton.md -->

# AtloriaButton

**Kind:** Class

**Source:** `atloria-monorepo/packages/ui-core/src/components/button/Button.ts` (line 22)

A versatile button component with multiple variants and sizes

**Extends:** `LitElement`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `render` | `render()` | `void` |

## Properties

| Property | Type |
|---|---|
| `styles` | `any` |
| `variant` | `ButtonVariant` |
| `size` | `ButtonSize` |
| `disabled` | `any` |
| `loading` | `any` |
| `type` | `'button' | 'submit' | 'reset'` |
| `ariaLabel` | `string | null` |

<!-- source: controller-auditcontroller.md -->

# AuditController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/audit/audit.controller.ts` (line 8)

## Relationships

- MODULE_DECLARES → `query`
- MODULE_DECLARES → `exportCSV`
- MODULE_DECLARES → `exportJSON`
- DEPENDS_ON → `auditservice`

<!-- source: constant-auth-register-throttle.md -->

# AUTH_REGISTER_THROTTLE

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/common/throttling.module.ts` (line 21)

<!-- source: type-badgevariant.md -->

# BadgeVariant

**Kind:** Type

**Source:** `atloria-monorepo/packages/ui-core/src/components/badge/Badge.ts` (line 5)

## Definition

```ts
'primary' | 'secondary' | 'success' | 'warning' | 'error' | 'info'
```

<!-- source: class-bashsession.md -->

# BashSession

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/tools/bash-session.ts` (line 48)

A persistent shell session that maintains cwd, env vars, and venv activation
across commands. Spawns a single bash process and sends commands via stdin,
reading output until a unique delimiter marker signals completion.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `start` | `start()` | `Promise<void>` |
| `execute` | `execute(command: string, options: { timeout?: number })` | `Promise<BashResult>` |
| `getCwd` | `getCwd()` | `string` |
| `isDisposed` | `isDisposed()` | `boolean` |
| `isRunning` | `isRunning()` | `boolean` |
| `dispose` | `dispose()` | `void` |

<!-- source: interface-batchprocessresult.md -->

# BatchProcessResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Parser/BatchFileProcessor.tsx` (line 14)

## Properties

| Property | Type |
|---|---|
| `filename` | `string` |
| `result` | `ParseResult` |
| `error` | `string` |
| `status` | `'pending' | 'processing' | 'success' | 'error'` |

<!-- source: module-billingmodule.md -->

# BillingModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/billing/billing.module.ts` (line 12)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `configmodule`
- MODULE_IMPORTS → `aimodule`
- MODULE_DECLARES → `billingcontroller`
- MODULE_PROVIDES → `billingservice`
- MODULE_EXPORTS → `billingservice`

<!-- source: function-buildexplorationplan.md -->

# buildExplorationPlan

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/workflows/exploration.ts` (line 35)

Build a codebase exploration plan.

Launches 3 parallel explorers that investigate the codebase from different
angles, then synthesizes their findings into a unified understanding.

## Signature

```ts
function buildExplorationPlan(options: {
  query?: string;
  workspace?: string;
}): OrchestrationPlan
```

## Parameters

| Name | Type |
|---|---|
| `options` | `{
  query?: string;
  workspace?: string;
}` |

**Returns:** `OrchestrationPlan`

<!-- source: function-buildllmstxt.md -->

# buildLlmsTxt

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/llms-txt.ts` (line 92)

## Signature

```ts
function buildLlmsTxt(doc: LlmsDoc, opts: LlmsTxtOptions): string
```

## Parameters

| Name | Type |
|---|---|
| `doc` | `LlmsDoc` |
| `opts` | `LlmsTxtOptions` |

**Returns:** `string`

<!-- source: function-buildsemanticutilities.md -->

# buildSemanticUtilities

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/theme.ts` (line 162)

Build semantic utility classes that map to CSS vars.
These replace hardcoded Tailwind color classes.

## Signature

```ts
function buildSemanticUtilities(): string
```

**Returns:** `string`

<!-- source: class-bulkcapturescreenshotsdto.md -->

# BulkCaptureScreenshotsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/screenshot/dto/capture-screenshot.dto.ts` (line 101)

DTO for bulk screenshot capture (job-based)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `urls` | `string[]` |
| `viewport` | `ViewportType` |
| `browser` | `BrowserType` |
| `waitTime` | `number` |

<!-- source: interface-buttonelement.md -->

# ButtonElement

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/template-analysis.interface.ts` (line 14)

Template Analysis Interfaces

Defines structured data extracted from Angular/Vue templates
for user journey diagram generation.

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `action` | `string` |
| `line` | `number` |
| `conditionalOn` | `string` |
| `routerLink` | `string` |
| `type` | `string` |
| `attributes` | `Record<string, string>` |

<!-- source: function-calculatenewposition.md -->

# calculateNewPosition

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Boards/helpers.ts` (line 137)

Given the current cards in a destination column (excluding the moved card)
and the index where the card will land, compute its new float position.

## Signature

```ts
function calculateNewPosition(destCards: BoardCardData[], insertIndex: number): number
```

## Parameters

| Name | Type |
|---|---|
| `destCards` | `BoardCardData[]` |
| `insertIndex` | `number` |

**Returns:** `number`

<!-- source: function-clampscrolldepth.md -->

# clampScrollDepth

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/analytics/utils/tracking-utils.ts` (line 47)

Clamp scroll depth into the 0–100 range. Some browsers occasionally report
101% on bounce or with sticky footers; clamp instead of dropping the row.

## Signature

```ts
function clampScrollDepth(depth: number | null | undefined): number | null
```

## Parameters

| Name | Type |
|---|---|
| `depth` | `number | null | undefined` |

**Returns:** `number | null`

<!-- source: function-closemodal.md -->

# closeModal

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 98)

Close a modal/dialog

## Signature

```ts
async function closeModal(page: Page): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |

**Returns:** `Promise<void>`

<!-- source: constant-contenttype.md -->

# contentType

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/opengraph-image.tsx` (line 10)

<!-- source: function-createvalidatelinkstool.md -->

# createValidateLinksTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/tools/validate-links.tool.ts` (line 38)

## Signature

```ts
function createValidateLinksTool(): ToolDefinition<TContext>
```

**Returns:** `ToolDefinition<TContext>`

<!-- source: component-ctabanner.md -->

# CtaBanner

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/cta/cta-banner.tsx` (line 19)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `icon` | `LucideIcon` | - | - |

## Diagram

```mermaid
graph TD
    component_CtaBanner_54d8e8bc["CtaBanner"]
    class component_CtaBanner_54d8e8bc rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `Icon`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- USES_HOOK → `useTranslation`

<!-- source: component-datebadge-2.md -->

# DateBadge

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/social-proof/social-proof-timeline.tsx` (line 23)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `dateKey` | `string` | ✓ | - |
| `t` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DateBadge_257ada65["DateBadge"]
    class component_DateBadge_257ada65 rootComponent
```

## Referenced By

- `MilestoneCard` (RENDERS)

<!-- source: interface-dependencyinfo.md -->

# DependencyInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 750)

Dependency injection info

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `token` | `string` |
| `optional` | `boolean` |

<!-- source: type-deviceclass.md -->

# DeviceClass

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/analytics/utils/tracking-utils.ts` (line 53)

## Definition

```ts
'mobile' | 'tablet' | 'desktop' | 'unknown'
```

<!-- source: class-discoveryauthconfigdto.md -->

# DiscoveryAuthConfigDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/discovery/dto/discovery.dto.ts` (line 13)

## Properties

| Property | Type |
|---|---|
| `loginUrl` | `string` |
| `username` | `string` |
| `password` | `string` |
| `usernameSelector` | `string` |
| `passwordSelector` | `string` |
| `submitSelector` | `string` |
| `successSelector` | `string` |

<!-- source: component-externalicon.md -->

# ExternalIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/DependencyGraph.tsx` (line 103)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_ExternalIcon_2da639e7["ExternalIcon"]
    class component_ExternalIcon_2da639e7 rootComponent
```

## Referenced By

- `DependencyGraph` (RENDERS)
- `DependencyCard` (RENDERS)

<!-- source: function-extractrenderedcomponents.md -->

# extractRenderedComponents

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 352)

Extract rendered child components (JSX elements that start with uppercase)

## Signature

```ts
function extractRenderedComponents(path: NodePath): string[]
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath` |

**Returns:** `string[]`

<!-- source: interface-featuresinteractivetabsprops.md -->

# FeaturesInteractiveTabsProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/features/features-interactive-tabs.tsx` (line 23)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `tabs` | `Tab[]` |

<!-- source: class-filescanner.md -->

# FileScanner

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/utils/file-scanner.ts` (line 86)

File Scanner Class

Provides methods for scanning directories, finding files by glob patterns,
and respecting .gitignore rules.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `scan` | `scan(config: FileScannerConfig)` | `Promise<ScannedFile[]>` |
| `scanWithContent` | `scanWithContent(config: FileScannerConfig)` | `Promise<ScannedFile[]>` |
| `getFileStats` | `getFileStats(filePath: string)` | `Promise<FileStats | null>` |
| `readFile` | `readFile(filePath: string)` | `Promise<string | null>` |
| `matchesPattern` | `matchesPattern(filePath: string, pattern: string)` | `boolean` |
| `parseGitignore` | `parseGitignore(rootDir: string)` | `Promise<string[]>` |
| `countFiles` | `countFiles(config: FileScannerConfig)` | `Promise<number>` |
| `groupByExtension` | `groupByExtension(files: ScannedFile[])` | `Record<string, ScannedFile[]>` |
| `groupByDirectory` | `groupByDirectory(files: ScannedFile[])` | `Record<string, ScannedFile[]>` |
| `getSupportedExtensions` | `getSupportedExtensions()` | `ExtensionCategories` |
| `createPatternForExtensions` | `createPatternForExtensions(extensions: string[])` | `string` |
| `getTypescriptPatterns` | `getTypescriptPatterns()` | `string[]` |
| `getDefaultExcludePatterns` | `getDefaultExcludePatterns()` | `string[]` |

<!-- source: function-generatemdx.md -->

# generateMdx

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/generators/mdx.generator.ts` (line 1589)

Generate MDX documentation

## Signature

```ts
async function generateMdx(provider: DataProvider, outputDir: string, options: Partial<MdxGeneratorOptions>): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `provider` | `DataProvider` |
| `outputDir` | `string` |
| `options` | `Partial<MdxGeneratorOptions>` |

**Returns:** `Promise<void>`

<!-- source: api-endpoint-getfollowers.md -->

# getFollowers

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/src/users/users.controller.ts` (line 86)

## Endpoint

`GET /users/:id/followers`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `UsersController` (MODULE_DECLARES)

<!-- source: function-getprojectfilesbyextension.md -->

# getProjectFilesByExtension

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 81)

Get files by extension from a project

## Signature

```ts
function getProjectFilesByExtension(projectPath: string, extensions: string[]): string[]
```

## Parameters

| Name | Type |
|---|---|
| `projectPath` | `string` |
| `extensions` | `string[]` |

**Returns:** `string[]`

<!-- source: interface-htmlqualityconfig.md -->

# HtmlQualityConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/guardrails/html-quality.guardrail.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `requireViewport` | `boolean` |
| `requireAlt` | `boolean` |
| `flagInlineStyles` | `boolean` |
| `maxInlineStyles` | `number` |

<!-- source: service-hybridmapperservice.md -->

# HybridMapperService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/hybrid-mapper.service.ts` (line 1)

<!-- source: type-instructionzone.md -->

# InstructionZone

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/context/instruction-loader.ts` (line 76)

## Definition

```ts
'system' | 'project' | 'task' | 'turn'
```

<!-- source: type-jobstatus-3.md -->

# JobStatus

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 148)

Job status for tracking generation progress.

## Definition

```ts
| 'queued'
  | 'processing'
  | 'generating_content'
  | 'generating_visuals'
  | 'assembling'
  | 'completed'
  | 'failed'
```

<!-- source: type-jobstatus.md -->

# JobStatus

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationGenerator.ts` (line 9)

Job status from API

## Definition

```ts
'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED'
```

<!-- source: api-endpoint-list-2.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.controller.ts` (line 95)

## Endpoint

`GET /suggestions`

| Parameter | In | Type | Required |
|---|---|---|---|
| `documentId` | query | `string` | ✓ |

## Referenced By

- `SuggestionController` (MODULE_DECLARES)
- `SuggestionAliasController` (MODULE_DECLARES)

<!-- source: interface-localeflowresult.md -->

# LocaleFlowResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/flow-replay.dto.ts` (line 225)

One locale's full screenshot set from a locale-fanned reshoot.

## Properties

| Property | Type |
|---|---|
| `locale` | `string` |
| `steps` | `FlowStepResult[]` |

<!-- source: service-pagesettleservice.md -->

# PageSettleService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/page-settle.service.ts` (line 10)

Service for waiting until a page has fully settled before capture.

Extracted verbatim from BatchScreenshotService so batch capture, flow-replay
(WS-A) and clip capture (WS-B) share one framework-agnostic settle strategy.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectLongPollingApp` | `detectLongPollingApp(page: Page)` | `Promise<boolean>` |
| `waitForAngularAppReady` | `waitForAngularAppReady(page: Page, timeoutMs: number)` | `Promise<void>` |
| `waitForPageReady` | `waitForPageReady(page: Page, timeoutMs: number)` | `Promise<void>` |
| `waitForDomStability` | `waitForDomStability(page: Page, checkIntervalMs: number, maxChecks: number)` | `Promise<void>` |

<!-- source: constant-plan-mode-allowed-tools.md -->

# PLAN_MODE_ALLOWED_TOOLS

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/session/plan-mode-filter.ts` (line 15)

Tools allowed during plan mode (read-only investigation)

<!-- source: graphql-type-profile.md -->

# Profile

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

User profile information

## Referenced By

- `User` (TYPE_OF)

<!-- source: interface-projectmetadata.md -->

# ProjectMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/providers/data-provider.interface.ts` (line 16)

Project metadata from either source

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `type` | `string` |
| `rootDir` | `string` |
| `frameworks` | `string[]` |
| `statistics` | `{
    totalFiles: number;
    parsedFiles: number;
    entityCounts: Record<string, number>;
  }` |
| `generatedAt` | `string` |

<!-- source: type-rolesourcetype.md -->

# RoleSourceType

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/utils/permission-extractor.ts` (line 17)

Permission Extractor

Extracts permission checks, route guards, role definitions, and
authentication configuration from source code. Detects both hardcoded
and dynamic role-based access control patterns.

## Definition

```ts
'hardcoded' | 'database' | 'external' | 'unknown'
```

<!-- source: api-endpoint-scan.md -->

# scan

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/discovery/discovery.controller.ts` (line 17)

POST /api/discovery/scan

Scans a web application via headless browser: login → menu walk → page profiling → grid depth.
Returns a SiteMap with all discovered routes and their element profiles.

Synchronous — typical runtime ~6 min for a 50-page app.

## Endpoint

`POST /discovery/scan`

## Referenced By

- `DiscoveryController` (MODULE_DECLARES)

<!-- source: constant-screenshotconfig.md -->

# screenshotConfig

**Kind:** Constant

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/config/screenshot.config.ts` (line 9)

Screenshot configuration

All values can be overridden via environment variables.
This replaces the hardcoded DEFAULTS object in batch-screenshot.service.ts.

<!-- source: class-sharedocumentmodal.md -->

# ShareDocumentModal

**Kind:** Class

**Source:** `atloria-monorepo/apps/web-e2e/src/pages/collaboration.page.ts` (line 184)

Share document modal page object

**Extends:** `BasePage`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `goto` | `goto()` | `Promise<void>` |
| `inviteUser` | `inviteUser(email: string, permission: 'view' | 'edit')` | `Promise<void>` |
| `getSharedUsers` | `getSharedUsers()` | `Locator` |
| `getSharedUserCount` | `getSharedUserCount()` | `Promise<number>` |
| `removeUser` | `removeUser(email: string)` | `Promise<void>` |
| `copyLink` | `copyLink()` | `Promise<void>` |
| `close` | `close()` | `Promise<void>` |
| `isVisible` | `isVisible()` | `Promise<boolean>` |

## Properties

| Property | Type |
|---|---|
| `modal` | `Locator` |
| `emailInput` | `Locator` |
| `permissionSelect` | `Locator` |
| `inviteButton` | `Locator` |
| `sharedUsersList` | `Locator` |
| `copyLinkButton` | `Locator` |
| `closeButton` | `Locator` |

<!-- source: type-statetype.md -->

# StateType

**Kind:** Type

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 311)

## Definition

```ts
typeof STATE_TYPES[number]
```

<!-- source: enum-syncjobstatus.md -->

# SyncJobStatus

**Kind:** Enum

**Source:** `atloria-monorepo/apps/api/src/project/dto/sync-job.dto.ts` (line 6)

Sync job status enum

## Values

- `PENDING`
- `RUNNING`
- `COMPLETED`
- `FAILED`
- `CANCELLED`

<!-- source: graphql-mutation-unfollowuser.md -->

# unfollowUser

**Kind:** Graphql Mutation

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Unfollow a user

## Referenced By

- `Mutation` (CALLS_API)

<!-- source: enum-websocketstate.md -->

# WebSocketState

**Kind:** Enum

**Source:** `atloria-monorepo/packages/api-client/src/clients/WebSocketClient.ts` (line 4)

WebSocket connection states

## Values

- `CONNECTING`
- `OPEN`
- `CLOSING`
- `CLOSED`

<!-- source: constant-addlexicalnode.md -->

# addLexicalNode$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 342)

Registers a lexical node to be used in the editor.

<!-- source: interface-agentstartpayload.md -->

# AgentStartPayload

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/agent/agent.types.ts` (line 28)

Agent WebSocket Protocol Types

Defines the event contract between frontend and backend for real-time
agent sessions. Mirrors the CLI experience over WebSocket.

Client → Server:
  agent:start    — Create a new session
  agent:send     — Send a message to the agent
  agent:inject   — Inject a message mid-task
  agent:cancel   — Cancel the current operation

Server → Client:
  agent:thinking   — Agent is processing
  agent:tool_start — Tool call started
  agent:tool_end   — Tool call completed
  agent:message    — Agent text output (streamed or full)
  agent:todo       — Todo list updated
  agent:turn_done  — Turn completed with usage stats
  agent:error      — Error occurred
  agent:ended      — Session ended

## Properties

| Property | Type |
|---|---|
| `workspace` | `string` |
| `model` | `string` |
| `maxTurns` | `number` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `superMode` | `boolean` |
| `verbose` | `boolean` |
| `autonomous` | `boolean` |
| `testCommand` | `string` |
| `resumeSessionId` | `string` |
| `routingTable` | `'gpt54-family' | import('@atloria/agent-core').ModelRoutingTable` |
| `mode` | `import('@atloria/agent-core').TaskMode` |

<!-- source: interface-agenttemplate.md -->

# AgentTemplate

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/orchestrator.ts` (line 28)

A template for spawning a sub-agent within a phase

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `focus` | `string` |
| `instructions` | `string` |
| `tools` | `string[]` |
| `model` | `string` |
| `category` | `TaskCategory` |

<!-- source: interface-aisession.md -->

# AISession

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-08.types.ts` (line 28)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `phaseId` | `string` |
| `type` | `'parent' | 'child'` |
| `parentSessionId` | `string` |
| `documentIds` | `string[]` |
| `tokenBudget` | `{
    input: number;
    output: number;
  }` |
| `sharedContext` | `SharedContext` |
| `status` | `'pending' | 'running' | 'completed' | 'failed'` |

<!-- source: function-apiclient.md -->

# apiClient

**Kind:** Function

**Source:** `atloria-monorepo/packages/api-client/src/lib/api-client.ts` (line 1)

## Signature

```ts
function apiClient(): string
```

**Returns:** `string`

<!-- source: service-appservice-2.md -->

# AppService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/app/app.service.ts` (line 5)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getData` | `getData()` | `unknown` |
| `getPublicStats` | `getPublicStats()` | `unknown` |
| `healthCheck` | `healthCheck()` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `redisservice`

<!-- source: class-atloriacard.md -->

# AtloriaCard

**Kind:** Class

**Source:** `atloria-monorepo/packages/ui-core/src/components/card/Card.ts` (line 19)

A flexible card component with multiple variants and slots

**Extends:** `LitElement`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `render` | `render()` | `void` |

## Properties

| Property | Type |
|---|---|
| `styles` | `any` |
| `variant` | `CardVariant` |
| `clickable` | `any` |
| `noPadding` | `any` |
| `compact` | `any` |

<!-- source: controller-authcontroller.md -->

# AuthController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/auth/auth.controller.ts` (line 20)

## Relationships

- MODULE_DECLARES → `register`
- MODULE_DECLARES → `login`
- MODULE_DECLARES → `refresh`
- MODULE_DECLARES → `verifyEmail`
- MODULE_DECLARES → `forgotPassword`
- MODULE_DECLARES → `resetPassword`
- MODULE_DECLARES → `resendVerification`
- MODULE_DECLARES → `logout`
- MODULE_DECLARES → `getMe`
- DEPENDS_ON → `authservice`

<!-- source: class-benchmarkmonitor.md -->

# BenchmarkMonitor

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/benchmark-monitor.ts` (line 113)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `close` | `close()` | `Promise<void>` |
| `analyze` | `analyze(report: BenchmarkReport)` | `FailureAnalysis` |
| `formatAnalysis` | `formatAnalysis(analysis: FailureAnalysis)` | `string` |

## Properties

| Property | Type |
|---|---|
| `onEvent` | `any` |
| `log` | `any` |

<!-- source: module-bitbucketmodule.md -->

# BitbucketModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/bitbucket/bitbucket.module.ts` (line 10)

## Relationships

- MODULE_IMPORTS → `configmodule`
- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_DECLARES → `bitbucketcontroller`
- MODULE_PROVIDES → `bitbucketservice`
- MODULE_EXPORTS → `bitbucketservice`

<!-- source: type-blocktype.md -->

# BlockType

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 103)

The type of the block that the current selection is in.

## Definition

```ts
'paragraph' | 'quote' | HeadingTagType | ''
```

<!-- source: interface-boardcarddata.md -->

# BoardCardData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Boards/helpers.ts` (line 86)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `position` | `number` |
| `columnId` | `string` |
| `issue` | `{
    id: string;
    ticketNumber: number;
    status: string;
    priority: string;
    category: string;
    ticketType?: string;
    description: string;
    pageTitle: string | null;
    pageUrl: string | null;
    assignee: { id: string; name: string | null; email: string } | null;
    createdAt: string;
    updatedAt: string;
    _count?: { comments: number };
  }` |

<!-- source: constant-bugreporttemplate.md -->

# bugReportTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/bug-report.template.ts` (line 3)

<!-- source: function-buildfeaturedevplan.md -->

# buildFeatureDevPlan

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/workflows/feature-dev.ts` (line 29)

Build a feature development orchestration plan.

## Signature

```ts
function buildFeatureDevPlan(options: {
  featureDescription?: string;
  workspace?: string;
}): OrchestrationPlan
```

## Parameters

| Name | Type |
|---|---|
| `options` | `{
  featureDescription?: string;
  workspace?: string;
}` |

**Returns:** `OrchestrationPlan`

<!-- source: function-buildngrxstateflow.md -->

# buildNgRxStateFlow

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ngrx-pattern-detector.ts` (line 582)

Build state flow from detected NgRx patterns

## Signature

```ts
function buildNgRxStateFlow(actions: NgRxActionPattern[], _reducers: NgRxReducerPattern[], selectors: NgRxSelectorPattern[], _effects: NgRxEffectPattern[]): StateFlow | null
```

## Parameters

| Name | Type |
|---|---|
| `actions` | `NgRxActionPattern[]` |
| `_reducers` | `NgRxReducerPattern[]` |
| `selectors` | `NgRxSelectorPattern[]` |
| `_effects` | `NgRxEffectPattern[]` |

**Returns:** `StateFlow | null`

<!-- source: function-buildseometadata.md -->

# buildSeoMetadata

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/seo-metadata.tool.ts` (line 70)

Build SEO metadata from page info.
Deterministic template — no AI call needed for basic metadata.

## Signature

```ts
function buildSeoMetadata(params: {
  pageTitle: string;
  pageSummary: string;
  productName?: string;
  heroImageUrl?: string;
  keywords?: string[];
}): SeoMetadata
```

## Parameters

| Name | Type |
|---|---|
| `params` | `{
  pageTitle: string;
  pageSummary: string;
  productName?: string;
  heroImageUrl?: string;
  keywords?: string[];
}` |

**Returns:** `SeoMetadata`

<!-- source: class-bulkdeletedocumentsdto.md -->

# BulkDeleteDocumentsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/bulk-operations.dto.ts` (line 7)

Bulk delete documents

## Properties

| Property | Type |
|---|---|
| `documentIds` | `string[]` |

<!-- source: interface-cacheentry.md -->

# CacheEntry

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/config.interface.ts` (line 235)

Cache entry for incremental parsing

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `contentHash` | `string` |
| `cachedAt` | `Date` |
| `parserName` | `string` |
| `result` | `unknown` |

<!-- source: function-clamptimeonpage.md -->

# clampTimeOnPage

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/analytics/utils/tracking-utils.ts` (line 37)

Clamp a raw time-on-page value to a reasonable upper bound and floor at 0.
Returns null if the input is null/undefined so the column stays nullable.

## Signature

```ts
function clampTimeOnPage(timeOnPage: number | null | undefined): number | null
```

## Parameters

| Name | Type |
|---|---|
| `timeOnPage` | `number | null | undefined` |

**Returns:** `number | null`

<!-- source: function-clearallpendingupdates.md -->

# clearAllPendingUpdates

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useOfflineSync.ts` (line 379)

Clear all pending updates across all documents
Use with caution - this will discard all offline changes

## Signature

```ts
function clearAllPendingUpdates(): void
```

**Returns:** `void`

<!-- source: function-createmockapiresponse.md -->

# createMockAPIResponse

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 249)

## Signature

```ts
function createMockAPIResponse(data: T, options: {
    status?: number;
    message?: string;
    pagination?: {
      page: number;
      limit: number;
      total: number;
      totalPages: number;
    };
  })
```

## Parameters

| Name | Type |
|---|---|
| `data` | `T` |
| `options` | `{
    status?: number;
    message?: string;
    pagination?: {
      page: number;
      limit: number;
      total: number;
      totalPages: number;
    };
  }` |

<!-- source: function-createvalidateoutputtool.md -->

# createValidateOutputTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/tools/validate-output.tool.ts` (line 29)

## Signature

```ts
function createValidateOutputTool(): ToolDefinition<TContext>
```

**Returns:** `ToolDefinition<TContext>`

<!-- source: component-ctacard.md -->

# CtaCard

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/cta/cta-card.tsx` (line 24)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `icon` | `LucideIcon` | - | - |

## Diagram

```mermaid
graph TD
    component_CtaCard_13ae657c["CtaCard"]
    class component_CtaCard_13ae657c rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `Icon`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- USES_HOOK → `useTranslation`

<!-- source: interface-dependencynode.md -->

# DependencyNode

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/relationship.interface.ts` (line 356)

Node in a dependency tree

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `type` | `string` |
| `relationshipType` | `RelationshipType` |
| `children` | `DependencyNode[]` |
| `depth` | `number` |

<!-- source: constant-desk-state-labels.md -->

# DESK_STATE_LABELS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 139)

## Definition

```ts
Record<DeskState, string>
```

<!-- source: class-discoveryscanrequestdto.md -->

# DiscoveryScanRequestDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/discovery/dto/discovery.dto.ts` (line 40)

## Properties

| Property | Type |
|---|---|
| `siteUrl` | `string` |
| `auth` | `DiscoveryAuthConfigDto` |
| `exploreGridDepth` | `boolean` |
| `timeoutMs` | `number` |
| `pageProfileTimeoutMs` | `number` |

<!-- source: type-docaudiencescope.md -->

# DocAudienceScope

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/project/audience-scope.util.ts` (line 11)

Audience → doc-set scope mapping.

A project serves multiple doc SETS side-by-side (user manual + technical
reference). Each DocVersion belongs to exactly one scope
(DocVersion.audienceScope) and each scope has its own independent ACTIVE
version. Audiences (viewer URL segments like /p/:slug/:audienceSlug) map
onto a scope so public reads resolve the ACTIVE version of the RIGHT set.

## Definition

```ts
'user' | 'technical' | 'api'
```

<!-- source: component-downshiftautocompletewithsuggestions.md -->

# DownshiftAutoCompleteWithSuggestions

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/ui/DownshiftAutoComplete.tsx` (line 29)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `autofocus` | `any` | ✓ | - |
| `suggestions` | `any` | ✓ | - |
| `control` | `any` | ✓ | - |
| `inputName` | `any` | ✓ | - |
| `placeholder` | `any` | ✓ | - |
| `initialInputValue` | `any` | ✓ | - |
| `setValue` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DownshiftAutoCompleteWithSuggestions_158f0032["DownshiftAutoCompleteWithSuggestions"]
    class component_DownshiftAutoCompleteWithSuggestions_158f0032 rootComponent
```

## Relationships

- RENDERS → `Controller`
- USES_HOOK → `useState`
- USES_HOOK → `useCellValue`
- USES_HOOK → `useCombobox`

## Referenced By

- `DownshiftAutoComplete` (RENDERS)

<!-- source: function-extracttypestring.md -->

# extractTypeString

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 222)

Convert TypeScript type to string representation

## Signature

```ts
function extractTypeString(typeNode: t.TSType | null | undefined): string
```

## Parameters

| Name | Type |
|---|---|
| `typeNode` | `t.TSType | null | undefined` |

**Returns:** `string`

<!-- source: class-filesystemstorageprovider.md -->

# FileSystemStorageProvider

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/storage/file-system-storage.provider.ts` (line 27)

File system storage provider implementation

**Implements:** `IStorageProvider`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getMode` | `getMode()` | `StorageMode` |
| `initialize` | `initialize()` | `Promise<void>` |
| `saveScreenshot` | `saveScreenshot(buffer: Buffer, metadata: ScreenshotMetadata)` | `Promise<ScreenshotSaveResult>` |
| `findExistingScreenshot` | `findExistingScreenshot(metadata: Partial<ScreenshotMetadata>)` | `Promise<ScreenshotSaveResult | null>` |
| `saveDocument` | `saveDocument(document: DocumentMetadata)` | `Promise<DocumentSaveResult>` |
| `documentExists` | `documentExists(_projectId: string, categoryPath: string[], slug: string)` | `Promise<boolean>` |
| `listDocuments` | `listDocuments(_projectId: string, categoryPath: string[])` | `Promise<Array<{ id: string; title: string; slug: string; url: string }>>` |

<!-- source: interface-footerconfig.md -->

# FooterConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 61)

## Properties

| Property | Type |
|---|---|
| `descriptionKey` | `string` |
| `linkGroups` | `Array<{
    titleKey: string;
    links: Array<{ labelKey: string; href: string }>;
  }>` |
| `legalLinks` | `Array<{ labelKey: string; href: string }>` |

<!-- source: function-generateuserdocscommand.md -->

# generateUserDocsCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/generate-user-docs.command.ts` (line 237)

Main command handler

## Signature

```ts
async function generateUserDocsCommand(options: GenerateUserDocsOptions): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `GenerateUserDocsOptions` |

**Returns:** `Promise<void>`

<!-- source: api-endpoint-getjobresult.md -->

# getJobResult

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/orchestrator.controller.ts` (line 109)

Get job result

## Endpoint

`GET /api/orchestrator/jobs/:jobId/result`

| Parameter | In | Type | Required |
|---|---|---|---|
| `jobId` | query | `string` | ✓ |

## Referenced By

- `OrchestratorController` (MODULE_DECLARES)

<!-- source: function-getregisteredparsers.md -->

# getRegisteredParsers

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/queue/processors/parse.processor.ts` (line 64)

Get registered parser names

## Signature

```ts
function getRegisteredParsers(): string[]
```

**Returns:** `string[]`

<!-- source: interface-htmlvalidationresult.md -->

# HtmlValidationResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/tools/validate-html.tool.ts` (line 11)

## Properties

| Property | Type |
|---|---|
| `valid` | `boolean` |
| `errors` | `string[]` |
| `warnings` | `string[]` |

<!-- source: component-internalicon.md -->

# InternalIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/DependencyGraph.tsx` (line 111)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_InternalIcon_2031600b["InternalIcon"]
    class component_InternalIcon_2031600b rootComponent
```

## Referenced By

- `DependencyGraph` (RENDERS)
- `DependencyCard` (RENDERS)

<!-- source: type-journalentrytype.md -->

# JournalEntryType

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/session-journal.ts` (line 26)

## Definition

```ts
| 'goal'          // Current objective (restated at end of context)
  | 'observation'   // What the agent found (concise)
  | 'hypothesis'    // Suspected root cause (falsifiable)
  | 'failure'       // What didn't work + why (prevents retry)
  | 'progress'
```

<!-- source: type-layouttype.md -->

# LayoutType

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 21)

## Definition

```ts
| HeroLayout
  | FeaturesLayout
  | HowItWorksLayout
  | PricingLayout
  | ProblemLayout
  | SocialProofLayout
  | FaqLayout
  | CtaLayout
```

<!-- source: service-loginselectordetectorservice.md -->

# LoginSelectorDetectorService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/login-selector-detector.service.ts` (line 1)

<!-- source: type-menustyle.md -->

# MenuStyle

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/BrandingContext.tsx` (line 11)

Project branding fetched from the public project endpoint.
All fields nullable — frontend falls back to defaults (Atloria cyan +
project name) when any field is missing.

## Definition

```ts
'minimal' | 'classic' | 'sidebar' | 'developer'
```

<!-- source: service-pdfservice.md -->

# PdfService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/pdf/pdf.service.ts` (line 28)

Renders a fully-composed HTML document to PDF bytes using headless Chromium.

This is the ONE place in the platform that owns Chromium PDF rendering — the
screenshot-worker pod is the only image that ships a browser. Other services
(e.g. the API's doc-version export) compose HTML and POST it here over HTTP
rather than launching Chromium in-process.

`PdfService` renders fully composed HTML documents into PDF bytes using headless Chromium in the screenshot-worker. It is the platform’s single browser-rendering boundary: upstream services prepare HTML and send it to this worker over HTTP instead of bundling or launching Chromium themselves. The service is responsible for configuring the page content, waiting for rendering readiness, and returning the generated PDF payload.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `renderPdf` | `renderPdf(html: string, options: RenderPdfOptions)` | `Promise<Buffer>` |

## Diagram

```mermaid
sequenceDiagram
  participant API as Calling Service
  participant Worker as Screenshot Worker
  participant PdfService
  participant Chromium as Headless Chromium

  API->>Worker: POST HTML document and PDF options
  Worker->>PdfService: renderPdf(html, options)
  PdfService->>Chromium: Create page and set HTML content
  Chromium-->>PdfService: Document rendered
  PdfService->>Chromium: Generate PDF
  Chromium-->>PdfService: PDF bytes
  PdfService-->>Worker: PDF bytes
  Worker-->>API: PDF response
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { PdfService } from './pdf/pdf.service';

@Injectable()
export class ExportService {
  constructor(private readonly pdfService: PdfService) {}

  async exportInvoice(): Promise<Buffer> {
    const html = `
      <!doctype html>
      <html>
        <head>
          <style>
            body { font-family: Arial, sans-serif; padding: 32px; }
            h1 { color: #1f2937; }
          </style>
        </head>
        <body>
          <h1>Invoice #INV-1001</h1>
          <p>Generated by the document export service.</p>
        </body>
      </html>
    `;

    return this.pdfService.renderPdf(html, {
      format: 'A4',
      printBackground: true,
      margin: {
        top: '16mm',
        right: '16mm',
        bottom: '16mm',
        left: '16mm',
      },
    });
  }
}
```

## AI Coding Instructions

- Keep Chromium and PDF-generation logic inside `PdfService`; other services should send composed HTML to the screenshot-worker rather than launching a browser locally.
- Pass complete, self-contained HTML whenever possible, including required styles and assets, so rendering is deterministic in the worker environment.
- Preserve PDF options such as page format, margins, and `printBackground` when adding export flows; visual output often depends on them.
- Ensure callers handle returned PDF bytes as binary data (`Buffer`/stream) and set `Content-Type: application/pdf` when returning downloads.
- Avoid adding browser-specific rendering behavior to API services; integrate through the screenshot-worker HTTP boundary instead.

## Relationships

- DEPENDS_ON → `playwrightservice`

<!-- source: constant-plan-mode-blocked-tools.md -->

# PLAN_MODE_BLOCKED_TOOLS

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/session/plan-mode-filter.ts` (line 29)

Tools explicitly blocked during plan mode

<!-- source: interface-rawpageprofile.md -->

# RawPageProfile

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/discovery/page-profiler.service.ts` (line 8)

Raw profile data returned from page.evaluate().
Matches the SiteMap types but kept separate to avoid cross-package imports in the worker.

## Properties

| Property | Type |
|---|---|
| `grids` | `Array<{
    framework: string;
    selector: string;
    rowCount: number;
    columns: string[];
    hasDetailNavigation: boolean;
    detailUrl?: string;
    detailProfile?: RawPageProfile;
  }>` |
| `tabs` | `Array<{
    label: string;
    index: number;
    selector: string;
    detectionMethod: string;
  }>` |
| `buttons` | `Array<{
    text: string;
    selector: string;
    isEnabled: boolean;
  }>` |
| `inputs` | `Array<{
    type: string;
    placeholder: string;
    selector: string;
    label?: string;
  }>` |
| `forms` | `Array<{
    selector: string;
    fieldCount: number;
    hasSubmitButton: boolean;
  }>` |
| `modals` | `Array<{
    selector: string;
    title?: string;
  }>` |

<!-- source: api-endpoint-reject.md -->

# reject

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.controller.ts` (line 121)

## Endpoint

`POST /suggestions/:id/reject`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `SuggestionController` (MODULE_DECLARES)
- `SuggestionAliasController` (MODULE_DECLARES)

<!-- source: interface-screenshotinfo.md -->

# ScreenshotInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/utils/screenshot-storage.helper.ts` (line 16)

## Properties

| Property | Type |
|---|---|
| `localPath` | `string` |
| `pageId` | `string` |
| `route` | `string` |
| `url` | `string` |
| `formState` | `string` |
| `description` | `string` |
| `viewport` | `{ width: number; height: number }` |

<!-- source: type-statecoveragestatus.md -->

# StateCoverageStatus

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/state-machine-diagram.generator.ts` (line 19)

Coverage status for a state

## Definition

```ts
'covered' | 'partial' | 'uncovered' | 'unknown'
```

<!-- source: constant-state-types.md -->

# STATE_TYPES

**Kind:** Constant

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 307)

<!-- source: graphql-type-tag.md -->

# Tag

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Tag for categorizing posts

## Relationships

- TYPE_OF → `Post`

## Referenced By

- `Post` (TYPE_OF)

<!-- source: api-endpoint-takeauthenticatedscreenshot.md -->

# takeAuthenticatedScreenshot

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.controller.ts` (line 248)

Take authenticated screenshot (login first, then capture)

POST /api/screenshot/authenticated

Body:
{
  "url": "https://example.com/dashboard",
  "projectId": "uuid",
  "organizationId": "uuid",
  "capturedBy": "uuid",
  "auth": {
    "loginUrl": "/login",
    "username": "user@example.com",
    "password": "password",
    "usernameSelector": "#username",
    "passwordSelector": "#password",
    "submitSelector": "button[type=submit]",
    "successSelector": ".dashboard"
  },
  "viewport": { "width": 1920, "height": 1080 },
  "fullPage": true
}

## Endpoint

`POST /screenshot/authenticated`

## Referenced By

- `ScreenshotController` (MODULE_DECLARES)

<!-- source: class-templategallerypage.md -->

# TemplateGalleryPage

**Kind:** Class

**Source:** `atloria-monorepo/apps/web-e2e/src/pages/templates.page.ts` (line 7)

Template gallery page object

**Extends:** `BasePage`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `goto` | `goto()` | `Promise<void>` |
| `getTemplateCards` | `getTemplateCards()` | `Locator` |
| `getTemplateByName` | `getTemplateByName(name: string)` | `Locator` |
| `getTemplateCount` | `getTemplateCount()` | `Promise<number>` |
| `search` | `search(query: string)` | `Promise<void>` |
| `clearSearch` | `clearSearch()` | `Promise<void>` |
| `filterByCategory` | `filterByCategory(category: string)` | `Promise<void>` |
| `getCategories` | `getCategories()` | `Promise<string[]>` |
| `previewTemplate` | `previewTemplate(name: string)` | `Promise<void>` |
| `useTemplate` | `useTemplate(name: string)` | `Promise<void>` |
| `hasTemplate` | `hasTemplate(name: string)` | `Promise<boolean>` |
| `getTemplateDetails` | `getTemplateDetails(name: string)` | `Promise<{
    name: string;
    description: string;
    category: string;
  }>` |

## Properties

| Property | Type |
|---|---|
| `gallery` | `Locator` |
| `searchInput` | `Locator` |
| `categoryFilter` | `Locator` |
| `templateCards` | `Locator` |
| `loadingState` | `Locator` |
| `emptyState` | `Locator` |

<!-- source: graphql-mutation-unlikepost.md -->

# unlikePost

**Kind:** Graphql Mutation

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Unlike a post

## Referenced By

- `Mutation` (CALLS_API)

<!-- source: enum-viewporttype.md -->

# ViewportType

**Kind:** Enum

**Source:** `atloria-monorepo/apps/api/src/screenshot/dto/capture-screenshot.dto.ts` (line 14)

## Values

- `DESKTOP`
- `TABLET`
- `MOBILE`

<!-- source: type-waittype.md -->

# WaitType

**Kind:** Type

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 108)

## Definition

```ts
typeof WAIT_TYPES[number]
```

<!-- source: constant-addmdastextension.md -->

# addMdastExtension$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 360)

Adds a mdast extension to the markdown parser.

<!-- source: interface-agentthinkingevent.md -->

# AgentThinkingEvent

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/agent/agent.types.ts` (line 92)

## Properties

| Property | Type |
|---|---|
| `agentName` | `string` |

<!-- source: interface-agenttransport.md -->

# AgentTransport

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/protocol/session-event-bridge.ts` (line 37)

A transport is a thin adapter between AgentProtocolEvents and a specific
output surface (terminal, WebSocket, IPC channel, etc.).

Implement this interface to add a new surface without touching the bridge.

<!-- source: interface-analysisinput.md -->

# AnalysisInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-04.types.ts` (line 20)

## Properties

| Property | Type |
|---|---|
| `chunks` | `Chunk[]` |
| `features` | `UserFeature[]` |

<!-- source: function-appender.md -->

# Appender

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 496)

## Signature

```ts
function Appender(cell$: NodeRef<T[]>, init: (r: Realm, sig$: NodeRef<T | T[]>) => void)
```

## Parameters

| Name | Type |
|---|---|
| `cell$` | `NodeRef<T[]>` |
| `init` | `(r: Realm, sig$: NodeRef<T | T[]>) => void` |

<!-- source: service-assetsservice.md -->

# AssetsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/assets/assets.service.ts` (line 25)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `uploadImage` | `uploadImage(options: UploadImageOptions)` | `unknown` |
| `getAsset` | `getAsset(id: string, organizationId: string)` | `unknown` |
| `deleteAsset` | `deleteAsset(id: string, organizationId: string, _userId: string)` | `unknown` |
| `listAssets` | `listAssets(organizationId: string, audienceIds: string[])` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `azureblobservice`

<!-- source: class-atloriacodesample.md -->

# AtloriaCodeSample

**Kind:** Class

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/CodeSample.ts` (line 16)

**Extends:** `LitElement`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `render` | `render()` | `void` |

## Properties

| Property | Type |
|---|---|
| `styles` | `any` |
| `samples` | `CodeSampleData[]` |
| `endpoint` | `any` |
| `method` | `any` |
| `baseUrl` | `any` |

<!-- source: class-benchmarkrunner.md -->

# BenchmarkRunner

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/runner.ts` (line 99)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `run` | `run(onProgress: (msg: string) => void)` | `Promise<BenchmarkReport>` |

<!-- source: controller-billingcontroller.md -->

# BillingController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/billing/billing.controller.ts` (line 23)

## Relationships

- MODULE_DECLARES → `checkout`
- MODULE_DECLARES → `portal`
- MODULE_DECLARES → `summary`
- MODULE_DECLARES → `webhook`
- DEPENDS_ON → `billingservice`

<!-- source: interface-boardcolumndata.md -->

# BoardColumnData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Boards/helpers.ts` (line 107)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `order` | `number` |
| `color` | `string` |
| `mapsToStatus` | `string | null` |
| `wipLimit` | `number | null` |
| `cards` | `BoardCardData[]` |

<!-- source: module-boardsmodule.md -->

# BoardsModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/boards/boards.module.ts` (line 9)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `issuesmodule`
- MODULE_DECLARES → `boardscontroller`
- MODULE_PROVIDES → `boardsservice`
- MODULE_EXPORTS → `boardsservice`

<!-- source: function-buildmemoryextractionprompt.md -->

# buildMemoryExtractionPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/session-memory.ts` (line 75)

Build a prompt for a summarizer model to extract session memories.

This is designed to be sent to a model call. Domain layers can either:
1. Call their model provider directly with this prompt
2. Use a sub-agent with this as the task

Returns null if the session is too short to extract from.

## Signature

```ts
function buildMemoryExtractionPrompt(ctx: SessionContext): string | null
```

## Parameters

| Name | Type |
|---|---|
| `ctx` | `SessionContext` |

**Returns:** `string | null`

<!-- source: function-buildpiniastateflow.md -->

# buildPiniaStateFlow

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/pinia-pattern-detector.ts` (line 467)

Build state flow from detected Pinia patterns

## Signature

```ts
function buildPiniaStateFlow(_stores: PiniaStorePattern[], actions: PiniaActionPattern[], getters: PiniaGetterPattern[]): StateFlow | null
```

## Parameters

| Name | Type |
|---|---|
| `_stores` | `PiniaStorePattern[]` |
| `actions` | `PiniaActionPattern[]` |
| `getters` | `PiniaGetterPattern[]` |

**Returns:** `StateFlow | null`

<!-- source: function-buildseosystemprompt.md -->

# buildSeoSystemPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/seo.prompts.ts` (line 9)

## Signature

```ts
function buildSeoSystemPrompt(config: GenerationConfig): string
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |

**Returns:** `string`

<!-- source: class-bulkmovedocumentsdto.md -->

# BulkMoveDocumentsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/bulk-operations.dto.ts` (line 22)

Bulk move documents to a different category

## Properties

| Property | Type |
|---|---|
| `documentIds` | `string[]` |
| `categoryId` | `string | null` |

<!-- source: constant-bundle-container.md -->

# BUNDLE_CONTAINER

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/docs-repo/bundle.service.ts` (line 17)

Private container holding one bundle per project per day: <projectId>/<yyyy-mm-dd>.bundle

<!-- source: type-buttonsize.md -->

# ButtonSize

**Kind:** Type

**Source:** `atloria-monorepo/packages/ui-core/src/components/button/Button.ts` (line 8)

## Definition

```ts
'sm' | 'md' | 'lg'
```

<!-- source: function-clearcolorcache.md -->

# clearColorCache

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/user-colors.ts` (line 136)

Clear the color cache (useful for testing or cleanup)

## Signature

```ts
function clearColorCache(): void
```

**Returns:** `void`

<!-- source: interface-cloudstorageconfig.md -->

# CloudStorageConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/storage.interface.ts` (line 293)

Cloud storage configuration

## Properties

| Property | Type |
|---|---|
| `apiBaseUrl` | `string` |
| `apiToken` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `timeout` | `number` |

<!-- source: function-clusterkey.md -->

# clusterKey

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr.service.ts` (line 342)

Deterministic per-page-set key → the same stale set updates the same PR (dedupe).

## Signature

```ts
function clusterKey(slugs: string[]): string
```

## Parameters

| Name | Type |
|---|---|
| `slugs` | `string[]` |

**Returns:** `string`

<!-- source: function-createmockerrorresponse.md -->

# createMockErrorResponse

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 270)

## Signature

```ts
function createMockErrorResponse(message: string, status)
```

## Parameters

| Name | Type |
|---|---|
| `message` | `string` |
| `status` | `any` |

<!-- source: component-ctasplitform.md -->

# CtaSplitForm

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/cta/cta-split-form.tsx` (line 24)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `contactItems` | `ContactItem[]` | - | - |
| `formId` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_CtaSplitForm_59c28a2f["CtaSplitForm"]
    class component_CtaSplitForm_59c28a2f rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- RENDERS → `motion-ul`
- RENDERS → `ItemIcon`
- USES_HOOK → `useTranslation`

<!-- source: interface-dependencytree.md -->

# DependencyTree

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/relationship.interface.ts` (line 321)

Dependency tree structure

## Properties

| Property | Type |
|---|---|
| `rootId` | `string` |
| `rootName` | `string` |
| `rootType` | `string` |
| `children` | `DependencyNode[]` |
| `depth` | `number` |
| `totalNodes` | `number` |

<!-- source: type-docscrjobtype.md -->

# DocsCrJobType

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/change-request/docs-cr-queue.service.ts` (line 7)

One change-request lifecycle job: branch staging, merge writeback, diff refresh, or the
conflict-resolution restage. Every job carries only the crId — state lives on the row.

## Definition

```ts
'cr-open' | 'cr-merge' | 'cr-refresh' | 'cr-restage'
```

<!-- source: constant-dynamic.md -->

# dynamic

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/layout.tsx` (line 8)

<!-- source: class-errorconfigdto.md -->

# ErrorConfigDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 276)

Error state configuration

## Properties

| Property | Type |
|---|---|
| `errorType` | `'validation' | 'network' | 'permission'` |
| `triggerMethod` | `string` |
| `expectedError` | `string` |

<!-- source: function-generateapp.md -->

# generateApp

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/generate.ts` (line 232)

## Signature

```ts
async function generateApp(outputDir: string, config: SiteAssemblyConfig): Promise<string>
```

## Parameters

| Name | Type |
|---|---|
| `outputDir` | `string` |
| `config` | `SiteAssemblyConfig` |

**Returns:** `Promise<string>`

<!-- source: function-generateentityid-2.md -->

# generateEntityId

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 440)

Generate a unique entity ID

## Signature

```ts
function generateEntityId(filePath: string, name: string, type: string): string
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string` |
| `name` | `string` |
| `type` | `string` |

**Returns:** `string`

<!-- source: api-endpoint-getjobstatus.md -->

# getJobStatus

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/orchestrator.controller.ts` (line 85)

Get job status

## Endpoint

`GET /api/orchestrator/jobs/:jobId/status`

| Parameter | In | Type | Required |
|---|---|---|---|
| `jobId` | query | `string` | ✓ |

## Referenced By

- `OrchestratorController` (MODULE_DECLARES)

<!-- source: function-getmcpconfigpath.md -->

# getMcpConfigPath

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/mcp.command.ts` (line 23)

## Signature

```ts
function getMcpConfigPath(): string
```

**Returns:** `string`

<!-- source: function-getserversideprops.md -->

# getServerSideProps

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/frontend/src/pages/profile/[id].tsx` (line 47)

## Signature

```ts
async function getServerSideProps({ params })
```

## Parameters

| Name | Type |
|---|---|
| `{ params }` | `any` |

<!-- source: class-graphqlparser-2.md -->

# GraphQLParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/api-schema/graphql.parser.ts` (line 60)

GraphQL Parser Implementation

Supports:
- GraphQL Schema Definition Language (SDL)
- Queries, Mutations, Subscriptions
- Object Types, Input Types, Enums, Interfaces, Unions
- Directives and field arguments

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: interface-herobentogridprops.md -->

# HeroBentoGridProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/hero/hero-bento-grid.tsx` (line 15)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `subheadlineKey` | `string` |
| `primaryCtaKey` | `string` |
| `primaryCtaUrl` | `string` |
| `secondaryCtaKey` | `string` |
| `secondaryCtaUrl` | `string` |
| `badgeKey` | `string` |
| `gridItems` | `{ titleKey: string; descriptionKey?: string; icon?: LucideIcon }[]` |
| `className` | `string` |

<!-- source: component-htmltoolbarcomponent.md -->

# HTMLToolbarComponent

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/html.tsx` (line 75)

## Diagram

```mermaid
graph TD
    component_HTMLToolbarComponent_48da1ddd["HTMLToolbarComponent"]
    class component_HTMLToolbarComponent_48da1ddd rootComponent
```

## Relationships

- USES_HOOK → `useCellValues`
- USES_HOOK → `useMemo`

## Referenced By

- `SpanWithColor` (RENDERS)

<!-- source: interface-imagegenerationoptions.md -->

# ImageGenerationOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/providers/azure-image.provider.ts` (line 16)

## Properties

| Property | Type |
|---|---|
| `prompt` | `string` |
| `size` | `'1024x1024' | '1024x1792' | '1792x1024'` |
| `background` | `'transparent' | 'opaque' | 'auto'` |
| `quality` | `'low' | 'medium' | 'high'` |
| `outputFormat` | `'png' | 'webp'` |

<!-- source: type-loopconfig.md -->

# LoopConfig

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/runtime-config.ts` (line 16)

## Definition

```ts
| { engine: 'openai-sdk' }
  | {
      engine: 'live-swe';
      /** Max same-turn requeries on format errors (default: 3) */
      maxRequeries?: number;
      /** Custom history processor pipeline (default: LastN + ClosedWindow) */
      historyProcessors?: HistoryProcessor[];
    }
```

<!-- source: service-metadocumentationservice.md -->

# MetaDocumentationService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-14-meta/meta-documentation.service.ts` (line 1)

<!-- source: type-mockuptype.md -->

# MockupType

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 37)

## Definition

```ts
'dashboard' | 'editor' | 'terminal' | 'api-playground' | 'analytics-chart' | 'mobile-app'
```

<!-- source: type-origin.md -->

# Origin

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 199)

## Definition

```ts
'chat escalation' | 'reader report' | 'email'
```

<!-- source: service-playwrightservice.md -->

# PlaywrightService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/playwright/playwright.service.ts` (line 52)

Playwright service for browser automation and screenshots

Features:
- Multiple browser support (Chromium, Firefox, WebKit)
- Custom viewport sizes
- Full-page screenshots
- Wait for selectors/timeouts
- Basic authentication
- Browser pooling for performance

`PlaywrightService` provides browser automation and screenshot generation for the screenshot worker. It manages pooled Playwright browser instances across Chromium, Firefox, and WebKit, applying navigation, authentication, viewport, wait, and full-page capture options before returning screenshot data.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getBrowser` | `getBrowser(type: BrowserType)` | `Promise<Browser>` |
| `takeScreenshot` | `takeScreenshot(options: ScreenshotOptions)` | `Promise<Buffer>` |
| `takeResponsiveScreenshots` | `takeResponsiveScreenshots(url: string, viewports: Array<{ name: string; width: number; height: number }>)` | `Promise<Array<{ name: string; screenshot: Buffer }>>` |
| `takeAuthenticatedScreenshot` | `takeAuthenticatedScreenshot(options: AuthenticatedScreenshotOptions)` | `Promise<Buffer>` |
| `getPageHtml` | `getPageHtml(url: string, browserType: BrowserType)` | `Promise<string>` |
| `onModuleDestroy` | `onModuleDestroy()` | `unknown` |

## Diagram

```mermaid
sequenceDiagram
  participant Caller as Screenshot Worker
  participant Service as PlaywrightService
  participant Pool as Browser Pool
  participant Browser as Playwright Browser
  participant Page as Browser Page
  participant Target as Target URL

  Caller->>Service: captureScreenshot(options)
  Service->>Pool: acquire(browserType)
  Pool-->>Service: browser instance
  Service->>Browser: newPage(viewport)
  Browser-->>Service: page
  Service->>Page: set authentication (optional)
  Service->>Page: goto(url)
  Page->>Target: HTTP request
  Target-->>Page: rendered document
  Service->>Page: waitForSelector / waitForTimeout
  Service->>Page: screenshot(fullPage)
  Page-->>Service: image buffer
  Service->>Pool: release(browser)
  Service-->>Caller: screenshot buffer
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { PlaywrightService } from './playwright/playwright.service';

@Injectable()
export class ScreenshotJobService {
  constructor(private readonly playwrightService: PlaywrightService) {}

  async generatePreview(): Promise<Buffer> {
    return this.playwrightService.captureScreenshot({
      url: 'https://example.com/dashboard',
      browser: 'chromium',
      viewport: {
        width: 1440,
        height: 900,
      },
      fullPage: true,
      waitForSelector: '[data-page-ready="true"]',
      waitForTimeout: 500,
      authentication: {
        username: process.env.PREVIEW_USERNAME!,
        password: process.env.PREVIEW_PASSWORD!,
      },
    });
  }
}
```

## AI Coding Instructions

- Reuse the service's browser-pooling flow; do not launch a new Playwright browser for every screenshot request.
- Always release browser resources in `finally` blocks when adding or modifying page/browser lifecycle logic.
- Validate URLs, browser types, viewport dimensions, and timeout values before passing user-controlled input to Playwright.
- Prefer `waitForSelector` for deterministic page readiness; use fixed timeouts only when no reliable selector is available.
- Keep screenshot options compatible across Chromium, Firefox, and WebKit, and test browser-specific behavior when adding new options.

<!-- source: api-endpoint-reject-2.md -->

# reject

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.controller.ts` (line 121)

## Endpoint

`POST /suggestions/:id/reject`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `SuggestionController` (MODULE_DECLARES)
- `SuggestionAliasController` (MODULE_DECLARES)

<!-- source: interface-renderpdfoptions.md -->

# RenderPdfOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/pdf/pdf.service.ts` (line 5)

## Properties

| Property | Type |
|---|---|
| `format` | `'A4' | 'A3' | 'A5' | 'Letter' | 'Legal' | 'Tabloid'` |
| `margin` | `{ top?: string; bottom?: string; left?: string; right?: string }` |
| `printBackground` | `boolean` |
| `displayHeaderFooter` | `boolean` |
| `headerTemplate` | `string` |
| `footerTemplate` | `string` |

<!-- source: interface-sessionsdeleteoptions.md -->

# SessionsDeleteOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/commands/sessions.command.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `all` | `boolean` |

<!-- source: component-spinner.md -->

# Spinner

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/changes/[crId]/page.tsx` (line 45)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `color` | `string` | - | "#6366F1" |

## Diagram

```mermaid
graph TD
    component_Spinner_423fccdb["Spinner"]
    class component_Spinner_423fccdb rootComponent
```

## Referenced By

- `ConflictFileCard` (RENDERS)
- `ChangeRequestDetailPage` (RENDERS)

<!-- source: constant-standard-profile.md -->

# STANDARD_PROFILE

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-profiles.ts` (line 181)

STANDARD_PROFILE — safe fallback when model is unknown.
Preserves current GPT-5.4 behavior so existing tests and deployments
are unaffected when no profile is specified.

## Definition

```ts
ModelCapabilityProfile
```

<!-- source: type-statemanagementlibrary.md -->

# StateManagementLibrary

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-management.interface.ts` (line 14)

State Management Interfaces

Defines interfaces for state management libraries (Redux, MobX, Zustand, etc.)
and their patterns for user documentation generation.

## Definition

```ts
| 'redux'
  | 'redux-toolkit'
  | 'mobx'
  | 'zustand'
  | 'recoil'
  | 'jotai'
  | 'context-api'
  | 'react-query'
  | 'swr'
  | 'ngrx'
  | 'akita'
  | 'ngxs'
  | 'pinia'
  | 'vuex'
```

<!-- source: api-endpoint-takeresponsivescreenshots.md -->

# takeResponsiveScreenshots

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.controller.ts` (line 213)

Take responsive screenshots (mobile, tablet, desktop)

POST /api/screenshot/responsive

Body:
{
  "url": "https://example.com",
  "projectId": "uuid",
  "organizationId": "uuid",
  "capturedBy": "uuid"
}

## Endpoint

`POST /screenshot/responsive`

## Referenced By

- `ScreenshotController` (MODULE_DECLARES)

<!-- source: class-templatepreviewmodal.md -->

# TemplatePreviewModal

**Kind:** Class

**Source:** `atloria-monorepo/apps/web-e2e/src/pages/templates.page.ts` (line 153)

Template preview modal page object

**Extends:** `BasePage`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `goto` | `goto()` | `Promise<void>` |
| `getTitle` | `getTitle()` | `Promise<string>` |
| `getPreviewContent` | `getPreviewContent()` | `Promise<string>` |
| `use` | `use()` | `Promise<void>` |
| `close` | `close()` | `Promise<void>` |
| `isVisible` | `isVisible()` | `Promise<boolean>` |

## Properties

| Property | Type |
|---|---|
| `modal` | `Locator` |
| `title` | `Locator` |
| `description` | `Locator` |
| `preview` | `Locator` |
| `useButton` | `Locator` |
| `closeButton` | `Locator` |

<!-- source: graphql-mutation-updatepost.md -->

# updatePost

**Kind:** Graphql Mutation

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Update a post

## Relationships

- TYPE_OF → `Post`
- TYPE_OF → `UpdatePostInput`

## Referenced By

- `Mutation` (CALLS_API)

<!-- source: graphql-type-updatepostinput.md -->

# UpdatePostInput

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Input for updating a post

## Referenced By

- `updatePost` (TYPE_OF)

<!-- source: constant-wait-types.md -->

# WAIT_TYPES

**Kind:** Constant

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 107)

<!-- source: api-endpoint-accept-3.md -->

# accept

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/invitation/invitation.controller.ts` (line 35)

## Endpoint

`POST /invitations/:token/accept`

| Parameter | In | Type | Required |
|---|---|---|---|
| `token` | query | `string` | ✓ |

## Referenced By

- `InvitationController` (MODULE_DECLARES)

<!-- source: component-activityrow.md -->

# ActivityRow

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/IssueSidePanel.tsx` (line 926)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `event` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ActivityRow_1df84edf["ActivityRow"]
    class component_ActivityRow_1df84edf rootComponent
```

## Referenced By

- `IssueSidePanel` (RENDERS)

<!-- source: constant-addnestededitorchild.md -->

# addNestedEditorChild$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 776)

Lets you add React components as children of any registered nested editor (useful for Lexical plugins).

<!-- source: interface-agenttodoevent.md -->

# AgentTodoEvent

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/agent/agent.types.ts` (line 114)

## Properties

| Property | Type |
|---|---|
| `items` | `Array<{
    id: string;
    description: string;
    status: 'pending' | 'in_progress' | 'completed' | 'skipped';
    result?: string;
  }>` |
| `stats` | `{
    total: number;
    completed: number;
    pending: number;
    inProgress: number;
    skipped: number;
  }` |

<!-- source: interface-analysisresult-2.md -->

# AnalysisResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-04.types.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `analyses` | `ChunkAnalysis[]` |
| `tokenUsage` | `TokenUsage[]` |

<!-- source: interface-anthropicmodelproviderconfig.md -->

# AnthropicModelProviderConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/anthropic-adapter.ts` (line 36)

## Properties

| Property | Type |
|---|---|
| `apiKey` | `string` |
| `defaultModel` | `string` |
| `baseUrl` | `string` |
| `timeout` | `number` |
| `maxTokens` | `number` |
| `modelProfile` | `ModelCapabilityProfile` |
| `azureHosted` | `boolean` |
| `azureApiVersion` | `string` |

<!-- source: function-applytheme.md -->

# applyTheme

**Kind:** Function

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/theme.ts` (line 96)

## Signature

```ts
function applyTheme(mode: ThemeMode, primaryColor: string)
```

## Parameters

| Name | Type |
|---|---|
| `mode` | `ThemeMode` |
| `primaryColor` | `string` |

<!-- source: class-atloriaendpointdetail.md -->

# AtloriaEndpointDetail

**Kind:** Class

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/EndpointDetail.ts` (line 64)

**Extends:** `LitElement`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `render` | `render()` | `void` |

## Properties

| Property | Type |
|---|---|
| `styles` | `any` |
| `endpoint` | `APIEndpoint` |
| `mode` | `ExplorerMode` |
| `environment` | `Environment` |
| `schemas` | `Record<string, Schema>` |

<!-- source: service-audienceservice.md -->

# AudienceService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/audience/audience.service.ts` (line 15)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `list` | `list(user: JwtPayload)` | `Promise<AudienceModel[]>` |
| `get` | `get(id: string, user: JwtPayload)` | `Promise<AudienceModel>` |
| `create` | `create(dto: CreateAudienceDto, user: JwtPayload)` | `Promise<AudienceModel>` |
| `update` | `update(id: string, dto: UpdateAudienceDto, user: JwtPayload)` | `Promise<AudienceModel>` |
| `delete` | `delete(id: string, user: JwtPayload)` | `Promise<void>` |
| `seedStandardAudiences` | `seedStandardAudiences()` | `Promise<void>` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: controller-bitbucketcontroller.md -->

# BitbucketController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/bitbucket/bitbucket.controller.ts` (line 10)

## Relationships

- MODULE_DECLARES → `getAuthUrl`
- MODULE_DECLARES → `handleCallback`
- MODULE_DECLARES → `getStatus`
- MODULE_DECLARES → `listRepos`
- MODULE_DECLARES → `listBranches`
- MODULE_DECLARES → `disconnect`
- DEPENDS_ON → `bitbucketservice`

<!-- source: class-bm25index.md -->

# BM25Index

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/bm25.ts` (line 59)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `addDocument` | `addDocument(id: string, text: string)` | `void` |
| `removeDocument` | `removeDocument(id: string)` | `void` |
| `search` | `search(query: string, topK: undefined)` | `Array<{ id: string; score: number }>` |
| `clear` | `clear()` | `void` |
| `serialize` | `serialize()` | `SerializedIndex` |
| `deserialize` | `deserialize(data: object)` | `BM25Index` |

<!-- source: interface-boarddata.md -->

# BoardData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Boards/helpers.ts` (line 117)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string | null` |
| `color` | `string` |
| `isDefault` | `boolean` |
| `settings` | `Record<string, unknown> | null` |
| `columns` | `BoardColumnData[]` |
| `createdAt` | `string` |
| `updatedAt` | `string` |

<!-- source: module-brandingmodule.md -->

# BrandingModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/branding/branding.module.ts` (line 8)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_DECLARES → `brandingcontroller`
- MODULE_PROVIDES → `brandingservice`
- MODULE_EXPORTS → `brandingservice`

<!-- source: function-buildprediction.md -->

# buildPrediction

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/swebench-evaluator.ts` (line 58)

Convert a TaskResult to SWE-bench prediction format.
Used for both successful and failed tasks (autosubmit pattern —
even partial patches are worth submitting).

## Signature

```ts
function buildPrediction(result: TaskResult, modelName: string): SWEBenchPrediction
```

## Parameters

| Name | Type |
|---|---|
| `result` | `TaskResult` |
| `modelName` | `string` |

**Returns:** `SWEBenchPrediction`

<!-- source: function-buildreduxstateflow.md -->

# buildReduxStateFlow

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/redux-pattern-detector.ts` (line 501)

Build state flow from detected patterns

## Signature

```ts
function buildReduxStateFlow(actions: ReduxActionPattern[], _reducers: ReduxReducerPattern[], selectors: ReduxSelectorPattern[]): StateFlow | null
```

## Parameters

| Name | Type |
|---|---|
| `actions` | `ReduxActionPattern[]` |
| `_reducers` | `ReduxReducerPattern[]` |
| `selectors` | `ReduxSelectorPattern[]` |

**Returns:** `StateFlow | null`

<!-- source: function-buildseotaskprompt.md -->

# buildSeoTaskPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/seo.prompts.ts` (line 44)

## Signature

```ts
function buildSeoTaskPrompt(pageTitle: string, pageSummary: string, productName: string): string
```

## Parameters

| Name | Type |
|---|---|
| `pageTitle` | `string` |
| `pageSummary` | `string` |
| `productName` | `string` |

**Returns:** `string`

<!-- source: class-bulkpublishdto.md -->

# BulkPublishDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/bulk-operations.dto.ts` (line 68)

Bulk publish all documents in a project

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `audienceSlug` | `string` |
| `setPublic` | `boolean` |

<!-- source: constant-bundle-retention.md -->

# BUNDLE_RETENTION

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/docs-repo/bundle.service.ts` (line 19)

Keep the newest N bundles per project; older ones are pruned after each upload.

<!-- source: type-buttonvariant.md -->

# ButtonVariant

**Kind:** Type

**Source:** `atloria-monorepo/packages/ui-core/src/components/button/Button.ts` (line 7)

## Definition

```ts
'primary' | 'secondary' | 'danger' | 'ghost'
```

<!-- source: function-clearwizardstate.md -->

# clearWizardState

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/useNewProjectWizard.ts` (line 104)

<!-- source: interface-codeblockinfo-2.md -->

# CodeBlockInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 972)

Code block information

## Properties

| Property | Type |
|---|---|
| `language` | `string` |
| `line` | `number` |
| `lines` | `number` |

<!-- source: function-collectentities.md -->

# collectEntities

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/curation.ts` (line 62)

Look up name/type for a set of entity ids in the UNCURATED navMap — the tree's
"Hidden (n)" section needs names, but hidden entities are filtered out of the served map.

## Signature

```ts
function collectEntities(navMap: NavMap | null | undefined, ids: string[]): Array<{ id: string; name: string; type: string }>
```

## Parameters

| Name | Type |
|---|---|
| `navMap` | `NavMap | null | undefined` |
| `ids` | `string[]` |

**Returns:** `Array<{ id: string; name: string; type: string }>`

<!-- source: function-createmockpaginatedresponse.md -->

# createMockPaginatedResponse

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 281)

## Signature

```ts
function createMockPaginatedResponse(items: T[], page, limit, total: number)
```

## Parameters

| Name | Type |
|---|---|
| `items` | `T[]` |
| `page` | `any` |
| `limit` | `any` |
| `total` | `number` |

<!-- source: type-docsprjob.md -->

# DocsPrJob

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr-queue.service.ts` (line 5)

## Definition

```ts
| { type: 'check'; projectId: string }
  | { type: 'pr-closed'; repoUrl: string; prNumber: number; merged: boolean }
```

<!-- source: constant-empty-filters.md -->

# EMPTY_FILTERS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 30)

## Definition

```ts
BoardFiltersState
```

<!-- source: interface-entity.md -->

# Entity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 217)

Base entity interface - all specific entities extend this

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `type` | `EntityType` |
| `name` | `string` |
| `filePath` | `string` |
| `startLine` | `number` |
| `endLine` | `number` |
| `description` | `string` |
| `tags` | `string[]` |
| `metadata` | `Record<string, unknown>` |
| `discoveredAt` | `Date` |
| `contentHash` | `string` |

<!-- source: component-faqaccordion.md -->

# FaqAccordion

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/faq/faq-accordion.tsx` (line 14)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `items` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FaqAccordion_1c913bb0["FaqAccordion"]
    class component_FaqAccordion_1c913bb0 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `AccordionItem`
- USES_HOOK → `useTranslation`

<!-- source: class-flowboundingboxdto.md -->

# FlowBoundingBoxDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/flow-replay.dto.ts` (line 45)

Percentage-of-viewport bounding box carried over from capture time.

## Properties

| Property | Type |
|---|---|
| `x` | `number` |
| `y` | `number` |
| `w` | `number` |
| `h` | `number` |

<!-- source: function-generatei18n.md -->

# generateI18n

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/generate.ts` (line 302)

## Signature

```ts
async function generateI18n(outputDir: string, locales: LocaleConfig[]): Promise<string>
```

## Parameters

| Name | Type |
|---|---|
| `outputDir` | `string` |
| `locales` | `LocaleConfig[]` |

**Returns:** `Promise<string>`

<!-- source: function-generaterelationshipid-2.md -->

# generateRelationshipId

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 462)

Generate a relationship ID

## Signature

```ts
function generateRelationshipId(sourceId: string, targetId: string, type: string): string
```

## Parameters

| Name | Type |
|---|---|
| `sourceId` | `string` |
| `targetId` | `string` |
| `type` | `string` |

**Returns:** `string`

<!-- source: api-endpoint-getkgstatistics.md -->

# getKGStatistics

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/orchestrator.controller.ts` (line 167)

Get Knowledge Graph statistics

## Endpoint

`GET /api/orchestrator/knowledge-graph/stats`

## Referenced By

- `OrchestratorController` (MODULE_DECLARES)

<!-- source: function-hasparser.md -->

# hasParser

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/queue/processors/parse.processor.ts` (line 57)

Check if a parser is registered

## Signature

```ts
function hasParser(name: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `name` | `string` |

**Returns:** `boolean`

<!-- source: interface-herodarkcenteredprops.md -->

# HeroDarkCenteredProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/hero/hero-dark-centered.tsx` (line 14)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `subheadlineKey` | `string` |
| `primaryCtaKey` | `string` |
| `primaryCtaUrl` | `string` |
| `secondaryCtaKey` | `string` |
| `secondaryCtaUrl` | `string` |
| `badgeKey` | `string` |
| `floatingStats` | `{ valueKey: string; labelKey: string }[]` |
| `imageSrc` | `string` |
| `imageAlt` | `string` |

<!-- source: interface-imagegenerationrequest.md -->

# ImageGenerationRequest

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 189)

Image generation request.

## Properties

| Property | Type |
|---|---|
| `prompt` | `string` |
| `width` | `number` |
| `height` | `number` |
| `background` | `'transparent' | 'opaque' | 'auto'` |
| `quality` | `'low' | 'medium' | 'high'` |

<!-- source: function-initscreenshotconfigcommand.md -->

# initScreenshotConfigCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/init-screenshot-config.command.ts` (line 87)

Generate screenshot configuration from AppMap

## Signature

```ts
async function initScreenshotConfigCommand(options: {
  target?: string;
  output?: string;
  appUrl?: string;
})
```

## Parameters

| Name | Type |
|---|---|
| `options` | `{
  target?: string;
  output?: string;
  appUrl?: string;
}` |

<!-- source: component-insertcard.md -->

# InsertCard

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/nested-jsx-elements.tsx` (line 60)

## Diagram

```mermaid
graph TD
    component_InsertCard_422f28bb["InsertCard"]
    class component_InsertCard_422f28bb rootComponent
```

## Relationships

- RENDERS → `Button`
- USES_HOOK → `usePublisher`

## Referenced By

- `Example` (RENDERS)

<!-- source: class-jinja2templateparser.md -->

# Jinja2TemplateParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/backend/jinja2-template.parser.ts` (line 81)

Jinja2 Template Parser

Extracts entities and relationships from Jinja2 template files.

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: { rootDir: string })` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: type-mcpclientoptions.md -->

# McpClientOptions

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/mcp/mcp-client.ts` (line 43)

## Definition

```ts
McpStdioOptions | McpHttpOptions
```

<!-- source: service-openaireviewerservice.md -->

# OpenAIReviewerService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/openai-reviewer.service.ts` (line 1)

<!-- source: type-pagetype.md -->

# PageType

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 88)

## Definition

```ts
'homepage' | 'landing' | 'product' | 'pricing' | 'contact'
```

<!-- source: type-pmejobstatus.md -->

# PmeJobStatus

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/stores/pmeStore.ts` (line 10)

## Definition

```ts
'idle' | 'queued' | 'processing' | 'generating_content' | 'generating_visuals' | 'assembling' | 'completed' | 'failed'
```

<!-- source: interface-retryconfig.md -->

# RetryConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/retry-handler.service.ts` (line 6)

Configuration for retry behavior

## Properties

| Property | Type |
|---|---|
| `maxRetries` | `number` |
| `initialDelayMs` | `number` |
| `backoffMultiplier` | `number` |
| `maxDelayMs` | `number` |
| `onRetry` | `(error: Error, attempt: number, delay: number) => void` |

<!-- source: service-retryhandlerservice.md -->

# RetryHandlerService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/retry-handler.service.ts` (line 74)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `isRetryableError` | `isRetryableError(error: Error | string | null | undefined, additionalRetryablePatterns: string[])` | `boolean` |
| `calculateBackoffDelay` | `calculateBackoffDelay(attempt: number, config: RetryConfig)` | `number` |
| `retryWithBackoff` | `retryWithBackoff(fn: () => Promise<T>, config: RetryConfig)` | `Promise<T>` |

<!-- source: interface-sessionslistoptions.md -->

# SessionsListOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/commands/sessions.command.ts` (line 16)

<!-- source: type-storagemode.md -->

# StorageMode

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/storage.interface.ts` (line 15)

Storage Provider Interfaces

Defines storage abstraction for dual-mode operation:
- File System Mode: Local directory storage (CLI)
- Cloud Mode: Azure Storage via API (API/Web)

## Definition

```ts
'file-system' | 'cloud'
```

<!-- source: constant-swebench-starter-ids.md -->

# SWEBENCH_STARTER_IDS

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/swebench-subset.ts` (line 228)

Just the task IDs for quick filtering.

## Definition

```ts
string[]
```

<!-- source: api-endpoint-takescreenshot.md -->

# takeScreenshot

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.controller.ts` (line 194)

Take a single screenshot

POST /api/screenshot

Body:
{
  "url": "https://example.com",
  "projectId": "uuid",
  "viewport": { "width": 1920, "height": 1080 },
  "fullPage": true,
  "waitForSelector": ".main-content"
}

## Endpoint

`POST /screenshot`

## Referenced By

- `ScreenshotController` (MODULE_DECLARES)

<!-- source: graphql-mutation-updateuser.md -->

# updateUser

**Kind:** Graphql Mutation

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Update user profile

## Relationships

- TYPE_OF → `User`
- TYPE_OF → `UpdateUserInput`

## Referenced By

- `Mutation` (CALLS_API)

<!-- source: graphql-type-updateuserinput.md -->

# UpdateUserInput

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Input for updating a user

## Referenced By

- `updateUser` (TYPE_OF)

<!-- source: api-endpoint-activate.md -->

# activate

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 182)

## Endpoint

`POST /doc-versions/:projectId/:versionId/activate`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-activitystrip.md -->

# ActivityStrip

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/changes/[crId]/page.tsx` (line 222)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `cr` | `ChangeRequest` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ActivityStrip_194bc6ab["ActivityStrip"]
    class component_ActivityStrip_194bc6ab rootComponent
```

## Referenced By

- `ChangeRequestDetailPage` (RENDERS)

<!-- source: constant-addsyntaxextension.md -->

# addSyntaxExtension$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 354)

Adds a syntax extension to the markdown parser.

<!-- source: interface-agenttoolendevent.md -->

# AgentToolEndEvent

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/agent/agent.types.ts` (line 101)

## Properties

| Property | Type |
|---|---|
| `toolName` | `string` |
| `outputPreview` | `string` |
| `durationMs` | `number` |

<!-- source: interface-analyticsconfig.md -->

# AnalyticsConfig

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/analytics.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `provider` | `AnalyticsProvider` |
| `trackingId` | `string` |

<!-- source: interface-applypatchoptions.md -->

# ApplyPatchOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/apply-patch.tool.ts` (line 38)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `maxFileSize` | `number` |
| `checkpointManager` | `CheckpointManager` |

<!-- source: class-atloriaendpointlist.md -->

# AtloriaEndpointList

**Kind:** Class

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/EndpointList.ts` (line 23)

**Extends:** `LitElement`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `render` | `render()` | `void` |

## Properties

| Property | Type |
|---|---|
| `styles` | `any` |
| `endpoints` | `APIEndpoint[]` |
| `selectedId` | `any` |
| `groupBy` | `'controller' | 'tag' | 'method'` |

<!-- source: service-auditservice.md -->

# AuditService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/audit/audit.service.ts` (line 19)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `record` | `record(event: AuditEventInput)` | `Promise<void>` |
| `query` | `query(opts: {
    organizationId: string;
    projectId?: string;
    docVersionId?: string;
    actorId?: string;
    action?: string;
    startDate?: string;
    endDate?: string;
    limit?: number;
    offset?: number;
  })` | `unknown` |
| `exportCSV` | `exportCSV(opts: { organizationId: string; projectId?: string })` | `Promise<string>` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: interface-boardfiltersstate.md -->

# BoardFiltersState

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 22)

## Properties

| Property | Type |
|---|---|
| `priorities` | `string[]` |
| `categories` | `string[]` |
| `assigneeIds` | `string[]` |
| `audiences` | `string[]` |
| `hasReporterEmail` | `'any' | 'yes' | 'no'` |

<!-- source: controller-boardscontroller.md -->

# BoardsController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 23)

## Relationships

- MODULE_DECLARES → `list`
- MODULE_DECLARES → `create`
- MODULE_DECLARES → `getOne`
- MODULE_DECLARES → `update`
- MODULE_DECLARES → `remove`
- MODULE_DECLARES → `restore`
- MODULE_DECLARES → `addColumn`
- MODULE_DECLARES → `reorderColumns`
- MODULE_DECLARES → `updateColumn`
- MODULE_DECLARES → `deleteColumn`
- MODULE_DECLARES → `listCards`
- MODULE_DECLARES → `addCards`
- MODULE_DECLARES → `moveCard`
- MODULE_DECLARES → `removeCard`
- MODULE_DECLARES → `getBoardsForIssue`
- DEPENDS_ON → `boardsservice`

<!-- source: function-buildchunkrelationshipgraph.md -->

# buildChunkRelationshipGraph

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-02-chunking/chunk-relationship-graph.ts` (line 14)

Build a relationship graph between chunks

## Signature

```ts
function buildChunkRelationshipGraph(chunks: Chunk[], allEntities: Entity[]): ChunkRelationshipGraph
```

## Parameters

| Name | Type |
|---|---|
| `chunks` | `Chunk[]` |
| `allEntities` | `Entity[]` |

**Returns:** `ChunkRelationshipGraph`

<!-- source: function-buildreviewnudge.md -->

# buildReviewNudge

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/self-review.ts` (line 78)

Build a compact review nudge (for injection into instructions).
Shorter than the full review prompt — just highlights what to check.

## Signature

```ts
function buildReviewNudge(editedFiles: EditedFile[]): string
```

## Parameters

| Name | Type |
|---|---|
| `editedFiles` | `EditedFile[]` |

**Returns:** `string`

<!-- source: function-buildstrategyquestionprompt.md -->

# buildStrategyQuestionPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/strategy.prompts.ts` (line 94)

## Signature

```ts
function buildStrategyQuestionPrompt(docSummary: string, screenshotCount: number): string
```

## Parameters

| Name | Type |
|---|---|
| `docSummary` | `string` |
| `screenshotCount` | `number` |

**Returns:** `string`

<!-- source: function-buildsystemoverview.md -->

# buildSystemOverview

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/system-overview.ts` (line 45)

## Signature

```ts
function buildSystemOverview(input: SystemOverviewInput): string
```

## Parameters

| Name | Type |
|---|---|
| `input` | `SystemOverviewInput` |

**Returns:** `string`

<!-- source: class-bulkupdateissuesdto.md -->

# BulkUpdateIssuesDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/issues/dto/update-issue.dto.ts` (line 28)

## Properties

| Property | Type |
|---|---|
| `issueIds` | `string[]` |
| `status` | `IssueStatus` |
| `priority` | `IssuePriority` |
| `assigneeId` | `string | null` |

<!-- source: constant-capture-actions.md -->

# CAPTURE_ACTIONS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/capture/dto/create-flow.dto.ts` (line 15)

<!-- source: module-capturemodule.md -->

# CaptureModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/capture/capture.module.ts` (line 11)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `draftdocumentmodule`
- MODULE_DECLARES → `capturecontroller`
- MODULE_DECLARES → `publiccapturecontroller`
- MODULE_PROVIDES → `captureservice`
- MODULE_PROVIDES → `flowdraftstitcherservice`
- MODULE_EXPORTS → `captureservice`

<!-- source: type-captureprogresscallback.md -->

# CaptureProgressCallback

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-capturer.service.ts` (line 34)

## Definition

```ts
(progress: CaptureProgress) => void
```

<!-- source: class-checkpointmanager.md -->

# CheckpointManager

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/context/checkpoint-manager.ts` (line 43)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createWithGit` | `createWithGit(rootDir: string, config: Omit<CheckpointManagerConfig, 'rootDir' | 'backend'> & {
      sessionId?: string;
      staleAgeDays?: number;
    })` | `CheckpointManager` |
| `snapshot` | `snapshot(relPath: string, label: string)` | `boolean` |
| `rollback` | `rollback(relPath: string, index: number)` | `string | null` |
| `getSnapshots` | `getSnapshots(relPath: string)` | `readonly Snapshot[]` |
| `getSnapshotCount` | `getSnapshotCount(relPath: string)` | `number` |
| `getTotalCount` | `getTotalCount()` | `number` |
| `getTrackedFiles` | `getTrackedFiles()` | `string[]` |
| `clear` | `clear()` | `void` |
| `getBackend` | `getBackend()` | `CheckpointBackend` |

<!-- source: interface-codeentity.md -->

# CodeEntity

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 4)

Simplified entity representation for AI analysis

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `type` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `startLine` | `number` |
| `endLine` | `number` |
| `metadata` | `Record<string, any>` |

<!-- source: function-composeresolvedcontent.md -->

# composeResolvedContent

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/section-merge.ts` (line 103)

Apply a list of per-section resolutions onto the current full document
content, returning the composed `resolvedContent` to POST back.

## Signature

```ts
function composeResolvedContent(current: string, resolutions: SectionResolution[]): string
```

## Parameters

| Name | Type |
|---|---|
| `current` | `string` |
| `resolutions` | `SectionResolution[]` |

**Returns:** `string`

<!-- source: function-composethreeway.md -->

# composeThreeWay

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/change-request/merge-compose.ts` (line 19)

Compose the auto-merged document from aligned three-way sections (S2.3 merge).

PURE — no I/O. The caller (CrWorker's merge gate) has already classified every section via
DiffService.threeWaySections and verified NONE are 'conflict'; this walks the aligned slots
in order and takes:
  - 'keep-mine'   → mine   (main moved this section; the proposal left it alone)
  - 'take-theirs' → theirs (the proposal changed this section; main left it alone)
  - 'unchanged'   → mine   (mine === theirs by definition — either side works)

A section DELETED on the winning side compares as '' and is dropped from the composition
(this also covers the deleted-on-both-sides slots threeWaySections appends as 'unchanged').
Section texts carry no trailing newline (they are joined line runs), so the composition
re-joins with '\n' and ends with a single trailing newline — matching the normalised form
every committed page already has.

## Signature

```ts
function composeThreeWay(sections: ThreeWaySection[]): string
```

## Parameters

| Name | Type |
|---|---|
| `sections` | `ThreeWaySection[]` |

**Returns:** `string`

<!-- source: function-createtestcollaborationsession.md -->

# createTestCollaborationSession

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 214)

## Signature

```ts
function createTestCollaborationSession(documentId: string, userCount): TestCollaborationSession
```

## Parameters

| Name | Type |
|---|---|
| `documentId` | `string` |
| `userCount` | `any` |

**Returns:** `TestCollaborationSession`

<!-- source: type-docsprstatus.md -->

# DocsPrStatus

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr.service.ts` (line 13)

## Definition

```ts
'opened' | 'updated' | 'skipped' | 'error'
```

<!-- source: interface-entitypath.md -->

# EntityPath

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/relationship.interface.ts` (line 291)

Graph path between entities

## Properties

| Property | Type |
|---|---|
| `startId` | `string` |
| `endId` | `string` |
| `relationships` | `Relationship[]` |
| `entityIds` | `string[]` |
| `length` | `number` |

<!-- source: component-faqtwocolumn.md -->

# FaqTwoColumn

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/faq/faq-two-column.tsx` (line 14)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `items` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FaqTwoColumn_26bcfedd["FaqTwoColumn"]
    class component_FaqTwoColumn_26bcfedd rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `AccordionItem`
- USES_HOOK → `useTranslation`

<!-- source: class-flowlocalesrequestdto.md -->

# FlowLocalesRequestDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/flow-replay.dto.ts` (line 211)

SUPERIOR: replay the WHOLE recipe once per locale in one call, emitting a
localized screenshot set per locale (blob-namespaced by locale).

**Extends:** `FlowReplayRequestDto`

## Properties

| Property | Type |
|---|---|
| `locales` | `string[]` |
| `viewport` | `ViewportDto` |

<!-- source: function-generatelandingpage.md -->

# generateLandingPage

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/generate.ts` (line 85)

## Signature

```ts
async function generateLandingPage(outputDir: string, sections: SectionSelection[], resolved: ManifestSection[], seo: SiteAssemblyConfig['seo']): Promise<string>
```

## Parameters

| Name | Type |
|---|---|
| `outputDir` | `string` |
| `sections` | `SectionSelection[]` |
| `resolved` | `ManifestSection[]` |
| `seo` | `SiteAssemblyConfig['seo']` |

**Returns:** `Promise<string>`

<!-- source: api-endpoint-getqueuemetrics.md -->

# getQueueMetrics

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/orchestrator.controller.ts` (line 152)

Get queue metrics

## Endpoint

`GET /api/orchestrator/queue/metrics`

## Referenced By

- `OrchestratorController` (MODULE_DECLARES)

<!-- source: function-getreactlifecyclemethods.md -->

# getReactLifecycleMethods

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 523)

Get lifecycle methods for React class components

## Signature

```ts
function getReactLifecycleMethods(): string[]
```

**Returns:** `string[]`

<!-- source: interface-herogradientsplitprops.md -->

# HeroGradientSplitProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/hero/hero-gradient-split.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `subheadlineKey` | `string` |
| `primaryCtaKey` | `string` |
| `primaryCtaUrl` | `string` |
| `secondaryCtaKey` | `string` |
| `secondaryCtaUrl` | `string` |
| `imageSrc` | `string` |
| `imageAlt` | `string` |
| `badges` | `{ textKey: string; icon?: LucideIcon }[]` |
| `className` | `string` |

<!-- source: interface-imagegenerationresponse.md -->

# ImageGenerationResponse

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/providers/azure-image.provider.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `b64Data` | `string` |
| `revisedPrompt` | `string` |

<!-- source: function-initializeallparsers.md -->

# initializeAllParsers

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/queue/processors/parser-registry.ts` (line 93)

Initialize and register all parsers from parser-core

## Signature

```ts
async function initializeAllParsers(rootDir): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `rootDir` | `any` |

**Returns:** `Promise<void>`

<!-- source: component-insertcomplexmarkdownbutton.md -->

# InsertComplexMarkdownButton

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/insert-markdown.tsx` (line 141)

## Diagram

```mermaid
graph TD
    component_InsertComplexMarkdownButton_46eea884["InsertComplexMarkdownButton"]
    class component_InsertComplexMarkdownButton_46eea884 rootComponent
```

## Relationships

- USES_HOOK → `usePublisher`

## Referenced By

- `InsertMarkdownWithTableAndList` (RENDERS)

<!-- source: class-jsonconfigparser-2.md -->

# JsonConfigParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/config-docs/json-config.parser.ts` (line 58)

JSON Config Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: constant-kind-badge.md -->

# KIND_BADGE

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/cr-shared.ts` (line 52)

## Definition

```ts
Record<ChangeRequestKind, { icon: string; label: string; bg: string; color: string }>
```

<!-- source: function-logincommand.md -->

# loginCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/login.command.ts` (line 144)

Login command handler

## Signature

```ts
async function loginCommand(options: LoginOptions): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `LoginOptions` |

**Returns:** `Promise<void>`

<!-- source: type-mcpserverconfig.md -->

# McpServerConfig

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/mcp/mcp-manager.ts` (line 45)

## Definition

```ts
McpStdioServerConfig | McpHttpServerConfig
```

<!-- source: service-parsercorebridge.md -->

# ParserCoreBridge

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/services/parser-core-bridge.service.ts` (line 1)

<!-- source: type-pricinglayout.md -->

# PricingLayout

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 15)

## Definition

```ts
'columns' | 'comparison-table' | 'slider'
```

<!-- source: interface-screenshotmetadata.md -->

# ScreenshotMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot-metadata.service.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `url` | `string` |
| `viewport` | `{ width: number; height: number }` |
| `stateType` | `'default' | 'hover' | 'modal' | 'error' | 'success' | 'loading'` |
| `flowStepId` | `string` |
| `browser` | `'chromium' | 'firefox' | 'webkit'` |
| `fullPage` | `boolean` |
| `contentHash` | `string` |

<!-- source: service-screenshotmetadataservice.md -->

# ScreenshotMetadataService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot-metadata.service.ts` (line 36)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `calculateContentHash` | `calculateContentHash(buffer: Buffer)` | `string` |
| `findExisting` | `findExisting(metadata: ScreenshotMetadata)` | `Promise<ExistingScreenshot | null>` |
| `shouldRegenerate` | `shouldRegenerate(existing: ExistingScreenshot, newContentHash: string)` | `boolean` |
| `save` | `save(buffer: Buffer, metadata: ScreenshotMetadata, assetUrl: string, organizationId: string, capturedBy: string, jobId: string)` | `Promise<{ id: string; version: number }>` |
| `getHistory` | `getHistory(projectId: string, flowStepId: string)` | `Promise<ExistingScreenshot[]>` |
| `markAsBaseline` | `markAsBaseline(screenshotId: string)` | `Promise<void>` |
| `getBaseline` | `getBaseline(projectId: string, viewport: string, stateType: string, flowStepId: string)` | `Promise<ExistingScreenshot | null>` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: type-searchdoctype.md -->

# SearchDocType

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/staticSearch.ts` (line 14)

Client-side scorer over the PREBUILT STATIC search index (F4).

PublicSearchModal fetches `/public/p/:slug/search-index.json` once and runs
this tiny inline scorer when the live search API is unavailable — so search
keeps working during an API/Azure outage or on a fully static export. No
external search dependency: a small, well-tuned term scorer.

Ranking = a text score (title/heading/token/excerpt matches, weighted by how
many query terms matched) plus a small entity-graph `boost` tie-breaker, so
the important pages float up among otherwise-similar text matches.

## Definition

```ts
'user_manual' | 'technical_ref'
```

<!-- source: interface-sessionsshowoptions.md -->

# SessionsShowOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/commands/sessions.command.ts` (line 17)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |

<!-- source: constant-swebench-starter-subset.md -->

# SWEBENCH_STARTER_SUBSET

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/swebench-subset.ts` (line 36)

## Definition

```ts
SubsetEntry[]
```

<!-- source: api-endpoint-takesmartauthenticatedscreenshot.md -->

# takeSmartAuthenticatedScreenshot

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.controller.ts` (line 280)

Smart authenticated screenshot - AI auto-detects login form selectors

POST /api/screenshot/smart-auth

Body:
{
  "url": "https://example.com/dashboard",
  "projectId": "uuid",
  "organizationId": "uuid",
  "capturedBy": "uuid",
  "auth": {
    "loginUrl": "https://example.com/login",
    "username": "user@example.com",
    "password": "password"
  },
  "viewport": { "width": 1920, "height": 1080 },
  "fullPage": true
}

The AI will automatically:
1. Navigate to the login page
2. Analyze the HTML to find username, password, and submit selectors
3. Fill in credentials and submit
4. Navigate to the target URL and take a screenshot

## Endpoint

`POST /screenshot/smart-auth`

## Referenced By

- `ScreenshotController` (MODULE_DECLARES)

<!-- source: type-templateelement.md -->

# TemplateElement

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/template-analysis.interface.ts` (line 206)

Generic template element (union type)

## Definition

```ts
| ButtonElement
  | LinkElement
  | FormElement
  | ComponentUsage
  | ModalTrigger
```

<!-- source: graphql-type-userconnection.md -->

# UserConnection

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

Paginated user list

## Relationships

- TYPE_OF → `User`

## Referenced By

- `users` (TYPE_OF)

<!-- source: component-activitytabbody.md -->

# ActivityTabBody

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/DeskCopilot.tsx` (line 525)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `thread` | `DeskThreadDetail` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ActivityTabBody_1faedad5["ActivityTabBody"]
    class component_ActivityTabBody_1faedad5 rootComponent
```

## Referenced By

- `DeskCopilot` (RENDERS)

<!-- source: api-endpoint-addcards.md -->

# addCards

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 153)

## Endpoint

`POST /projects/:projectId/boards/:boardId/cards`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `boardId` | query | `string` | ✓ |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: constant-addtomarkdownextension.md -->

# addToMarkdownExtension$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 372)

Adds a markdown to string extension to be used when exporting markdown from the Lexical tree.

<!-- source: interface-agenttoolstartevent.md -->

# AgentToolStartEvent

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/agent/agent.types.ts` (line 96)

## Properties

| Property | Type |
|---|---|
| `toolName` | `string` |
| `input` | `string` |

<!-- source: interface-analyzerprogresscallback.md -->

# AnalyzerProgressCallback

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-04-analysis/analyzer.service.ts` (line 31)

<!-- source: class-atloriaenvironmentselector.md -->

# AtloriaEnvironmentSelector

**Kind:** Class

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/EnvironmentSelector.ts` (line 14)

**Extends:** `LitElement`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `render` | `render()` | `void` |

## Properties

| Property | Type |
|---|---|
| `styles` | `any` |
| `environments` | `Environment[]` |
| `selected` | `any` |

<!-- source: interface-attemptresult.md -->

# AttemptResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/retry-runner.ts` (line 40)

## Properties

| Property | Type |
|---|---|
| `attemptIndex` | `number` |
| `score` | `number` |

<!-- source: service-authservice.md -->

# AuthService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/auth/auth.service.ts` (line 26)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `register` | `register(registerDto: RegisterDto)` | `Promise<AuthResponseDto>` |
| `verifyEmail` | `verifyEmail(token: string)` | `Promise<{ verified: boolean; email: string }>` |
| `resendVerification` | `resendVerification(userId: string)` | `Promise<{ sent: boolean; alreadyVerified?: boolean }>` |
| `forgotPassword` | `forgotPassword(email: string)` | `Promise<{ message: string }>` |
| `resetPassword` | `resetPassword(token: string, newPassword: string)` | `Promise<{ success: boolean }>` |
| `login` | `login(loginDto: LoginDto)` | `Promise<AuthResponseDto>` |
| `refresh` | `refresh(refreshToken: string)` | `Promise<AuthResponseDto>` |
| `logout` | `logout(userId: string)` | `Promise<void>` |
| `getMe` | `getMe(userId: string)` | `Promise<UserResponseDto>` |
| `validateUser` | `validateUser(email: string, password: string)` | `Promise<User | null>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `redisservice`
- DEPENDS_ON → `jwtservice`
- DEPENDS_ON → `configservice`
- DEPENDS_ON → `emailservice`

<!-- source: controller-brandingcontroller.md -->

# BrandingController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/branding/branding.controller.ts` (line 8)

## Relationships

- MODULE_DECLARES → `getBranding`
- MODULE_DECLARES → `updateBranding`
- DEPENDS_ON → `brandingservice`

<!-- source: interface-breadcrumb.md -->

# Breadcrumb

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Layout/Breadcrumbs.tsx` (line 11)

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `href` | `string` |
| `current` | `boolean` |

<!-- source: function-buildextractionprompt.md -->

# buildExtractionPrompt

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/services/business-context-extractor.ts` (line 27)

Build the AI extraction prompt from combined source text.
The caller reads sources, concatenates text, and passes it here.

## Signature

```ts
function buildExtractionPrompt(sourceText: string, productName: string): string
```

## Parameters

| Name | Type |
|---|---|
| `sourceText` | `string` |
| `productName` | `string` |

**Returns:** `string`

<!-- source: function-buildreviewprompt.md -->

# buildReviewPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/self-review.ts` (line 36)

Build a review prompt for a set of file diffs.
Can be sent to a sub-agent or injected as a nudge.

## Signature

```ts
function buildReviewPrompt(editedFiles: EditedFile[]): string
```

## Parameters

| Name | Type |
|---|---|
| `editedFiles` | `EditedFile[]` |

**Returns:** `string`

<!-- source: function-buildstrategysystemprompt.md -->

# buildStrategySystemPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/strategy.prompts.ts` (line 10)

## Signature

```ts
function buildStrategySystemPrompt(config: GenerationConfig): string
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |

**Returns:** `string`

<!-- source: class-bulkupdatevisibilitydto.md -->

# BulkUpdateVisibilityDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/bulk-operations.dto.ts` (line 46)

Bulk update document visibility

## Properties

| Property | Type |
|---|---|
| `documentIds` | `string[]` |
| `isPublic` | `boolean` |

<!-- source: function-calculatecoveragereport.md -->

# calculateCoverageReport

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/coverage-calculator.ts` (line 236)

Calculate overall coverage report

## Signature

```ts
function calculateCoverageReport(entities: Entity[], screenshots: EnhancedScreenshotMetadata[], interactions: UIInteraction[]): CoverageReport
```

## Parameters

| Name | Type |
|---|---|
| `entities` | `Entity[]` |
| `screenshots` | `EnhancedScreenshotMetadata[]` |
| `interactions` | `UIInteraction[]` |

**Returns:** `CoverageReport`

<!-- source: type-capturetype.md -->

# CaptureType

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/screenshot-spec.types.ts` (line 19)

What kind of UI state to capture

## Definition

```ts
| 'page'
  | 'modal'
  | 'tab'
  | 'form-empty'
  | 'form-validation'
  | 'form-filled'
  | 'toast'
  | 'state-guided'
  | 'workflow-sequence'
```

<!-- source: constant-changelogtemplate.md -->

# changelogTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/changelog.template.ts` (line 3)

<!-- source: module-changerequestmodule.md -->

# ChangeRequestModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.module.ts` (line 21)

## Relationships

- MODULE_IMPORTS → `configmodule`
- MODULE_IMPORTS → `docsrepomodule`
- MODULE_IMPORTS → `forwardref`
- MODULE_DECLARES → `changerequestcontroller`
- MODULE_DECLARES → `docsconfigcontroller`
- MODULE_PROVIDES → `changerequestservice`
- MODULE_PROVIDES → `docsconfigservice`
- MODULE_PROVIDES → `docscrqueue`
- MODULE_PROVIDES → `crworker`
- MODULE_PROVIDES → `diffservice`
- MODULE_EXPORTS → `changerequestservice`
- MODULE_EXPORTS → `docscrqueue`
- MODULE_EXPORTS → `diffservice`

<!-- source: class-chunker.md -->

# Chunker

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/chunker.ts` (line 56)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `chunkFile` | `chunkFile(filePath: string, rootDir: string)` | `CodeChunk[]` |
| `chunkDirectory` | `chunkDirectory(rootDir: string, config: {
      maxFiles?: number;
      includeExtensions?: string[];
      excludeDirs?: string[];
      targetChunkTokens?: number;
    })` | `CodeChunk[]` |
| `extractImports` | `extractImports(content: string)` | `string` |

<!-- source: interface-coderelationship.md -->

# CodeRelationship

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 17)

Simplified relationship representation for AI analysis

## Properties

| Property | Type |
|---|---|
| `sourceId` | `string` |
| `targetId` | `string` |
| `type` | `string` |
| `metadata` | `Record<string, any>` |

<!-- source: function-computeentityimportance.md -->

# computeEntityImportance

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/search-index.ts` (line 143)

Per-entity importance 0..1 = blend of call-graph in-degree centrality
(how many things reference it) and public-API-surface weight (its kind).

## Signature

```ts
function computeEntityImportance(entities: GraphEntity[], relationships: GraphRelationship[]): Map<string, number>
```

## Parameters

| Name | Type |
|---|---|
| `entities` | `GraphEntity[]` |
| `relationships` | `GraphRelationship[]` |

**Returns:** `Map<string, number>`

<!-- source: function-countactivefilters.md -->

# countActiveFilters

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 48)

## Signature

```ts
function countActiveFilters(f: BoardFiltersState): number
```

## Parameters

| Name | Type |
|---|---|
| `f` | `BoardFiltersState` |

**Returns:** `number`

<!-- source: function-createtestcomment.md -->

# createTestComment

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 105)

## Signature

```ts
function createTestComment(overrides: Partial<TestCommentData>): TestCommentData
```

## Parameters

| Name | Type |
|---|---|
| `overrides` | `Partial<TestCommentData>` |

**Returns:** `TestCommentData`

<!-- source: interface-envvariableentity.md -->

# EnvVariableEntity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 920)

Environment variable entity

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.ENV_VARIABLE` |
| `variableName` | `string` |
| `exampleValue` | `string` |
| `isSensitive` | `boolean` |
| `isRequired` | `boolean` |
| `category` | `string` |

<!-- source: type-eventtype.md -->

# EventType

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/events/events.service.ts` (line 20)

## Definition

```ts
(typeof EVENT_TYPES)[number]
```

<!-- source: component-featureicon.md -->

# FeatureIcon

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/feature-icon.tsx` (line 17)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `icon` | `LucideIcon` | ✓ | - |
| `size` | `number` | - | 24 |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_FeatureIcon_500ff6b3["FeatureIcon"]
    class component_FeatureIcon_500ff6b3 rootComponent
```

## Relationships

- RENDERS → `Icon`

<!-- source: class-flowredactboxdto.md -->

# FlowRedactBoxDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/flow-replay.dto.ts` (line 57)

A region (PERCENT 0-100 of the natural image) to BLACK OUT before upload. The
worker burns a filled rectangle into the screenshot pixels — destructive by
design, so a redacted value can never be recovered from the stored asset.

## Properties

| Property | Type |
|---|---|
| `x` | `number` |
| `y` | `number` |
| `w` | `number` |
| `h` | `number` |

<!-- source: function-generatelocales.md -->

# generateLocales

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/generate.ts` (line 327)

## Signature

```ts
async function generateLocales(outputDir: string, locales: LocaleConfig[]): Promise<string[]>
```

## Parameters

| Name | Type |
|---|---|
| `outputDir` | `string` |
| `locales` | `LocaleConfig[]` |

**Returns:** `Promise<string[]>`

<!-- source: api-endpoint-getuserbyid.md -->

# getUserById

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

Get user by ID

## Endpoint

`GET /users/{id}`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Relationships

- REFERENCES → `UserWithProfile`
- REFERENCES → `Error`

## Referenced By

- `User Management API` (IMPLEMENTS_API)

<!-- source: function-hashstring.md -->

# hashString

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 449)

Simple hash function for generating unique IDs

## Signature

```ts
function hashString(str: string): string
```

## Parameters

| Name | Type |
|---|---|
| `str` | `string` |

**Returns:** `string`

<!-- source: interface-herominimalcenteredprops.md -->

# HeroMinimalCenteredProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/hero/hero-minimal-centered.tsx` (line 14)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `subheadlineKey` | `string` |
| `primaryCtaKey` | `string` |
| `primaryCtaUrl` | `string` |
| `secondaryCtaKey` | `string` |
| `secondaryCtaUrl` | `string` |
| `badgeKey` | `string` |
| `badgeIcon` | `LucideIcon` |
| `dividerIcons` | `LucideIcon[]` |
| `imageSrc` | `string` |
| `imageAlt` | `string` |

<!-- source: interface-imagemetadata.md -->

# ImageMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/guardrails/image-quality.guardrail.ts` (line 28)

## Properties

| Property | Type |
|---|---|
| `width` | `number` |
| `height` | `number` |
| `format` | `string` |
| `sizeBytes` | `number` |
| `hasAlpha` | `boolean` |
| `url` | `string` |

<!-- source: component-insertcustomimage.md -->

# InsertCustomImage

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/images.tsx` (line 99)

## Diagram

```mermaid
graph TD
    component_InsertCustomImage_2db81f54["InsertCustomImage"]
    class component_InsertCustomImage_2db81f54 rootComponent
```

## Relationships

- USES_HOOK → `usePublisher`

## Referenced By

- `InsertImageSignal` (RENDERS)

<!-- source: class-markdownparser-2.md -->

# MarkdownParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/config-docs/markdown.parser.ts` (line 64)

Markdown Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: function-mcpaddcommand.md -->

# mcpAddCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/mcp.command.ts` (line 53)

## Signature

```ts
async function mcpAddCommand(name: string, options: McpAddOptions): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `name` | `string` |
| `options` | `McpAddOptions` |

**Returns:** `Promise<void>`

<!-- source: function-measureexecutiontime.md -->

# measureExecutionTime

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 332)

Measure execution time

## Signature

```ts
async function measureExecutionTime(fn: () => Promise<T>): Promise<{ result: T; duration: number }>
```

## Parameters

| Name | Type |
|---|---|
| `fn` | `() => Promise<T>` |

**Returns:** `Promise<{ result: T; duration: number }>`

<!-- source: type-memorypersister.md -->

# MemoryPersister

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/session-memory.ts` (line 60)

Callback that receives extracted memories for persistence.
Domain layers implement this to write memories to disk, database, etc.

## Definition

```ts
(memories: SessionMemory[]) => void | Promise<void>
```

<!-- source: constant-metadata.md -->

# metadata

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/compare/gitbook/page.tsx` (line 11)

/compare/gitbook — bottom-funnel "gitbook alternative" / "atloria vs gitbook".
Fair by design: concedes GitBook's real strengths (authoring-workflow maturity + Git Sync,
collaboration maturity, SOC 2 Type II + ISO 27001, richer adaptive content, and
their newly-shipped 8 comparison pages) and only claims Atloria capabilities that
are live-verified. Every competitor fact is from gitbook.com's live docs/pricing
(verified 2026-07-11). Design mirrors /product/agent-actions: light + colorful.

<!-- source: graphql-type-mutation.md -->

# Mutation

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

## Relationships

- CALLS_API → `createUser`
- CALLS_API → `updateUser`
- CALLS_API → `deleteUser`
- CALLS_API → `createPost`
- CALLS_API → `updatePost`
- CALLS_API → `deletePost`
- CALLS_API → `likePost`
- CALLS_API → `unlikePost`
- CALLS_API → `followUser`
- CALLS_API → `unfollowUser`
- CALLS_API → `addComment`
- CALLS_API → `login`
- CALLS_API → `refreshToken`

<!-- source: service-parserservice-2.md -->

# ParserService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/parser.service.ts` (line 1)

<!-- source: type-problemlayout.md -->

# ProblemLayout

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 16)

## Definition

```ts
'centered' | 'split-visual'
```

<!-- source: interface-screenshotoptions.md -->

# ScreenshotOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/playwright/playwright.service.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `browserType` | `BrowserType` |
| `viewport` | `{
    width: number;
    height: number;
  }` |
| `fullPage` | `boolean` |
| `waitForSelector` | `string` |
| `waitForTimeout` | `number` |
| `authentication` | `{
    username: string;
    password: string;
  }` |

<!-- source: service-screenshotservice.md -->

# ScreenshotService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.service.ts` (line 78)

Screenshot orchestration service

Coordinates Playwright and Storage services to:
1. Take screenshots
2. Upload to Azure Blob Storage
3. Return public URLs

## Methods

| Method | Signature | Returns |
|---|---|---|
| `takeAndUpload` | `takeAndUpload(request: TakeScreenshotRequest)` | `Promise<ScreenshotResult>` |
| `takeResponsiveScreenshots` | `takeResponsiveScreenshots(url: string, projectId: string, organizationId: string, capturedBy: string)` | `Promise<ScreenshotResult[]>` |
| `takeAuthenticatedScreenshot` | `takeAuthenticatedScreenshot(request: TakeAuthenticatedScreenshotRequest)` | `Promise<ScreenshotResult>` |
| `takeSmartAuthenticatedScreenshot` | `takeSmartAuthenticatedScreenshot(_request: TakeSmartAuthenticatedScreenshotRequest)` | `Promise<ScreenshotResult>` |

## Relationships

- DEPENDS_ON → `playwrightservice`
- DEPENDS_ON → `storageservice`
- DEPENDS_ON → `screenshotmetadataservice`

<!-- source: type-slastate.md -->

# SlaState

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 20)

## Definition

```ts
'ok' | 'warn' | 'breach' | null
```

<!-- source: interface-stdiotransportoptions.md -->

# StdioTransportOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/stdio-transport.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `formatTodo` | `(items: ReadonlyArray<TodoItem>, stats: TodoStats) => string` |

<!-- source: constant-tool-profiles.md -->

# TOOL_PROFILES

**Kind:** Constant

**Source:** `atloria-monorepo/libs/agent-core/src/tools/tool-profiles.ts` (line 24)

Tool name sets per mode. `null` means all tools (full mode).

Note: tool_search is always included — it's the discovery mechanism
for deferred tools. journal and note are always included for working memory.

## Definition

```ts
Record<TaskMode, readonly string[] | null>
```

<!-- source: type-typedefinitionmap.md -->

# TypeDefinitionMap

**Kind:** Type

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 51)

Type definition map for resolving type references

## Definition

```ts
Map<string, t.TSInterfaceDeclaration | t.TSTypeAliasDeclaration>
```

<!-- source: api-endpoint-validateselectors.md -->

# validateSelectors

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/batch-screenshot.controller.ts` (line 351)

## Endpoint

`POST /screenshot/validate-selectors`

## Referenced By

- `BatchScreenshotController` (MODULE_DECLARES)

<!-- source: api-endpoint-addcolumn.md -->

# addColumn

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 93)

## Endpoint

`POST /projects/:projectId/boards/:boardId/columns`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `boardId` | query | `string` | ✓ |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: constant-addtopareachild.md -->

# addTopAreaChild$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 746)

Lets you add React components on top of the editor (like the toolbar).

<!-- source: interface-agenttraffic.md -->

# AgentTraffic

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/events/agent-analytics.service.ts` (line 15)

Agent-native analytics — "who/what AI is reading your docs".

A read-side aggregation over the `agent_read` interaction_events the public agent
surfaces (llms.txt / llms-full.txt / .md twins / MCP) already record via EventsService.
No new capture. Mirrors ManualsInsightsService.deflection: one org-scoped fetch, JS
aggregation, a zero-filled daily trend. The `refusedQuestions` panel folds in the
`chat_refused` signal — the loop-closer: what agents/users asked that the docs
couldn't answer.

## Properties

| Property | Type |
|---|---|
| `windowDays` | `number` |
| `total` | `number` |
| `byAgent` | `Array<{ agent: string; count: number }>` |
| `bySurface` | `Array<{ surface: string; count: number }>` |
| `topPages` | `Array<{ path: string; count: number }>` |
| `trend` | `Array<{ date: string; count: number }>` |
| `refusedQuestions` | `Array<{ question: string; count: number }>` |

<!-- source: component-aienrichmentcontent.md -->

# AiEnrichmentContent

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/entity/[entityId]/page.tsx` (line 170)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `content` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_AiEnrichmentContent_36de275e["AiEnrichmentContent"]
    class component_AiEnrichmentContent_36de275e rootComponent
```

## Relationships

- RENDERS → `MarkdownRenderer`

## Referenced By

- `EntityDetailPage` (RENDERS)

<!-- source: interface-angulardetectionconfig.md -->

# AngularDetectionConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/angular.patterns.ts` (line 235)

## Properties

| Property | Type |
|---|---|
| `name` | `'angular'` |
| `filePatterns` | `string[]` |
| `identifiers` | `RegExp[]` |
| `configFiles` | `string[]` |

<!-- source: class-atloriainput.md -->

# AtloriaInput

**Kind:** Class

**Source:** `atloria-monorepo/packages/ui-core/src/components/input/Input.ts` (line 22)

A fully accessible input component with validation states

**Extends:** `LitElement`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `focus` | `focus()` | `void` |
| `blur` | `blur()` | `void` |
| `select` | `select()` | `void` |
| `render` | `render()` | `void` |

## Properties

| Property | Type |
|---|---|
| `styles` | `any` |
| `type` | `InputType` |
| `name` | `any` |
| `value` | `any` |
| `label` | `any` |
| `placeholder` | `any` |
| `helperText` | `any` |
| `errorMessage` | `any` |
| `successMessage` | `any` |
| `required` | `any` |
| `disabled` | `any` |
| `readonly` | `any` |
| `minlength` | `number` |
| `maxlength` | `number` |
| `pattern` | `string` |
| `autocomplete` | `string` |

<!-- source: interface-autonomousinstructionsoptions.md -->

# AutonomousInstructionsOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/autonomous-loop.ts` (line 60)

## Properties

| Property | Type |
|---|---|
| `goal` | `string` |
| `workspaceDir` | `string` |
| `qualityGates` | `QualityGate[]` |
| `context` | `string` |
| `discoveryHints` | `string[]` |

<!-- source: service-azureaisearchservice.md -->

# AzureAISearchService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/web-search/services/azure-ai-search.service.ts` (line 23)

Azure AI Search Service
Queries the indexed competitor documentation

## Methods

| Method | Signature | Returns |
|---|---|---|
| `search` | `search(query: SearchQuery)` | `Promise<CompetitorSearchResult>` |
| `searchByCategory` | `searchByCategory(category: string, limit: unknown)` | `Promise<SearchResult[]>` |
| `getDocumentByUrl` | `getDocumentByUrl(url: string)` | `Promise<SearchResult | null>` |
| `healthCheck` | `healthCheck()` | `Promise<boolean>` |

<!-- source: interface-breadcrumbitem.md -->

# BreadcrumbItem

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/Breadcrumbs.tsx` (line 8)

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `href` | `string` |

<!-- source: function-buildpamsintelligence.md -->

# buildPAMSIntelligence

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/agent-screenshot-mapper.ts` (line 267)

Pre-built intelligence for PAMS — in production this would be generated
by the agent reading the source code. For the POC, we extracted it manually
from the routing analysis.

## Signature

```ts
function buildPAMSIntelligence(): SourceCodeIntelligence
```

**Returns:** `SourceCodeIntelligence`

<!-- source: function-buildsandboxargs.md -->

# buildSandboxArgs

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/bash-sandbox.ts` (line 84)

Build the argument array for spawning a command under sandbox-exec.

## Signature

```ts
function buildSandboxArgs(command: string, rootDir: string): string[]
```

## Parameters

| Name | Type |
|---|---|
| `command` | `string` |
| `rootDir` | `string` |

**Returns:** `string[]`

<!-- source: function-buildthemecss.md -->

# buildThemeCss

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/theme.ts` (line 138)

Build a <style> block with :root CSS custom properties.

## Signature

```ts
function buildThemeCss(theme: ResolvedTheme): string
```

## Parameters

| Name | Type |
|---|---|
| `theme` | `ResolvedTheme` |

**Returns:** `string`

<!-- source: function-calculatestatemachinecoverage.md -->

# calculateStateMachineCoverage

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/coverage-calculator.ts` (line 144)

Calculate coverage for a single state machine

## Signature

```ts
function calculateStateMachineCoverage(stateMachine: StateMachine, screenshots: EnhancedScreenshotMetadata[], interactions: UIInteraction[]): StateMachineCoverage
```

## Parameters

| Name | Type |
|---|---|
| `stateMachine` | `StateMachine` |
| `screenshots` | `EnhancedScreenshotMetadata[]` |
| `interactions` | `UIInteraction[]` |

**Returns:** `StateMachineCoverage`

<!-- source: controller-capturecontroller.md -->

# CaptureController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/capture/capture.controller.ts` (line 29)

Member-gated capture endpoints. A project member records a walkthrough of
THEIR product; we store the recipe (selectors + actions), never fabricated
screenshots and never secret input values.

## Relationships

- MODULE_DECLARES → `create`
- MODULE_DECLARES → `list`
- MODULE_DECLARES → `get`
- MODULE_DECLARES → `updateSteps`
- MODULE_DECLARES → `reshootStep`
- MODULE_DECLARES → `reshootLocales`
- MODULE_DECLARES → `remove`
- MODULE_DECLARES → `draft`
- DEPENDS_ON → `captureservice`

<!-- source: class-capturedstepdto.md -->

# CapturedStepDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/capture/dto/create-flow.dto.ts` (line 40)

One recorded step in the recipe. Mirrors CapturedStep in the contract.

## Properties

| Property | Type |
|---|---|
| `order` | `number` |
| `action` | `CaptureAction` |
| `selector` | `string` |
| `xpath` | `string` |
| `elementText` | `string` |
| `elementRole` | `string` |
| `url` | `string` |
| `boundingBox` | `BoundingBoxDto` |
| `value` | `string` |
| `note` | `string` |
| `caption` | `string` |
| `redactions` | `RedactBoxDto[]` |
| `ts` | `number` |

<!-- source: type-cardvariant.md -->

# CardVariant

**Kind:** Type

**Source:** `atloria-monorepo/packages/ui-core/src/components/card/Card.ts` (line 5)

## Definition

```ts
'elevated' | 'outlined' | 'flat'
```

<!-- source: class-circledetector.md -->

# CircleDetector

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/circle-detector.ts` (line 307)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `recordTurn` | `recordTurn(record: TurnRecord)` | `void` |
| `analyze` | `analyze()` | `CircleDetectionResult` |
| `getProgressDelta` | `getProgressDelta()` | `number` |
| `suggestBudgetExtension` | `suggestBudgetExtension(currentTurn: number, maxTurns: number)` | `number` |
| `reset` | `reset()` | `void` |
| `getWindow` | `getWindow()` | `readonly TurnRecord[]` |

<!-- source: constant-codereviewchecklisttemplate.md -->

# codeReviewChecklistTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/code-review-checklist.template.ts` (line 3)

<!-- source: interface-codesample.md -->

# CodeSample

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/code-samples.ts` (line 28)

## Properties

| Property | Type |
|---|---|
| `lang` | `string` |
| `source` | `string` |

<!-- source: module-collaborationmodule.md -->

# CollaborationModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/collaboration/collaboration.module.ts` (line 40)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `docsrepomodule`
- MODULE_PROVIDES → `collaborationservice`
- MODULE_PROVIDES → `collaborationgateway`
- MODULE_PROVIDES → `documentpersistenceservice`
- MODULE_PROVIDES → `collaborationmetricsservice`
- MODULE_EXPORTS → `collaborationservice`
- MODULE_EXPORTS → `documentpersistenceservice`
- MODULE_EXPORTS → `collaborationmetricsservice`

<!-- source: function-countof.md -->

# countOf

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 237)

## Signature

```ts
function countOf(v: CountValue | undefined): number
```

## Parameters

| Name | Type |
|---|---|
| `v` | `CountValue | undefined` |

**Returns:** `number`

<!-- source: function-createtestcommentthread.md -->

# createTestCommentThread

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 122)

## Signature

```ts
function createTestCommentThread(documentId: string, replyCount): TestCommentData[]
```

## Parameters

| Name | Type |
|---|---|
| `documentId` | `string` |
| `replyCount` | `any` |

**Returns:** `TestCommentData[]`

<!-- source: function-detectaiagent.md -->

# detectAiAgent

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/events/agent-detect.ts` (line 42)

Classify a User-Agent for agent-read recording.
 - Known AI bot           → its normalized vendor name.
 - Empty / scripted UA    → 'Other bot' (record it — it's not a human).
 - Real browser           → null (don't record; that's page-view analytics).
 - Anything else unknown  → 'Other bot' (better to log than to lose the signal).

## Signature

```ts
function detectAiAgent(userAgent: string | null): string | null
```

## Parameters

| Name | Type |
|---|---|
| `userAgent` | `string | null` |

**Returns:** `string | null`

<!-- source: interface-eventdefinition.md -->

# EventDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 380)

Event definition (Vue, Angular)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `payload` | `string` |
| `description` | `string` |

<!-- source: type-exportsection.md -->

# ExportSection

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/analytics/export/analytics-export.service.ts` (line 8)

## Definition

```ts
| 'overview'
  | 'topDocs'
  | 'topSearches'
  | 'devices'
  | 'sources'
```

<!-- source: component-featuresalternating.md -->

# FeaturesAlternating

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/features/features-alternating.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `features` | `Feature[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FeaturesAlternating_6cfc90a5["FeaturesAlternating"]
    class component_FeaturesAlternating_6cfc90a5 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- USES_HOOK → `useTranslation`

<!-- source: class-flowreplayrequestdto.md -->

# FlowReplayRequestDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/flow-replay.dto.ts` (line 112)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `organizationId` | `string` |
| `capturedBy` | `string` |
| `documentId` | `string` |
| `flowId` | `string` |
| `startUrl` | `string` |
| `auth` | `BatchAuthConfigDto` |
| `config` | `BatchConfigDto` |
| `steps` | `FlowStepDto[]` |

<!-- source: function-generatemain.md -->

# generateMain

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/generate.ts` (line 149)

## Signature

```ts
async function generateMain(outputDir: string, config: SiteAssemblyConfig): Promise<string>
```

## Parameters

| Name | Type |
|---|---|
| `outputDir` | `string` |
| `config` | `SiteAssemblyConfig` |

**Returns:** `Promise<string>`

<!-- source: api-endpoint-getuserposts.md -->

# getUserPosts

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/src/users/users.controller.ts` (line 79)

## Endpoint

`GET /users/:id/posts`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `UsersController` (MODULE_DECLARES)

<!-- source: function-hasjsxinpath.md -->

# hasJSXInPath

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 52)

Check if an AST node contains JSX

## Signature

```ts
function hasJSXInPath(path: NodePath): boolean
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath` |

**Returns:** `boolean`

<!-- source: interface-howitworkscardsgridprops.md -->

# HowItWorksCardsGridProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/how-it-works/how-it-works-cards-grid.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `labelKey` | `string` |
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `steps` | `{ icon: LucideIcon; titleKey: string; descriptionKey: string }[]` |

<!-- source: interface-imagequalityconfig.md -->

# ImageQualityConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/guardrails/image-quality.guardrail.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `maxSizeBytes` | `number` |
| `expectedWidth` | `number` |
| `expectedHeight` | `number` |
| `dimensionTolerance` | `number` |
| `requireTransparent` | `boolean` |

<!-- source: component-insertgrid.md -->

# InsertGrid

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/nested-jsx-elements.tsx` (line 79)

## Diagram

```mermaid
graph TD
    component_InsertGrid_422d1885["InsertGrid"]
    class component_InsertGrid_422d1885 rootComponent
```

## Relationships

- RENDERS → `Button`
- USES_HOOK → `usePublisher`

## Referenced By

- `Example` (RENDERS)

<!-- source: function-mcplistcommand.md -->

# mcpListCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/mcp.command.ts` (line 98)

## Signature

```ts
async function mcpListCommand(options: { configPath?: string }): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `{ configPath?: string }` |

**Returns:** `Promise<void>`

<!-- source: class-mdxparser-2.md -->

# MdxParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/config-docs/mdx.parser.ts` (line 53)

MDX Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: function-measurememoryusage.md -->

# measureMemoryUsage

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 344)

Measure memory usage

## Signature

```ts
function measureMemoryUsage(): {
  heapUsed: number;
  heapTotal: number;
  external: number;
  rss: number;
}
```

**Returns:** `{
  heapUsed: number;
  heapTotal: number;
  external: number;
  rss: number;
}`

<!-- source: constant-metadata-2.md -->

# metadata

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/compare/mintlify/page.tsx` (line 10)

/compare/mintlify — bottom-funnel "mintlify alternative" / "atloria vs mintlify".
Fair by design: concedes Mintlify's real strengths (distribution, polish, 20k+
customers, agent-traffic dashboard) and only claims Atloria capabilities that are
live-verified. Every competitor fact is drawn from mintlify.com's live docs/pricing
(verified 2026-07-11). Design mirrors /product/agent-actions: light + colorful.

<!-- source: type-modelinputitem.md -->

# ModelInputItem

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-provider-interface.ts` (line 56)

A single item in the conversation input.
Intentionally simple — providers map to their API's format internally.

## Definition

```ts
| { role: 'user'; content: string }
  | { role: 'assistant'; content: string; toolCalls?: ModelToolCall[] }
  | { role: 'tool'; toolCallId: string; content: string }
```

<!-- source: service-phaseservice.md -->

# PhaseService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-07-phases/divider.service.ts` (line 1)

<!-- source: graphql-type-query.md -->

# Query

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

GraphQL Schema for User Management API

## Relationships

- CALLS_API → `users`
- CALLS_API → `user`
- CALLS_API → `posts`
- CALLS_API → `post`
- CALLS_API → `searchUsers`

<!-- source: type-renderandcapturefn.md -->

# RenderAndCaptureFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/tools/visual-qa.tool.ts` (line 25)

Function signature for rendering HTML and capturing screenshots.
In production: Playwright. In tests: mock.

## Definition

```ts
(
  html: string,
  viewports: Array<{ name: string; width: number; height: number }>
) => Promise<QaScreenshot[]>
```

<!-- source: interface-screenshotresult.md -->

# ScreenshotResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.service.ts` (line 59)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `url` | `string` |
| `filename` | `string` |
| `size` | `number` |
| `viewport` | `{ width: number; height: number }` |
| `uploadedAt` | `Date` |
| `version` | `number` |
| `isNew` | `boolean` |

<!-- source: type-snoozepreset.md -->

# SnoozePreset

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/DeskDialogs.tsx` (line 34)

## Definition

```ts
'1_hour' | 'tomorrow' | 'next_week'
```

<!-- source: service-stateresolverservice.md -->

# StateResolverService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/state-resolver.service.ts` (line 50)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `resolveState` | `resolveState(page: Page, config: StateResolutionConfigDto)` | `Promise<StateResolutionResult>` |

<!-- source: interface-storageconfig.md -->

# StorageConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/cli/src/services/storage-helper.service.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `mode` | `'static' | 'dynamic'` |
| `outputDir` | `string` |
| `apiUrl` | `string` |
| `apiToken` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |

<!-- source: api-endpoint-addcomment.md -->

# addComment

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/issues.controller.ts` (line 96)

## Endpoint

`POST /projects/:projectId/issues/:issueId/comments`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `issueId` | query | `string` | ✓ |

## Referenced By

- `IssuesController` (MODULE_DECLARES)

<!-- source: interface-agentturndoneevent.md -->

# AgentTurnDoneEvent

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/agent/agent.types.ts` (line 130)

## Properties

| Property | Type |
|---|---|
| `turnNumber` | `number` |
| `usage` | `{
    inputTokens: number;
    outputTokens: number;
    totalTokens: number;
  }` |

<!-- source: component-aienrichmentcontent-2.md -->

# AiEnrichmentContent

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/technical/entity/[entityId]/page.tsx` (line 100)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `content` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_AiEnrichmentContent_71334741["AiEnrichmentContent"]
    class component_AiEnrichmentContent_71334741 rootComponent
```

## Referenced By

- `PublicEntityDetailPage` (RENDERS)

<!-- source: constant-all-detection-configs.md -->

# ALL_DETECTION_CONFIGS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/index.ts` (line 44)

All available detection configurations

<!-- source: interface-angularinput.md -->

# AngularInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/angular-detector.ts` (line 48)

Angular input property

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `required` | `boolean` |
| `alias` | `string` |

<!-- source: class-atloriamodeswitcher.md -->

# AtloriaModeSwitcher

**Kind:** Class

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/ModeSwitcher.ts` (line 10)

**Extends:** `LitElement`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `connectedCallback` | `connectedCallback()` | `void` |
| `disconnectedCallback` | `disconnectedCallback()` | `void` |
| `render` | `render()` | `void` |

## Properties

| Property | Type |
|---|---|
| `styles` | `any` |
| `mode` | `ExplorerMode` |

<!-- source: interface-autonomousturnhookoptions.md -->

# AutonomousTurnHookOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/autonomous-loop.ts` (line 258)

## Properties

| Property | Type |
|---|---|
| `investigationNudgeTurn` | `number` |
| `verificationNudgeTurn` | `number` |
| `maxTurns` | `number` |
| `qualityGateProvider` | `QualityGateProvider` |
| `tokenBudget` | `number` |
| `afterTurn` | `AfterTurnCallback` |
| `errorRecoveryThreshold` | `number` |
| `circuitBreakerThreshold` | `number` |
| `circuitBreakerCooldown` | `number` |
| `noteStore` | `AgentNoteStore` |
| `maxObservations` | `number` |
| `reactiveCompactThreshold` | `number` |
| `historyProcessors` | `HistoryProcessor[]` |
| `postCompactionHook` | `PostCompactionHook` |
| `modelCompactor` | `ModelCompactor` |
| `circleDetector` | `CircleDetectorOptions | false` |
| `envTracker` | `import('../tools/env-tracker').EnvTracker` |
| `sessionJournal` | `import('./session-journal').SessionJournal` |
| `phaseDirectives` | `boolean` |

<!-- source: service-azureblobservice.md -->

# AzureBlobService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/assets/azure-blob.service.ts` (line 8)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `upload` | `upload(options: {
    buffer: Buffer;
    filename: string;
    mimeType: string;
    organizationId: string;
  })` | `Promise<{ url: string; cdnUrl: string }>` |
| `delete` | `delete(blobName: string)` | `Promise<void>` |
| `getBlobUrl` | `getBlobUrl(blobName: string)` | `string` |
| `generateSasUrl` | `generateSasUrl(blobName: string, _expiresInMinutes: unknown)` | `Promise<string>` |

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: function-buildplaceholdermappingprompt.md -->

# buildPlaceholderMappingPrompt

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/agent-screenshot-mapper.ts` (line 191)

Prompt for sub-agents that map doc placeholders to screenshot specs
using the pre-built SourceCodeIntelligence.

## Signature

```ts
function buildPlaceholderMappingPrompt(intelligence: SourceCodeIntelligence, docs: DocScreenshotRequest[], siteUrl: string): string
```

## Parameters

| Name | Type |
|---|---|
| `intelligence` | `SourceCodeIntelligence` |
| `docs` | `DocScreenshotRequest[]` |
| `siteUrl` | `string` |

**Returns:** `string`

<!-- source: function-buildseatbeltprofile.md -->

# buildSeatbeltProfile

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/bash-sandbox.ts` (line 31)

Build a macOS Seatbelt profile (SBPL) that:
- Denies everything by default
- Allows global file reads (metadata, data, xattr)
- Allows file writes only within rootDir
- Allows process exec/fork (needed for sh, node, npm, git, etc.)
- Allows signal sending to own process group

## Signature

```ts
function buildSeatbeltProfile(rootDir: string): string
```

## Parameters

| Name | Type |
|---|---|
| `rootDir` | `string` |

**Returns:** `string`

<!-- source: function-buildthemetogglehtml.md -->

# buildThemeToggleHtml

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/theme.ts` (line 190)

Build the floating theme toggle HTML widget.

## Signature

```ts
function buildThemeToggleHtml(): string
```

**Returns:** `string`

<!-- source: class-capturescreenshotdto.md -->

# CaptureScreenshotDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/screenshot/dto/capture-screenshot.dto.ts` (line 29)

DTO for capturing a single screenshot

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `url` | `string` |
| `viewport` | `ViewportType` |
| `browser` | `BrowserType` |
| `waitTime` | `number` |
| `isBaseline` | `boolean` |
| `flowStepId` | `string` |
| `stateType` | `string` |

<!-- source: controller-categorycontroller.md -->

# CategoryController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/document/category.controller.ts` (line 23)

## Relationships

- MODULE_DECLARES → `create`
- MODULE_DECLARES → `list`
- MODULE_DECLARES → `getTree`
- MODULE_DECLARES → `get`
- MODULE_DECLARES → `update`
- MODULE_DECLARES → `delete`
- MODULE_DECLARES → `reorder`
- DEPENDS_ON → `categoryservice`

<!-- source: type-changerequestkind.md -->

# ChangeRequestKind

**Kind:** Type

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/change-requests.ts` (line 6)

Change request kind — who authored the proposal

## Definition

```ts
'human' | 'regen' | 'agent'
```

<!-- source: function-checkifexported-2.md -->

# checkIfExported

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 587)

Check if a name is exported

## Signature

```ts
function checkIfExported(name: string, exportedNames: Set<string>): boolean
```

## Parameters

| Name | Type |
|---|---|
| `name` | `string` |
| `exportedNames` | `Set<string>` |

**Returns:** `boolean`

<!-- source: class-closedwindowprocessor.md -->

# ClosedWindowProcessor

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/context/history-processors.ts` (line 169)

Deduplicates file views — keeps only the most recent read of each file.
Older reads of the same file are replaced with a pointer.

Inspired by SWE-agent's ClosedWindowProcessor pattern.

Targets tools that read files: read_file, glob_search, grep_search.
Identifies the file path from tool input, and for duplicate paths,
replaces older outputs with "[Outdated — re-read in a later turn]".

**Implements:** `HistoryProcessor`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `process` | `process(items: AgentInputItem[])` | `AgentInputItem[]` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |

<!-- source: interface-codeparserprops.md -->

# CodeParserProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Parser/CodeParser.tsx` (line 10)

## Properties

| Property | Type |
|---|---|
| `initialCode` | `string` |
| `initialLanguage` | `string` |
| `onParseComplete` | `(result: unknown) => void` |
| `className` | `string` |

<!-- source: module-commentmodule.md -->

# CommentModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/comment/comment.module.ts` (line 21)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `gatewaymodule`
- MODULE_IMPORTS → `activitymodule`
- MODULE_IMPORTS → `notificationmodule`
- MODULE_DECLARES → `commentcontroller`
- MODULE_PROVIDES → `commentservice`
- MODULE_PROVIDES → `commentgateway`
- MODULE_EXPORTS → `commentservice`
- MODULE_EXPORTS → `commentgateway`

<!-- source: constant-competitor-docs.md -->

# COMPETITOR_DOCS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/web-search/data/competitor-docs-index.ts` (line 18)

## Definition

```ts
CompetitorDoc[]
```

<!-- source: interface-competitorinfo-2.md -->

# CompetitorInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/competitor.interface.ts` (line 5)

Competitor documentation interfaces for Stage 2 AI Enhancement

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `docsUrl` | `string` |
| `apiDocsUrl` | `string` |
| `reason` | `string` |
| `category` | `string` |

<!-- source: function-createapiclient.md -->

# createAPIClient

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/api-client.ts` (line 112)

Create an API client for the Atloria application

This client makes HTTP requests to the backend API

## Signature

```ts
function createAPIClient(config: {
  apiUrl: string;
  getToken?: () => string | null;
  /** True while NextAuth is still resolving the session — the fetcher waits instead of firing unauthenticated. */
  isSessionLoading?: () => boolean;
}): APIClient
```

## Parameters

| Name | Type |
|---|---|
| `config` | `{
  apiUrl: string;
  getToken?: () => string | null;
  /** True while NextAuth is still resolving the session — the fetcher waits instead of firing unauthenticated. */
  isSessionLoading?: () => boolean;
}` |

**Returns:** `APIClient`

<!-- source: function-createtestdocument.md -->

# createTestDocument

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 63)

## Signature

```ts
function createTestDocument(overrides: Partial<TestDocumentData>): TestDocumentData
```

## Parameters

| Name | Type |
|---|---|
| `overrides` | `Partial<TestDocumentData>` |

**Returns:** `TestDocumentData`

<!-- source: function-diffsnapshot.md -->

# diffSnapshot

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-materializer.service.ts` (line 89)

## Signature

```ts
function diffSnapshot(pageEntities: Array<{ id: string; name?: string; type?: string } & Record<string, unknown>>, baseline: Record<string, string>): SnapshotDiff
```

## Parameters

| Name | Type |
|---|---|
| `pageEntities` | `Array<{ id: string; name?: string; type?: string } & Record<string, unknown>>` |
| `baseline` | `Record<string, string>` |

**Returns:** `SnapshotDiff`

<!-- source: interface-exportinfo.md -->

# ExportInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 422)

Export information

## Properties

| Property | Type |
|---|---|
| `isDefault` | `boolean` |
| `namedExports` | `string[]` |

<!-- source: component-featuresbentomodern.md -->

# FeaturesBentoModern

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/features/features-bento-modern.tsx` (line 28)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `features` | `BentoFeature[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FeaturesBentoModern_4141f1ec["FeaturesBentoModern"]
    class component_FeaturesBentoModern_4141f1ec rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `FeatureIcon`
- USES_HOOK → `useTranslation`

<!-- source: class-flowreshootrequestdto.md -->

# FlowReshootRequestDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/flow-replay.dto.ts` (line 191)

Re-shoot ONE step of a recipe. The worker replays steps 0..(targetStepId-1) in a
single context to reach the right screen, then re-captures only `targetStepId`
— optionally at a new viewport / UI locale — and burns any per-step redactions
into the fresh asset. Runs SYNCHRONOUSLY (no job row): the caller gets the fresh
result back and the blob overwrites the canonical key, so existing drafts refresh.

`targetStepId` is a flowStepId: 0 = initial state; N = state AFTER the Nth step.

**Extends:** `FlowReplayRequestDto`

## Properties

| Property | Type |
|---|---|
| `targetStepId` | `number` |
| `viewport` | `ViewportDto` |
| `locale` | `string` |

<!-- source: api-endpoint-getusers.md -->

# getUsers

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

Get all users

## Endpoint

`GET /users`

| Parameter | In | Type | Required |
|---|---|---|---|
| `limit` | query | `integer` | - |
| `offset` | query | `integer` | - |

## Referenced By

- `User Management API` (IMPLEMENTS_API)

<!-- source: component-insertmyleaf.md -->

# InsertMyLeaf

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/jsx.tsx` (line 67)

## Diagram

```mermaid
graph TD
    component_InsertMyLeaf_763410a3["InsertMyLeaf"]
    class component_InsertMyLeaf_763410a3 rootComponent
```

## Relationships

- RENDERS → `Button`
- USES_HOOK → `usePublisher`

## Referenced By

- `Example` (RENDERS)

<!-- source: function-islifecyclemethod.md -->

# isLifecycleMethod

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 540)

Check if a method name is a React lifecycle method

## Signature

```ts
function isLifecycleMethod(methodName: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `methodName` | `string` |

**Returns:** `boolean`

<!-- source: function-loadmanifest.md -->

# loadManifest

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/validate.ts` (line 26)

## Signature

```ts
async function loadManifest(componentLibraryDir: string): Promise<Manifest>
```

## Parameters

| Name | Type |
|---|---|
| `componentLibraryDir` | `string` |

**Returns:** `Promise<Manifest>`

<!-- source: interface-localeconfig.md -->

# LocaleConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 70)

## Properties

| Property | Type |
|---|---|
| `code` | `string` |
| `name` | `string` |
| `nativeName` | `string` |
| `dir` | `'ltr' | 'rtl'` |
| `translations` | `Record<string, string>` |

<!-- source: function-mcpremovecommand.md -->

# mcpRemoveCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/mcp.command.ts` (line 125)

## Signature

```ts
async function mcpRemoveCommand(name: string, options: { configPath?: string }): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `name` | `string` |
| `options` | `{ configPath?: string }` |

**Returns:** `Promise<void>`

<!-- source: constant-metadata-3.md -->

# metadata

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/compare/page.tsx` (line 9)

/compare — the comparison hub. One honest framing line + cards to each vs-page.
We only link comparisons that actually exist (Mintlify, GitBook); the rest are
listed as "in progress" without dead links. Fairness is the whole pitch: our
tables concede where the other tool wins. Design mirrors /product/agent-actions.

<!-- source: class-migrationparser-2.md -->

# MigrationParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/database/migration.parser.ts` (line 52)

Migration Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: type-modelproviderconfig.md -->

# ModelProviderConfig

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/runtime-config.ts` (line 30)

## Definition

```ts
| { provider: 'azure-responses'; config: AzureModelProviderConfig }
  | { provider: 'anthropic'; config: import('./anthropic-adapter').AnthropicModelProviderConfig }
  | { provider: 'vercel-ai'; config: VercelAIProviderConfig }
  | { provider: 'custom'; instance: IModelProvider }
```

<!-- source: type-normalizefn.md -->

# NormalizeFn

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/docs-repo/docs-repo.service.ts` (line 16)

The markdown canonicaliser (@atloria/doc-normalizer.normalize). Injected via the
DOC_NORMALIZE token so this service has NO static dependency on the ESM-only mdast
stack — the real function is provided by DocsRepoModule (webpack bundles it at build),
and unit tests supply a faithful stand-in. Every stored content byte goes through this.

## Definition

```ts
(markdown: string) => string
```

<!-- source: interface-pagemetadata.md -->

# PageMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 115)

## Properties

| Property | Type |
|---|---|
| `generatedAt` | `Date` |
| `model` | `string` |
| `tokenUsage` | `{
    inputTokens: number;
    outputTokens: number;
  }` |
| `generationTimeMs` | `number` |

<!-- source: function-readfixturefile.md -->

# readFixtureFile

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 37)

Read a fixture file

## Signature

```ts
function readFixtureFile(relativePath: string): string
```

## Parameters

| Name | Type |
|---|---|
| `relativePath` | `string` |

**Returns:** `string`

<!-- source: service-screenshotcapturerservice.md -->

# ScreenshotCapturerService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-capturer.service.ts` (line 1)

<!-- source: type-sectionchoices.md -->

# SectionChoices

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 232)

Maps section type to chosen variant key for finalization.

## Definition

```ts
Partial<Record<SectionType, 'A' | 'B' | 'C'>>
```

<!-- source: interface-smartauthconfig.md -->

# SmartAuthConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.service.ts` (line 41)

## Properties

| Property | Type |
|---|---|
| `loginUrl` | `string` |
| `username` | `string` |
| `password` | `string` |

<!-- source: type-sortoption.md -->

# SortOption

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/components/Documents/SortControl.tsx` (line 6)

## Definition

```ts
| 'order-asc'
  | 'title-asc'
  | 'title-desc'
  | 'updated-desc'
  | 'updated-asc'
  | 'created-desc'
  | 'created-asc'
```

<!-- source: service-storageservice.md -->

# StorageService

**Kind:** Service

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/storage/storage.service.ts` (line 27)

Azure Blob Storage service for storing screenshots

Features:
- Upload screenshots to Azure Blob Storage
- Generate public URLs
- Support for metadata
- Auto-create containers

`StorageService` is a NestJS backend service responsible for persisting screenshot files into Azure Blob Storage and returning accessible URLs for later retrieval. It encapsulates container management (including auto-creation), upload operations, and optional blob metadata handling so the screenshot-worker can store outputs reliably without duplicating storage logic.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `upload` | `upload(options: UploadOptions)` | `Promise<UploadResult>` |
| `uploadMultiple` | `uploadMultiple(uploads: UploadOptions[])` | `Promise<UploadResult[]>` |
| `delete` | `delete(filename: string)` | `Promise<void>` |
| `isAvailable` | `isAvailable()` | `boolean` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant Worker as Screenshot Worker
  participant Storage as StorageService
  participant Azure as Azure Blob Storage

  Worker->>Storage: uploadScreenshot(buffer, filename, container, metadata?)
  Storage->>Azure: ensureContainerExists(container)
  Azure-->>Storage: container ready
  Storage->>Azure: uploadBlob(container, filename, buffer, metadata)
  Azure-->>Storage: upload result (etag/version)
  Storage->>Azure: generatePublicUrl(container, filename)
  Azure-->>Storage: public URL
  Storage-->>Worker: { url, blobName, container, etag? }
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { StorageService } from './storage/storage.service';

@Injectable()
export class ScreenshotJobService {
  constructor(private readonly storage: StorageService) {}

  async persistScreenshot(pngBuffer: Buffer, jobId: string) {
    const container = 'screenshots';
    const blobName = `jobs/${jobId}.png`;

    const result = await this.storage.uploadScreenshot(pngBuffer, blobName, {
      container,
      contentType: 'image/png',
      metadata: {
        jobId,
        source: 'screenshot-worker',
      },
    });

    // Store result.url in DB / emit event, etc.
    return result.url;
  }
}
```

## AI Coding Instructions

- Keep Azure-specific logic (container creation, blob client setup, URL generation) inside `StorageService`; call it from jobs/workers/controllers rather than re-implementing storage concerns.
- Always pass a deterministic `blobName` (include job IDs / timestamps) to avoid accidental overwrites; if overwrites are intended, document it explicitly.
- When attaching metadata, ensure values are strings and keep keys stable (Azure metadata constraints); avoid putting sensitive data in metadata since it can be exposed.
- Handle container creation idempotently (create-if-not-exists) and surface meaningful errors (auth, missing connection string, permissions) to the caller for retry/backoff logic.
- Prefer returning the generated public URL from the service (single source of truth for URL format/SAS/public access strategy) and avoid hardcoding URL templates elsewhere.

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: graphql-type-subscription.md -->

# Subscription

**Kind:** Graphql Type

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/schema.graphql` (line 1)

## Relationships

- CALLS_API → `newPost`
- CALLS_API → `newComment`
- CALLS_API → `newFollower`

<!-- source: api-endpoint-addmember.md -->

# addMember

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 184)

## Endpoint

`POST /projects/:id/members`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: interface-agentverboseevent.md -->

# AgentVerboseEvent

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/agent/agent.types.ts` (line 144)

## Properties

| Property | Type |
|---|---|
| `category` | `string` |
| `message` | `string` |
| `data` | `Record<string, unknown>` |
| `timestamp` | `number` |

<!-- source: constant-all-detectors.md -->

# ALL_DETECTORS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/index.ts` (line 69)

All available detectors

<!-- source: interface-angularservicemapping.md -->

# AngularServiceMapping

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/cross-language.types.ts` (line 81)

Angular Service Analysis - Maps service methods to API endpoints

## Properties

| Property | Type |
|---|---|
| `serviceFile` | `string` |
| `serviceName` | `string` |
| `baseUrl` | `string` |
| `methods` | `Array<{
    methodName: string; // "createJob"
    httpMethod: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
    endpoint: string; // "/api/sales/jobs"
    parameters: string[]; // ["jobData: CreateJobDto"]
    returnType: string; // "Observable<Job>"
    usedByComponents: string[]; // ["OrderFormComponent", "OrderListComponent"]
  }>` |

<!-- source: component-answerskeleton.md -->

# AnswerSkeleton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/DeskCopilot.tsx` (line 95)

## Diagram

```mermaid
graph TD
    component_AnswerSkeleton_3e78c168["AnswerSkeleton"]
    class component_AnswerSkeleton_3e78c168 rootComponent
```

## Referenced By

- `CopilotTabBody` (RENDERS)

<!-- source: class-atloriarequestpanel.md -->

# AtloriaRequestPanel

**Kind:** Class

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/RequestPanel.ts` (line 46)

**Extends:** `LitElement`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `connectedCallback` | `connectedCallback()` | `void` |
| `disconnectedCallback` | `disconnectedCallback()` | `void` |
| `updated` | `updated(changedProperties: Map<string, any>)` | `void` |
| `render` | `render()` | `void` |

## Properties

| Property | Type |
|---|---|
| `styles` | `any` |
| `endpoint` | `APIEndpoint` |
| `environment` | `Environment` |
| `globalAuthToken` | `string` |

<!-- source: interface-azuremodelproviderconfig.md -->

# AzureModelProviderConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 177)

Model provider configuration for Azure OpenAI.

## Properties

| Property | Type |
|---|---|
| `modelProfile` | `import('./model-profiles').ModelCapabilityProfile` |
| `endpoint` | `string` |
| `apiKey` | `string` |
| `apiVersion` | `string` |
| `useV1Endpoint` | `boolean` |
| `defaultModel` | `string` |
| `timeout` | `number` |
| `fallbackModel` | `string` |
| `store` | `boolean` |
| `truncation` | `'auto' | 'disabled'` |
| `deferredToolNames` | `Set<string>` |

<!-- source: service-azuresearchservice.md -->

# AzureSearchService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/azure-search.service.ts` (line 105)

Azure AI Search Service

Wrapper around Azure AI Search SDK.
Handles:
- Index creation and management
- Document indexing
- Full-text search with filtering
- Project-level isolation (multi-tenancy)
- Faceted search

`AzureSearchService` is a NestJS service that wraps the Azure AI Search SDK to provide a consistent API for indexing and searching documents within the backend. It manages index lifecycle (create/update), document ingestion, and full‑text search with filtering and faceting. The service enforces project-level isolation (multi-tenancy) so each project’s data is indexed and queried independently.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initializeIndex` | `initializeIndex()` | `Promise<void>` |
| `indexDocument` | `indexDocument(document: SearchDocument)` | `Promise<void>` |
| `indexBatch` | `indexBatch(documents: SearchDocument[])` | `Promise<void>` |
| `updateDocument` | `updateDocument(document: SearchDocument)` | `Promise<void>` |
| `deleteDocument` | `deleteDocument(documentId: string)` | `Promise<void>` |
| `search` | `search(query: string, options: SearchOptions)` | `Promise<SearchResponse>` |
| `getSuggestions` | `getSuggestions(query: string, organizationId: string, projectId: string, limit: number)` | `Promise<string[]>` |
| `deleteVersionDocuments` | `deleteVersionDocuments(projectId: string, docVersionIds: string[])` | `Promise<number>` |
| `deleteProjectDocuments` | `deleteProjectDocuments(projectId: string)` | `Promise<void>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant C as API Controller/Resolver
  participant S as AzureSearchService (NestJS)
  participant SDK as Azure AI Search SDK
  participant IDX as Search Index
  participant DOC as Indexed Documents

  C->>S: ensureIndex(projectId, schema)
  S->>SDK: createOrUpdateIndex(indexName, schema)
  SDK->>IDX: Upsert index definition
  IDX-->>SDK: OK
  SDK-->>S: OK
  S-->>C: ready

  C->>S: indexDocuments(projectId, docs)
  S->>SDK: upload/mergeOrUpload(indexName, docs)
  SDK->>DOC: Write documents
  DOC-->>SDK: Result
  SDK-->>S: Result
  S-->>C: indexed

  C->>S: search(projectId, query, filters, facets)
  S->>SDK: search(indexName, query, options)
  SDK->>IDX: Query w/ filter + facets
  IDX-->>SDK: Hits + facet counts
  SDK-->>S: Results
  S-->>C: results
```

## Usage

```ts
import { Controller, Get, Post, Body, Query } from '@nestjs/common';
import { AzureSearchService } from './azure-search.service';

@Controller('search')
export class SearchController {
  constructor(private readonly azureSearch: AzureSearchService) {}

  @Post('reindex')
  async reindex(@Body() body: { projectId: string; documents: any[] }) {
    // Ensure the tenant-specific index exists and is up to date
    await this.azureSearch.ensureIndex(body.projectId, {
      // Example index schema (shape depends on your implementation)
      name: 'documents',
      fields: [
        { name: 'id', type: 'Edm.String', key: true, filterable: true },
        { name: 'projectId', type: 'Edm.String', filterable: true },
        { name: 'title', type: 'Edm.String', searchable: true },
        { name: 'content', type: 'Edm.String', searchable: true },
        { name: 'tags', type: 'Collection(Edm.String)', filterable: true, facetable: true },
      ],
    });

    // Index documents (typically include projectId for isolation and filtering)
    await this.azureSearch.indexDocuments(body.projectId, body.documents);

    return { ok: true };
  }

  @Get()
  async search(
    @Query('projectId') projectId: string,
    @Query('q') q = '*',
    @Query('tag') tag?: string,
  ) {
    const filter = tag ? `tags/any(t: t eq '${tag}')` : undefined;

    const results = await this.azureSearch.search(projectId, q, {
      filter,
      facets: ['tags,count:10'],
      top: 20,
      skip: 0,
    });

    return results;
  }
}
```

## AI Coding Instructions

- Preserve project-level isolation: always derive the index name and/or filter scope from `projectId` and avoid cross-project queries by default.
- Keep index schema changes backward-compatible where possible; when changing fields, update `ensureIndex` flows and reindex strategy accordingly.
- When adding filters/facets, validate and sanitize user inputs to avoid malformed OData filter strings and unexpected query errors.
- Use Azure SDK batching/merge-or-upload patterns for indexing to avoid payload limits and reduce partial-failure risk; surface indexing errors with actionable logs.
- Ensure integration points (env/config for endpoint, API key, index naming conventions) are centralized so deployments don’t diverge between environments.

## Relationships

- DEPENDS_ON → `configservice`
- DEPENDS_ON → `prismaservice`

<!-- source: function-buildsetupinstructions.md -->

# buildSetupInstructions

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/setup-agent.ts` (line 78)

Build the system prompt / instructions for the setup sub-agent.

The returned string tells the agent exactly what to detect, in what order,
and how to format its final output.

## Signature

```ts
function buildSetupInstructions(workDir: string): string
```

## Parameters

| Name | Type |
|---|---|
| `workDir` | `string` |

**Returns:** `string`

<!-- source: function-buildsourceanalysisprompt.md -->

# buildSourceAnalysisPrompt

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/agent-screenshot-mapper.ts` (line 124)

Prompt for the main agent to analyze the source code and build the
SourceCodeIntelligence artifact. This runs ONCE per project.

## Signature

```ts
function buildSourceAnalysisPrompt(sourceCodePath: string, framework: string): string
```

## Parameters

| Name | Type |
|---|---|
| `sourceCodePath` | `string` |
| `framework` | `string` |

**Returns:** `string`

<!-- source: function-buildthemetogglejs.md -->

# buildThemeToggleJs

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/theme.ts` (line 209)

Build the client-side JS for theme toggling.
Accepts the default theme mode to use as initial value.

## Signature

```ts
function buildThemeToggleJs(defaultMode: ThemeMode): string
```

## Parameters

| Name | Type |
|---|---|
| `defaultMode` | `ThemeMode` |

**Returns:** `string`

<!-- source: controller-categorydocumentscontroller.md -->

# CategoryDocumentsController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 953)

Category Documents Controller - Handles document ordering within categories

## Relationships

- MODULE_DECLARES → `reorderDocuments`
- DEPENDS_ON → `documentservice`

<!-- source: class-categoryfiltersdto.md -->

# CategoryFiltersDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/category.dto.ts` (line 106)

DTO for category query filters

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `parentId` | `string` |
| `docVersionId` | `string` |

<!-- source: type-changerequeststatus.md -->

# ChangeRequestStatus

**Kind:** Type

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/change-requests.ts` (line 11)

Change request lifecycle status

## Definition

```ts
'draft' | 'open' | 'merging' | 'merged' | 'closed' | 'failed'
```

<!-- source: interface-codeviewerprops.md -->

# CodeViewerProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Parser/CodeViewer.tsx` (line 7)

## Properties

| Property | Type |
|---|---|
| `code` | `string` |
| `language` | `string` |
| `symbols` | `Symbol[]` |
| `highlightedSymbol` | `Symbol` |
| `onSymbolClick` | `(symbol: Symbol) => void` |
| `className` | `string` |

<!-- source: interface-competitorresearchresult-2.md -->

# CompetitorResearchResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/competitor.interface.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `projectType` | `string` |
| `competitors` | `CompetitorInfo[]` |
| `crawledPages` | `CrawledCompetitorPage[]` |
| `summary` | `string` |
| `totalContentLength` | `number` |
| `researchedAt` | `Date` |

<!-- source: class-consolidator.md -->

# Consolidator

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/memory/consolidator.ts` (line 33)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `consolidate` | `consolidate(store: MemoryStore, projectId: string)` | `ConsolidationReport` |

<!-- source: function-crawlpage.md -->

# crawlPage

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/web-crawler.ts` (line 32)

Crawl a single documentation page

## Signature

```ts
async function crawlPage(url: string): Promise<CrawledPage | null>
```

## Parameters

| Name | Type |
|---|---|
| `url` | `string` |

**Returns:** `Promise<CrawledPage | null>`

<!-- source: function-createtestdocuments.md -->

# createTestDocuments

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 80)

## Signature

```ts
function createTestDocuments(count: number): TestDocumentData[]
```

## Parameters

| Name | Type |
|---|---|
| `count` | `number` |

**Returns:** `TestDocumentData[]`

<!-- source: constant-cr-kinds.md -->

# CR_KINDS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/change-request/dto/change-request.dto.ts` (line 5)

<!-- source: module-dashboardmodule.md -->

# DashboardModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/dashboard/dashboard.module.ts` (line 8)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_DECLARES → `dashboardcontroller`
- MODULE_PROVIDES → `dashboardservice`
- MODULE_EXPORTS → `dashboardservice`

<!-- source: function-deriveautoquestion.md -->

# deriveAutoQuestion

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/copilotUtils.ts` (line 39)

The customer's question = the LAST customer message. The thread description
is the first customer message (ThreadView renders it that way), so the
fallback chain is: last non-internal, non-agent comment → description → title.
Comments with an authorName are agent replies (same rule as the timeline).

## Signature

```ts
function deriveAutoQuestion(thread: Pick<DeskThreadDetail, 'title' | 'description'> & { comments?: DeskComment[] }): string
```

## Parameters

| Name | Type |
|---|---|
| `thread` | `Pick<DeskThreadDetail, 'title' | 'description'> & { comments?: DeskComment[] }` |

**Returns:** `string`

<!-- source: function-extractclientip.md -->

# extractClientIp

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/analytics/utils/tracking-utils.ts` (line 128)

Extract the client IP from a NestJS/Express request. Checks headers set
by reverse proxies and CDNs in this order:
  1. CF-Connecting-IP (Cloudflare)
  2. X-Real-IP (nginx default)
  3. X-Forwarded-For (standard proxy header — first IP in the chain)
  4. req.ip / connection.remoteAddress (direct connection fallback)

Returns `null` if nothing usable is found (should be rare in production).

## Signature

```ts
function extractClientIp(req: {
  headers?: Record<string, string | string[] | undefined>;
  ip?: string;
  connection?: { remoteAddress?: string };
  socket?: { remoteAddress?: string };
}): string | null
```

## Parameters

| Name | Type |
|---|---|
| `req` | `{
  headers?: Record<string, string | string[] | undefined>;
  ip?: string;
  connection?: { remoteAddress?: string };
  socket?: { remoteAddress?: string };
}` |

**Returns:** `string | null`

<!-- source: component-featuresgridcards.md -->

# FeaturesGridCards

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/features/features-grid-cards.tsx` (line 22)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `labelKey` | `string` | - | - |
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `features` | `Feature[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FeaturesGridCards_5329cff6["FeaturesGridCards"]
    class component_FeaturesGridCards_5329cff6 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-span`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `FeatureIcon`
- USES_HOOK → `useTranslation`

<!-- source: interface-fielddefinition.md -->

# FieldDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 648)

Field definition for a database model

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `nullable` | `boolean` |
| `unique` | `boolean` |
| `primaryKey` | `boolean` |
| `autoIncrement` | `boolean` |
| `defaultValue` | `unknown` |
| `description` | `string` |
| `columnName` | `string` |

<!-- source: class-flowstepdto.md -->

# FlowStepDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/flow-replay.dto.ts` (line 68)

One step to replay. Mirrors the api-side CapturedStepDto so a CapturedFlow can
be forwarded to the worker verbatim.

## Properties

| Property | Type |
|---|---|
| `order` | `number` |
| `action` | `FlowAction` |
| `selector` | `string` |
| `xpath` | `string` |
| `elementText` | `string` |
| `url` | `string` |
| `value` | `string` |
| `boundingBox` | `FlowBoundingBoxDto` |
| `redactions` | `FlowRedactBoxDto[]` |

<!-- source: api-endpoint-healthcheck.md -->

# healthCheck

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/orchestrator.controller.ts` (line 217)

Health check

## Endpoint

`GET /api/orchestrator/health`

## Referenced By

- `OrchestratorController` (MODULE_DECLARES)

<!-- source: component-insertsimplemarkdownbutton.md -->

# InsertSimpleMarkdownButton

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/insert-markdown.tsx` (line 99)

## Diagram

```mermaid
graph TD
    component_InsertSimpleMarkdownButton_356fd240["InsertSimpleMarkdownButton"]
    class component_InsertSimpleMarkdownButton_356fd240 rootComponent
```

## Relationships

- USES_HOOK → `usePublisher`

## Referenced By

- `InsertSimpleMarkdown` (RENDERS)

<!-- source: function-isreactclasscomponent.md -->

# isReactClassComponent

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 75)

Check if a class extends React.Component or React.PureComponent

## Signature

```ts
function isReactClassComponent(path: NodePath<t.ClassDeclaration>): boolean
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath<t.ClassDeclaration>` |

**Returns:** `boolean`

<!-- source: interface-manifest.md -->

# Manifest

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 109)

## Properties

| Property | Type |
|---|---|
| `version` | `string` |
| `categories` | `Record<string, CategoryMeta>` |
| `sections` | `ManifestSection[]` |

<!-- source: constant-metadata-4.md -->

# metadata

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/customers/healthy/page.tsx` (line 13)

/customers/healthy — Fern/ElevenLabs-format case study. Honest framing:
Healthy is a Sherkety-ERP customer; Atloria generated their product manual,
served live on the customer's own domain (docs-test.shoteco.com).

Verified numbers only (2026-07-11): 471 manual pages · v47 ACTIVE (public
version history) · Arabic (RTL) · custom domain with auto-provisioned TLS ·
agent-captured screenshots. No invented quotes or numbers.
Design: light + colorful, one violet→cyan gradient, emerald = verified.

<!-- source: type-modelresponseitem.md -->

# ModelResponseItem

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-provider-interface.ts` (line 87)

A single item in the model's response.

## Definition

```ts
| { type: 'message'; content: string }
  | { type: 'function_call'; callId: string; name: string; arguments: string }
```

<!-- source: class-nestjsparser-2.md -->

# NestjsParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/backend/nestjs.parser.ts` (line 67)

NestJS Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: interface-pageoutput.md -->

# PageOutput

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 108)

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `sections` | `SectionContent[]` |
| `fullHtml` | `string` |
| `metadata` | `PageMetadata` |

<!-- source: function-parsecommand.md -->

# parseCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/parse.command.ts` (line 172)

Parse command handler

## Signature

```ts
async function parseCommand(options: ParseOptions): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `ParseOptions` |

**Returns:** `Promise<void>`

<!-- source: function-readprojectfiles.md -->

# readProjectFiles

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 45)

Read all files in a directory recursively

## Signature

```ts
function readProjectFiles(projectPath: string, extensions: string[]): Array<{ filePath: string; content: string }>
```

## Parameters

| Name | Type |
|---|---|
| `projectPath` | `string` |
| `extensions` | `string[]` |

**Returns:** `Array<{ filePath: string; content: string }>`

<!-- source: type-reportformat.md -->

# ReportFormat

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/analytics/export/scheduled-reports.service.ts` (line 9)

## Definition

```ts
'PDF' | 'CSV'
```

<!-- source: service-screenshotextractorservice.md -->

# ScreenshotExtractorService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-extractor.service.ts` (line 1)

<!-- source: type-sectionrenderer.md -->

# SectionRenderer

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/tools/layouts/registry.ts` (line 12)

Signature every layout renderer must match.

## Definition

```ts
(
  content: Record<string, any>,
  visualStrategy: VisualStrategy,
) => string
```

<!-- source: type-sourcebadge.md -->

# SourceBadge

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/copilotUtils.ts` (line 58)

## Definition

```ts
'DOC' | 'SRC'
```

<!-- source: interface-stateresolutionresult.md -->

# StateResolutionResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/state-resolver.service.ts` (line 17)

## Properties

| Property | Type |
|---|---|
| `resolved` | `boolean` |
| `detailUrl` | `string` |
| `matchedRowIndex` | `number` |
| `matchedText` | `string` |
| `error` | `string` |

<!-- source: function-validateconfig.md -->

# validateConfig

**Kind:** Function

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/validate.ts` (line 35)

## Signature

```ts
function validateConfig(config: SiteAssemblyConfig, manifest: Manifest): ValidationResult
```

## Parameters

| Name | Type |
|---|---|
| `config` | `SiteAssemblyConfig` |
| `manifest` | `Manifest` |

**Returns:** `ValidationResult`

<!-- source: api-endpoint-addreply.md -->

# addReply

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/comment/comment.controller.ts` (line 346)

Add a reply to an existing comment

## Endpoint

`POST /documents/:documentId/comments/:id/replies`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `CommentController` (MODULE_DECLARES)

<!-- source: interface-aimessage.md -->

# AIMessage

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/ai/interfaces/ai-types.ts` (line 3)

## Properties

| Property | Type |
|---|---|
| `role` | `'user' | 'assistant' | 'system'` |
| `content` | `string` |

<!-- source: constant-all-heading-levels.md -->

# ALL_HEADING_LEVELS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/headings/index.ts` (line 22)

<!-- source: interface-antddetectionconfig.md -->

# AntdDetectionConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/antd.patterns.ts` (line 278)

## Properties

| Property | Type |
|---|---|
| `name` | `'antd'` |
| `filePatterns` | `string[]` |
| `identifiers` | `RegExp[]` |
| `configFiles` | `string[]` |

<!-- source: component-apipanel.md -->

# ApiPanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/page.tsx` (line 309)

## Diagram

```mermaid
graph TD
    component_ApiPanel_5363d6d4["ApiPanel"]
    class component_ApiPanel_5363d6d4 rootComponent
```

## Relationships

- RENDERS → `PreviewShell`

## Referenced By

- `HomePage` (RENDERS)

<!-- source: class-atloriaresponsepanel.md -->

# AtloriaResponsePanel

**Kind:** Class

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/ResponsePanel.ts` (line 19)

**Extends:** `LitElement`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `render` | `render()` | `void` |

## Properties

| Property | Type |
|---|---|
| `styles` | `any` |
| `response` | `APIResponse` |
| `loading` | `any` |
| `error` | `Error` |

<!-- source: interface-backgroundcompleteevent.md -->

# BackgroundCompleteEvent

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/spawn-agent.tool.ts` (line 77)

## Properties

| Property | Type |
|---|---|
| `agentName` | `string` |
| `task` | `string` |
| `success` | `boolean` |
| `output` | `string` |
| `error` | `string` |
| `durationMs` | `number` |

<!-- source: service-billingservice.md -->

# BillingService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/billing/billing.service.ts` (line 23)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createCheckoutSession` | `createCheckoutSession(user: JwtPayload, plan: BillingPlanKey)` | `Promise<{ url: string }>` |
| `createPortalSession` | `createPortalSession(user: JwtPayload)` | `Promise<{ url: string }>` |
| `handleWebhook` | `handleWebhook(rawBody: Buffer, signature: string)` | `Promise<{ received: boolean }>` |
| `getSummary` | `getSummary(user: JwtPayload)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `configservice`
- DEPENDS_ON → `aiusageservice`
- DEPENDS_ON → `stripe`

<!-- source: function-buildstructuralfeedback.md -->

# buildStructuralFeedback

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/generator.service.ts` (line 902)

Build human-readable structural feedback from a StructureScore.
Used to construct the regeneration prompt when a doc fails the structure gate.

## Signature

```ts
function buildStructuralFeedback(score: StructureScore): string
```

## Parameters

| Name | Type |
|---|---|
| `score` | `StructureScore` |

**Returns:** `string`

<!-- source: function-buildtoolusageguide.md -->

# buildToolUsageGuide

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/tool-usage-guide.ts` (line 34)

Build tool usage instructions to inject into an agent's system prompt.

Example:
```typescript
const guide = buildToolUsageGuide({
  tools: ['read', 'edit', 'write', 'glob', 'grep', 'list_directory'],
});
const instructions = `${baseInstructions}\n\n${guide}`;
```

## Signature

```ts
function buildToolUsageGuide(options: ToolGuideOptions): string
```

## Parameters

| Name | Type |
|---|---|
| `options` | `ToolGuideOptions` |

**Returns:** `string`

<!-- source: function-buildvariantsystemprompt.md -->

# buildVariantSystemPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/variant.prompts.ts` (line 58)

## Signature

```ts
function buildVariantSystemPrompt(config: GenerationConfig, variantStyle: VariantStyle): string
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |
| `variantStyle` | `VariantStyle` |

**Returns:** `string`

<!-- source: class-categoryskeletondto.md -->

# CategorySkeletonDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/documentation/dto/doc-automation.dto.ts` (line 34)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `icon` | `string` |
| `documents` | `DocumentSkeletonDto[]` |

<!-- source: controller-changerequestcontroller.md -->

# ChangeRequestController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.controller.ts` (line 20)

Docs change requests (S2.1), project-scoped. POST creates a 'draft' row and enqueues the
branch-staging job — the response is the draft; the worker flips it to 'open' (with
baseCommit/headCommit/diffCache) or 'failed' asynchronously. Poll GET :crId for the outcome.

ProjectOrgGuard (not OrganizationGuard) is the class-level authorizer: every route is keyed
on `:projectId`, and OrganizationGuard no-ops when the request carries no `organizationId`,
so it would let a user from another org act on this project. ProjectOrgGuard loads the
project and enforces org ownership on GET and POST alike.

`ChangeRequestController` manages project-scoped documentation change requests. Creating a request persists it as a `draft` and queues branch staging work; clients then poll the request endpoint until the worker transitions it to `open` with diff metadata or to `failed`.

All routes are protected by `ProjectOrgGuard`, which resolves the project from `:projectId` and verifies organization ownership. Do not replace it with `OrganizationGuard`, because requests without an `organizationId` could otherwise bypass organization authorization.

## Diagram

```mermaid
graph LR
  Client[Client] -->|POST /projects/:projectId/change-requests| Controller[ChangeRequestController]
  Controller --> Guard[ProjectOrgGuard]
  Guard --> Project[Load project and verify org ownership]
  Controller --> DB[(Change request table)]
  Controller --> Queue[Branch-staging job queue]

  DB -->|draft response| Client
  Queue --> Worker[Branch staging worker]
  Worker -->|open + baseCommit/headCommit/diffCache<br/>or failed| DB

  Client -->|GET /projects/:projectId/change-requests/:crId| Controller
  Controller --> Guard
  Controller -->|current draft/open/failed state| Client
```

## Usage

```ts
const projectId = 'proj_123';

// Create a draft change request. The staging worker processes it asynchronously.
const createResponse = await fetch(
  `/projects/${projectId}/change-requests`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: `Bearer ${accessToken}`,
    },
    body: JSON.stringify({
      title: 'Update onboarding documentation',
      branch: 'docs/update-onboarding',
    }),
  },
);

const changeRequest = await createResponse.json();
// Initially expected: { id: 'cr_123', status: 'draft', ... }

// Poll until branch staging succeeds or fails.
const statusResponse = await fetch(
  `/projects/${projectId}/change-requests/${changeRequest.id}`,
  {
    headers: { Authorization: `Bearer ${accessToken}` },
  },
);

const updatedChangeRequest = await statusResponse.json();

if (updatedChangeRequest.status === 'open') {
  console.log(updatedChangeRequest.baseCommit);
  console.log(updatedChangeRequest.headCommit);
  console.log(updatedChangeRequest.diffCache);
} else if (updatedChangeRequest.status === 'failed') {
  console.error('Branch staging failed');
}
```

## AI Coding Instructions

- Keep every route project-scoped through `:projectId`; use the project context when loading or mutating change requests.
- Preserve `ProjectOrgGuard` as the class-level guard for both read and write routes; `OrganizationGuard` is insufficient for these endpoints.
- Treat `POST` as asynchronous: return the persisted `draft` record after enqueuing branch staging, rather than attempting to generate commits or diffs in the request.
- Ensure the staging worker is responsible for transitioning requests to `open` with `baseCommit`, `headCommit`, and `diffCache`, or to `failed` on errors.
- Clients should poll `GET .../:crId` and handle all lifecycle states, especially `draft`, `open`, and `failed`.

## Relationships

- MODULE_DECLARES → `open`
- MODULE_DECLARES → `list`
- MODULE_DECLARES → `get`
- MODULE_DECLARES → `close`
- MODULE_DECLARES → `merge`
- MODULE_DECLARES → `refreshDiff`
- MODULE_DECLARES → `resolve`
- DEPENDS_ON → `changerequestservice`

<!-- source: type-clicklinkcallback.md -->

# ClickLinkCallback

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 345)

## Definition

```ts
(url: string) => void
```

<!-- source: interface-collaborationuser.md -->

# CollaborationUser

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useCollaboration.ts` (line 19)

Represents an active user in a collaboration session

## Properties

| Property | Type |
|---|---|
| `userId` | `string` |
| `userName` | `string` |
| `email` | `string` |
| `avatar` | `string` |
| `color` | `string` |
| `cursor` | `CursorPosition` |
| `selection` | `SelectionRange` |

<!-- source: interface-componentaction.md -->

# ComponentAction

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 116)

## Properties

| Property | Type |
|---|---|
| `type` | `'button_click' | 'form_submit' | 'link_click' | 'event'` |
| `handler` | `string` |
| `label` | `string` |
| `filePath` | `string` |
| `lineNumber` | `number` |

<!-- source: class-contextmanager.md -->

# ContextManager

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/context/context-manager.ts` (line 54)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `add` | `add(item: Omit<ContextItem, 'turn' | 'tokenEstimate'> & { tokenEstimate?: number })` | `void` |
| `nextTurn` | `nextTurn()` | `void` |
| `getItems` | `getItems()` | `ReadonlyArray<ContextItem>` |
| `getTurn` | `getTurn()` | `number` |
| `getTotalTokens` | `getTotalTokens()` | `number` |
| `shouldCompact` | `shouldCompact()` | `boolean` |
| `compact` | `compact()` | `Promise<void>` |
| `clear` | `clear()` | `void` |

<!-- source: function-crawlpages.md -->

# crawlPages

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/web-crawler.ts` (line 89)

Crawl multiple pages with concurrency control

## Signature

```ts
async function crawlPages(urls: string[], concurrency): Promise<CrawledPage[]>
```

## Parameters

| Name | Type |
|---|---|
| `urls` | `string[]` |
| `concurrency` | `any` |

**Returns:** `Promise<CrawledPage[]>`

<!-- source: function-createtesttemplate.md -->

# createTestTemplate

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 164)

## Signature

```ts
function createTestTemplate(overrides: Partial<TestTemplateData>): TestTemplateData
```

## Parameters

| Name | Type |
|---|---|
| `overrides` | `Partial<TestTemplateData>` |

**Returns:** `TestTemplateData`

<!-- source: constant-cr-statuses.md -->

# CR_STATUSES

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/change-request/dto/change-request.dto.ts` (line 8)

<!-- source: function-derivecaption.md -->

# deriveCaption

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/captionRules.ts` (line 22)

Decide whether an image's alt text is a meaningful <figcaption>.
Returns the trimmed caption, or null when it should be suppressed because it
is empty, a generic placeholder word, a bare filename, or a duplicate of the
page heading (the page already renders that title as the H1).

## Signature

```ts
function deriveCaption(alt: string, documentTitle: string): string | null
```

## Parameters

| Name | Type |
|---|---|
| `alt` | `string` |
| `documentTitle` | `string` |

**Returns:** `string | null`

<!-- source: module-docsprmodule.md -->

# DocsPrModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr.module.ts` (line 23)

## Relationships

- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `githubappmodule`
- MODULE_IMPORTS → `parsingmodule`
- MODULE_DECLARES → `docsprcontroller`
- MODULE_PROVIDES → `pageregenservice`
- MODULE_PROVIDES → `agentregenservice`
- MODULE_PROVIDES → `docsprservice`
- MODULE_PROVIDES → `docsprqueue`
- MODULE_EXPORTS → `pageregenservice`
- MODULE_EXPORTS → `docsprservice`

<!-- source: component-featureshorizontalflow.md -->

# FeaturesHorizontalFlow

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/features/features-horizontal-flow.tsx` (line 25)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `features` | `Feature[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FeaturesHorizontalFlow_7700544e["FeaturesHorizontalFlow"]
    class component_FeaturesHorizontalFlow_7700544e rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: function-filltemplate.md -->

# fillTemplate

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/ai/prompts/prompt-templates.ts` (line 125)

Replace template variables in a prompt

## Signature

```ts
function fillTemplate(template: string, variables: Record<string, string>): string
```

## Parameters

| Name | Type |
|---|---|
| `template` | `string` |
| `variables` | `Record<string, string>` |

**Returns:** `string`

<!-- source: interface-headinginfo.md -->

# HeadingInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 875)

Heading information in markdown

## Properties

| Property | Type |
|---|---|
| `level` | `number` |
| `text` | `string` |
| `line` | `number` |

<!-- source: class-interactionconfigdto.md -->

# InteractionConfigDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 257)

Interaction configuration for hover, focus, etc.

## Properties

| Property | Type |
|---|---|
| `interactionType` | `'hover' | 'focus' | 'rightClick'` |
| `holdDuration` | `number` |
| `targetHint` | `string` |

<!-- source: function-isreactcomponent.md -->

# isReactComponent

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 68)

Check if a function component is a React component (returns JSX)

## Signature

```ts
function isReactComponent(path: NodePath<t.FunctionDeclaration | t.ArrowFunctionExpression | t.FunctionExpression>): boolean
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath<t.FunctionDeclaration | t.ArrowFunctionExpression | t.FunctionExpression>` |

**Returns:** `boolean`

<!-- source: component-lazyimage.md -->

# LazyImage

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/ImageEditor.tsx` (line 82)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `title` | `string` | ✓ | - |
| `alt` | `string` | ✓ | - |
| `className` | `string | null` | ✓ | - |
| `imageRef` | `unknown` | ✓ | - |
| `src` | `string` | ✓ | - |
| `width` | `number | unknown` | ✓ | - |
| `height` | `number | unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_LazyImage_7ef42f1d["LazyImage"]
    class component_LazyImage_7ef42f1d rootComponent
```

## Referenced By

- `ImageEditor` (RENDERS)

<!-- source: api-endpoint-login.md -->

# login

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

User login

## Endpoint

`POST /auth/login`

## Relationships

- REFERENCES → `LoginRequest`
- REFERENCES → `AuthResponse`

## Referenced By

- `User Management API` (IMPLEMENTS_API)

<!-- source: interface-manifestprop.md -->

# ManifestProp

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 136)

## Properties

| Property | Type |
|---|---|
| `type` | `string` |
| `required` | `boolean` |
| `description` | `string` |

<!-- source: constant-metadata-5.md -->

# metadata

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/customers/page.tsx` (line 16)

/customers — the live-proof gallery. The one proof format nobody can fake:
every card is a clickable, generated documentation property you can open,
search, and check against the source. No logos, no testimonials, no star
ratings, no invented metrics — only real, live-verified assets.

Numbers (verified 2026-07-11): dogfood 5,087 live pages / 30,529 code
entities; Healthy 471 pages, v47 ACTIVE (docs-test.shoteco.com); commander.js
202 code entities via /try. Benchmarks: 100% citation validity (8/8), 0
fabricated citations (/groundedness); 8.2 enterprise / 8.4 mid-market
(/manuals-benchmark).
Design: light + colorful, one violet→cyan gradient, emerald = verified.

<!-- source: class-nextjsparser-2.md -->

# NextjsParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/frontend/nextjs.parser.ts` (line 57)

Next.js Parser

Pure TypeScript class that extends ReactParser to add Next.js-specific features.
No NestJS dependencies required.

**Extends:** `ReactParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `version` | `string` |
| `supportedPatterns` | `string[]` |

<!-- source: interface-pmecompletedevent.md -->

# PmeCompletedEvent

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 210)

WebSocket completion event payload.

## Properties

| Property | Type |
|---|---|
| `jobId` | `string` |
| `htmlUrl` | `string` |
| `pageCount` | `number` |
| `assetCount` | `number` |
| `durationMs` | `number` |

<!-- source: type-postcompactionhook.md -->

# PostCompactionHook

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/session/types.ts` (line 25)

Callback invoked after context compaction. Receives recently accessed file paths.
Returns file contents to inject as synthetic context items.
This enables "hard rehydration" — automatically restoring working context
after compaction, matching Claude Code's behavior.

## Definition

```ts
(recentFiles: string[]) => Promise<RehydrationItem[]> | RehydrationItem[]
```

<!-- source: function-processscreenshots.md -->

# processScreenshots

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/utils/screenshot-storage.helper.ts` (line 31)

Process and save screenshots using storage helper

This handles intelligent deduplication and metadata tracking

## Signature

```ts
async function processScreenshots(screenshots: ScreenshotInfo[], storage: StorageHelperService): Promise<Array<{ original: ScreenshotInfo; saved: { id: string; url: string; isNew: boolean } }>>
```

## Parameters

| Name | Type |
|---|---|
| `screenshots` | `ScreenshotInfo[]` |
| `storage` | `StorageHelperService` |

**Returns:** `Promise<Array<{ original: ScreenshotInfo; saved: { id: string; url: string; isNew: boolean } }>>`

<!-- source: function-registerparser.md -->

# registerParser

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/queue/processors/parse.processor.ts` (line 44)

Register a parser implementation

## Signature

```ts
function registerParser(name: string, parser: {
    parseFile: (filePath: string, content?: string) => Promise<ParseResult>;
    parseFiles: (files: Array<{ filePath: string; content?: string }>) => Promise<ParseResult[]>;
  }): void
```

## Parameters

| Name | Type |
|---|---|
| `name` | `string` |
| `parser` | `{
    parseFile: (filePath: string, content?: string) => Promise<ParseResult>;
    parseFiles: (files: Array<{ filePath: string; content?: string }>) => Promise<ParseResult[]>;
  }` |

**Returns:** `void`

<!-- source: type-resourcekind.md -->

# ResourceKind

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/auth/guards/resource-org.guard.ts` (line 42)

ResourceOrgGuard — generalized cross-tenant ownership enforcement.

WHY: OrganizationGuard only validates an EXPLICIT `organizationId` present in the request and
no-ops otherwise, so any route scoped only by a child id (`:projectId`, `:versionId`,
`:documentId`, `:id`, …) sails past it. A security audit found this hole recurs across ~16
controllers / 100+ routes, letting any authenticated user read, mutate, or DESTROY another
tenant's data (e.g. DELETE a foreign doc-version and cascade-delete every document in it).
ProjectOrgGuard closed it for `:projectId`; this guard generalizes that to every id type by
resolving the resource → its owning organization and comparing to the caller's.

USAGE (declarative — annotate the route or controller):

## Definition

```ts
| 'project'
  | 'document'
  | 'docVersion'
  | 'documentationJob'
  | 'supportAgentConfig'
  | 'comment'
  | 'suggestion'
  | 'pmeJob'
  | 'pmePage'
  | 'pmeVariant'
  | 'changeRequest'
  | 'scheduledReport'
```

<!-- source: service-screenshotmapperservice.md -->

# ScreenshotMapperService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-mapper.service.ts` (line 1)

<!-- source: type-sectiontype.md -->

# SectionType

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 90)

## Definition

```ts
| 'hero'
  | 'problem'
  | 'features'
  | 'how-it-works'
  | 'social-proof'
  | 'pricing'
  | 'faq'
  | 'cta'
```

<!-- source: interface-takeauthenticatedscreenshotrequest.md -->

# TakeAuthenticatedScreenshotRequest

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.service.ts` (line 29)

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `capturedBy` | `string` |
| `auth` | `AuthConfig` |
| `viewport` | `{ width: number; height: number }` |
| `fullPage` | `boolean` |
| `waitForSelector` | `string` |
| `browser` | `'chromium' | 'firefox' | 'webkit'` |

<!-- source: type-themename.md -->

# ThemeName

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/theme-presets.ts` (line 58)

## Definition

```ts
keyof typeof THEME_PRESETS
```

<!-- source: api-endpoint-admindelete.md -->

# adminDelete

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/comment/comment.controller.ts` (line 230)

Delete a comment (Admin only - can delete any comment)

## Endpoint

`DELETE /documents/:documentId/comments/:id/admin`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `CommentController` (MODULE_DECLARES)

<!-- source: interface-aiprovider-2.md -->

# AIProvider

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/ai/interfaces/ai-provider.interface.ts` (line 32)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |

<!-- source: constant-allowedheadinglevels.md -->

# allowedHeadingLevels$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/headings/index.ts` (line 42)

Holds the allowed heading levels.

<!-- source: interface-apicallpattern.md -->

# ApiCallPattern

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/cross-language.types.ts` (line 58)

## Properties

| Property | Type |
|---|---|
| `pattern` | `| 'http_client'
    | 'fetch'
    | 'axios'
    | 'angular_http'
    | 'rxjs'
    | 'nuxt_fetch'
    | 'python_requests'
    | 'python_httpx'` |
| `regex` | `RegExp` |
| `extractEndpoint` | `(match: RegExpMatchArray) => string` |

<!-- source: component-appsection.md -->

# AppSection

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/EntityTree.tsx` (line 108)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `group` | `NavAppGroup` | ✓ | - |
| `enrichedIds` | `Set` | ✓ | - |
| `projectId` | `string` | ✓ | - |
| `selectedEntityId` | `string` | - | - |
| `isLib` | `boolean` | - | false |
| `entityHrefBase` | `string` | - | - |
| `pinnedIds` | `Set` | - | - |
| `onCurate` | `unknown` | - | - |

## Diagram

```mermaid
graph TD
    component_AppSection_1469504a["AppSection"]
    class component_AppSection_1469504a rootComponent
```

## Relationships

- RENDERS → `ChevronRightIcon`
- RENDERS → `CircleStackIcon`
- RENDERS → `CubeIcon`
- RENDERS → `EntityIcon`
- RENDERS → `CurateButtons`
- USES_HOOK → `useState`

## Referenced By

- `EntityTree` (RENDERS)

<!-- source: class-audienceendpoints.md -->

# AudienceEndpoints

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/audiences.ts` (line 30)

Audience endpoints

## Methods

| Method | Signature | Returns |
|---|---|---|
| `list` | `list()` | `Promise<AudienceModel[]>` |
| `get` | `get(id: string)` | `Promise<AudienceModel>` |
| `create` | `create(dto: CreateAudienceDto)` | `Promise<AudienceModel>` |
| `update` | `update(id: string, dto: UpdateAudienceDto)` | `Promise<AudienceModel>` |
| `delete` | `delete(id: string)` | `Promise<void>` |

<!-- source: interface-bashresult.md -->

# BashResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/bash-session.ts` (line 18)

Result of executing a command in a bash session.

## Properties

| Property | Type |
|---|---|
| `stdout` | `string` |
| `stderr` | `string` |
| `exitCode` | `number` |
| `timedOut` | `boolean` |
| `cwd` | `string` |

<!-- source: service-bitbucketservice.md -->

# BitbucketService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/bitbucket/bitbucket.service.ts` (line 5)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getAuthUrl` | `getAuthUrl(userId: string)` | `string` |
| `handleCallback` | `handleCallback(code: string, userId: string)` | `Promise<void>` |
| `getConnectionStatus` | `getConnectionStatus(userId: string)` | `Promise<{ connected: boolean; username: string | null }>` |
| `listRepos` | `listRepos(userId: string)` | `Promise<any[]>` |
| `listBranches` | `listBranches(userId: string, owner: string, repo: string)` | `Promise<any[]>` |
| `disconnect` | `disconnect(userId: string)` | `Promise<void>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `configservice`

<!-- source: function-buildvarianttaskprompt.md -->

# buildVariantTaskPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/variant.prompts.ts` (line 80)

## Signature

```ts
function buildVariantTaskPrompt(sectionType: SectionType, contentJson: string, variantKey: VariantKey): string
```

## Parameters

| Name | Type |
|---|---|
| `sectionType` | `SectionType` |
| `contentJson` | `string` |
| `variantKey` | `VariantKey` |

**Returns:** `string`

<!-- source: function-calculategroundingscore.md -->

# calculateGroundingScore

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/grounding-checker.ts` (line 139)

Calculate grounding score for entity mentions against known entities.

For each mention, checks if it fuzzy-matches (Jaccard >= 0.5) any known entity.
- score = matchedCount / totalMentions
- Returns 0.5 (neutral) if totalMentions === 0

## Signature

```ts
function calculateGroundingScore(mentions: string[], knownEntities: string[]): GroundingScoreResult
```

## Parameters

| Name | Type |
|---|---|
| `mentions` | `string[]` |
| `knownEntities` | `string[]` |

**Returns:** `GroundingScoreResult`

<!-- source: class-changerequestfiledto.md -->

# ChangeRequestFileDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/change-request/dto/change-request.dto.ts` (line 11)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `proposedContent` | `string` |

<!-- source: function-checkcostlimit.md -->

# checkCostLimit

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/agent-hardening.ts` (line 141)

Check if a task has exceeded its cost budget.

Pattern from SWE-agent: $3/task default limit.
When exceeded, autosubmit whatever patch exists.

## Signature

```ts
function checkCostLimit(currentCost: number, limit: number | undefined): boolean
```

## Parameters

| Name | Type |
|---|---|
| `currentCost` | `number` |
| `limit` | `number | undefined` |

**Returns:** `boolean`

<!-- source: controller-commentcontroller.md -->

# CommentController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/comment/comment.controller.ts` (line 34)

Controller for managing document comments
Provides endpoints for CRUD operations, threading, and resolution

`CommentController` exposes NestJS API endpoints for managing comments attached to documents. It handles comment creation, retrieval, updates, deletion, threaded replies, and resolution state while delegating business logic to the comment service layer.

## Diagram

```mermaid
graph LR
  Client[Client Application] --> Controller[CommentController]
  Controller --> Service[CommentService]
  Service --> Database[(Database)]

  Controller --> Create[Create Comment]
  Controller --> List[List Document Comments]
  Controller --> Update[Update Comment]
  Controller --> Thread[Manage Replies]
  Controller --> Resolve[Resolve or Reopen]
  Controller --> Delete[Delete Comment]

  Create --> Service
  List --> Service
  Update --> Service
  Thread --> Service
  Resolve --> Service
  Delete --> Service
```

## Usage

```ts
// Example client request to create a comment for a document
const response = await fetch(`/api/documents/${documentId}/comments`, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: `Bearer ${accessToken}`,
  },
  body: JSON.stringify({
    content: 'Please verify this section before publishing.',
    parentCommentId: null, // Set to an existing comment ID when creating a reply
  }),
});

const comment = await response.json();

// Resolve an existing comment thread
await fetch(`/api/comments/${comment.id}/resolve`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
});
```

## AI Coding Instructions

- Keep controller methods thin: validate request DTOs, extract authenticated user context, and delegate business rules to `CommentService`.
- Preserve document-level authorization checks for every comment operation, including replies, resolution, updates, and deletion.
- When adding threaded-comment functionality, validate that a `parentCommentId` belongs to the same document as the new reply.
- Return consistent DTOs for comments, including author information, reply relationships, and resolution status where applicable.
- Avoid deleting or resolving comments directly in the controller; use service methods to enforce ownership, permissions, and audit behavior.

## Relationships

- MODULE_DECLARES → `create`
- MODULE_DECLARES → `list`
- MODULE_DECLARES → `getById`
- MODULE_DECLARES → `update`
- MODULE_DECLARES → `delete`
- MODULE_DECLARES → `adminDelete`
- MODULE_DECLARES → `resolve`
- MODULE_DECLARES → `unresolve`
- MODULE_DECLARES → `addReply`
- DEPENDS_ON → `commentservice`

<!-- source: interface-completionsummaryprops.md -->

# CompletionSummaryProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/DocAutomation/CompletionSummary.tsx` (line 22)

## Properties

| Property | Type |
|---|---|
| `result` | `JobResult` |
| `projectSlug` | `string` |
| `projectId` | `string` |
| `onGenerateAgain` | `() => void` |
| `onViewDocs` | `() => void` |
| `screenshotProgress` | `{
    batchIndex: number;
    totalBatches: number;
    captured: number;
    totalMappings: number;
  } | null` |
| `onCancelScreenshots` | `() => void` |

<!-- source: interface-componententity-2.md -->

# ComponentEntity

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 360)

Component entity (React, Vue, Angular)

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.COMPONENT` |
| `componentType` | `'functional' | 'class'` |
| `props` | `PropDefinition[]` |
| `hooks` | `HookUsage[]` |
| `events` | `EventDefinition[]` |
| `slots` | `SlotDefinition[]` |
| `childComponents` | `string[]` |
| `stateManagement` | `StateManagementInfo` |
| `exports` | `ExportInfo` |
| `semanticMetadata` | `SemanticMetadata` |
| `stateMachines` | `StateMachine[]` |

<!-- source: type-confidencelevel.md -->

# ConfidenceLevel

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 40)

## Definition

```ts
(typeof CONFIDENCE_LEVELS)[number]
```

<!-- source: class-coordinationdoc.md -->

# CoordinationDoc

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/context/coordination-doc.ts` (line 20)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `toMarkdown` | `toMarkdown()` | `string` |
| `getSection` | `getSection(title: string)` | `CoordinationSection | undefined` |
| `getSectionTitles` | `getSectionTitles()` | `string[]` |
| `setSection` | `setSection(title: string, content: string, updatedBy: string)` | `void` |
| `appendToSection` | `appendToSection(title: string, content: string, updatedBy: string)` | `void` |
| `removeSection` | `removeSection(title: string)` | `boolean` |
| `clear` | `clear()` | `void` |
| `isEmpty` | `isEmpty()` | `boolean` |

<!-- source: function-createdefaultorchestrator.md -->

# createDefaultOrchestrator

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/orchestrator/create-default-orchestrator.ts` (line 66)

A ready-to-use orchestrator with all default parsers registered.

## Signature

```ts
function createDefaultOrchestrator(): ParserOrchestrator
```

**Returns:** `ParserOrchestrator`

<!-- source: function-createtesttemplates.md -->

# createTestTemplates

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 181)

## Signature

```ts
function createTestTemplates(count: number): TestTemplateData[]
```

## Parameters

| Name | Type |
|---|---|
| `count` | `number` |

**Returns:** `TestTemplateData[]`

<!-- source: constant-currentuser.md -->

# CurrentUser

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/auth/decorators/current-user.decorator.ts` (line 13)

<!-- source: function-derivefilteroptions.md -->

# deriveFilterOptions

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 104)

Derive the lists of options to show (only what's actually present on the board)

## Signature

```ts
function deriveFilterOptions(board: BoardData | null)
```

## Parameters

| Name | Type |
|---|---|
| `board` | `BoardData | null` |

<!-- source: module-docsrepomodule.md -->

# DocsRepoModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/docs-repo/docs-repo.module.ts` (line 25)

## Relationships

- MODULE_IMPORTS → `configmodule`
- MODULE_PROVIDES → `docsreposervice`
- MODULE_PROVIDES → `outboxservice`
- MODULE_PROVIDES → `commitlockservice`
- MODULE_PROVIDES → `reconcilerservice`
- MODULE_PROVIDES → `docsrepoqueue`
- MODULE_PROVIDES → `committerworker`
- MODULE_PROVIDES → `outboxpollerservice`
- MODULE_PROVIDES → `bundleservice`
- MODULE_EXPORTS → `outboxservice`
- MODULE_EXPORTS → `docsreposervice`
- MODULE_EXPORTS → `reconcilerservice`
- MODULE_EXPORTS → `docsrepoqueue`
- MODULE_EXPORTS → `commitlockservice`

<!-- source: component-featuresinteractivetabs.md -->

# FeaturesInteractiveTabs

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/features/features-interactive-tabs.tsx` (line 35)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `tabs` | `Tab[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FeaturesInteractiveTabs_691f6854["FeaturesInteractiveTabs"]
    class component_FeaturesInteractiveTabs_691f6854 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `Icon`
- RENDERS → `motion-span`
- RENDERS → `AnimatePresence`
- USES_HOOK → `useTranslation`
- USES_HOOK → `useState`

<!-- source: function-formatconversationhistory.md -->

# formatConversationHistory

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/support-agent/prompts/rag-context-formatter.ts` (line 129)

Formats conversation history for context

## Signature

```ts
function formatConversationHistory(history: Array<{ role: string; content: string }>): string
```

## Parameters

| Name | Type |
|---|---|
| `history` | `Array<{ role: string; content: string }>` |

**Returns:** `string`

<!-- source: interface-hookentity.md -->

# HookEntity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 834)

Hook entity (React)

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.HOOK` |
| `returnType` | `string` |
| `parameters` | `ParameterDefinition[]` |
| `dependencies` | `string[]` |
| `isCustom` | `boolean` |

<!-- source: function-isreactfile.md -->

# isReactFile

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 469)

Check if a file is a React/JSX file

## Signature

```ts
function isReactFile(filePath: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string` |

**Returns:** `boolean`

<!-- source: component-linkeditform.md -->

# LinkEditForm

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/LinkDialog.tsx` (line 45)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `url` | `string` | ✓ | - |
| `title` | `string` | ✓ | - |
| `onSubmit` | `Function` | ✓ | - |
| `onCancel` | `Function` | ✓ | - |
| `linkAutocompleteSuggestions` | `string[]` | ✓ | - |
| `showLinkTitleField` | `boolean` | ✓ | - |
| `showAnchorTextField` | `boolean` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_LinkEditForm_60bd3dbc["LinkEditForm"]
    class component_LinkEditForm_60bd3dbc rootComponent
```

## Relationships

- RENDERS → `DownshiftAutoComplete`
- USES_HOOK → `useForm`
- USES_HOOK → `useTranslation`

## Referenced By

- `LinkDialog` (RENDERS)

<!-- source: interface-manifestsection.md -->

# ManifestSection

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 120)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `category` | `string` |
| `file` | `string` |
| `exportName` | `string` |
| `destinationPath` | `string` |
| `description` | `string` |
| `visual` | `Record<string, unknown>` |
| `tags` | `string[]` |
| `bestFor` | `string[]` |
| `props` | `Record<string, ManifestProp>` |
| `dependencies` | `string[]` |
| `sharedComponents` | `string[]` |
| `sampleTranslationKeys` | `Record<string, string>` |

<!-- source: constant-metadata-6.md -->

# metadata

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/groundedness/page.tsx` (line 8)

Public groundedness benchmark (Track C 0.4) — the category-of-one claim: no docs/AI
vendor in any lane publishes accuracy metrics. Numbers from a benchmark run against
Atloria's own monorepo; the full methodology is published on the page. (The runnable
harness is being extracted into a public repo — until it's live, we claim methodology,
not a downloadable harness.)

<!-- source: class-odooxmlparser.md -->

# OdooXmlParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/backend/odoo-xml.parser.ts` (line 37)

Odoo XML View Parser
Extracts UI elements, views, actions, and menus from Odoo XML files

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: api-endpoint-parseproject.md -->

# parseProject

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/orchestrator/orchestrator.controller.ts` (line 58)

Parse an entire project

## Endpoint

`POST /api/orchestrator/projects/parse`

## Referenced By

- `OrchestratorController` (MODULE_DECLARES)

<!-- source: interface-pmecontext.md -->

# PmeContext

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 128)

PME-specific context passed through the agent's RunContext.

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `userId` | `string` |
| `config` | `GenerationConfig` |

<!-- source: type-progresscallback.md -->

# ProgressCallback

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 232)

Progress callback for long-running agent jobs.

## Definition

```ts
(progress: {
  percent: number;
  stage: string;
  message?: string;
}) => void
```

<!-- source: function-registervalidatecoveragecommand.md -->

# registerValidateCoverageCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/validate-coverage.command.ts` (line 221)

Register command with Commander

## Signature

```ts
function registerValidateCoverageCommand(program: any): void
```

## Parameters

| Name | Type |
|---|---|
| `program` | `any` |

**Returns:** `void`

<!-- source: class-renderpdfdto.md -->

# RenderPdfDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/pdf/pdf.controller.ts` (line 5)

## Properties

| Property | Type |
|---|---|
| `html` | `string` |
| `options` | `RenderPdfOptions` |

<!-- source: service-screenshotreplacerservice.md -->

# ScreenshotReplacerService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-replacer.service.ts` (line 1)

<!-- source: type-searchdoctype-2.md -->

# SearchDocType

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/technical-docs/search-index.ts` (line 20)

Prebuilt STATIC search index for a published site (F4).

A compact, self-contained JSON blob the reader fetches once and searches
client-side when the live search API (Azure AI Search / Postgres) is
unavailable — so search survives an API outage or a static export.

This module is a PURE transform (no I/O) so it is fully unit-testable: the
materializer fetches the corpus + entity graph and hands them here.

SUPERIOR: for technical-doc sites each page carries an entity-graph
importance `boost` (call-graph in-degree centrality + public-API-surface
weight). The client scorer uses it as a tie-breaker so the important ~5% of
thousands of generated reference pages float to the top. User-manual pages
(no code graph) get boost 0 and rank on text alone.

## Definition

```ts
'user_manual' | 'technical_ref'
```

<!-- source: type-socialprooflayout.md -->

# SocialProofLayout

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 17)

## Definition

```ts
'stats-grid' | 'testimonial-cards'
```

<!-- source: interface-takescreenshotrequest.md -->

# TakeScreenshotRequest

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.service.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `capturedBy` | `string` |
| `viewport` | `{ width: number; height: number }` |
| `fullPage` | `boolean` |
| `waitForSelector` | `string` |
| `stateType` | `'default' | 'hover' | 'modal' | 'error' | 'success' | 'loading'` |
| `flowStepId` | `string` |
| `browser` | `'chromium' | 'firefox' | 'webkit'` |

<!-- source: type-timeperiod.md -->

# TimePeriod

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/TimePeriodSelector.tsx` (line 3)

## Definition

```ts
7 | 30 | 90 | 365
```

<!-- source: function-useauth.md -->

# useAuth

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/frontend/src/hooks/useAuth.ts` (line 16)

<!-- source: interface-airesponse.md -->

# AIResponse

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/ai/interfaces/ai-provider.interface.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `text` | `string` |
| `usage` | `TokenUsage` |
| `model` | `string` |

<!-- source: constant-allowsetimagedimensions.md -->

# allowSetImageDimensions$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 347)

Allow to set width and height of image through dialog window

<!-- source: interface-apiclient.md -->

# APIClient

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/types.ts` (line 9)

Shared types for

<!-- source: api-endpoint-applyedit.md -->

# applyEdit

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 95)

## Endpoint

`POST /doc-versions/:projectId/apply-edit`

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-areachart.md -->

# AreaChart

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/AgentTrafficCockpit.tsx` (line 39)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `trend` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_AreaChart_4f097617["AreaChart"]
    class component_AreaChart_4f097617 rootComponent
```

## Referenced By

- `AgentTrafficCockpit` (RENDERS)

<!-- source: class-audiencerenderer.md -->

# AudienceRenderer

**Kind:** Class

**Source:** `atloria-monorepo/packages/core/src/rendering/audience-renderer.ts` (line 64)

Audience Renderer

Evaluates audience logic and filters content based on viewer permissions.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `render` | `render(ast: DocumentAST)` | `string` |

<!-- source: interface-bashsessionoptions.md -->

# BashSessionOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/bash-session.ts` (line 6)

Options for creating a persistent bash session.

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `shell` | `string` |
| `env` | `Record<string, string>` |
| `defaultTimeout` | `number` |

<!-- source: service-boardsservice.md -->

# BoardsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/boards/boards.service.ts` (line 52)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `list` | `list(projectId: string, user: JwtPayload)` | `unknown` |
| `create` | `create(projectId: string, dto: CreateBoardDto, user: JwtPayload)` | `unknown` |
| `getOne` | `getOne(projectId: string, boardId: string, user: JwtPayload, includeCards: unknown)` | `unknown` |
| `update` | `update(projectId: string, boardId: string, dto: UpdateBoardDto, user: JwtPayload)` | `unknown` |
| `remove` | `remove(projectId: string, boardId: string, user: JwtPayload)` | `unknown` |
| `restore` | `restore(projectId: string, boardId: string, user: JwtPayload)` | `unknown` |
| `addColumn` | `addColumn(projectId: string, boardId: string, dto: CreateColumnDto, user: JwtPayload)` | `unknown` |
| `updateColumn` | `updateColumn(projectId: string, boardId: string, columnId: string, dto: UpdateColumnDto, user: JwtPayload)` | `unknown` |
| `reorderColumns` | `reorderColumns(projectId: string, boardId: string, dto: ReorderColumnsDto, user: JwtPayload)` | `unknown` |
| `deleteColumn` | `deleteColumn(projectId: string, boardId: string, columnId: string, moveCardsTo: string | undefined, user: JwtPayload)` | `unknown` |
| `listCards` | `listCards(projectId: string, boardId: string, since: Date | undefined, user: JwtPayload)` | `unknown` |
| `addCards` | `addCards(projectId: string, boardId: string, dto: AddCardsDto, user: JwtPayload)` | `unknown` |
| `moveCard` | `moveCard(projectId: string, boardId: string, cardId: string, dto: MoveCardDto, user: JwtPayload)` | `unknown` |
| `removeCard` | `removeCard(projectId: string, boardId: string, cardId: string, user: JwtPayload)` | `unknown` |
| `getBoardsForIssue` | `getBoardsForIssue(projectId: string, issueId: string, user: JwtPayload)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `issuesservice`

<!-- source: function-buildvisualsystemprompt.md -->

# buildVisualSystemPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/visual.prompts.ts` (line 9)

## Signature

```ts
function buildVisualSystemPrompt(config: GenerationConfig): string
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |

**Returns:** `string`

<!-- source: function-call.md -->

# call

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/fp.ts` (line 54)

Calls the passed function.

## Signature

```ts
function call(proc: () => unknown)
```

## Parameters

| Name | Type |
|---|---|
| `proc` | `() => unknown` |

<!-- source: class-chatdto.md -->

# ChatDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/support-agent/dto/chat.dto.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `message` | `string` |
| `versionNumber` | `number` |
| `conversationHistory` | `ConversationMessageDto[]` |
| `sessionId` | `string` |

<!-- source: function-clamptimeout.md -->

# clampTimeout

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/agent-hardening.ts` (line 33)

Agent Hardening — Defensive Patterns for Benchmark Execution

Utilities adopted from SWE-agent and Claude Code:
- Bash timeout clamping utility (prevents single commands from hogging budget)
- Pager-disabling environment (PAGER=cat, etc.)
- Cost limit per task ($3-5 budget)
- Autosubmission on error (partial patch > no patch)
- Zero-progress detection (3 consecutive zero-token turns)

Note: Task-level timeout is 1800s (30 min, matching SWE-agent).
Setup time is excluded — timer starts AFTER setupTask() completes.
Per-command bash timeout is 120s (benchmark) / 60s (interactive).

These are pure utility functions — no side effects, easy to test.

## Signature

```ts
function clampTimeout(requested: number | undefined, ceiling: number, defaultMs: number): number
```

## Parameters

| Name | Type |
|---|---|
| `requested` | `number | undefined` |
| `ceiling` | `number` |
| `defaultMs` | `number` |

**Returns:** `number`

<!-- source: interface-componenthierarchydiagramoptions.md -->

# ComponentHierarchyDiagramOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/component-hierarchy-diagram.generator.ts` (line 17)

Options for component hierarchy diagram generation

## Properties

| Property | Type |
|---|---|
| `showProps` | `boolean` |
| `showStateMachines` | `boolean` |
| `showComponentTypes` | `boolean` |
| `maxDepth` | `number` |
| `direction` | `'TD' | 'TB' | 'LR' | 'RL' | 'BT'` |
| `includeTheme` | `boolean` |
| `nodeShape` | `'rectangle' | 'rounded' | 'stadium' | 'circle' | 'hexagon'` |
| `highlightRoot` | `boolean` |

<!-- source: interface-configeditorprops.md -->

# ConfigEditorProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/DocAutomation/ConfigEditor.tsx` (line 21)

## Properties

| Property | Type |
|---|---|
| `config` | `DocumentationConfig | null` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `onSave` | `(data: CreateConfigDto | UpdateConfigDto) => Promise<void>` |
| `onCancel` | `() => void` |

<!-- source: function-createprojectfordir.md -->

# createProjectForDir

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/schema-resolver.ts` (line 253)

Build a ts-morph Project for a repo dir. Uses the nearest tsconfig for compiler options
(type resolution fidelity) but ALWAYS adds source files by glob — solution-style tsconfigs
(`include: []` + project references, as Nx apps use) would otherwise load zero files.

## Signature

```ts
function createProjectForDir(rootDir: string): Project
```

## Parameters

| Name | Type |
|---|---|
| `rootDir` | `string` |

**Returns:** `Project`

<!-- source: function-createtestuser.md -->

# createTestUser

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 32)

## Signature

```ts
function createTestUser(overrides: Partial<TestUserData>): TestUserData
```

## Parameters

| Name | Type |
|---|---|
| `overrides` | `Partial<TestUserData>` |

**Returns:** `TestUserData`

<!-- source: class-cronscheduler.md -->

# CronScheduler

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/tools/cron.tool.ts` (line 39)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `parseInterval` | `parseInterval(schedule: string)` | `number | null` |
| `create` | `create(schedule: string, message: string)` | `CronJob | null` |
| `delete` | `delete(id: string)` | `boolean` |
| `list` | `list()` | `Array<{ id: string; schedule: string; message: string; next_fire_at: number }>` |
| `dispose` | `dispose()` | `void` |

<!-- source: controller-dashboardcontroller.md -->

# DashboardController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/dashboard/dashboard.controller.ts` (line 10)

## Relationships

- MODULE_DECLARES → `getStats`
- MODULE_DECLARES → `getProjectStats`
- MODULE_DECLARES → `getUserActivity`
- DEPENDS_ON → `dashboardservice`

<!-- source: constant-databaseschematemplate.md -->

# databaseSchemaTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/database-schema.template.ts` (line 3)

<!-- source: type-dependencytype.md -->

# DependencyType

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 236)

## Definition

```ts
| 'imports' // import { X } from './x'
  | 'extends' // class X extends Y
  | 'implements' // class X implements Y
  | 'uses' // X uses Y in its implementation
  | 'validates' // X validates using Y (schema)
  | 'calls' // X calls Y.method()
  | 'renders' // X renders <Y />
  | 'state' // X uses Y f…
```

<!-- source: function-deskstateof.md -->

# deskStateOf

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 148)

## Signature

```ts
function deskStateOf(t: Pick<DeskThread, 'status' | 'firstAgentReplyAt' | 'snoozedUntil'>): DeskState
```

## Parameters

| Name | Type |
|---|---|
| `t` | `Pick<DeskThread, 'status' | 'firstAgentReplyAt' | 'snoozedUntil'>` |

**Returns:** `DeskState`

<!-- source: module-documentationmodule.md -->

# DocumentationModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/documentation/documentation.module.ts` (line 35)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `aimodule`
- MODULE_IMPORTS → `graphmodule`
- MODULE_IMPORTS → `configmodule`
- MODULE_IMPORTS → `forwardref`
- MODULE_IMPORTS → `forwardref`
- MODULE_IMPORTS → `forwardref`
- MODULE_IMPORTS → `docversionmodule`
- MODULE_IMPORTS → `docsrepomodule`
- MODULE_IMPORTS → `forwardref`
- MODULE_IMPORTS → `notificationmodule`
- MODULE_IMPORTS → `emailmodule`
- MODULE_DECLARES → `documentationcontroller`
- MODULE_DECLARES → `searchcontroller`
- MODULE_DECLARES → `docautomationcontroller`
- MODULE_PROVIDES → `documentationservice`
- MODULE_PROVIDES → `workflowdetectorservice`
- MODULE_PROVIDES → `userdocsgeneratorservice`
- MODULE_PROVIDES → `featuredetectorservice`
- MODULE_PROVIDES → `featuredocsgeneratorservice`
- MODULE_PROVIDES → `tutorialdetectorservice`
- MODULE_PROVIDES → `tutorialgeneratorservice`
- MODULE_PROVIDES → `neo4jdocsorchestratorservice`
- MODULE_PROVIDES → `keywordextractorservice`
- MODULE_PROVIDES → `azuresearchservice`
- MODULE_PROVIDES → `documentindexingservice`
- MODULE_PROVIDES → `docautomationservice`
- MODULE_PROVIDES → `docautomationgateway`
- MODULE_PROVIDES → `docautomationschedulerservice`
- MODULE_EXPORTS → `documentationservice`
- MODULE_EXPORTS → `featuredetectorservice`
- MODULE_EXPORTS → `featuredocsgeneratorservice`
- MODULE_EXPORTS → `tutorialdetectorservice`
- MODULE_EXPORTS → `tutorialgeneratorservice`
- MODULE_EXPORTS → `documentindexingservice`
- MODULE_EXPORTS → `azuresearchservice`
- MODULE_EXPORTS → `docautomationservice`
- MODULE_EXPORTS → `docautomationgateway`

<!-- source: function-formatragcontext.md -->

# formatRagContext

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/support-agent/prompts/rag-context-formatter.ts` (line 27)

Formats RAG search results into a structured context for the AI

## Signature

```ts
function formatRagContext(searchResults: RagSearchResult[], projectName: string): FormattedRagContext
```

## Parameters

| Name | Type |
|---|---|
| `searchResults` | `RagSearchResult[]` |
| `projectName` | `string` |

**Returns:** `FormattedRagContext`

<!-- source: component-herobentogrid.md -->

# HeroBentoGrid

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/hero/hero-bento-grid.tsx` (line 27)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `subheadlineKey` | `string` | ✓ | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `badgeKey` | `string` | - | - |
| `gridItems` | `unknown[]` | - | - |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_HeroBentoGrid_53787f49["HeroBentoGrid"]
    class component_HeroBentoGrid_53787f49 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h1`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: interface-hookusage.md -->

# HookUsage

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 363)

Hook usage in a component

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `'built-in' | 'custom'` |
| `location` | `string` |
| `dependencies` | `string[]` |

<!-- source: function-istypescriptfile.md -->

# isTypeScriptFile

**Kind:** Function

**Source:** `atloria-monorepo/apps/frontend-parser/src/utils/ast-helpers.ts` (line 476)

Check if a file is a TypeScript file

## Signature

```ts
function isTypeScriptFile(filePath: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string` |

**Returns:** `boolean`

<!-- source: constant-metadata-7.md -->

# metadata

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/layout.tsx` (line 7)

## Definition

```ts
Metadata
```

<!-- source: interface-milestone.md -->

# Milestone

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/social-proof/social-proof-timeline.tsx` (line 11)

## Properties

| Property | Type |
|---|---|
| `dateKey` | `string` |
| `titleKey` | `string` |
| `descriptionKey` | `string` |

<!-- source: component-milestonecard-2.md -->

# MilestoneCard

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/social-proof/social-proof-timeline.tsx` (line 50)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `milestone` | `Milestone` | ✓ | - |
| `t` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_MilestoneCard_3fd5ea70["MilestoneCard"]
    class component_MilestoneCard_3fd5ea70 rootComponent
```

## Relationships

- RENDERS → `DateBadge`

## Referenced By

- `SocialProofTimeline` (RENDERS)

<!-- source: class-openapiparser-2.md -->

# OpenAPIParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/api-schema/openapi.parser.ts` (line 37)

OpenAPI Parser Implementation (Parser-Core Version)

Supports:
- OpenAPI 3.0.x and 3.1.x
- Swagger 2.0
- JSON and YAML formats

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: interface-pmefailedevent.md -->

# PmeFailedEvent

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 221)

WebSocket failure event payload.

## Properties

| Property | Type |
|---|---|
| `jobId` | `string` |
| `error` | `string` |
| `stage` | `string` |

<!-- source: type-qualitygateprovider.md -->

# QualityGateProvider

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/autonomous-loop.ts` (line 54)

Optional callback that lets the domain layer update gate status.
Called by the TurnHook before each model call.

## Definition

```ts
() => QualityGate[] | Promise<QualityGate[]>
```

<!-- source: api-endpoint-remove.md -->

# remove

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/src/users/users.controller.ts` (line 67)

## Endpoint

`DELETE /users/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `UsersController` (MODULE_DECLARES)

<!-- source: function-retrywithaisuggestions.md -->

# retryWithAISuggestions

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/utils/ai-auth-debugger.ts` (line 238)

Apply AI-suggested fixes and retry authentication

## Signature

```ts
async function retryWithAISuggestions(_page: any, _config: AuthConfig, suggestions: any[]): Promise<boolean>
```

## Parameters

| Name | Type |
|---|---|
| `_page` | `any` |
| `_config` | `AuthConfig` |
| `suggestions` | `any[]` |

**Returns:** `Promise<boolean>`

<!-- source: class-screenshotactiondto.md -->

# ScreenshotActionDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 57)

Screenshot action DTO for pre-capture interactions

Supports various action types:
- click/dblclick: Click on element (requires selector)
- type/fill: Input text (requires selector and value)
- press: Press keyboard key (requires key)
- wait: Wait for duration or selector
- scroll: Scroll to element or bottom
- hover/focus/blur: Element interactions (require selector)
- select: Select dropdown option (requires selector and value)
- navigate: Navigate to URL (requires value)
- frame: Enter/exit iframe (requires selector and frameAction)

## Properties

| Property | Type |
|---|---|
| `type` | `ActionType` |
| `selector` | `string` |
| `selectorHint` | `string` |
| `value` | `string` |
| `duration` | `number` |
| `key` | `string` |
| `frameAction` | `FrameAction` |
| `optional` | `boolean` |
| `description` | `string` |
| `waitAfter` | `number` |

<!-- source: service-screenshotuploaderservice.md -->

# ScreenshotUploaderService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-uploader.service.ts` (line 1)

<!-- source: type-stalenesslevel.md -->

# StalenessLevel

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/doc-version/screenshot-staleness.service.ts` (line 3)

## Definition

```ts
'fresh' | 'valid' | 'warning' | 'stale' | 'critical' | 'missing'
```

<!-- source: type-storeassetfn.md -->

# StoreAssetFn

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/tools/store-asset.tool.ts` (line 14)

Storage function signature — matches AzureBlobService.upload() shape.

## Definition

```ts
(
  content: string | Buffer,
  path: string,
  contentType: string
) => Promise<{ url: string }>
```

<!-- source: interface-takesmartauthenticatedscreenshotrequest.md -->

# TakeSmartAuthenticatedScreenshotRequest

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.service.ts` (line 47)

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `capturedBy` | `string` |
| `auth` | `SmartAuthConfig` |
| `viewport` | `{ width: number; height: number }` |
| `fullPage` | `boolean` |
| `waitForSelector` | `string` |
| `browser` | `'chromium' | 'firefox' | 'webkit'` |

<!-- source: type-toastvariant.md -->

# ToastVariant

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/components/Boards/Toast.tsx` (line 11)

## Definition

```ts
'success' | 'error' | 'info'
```

<!-- source: function-validateentity.md -->

# validateEntity

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 223)

Validate entity structure

## Signature

```ts
function validateEntity(entity: Entity): boolean
```

## Parameters

| Name | Type |
|---|---|
| `entity` | `Entity` |

**Returns:** `boolean`

<!-- source: interface-aiusagemetrics.md -->

# AIUsageMetrics

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/ai/interfaces/ai-types.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `promptTokens` | `number` |
| `completionTokens` | `number` |
| `totalTokens` | `number` |
| `provider` | `string` |
| `model` | `string` |
| `timestamp` | `Date` |

<!-- source: constant-angular-component-patterns.md -->

# ANGULAR_COMPONENT_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/angular.patterns.ts` (line 12)

Angular Pattern Detection

Patterns for detecting Angular components, services, templates, and RxJS usage.
Critical for enterprise applications using Angular + DevExtreme.

<!-- source: interface-apiclient-2.md -->

# APIClient

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/types/api-client.ts` (line 95)

API Client interface for making backend requests
This follows the Repository pattern to abstract data access

## Properties

| Property | Type |
|---|---|
| `audiences` | `{
    list(): Promise<AudienceModel[]>;
    get(id: string): Promise<AudienceModel>;
    create(data: {
      name: string;
      slug: string;
      color: string;
      icon: string;
      description?: string;
    }): Promise<AudienceModel>;
    update(
      id: string,
      data: {
        name?: string;
        slug?: string;
        color?: string;
        icon?: string;
        description?: string;
      },
    ): Promise<AudienceModel>;
    delete(id: string): Promise<void>;
  }` |
| `documents` | `{
    get(id: string): Promise<Document>;
    list(params?: { projectId?: string }): Promise<DocumentListResponse>;
    create(data: Partial<Document>): Promise<Document>;
    update(id: string, data: Partial<Document>): Promise<Document>;
    delete(id: string): Promise<void>;
    publish(id: string, isPublic?: boolean): Promise<Document>;
    unpublish(id: string): Promise<Document>;
    getRevisions(id: string, limit?: number, offset?: number): Promise<DocumentRevision[]>;
    getRevision(id: string, revisionId: string): Promise<DocumentRevision>;
    restoreRevision(id: string, revisionId: string): Promise<Document>;
    compareDocuments(
      id: string,
      from: string,
      to: string,
      type?: 'version' | 'revision',
    ): Promise<DocumentCompareResult>;
  }` |
| `projects` | `{
    get(id: string): Promise<Project>;
    list(params?: { organizationId?: string }): Promise<Project[]>;
    create(data: Partial<Project>): Promise<Project>;
    update(id: string, data: Partial<Project>): Promise<Project>;
    delete(id: string): Promise<void>;
    publish(id: string): Promise<{
      id: string;
      name: string;
      slug: string;
      urlId: string;
      publishedSlug: string;
      publicUrl: string;
      publishedAt: string;
      isPublic: boolean;
    }>;
    unpublish(id: string): Promise<Project>;
  }` |
| `comments` | `{
    list(documentId: string, params?: any): Promise<CommentWithUser[]>;
    get(documentId: string, commentId: string): Promise<CommentWithUser>;
    create(documentId: string, dto: CreateCommentDto): Promise<CommentWithUser>;
    update(
      documentId: string,
      commentId: string,
      dto: UpdateCommentDto,
    ): Promise<CommentWithUser>;
    delete(documentId: string, commentId: string): Promise<void>;
    resolve(documentId: string, commentId: string): Promise<CommentWithUser>;
    unresolve(documentId: string, commentId: string): Promise<CommentWithUser>;
    reply(
      documentId: string,
      parentCommentId: string,
      dto: Omit<CreateCommentDto, 'parentCommentId'>,
    ): Promise<CommentWithUser>;
    getReplies(parentCommentId: string): Promise<CommentWithUser[]>;
  }` |
| `suggestions` | `{
    list(documentId: string, params?: any): Promise<SuggestionWithUser[]>;
    get(suggestionId: string): Promise<SuggestionWithUser>;
    create(documentId: string, dto: CreateSuggestionDto): Promise<SuggestionWithUser>;
    update(suggestionId: string, dto: UpdateSuggestionDto): Promise<SuggestionWithUser>;
    delete(suggestionId: string): Promise<void>;
    accept(suggestionId: string, reviewComment?: string): Promise<SuggestionWithUser>;
    reject(suggestionId: string, reviewComment?: string): Promise<SuggestionWithUser>;
  }` |
| `auth` | `{
    login(email: string, password: string): Promise<{ user: User; token: string }>;
    logout(): Promise<void>;
    getCurrentUser(): Promise<User | null>;
    register(data: {
      email: string;
      password: string;
      name: string;
    }): Promise<{ user: User; token: string }>;
  }` |
| `parser` | `{
    parse(code: string, language: string, filename?: string): Promise<ParseResult>;
    parseDocument(documentId: string): Promise<ParseResult>;
    getSupportedLanguages(): Promise<SupportedLanguagesResponse>;
  }` |
| `templates` | `{
    list(filters?: TemplateFiltersDto): Promise<DocumentTemplate[]>;
    get(id: string): Promise<DocumentTemplate>;
    create(dto: CreateTemplateDto): Promise<DocumentTemplate>;
    update(id: string, dto: Partial<CreateTemplateDto>): Promise<DocumentTemplate>;
    delete(id: string): Promise<void>;
    useTemplate(id: string, dto: CreateFromTemplateDto): Promise<Document>;
    saveAsTemplate(documentId: string, dto: SaveAsTemplateDto): Promise<DocumentTemplate>;
  }` |
| `branding` | `{
    get(projectId: string): Promise<any>;
    update(projectId: string, dto: any): Promise<any>;
  }` |
| `issues` | `{
    list(projectId: string, params?: Record<string, any>): Promise<any>;
    getStats(projectId: string): Promise<any>;
    get(projectId: string, issueId: string): Promise<any>;
    update(projectId: string, issueId: string, dto: any): Promise<any>;
    bulkUpdate(projectId: string, dto: any): Promise<any>;
    addComment(projectId: string, issueId: string, dto: any): Promise<any>;
    getDuplicates(projectId: string, issueId: string): Promise<any>;
    getBoardsForIssue(projectId: string, issueId: string): Promise<any>;
  }` |
| `boards` | `{
    list(projectId: string): Promise<any>;
    create(projectId: string, dto: any): Promise<any>;
    get(projectId: string, boardId: string, includeCards?: boolean): Promise<any>;
    update(projectId: string, boardId: string, dto: any): Promise<any>;
    deleteBoard(projectId: string, boardId: string): Promise<any>;
    restore(projectId: string, boardId: string): Promise<any>;
    addColumn(projectId: string, boardId: string, dto: any): Promise<any>;
    updateColumn(projectId: string, boardId: string, columnId: string, dto: any): Promise<any>;
    reorderColumns(projectId: string, boardId: string, columnIds: string[]): Promise<any>;
    deleteColumn(projectId: string, boardId: string, columnId: string, moveCardsTo?: string): Promise<any>;
    listCards(projectId: string, boardId: string, since?: string): Promise<any>;
    addCards(projectId: string, boardId: string, dto: { issueIds: string[]; columnId?: string }): Promise<any>;
    moveCard(projectId: string, boardId: string, cardId: string, dto: { columnId: string; position: number }): Promise<any>;
    removeCard(projectId: string, boardId: string, cardId: string): Promise<any>;
  }` |
| `analytics` | `{
    getOverview(projectId: string, days: number): Promise<any>;
    getDailyTraffic(projectId: string, days: number): Promise<any>;
    getTopDocuments(projectId: string, days: number): Promise<any>;
    getTopSearchQueries(projectId: string, days: number): Promise<any>;
    getVersionTraffic(projectId: string, days: number): Promise<any>;
    getDeviceBreakdown(projectId: string, days: number): Promise<any>;
    getSourceBreakdown(projectId: string, days: number): Promise<any>;
    getGeoBreakdown(projectId: string, days: number): Promise<any>;
    getZeroResultSearches(projectId: string, days: number): Promise<any>;
    getGhostDocs(projectId: string, days: number): Promise<any>;
    getTrendingDocs(projectId: string, days: number): Promise<any>;
    getScrollHistogram(projectId: string, days: number): Promise<any>;
    getFeedbackSummary(projectId: string, days: number): Promise<any>;
    submitFeedback(data: any): Promise<any>;
    exportNow(projectId: string, data: any): Promise<any>;
    listScheduledReports(projectId: string): Promise<any>;
    createScheduledReport(projectId: string, data: any): Promise<any>;
    updateScheduledReport(projectId: string, id: string, data: any): Promise<any>;
    deleteScheduledReport(projectId: string, id: string): Promise<any>;
    runScheduledReport(projectId: string, id: string): Promise<any>;
    listExportHistory(projectId: string): Promise<any>;
  }` |

<!-- source: api-endpoint-approve.md -->

# approve

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 690)

## Endpoint

`POST /doc-versions/:projectId/:versionId/approval/approve`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-assigneerow.md -->

# AssigneeRow

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 501)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `id` | `string` | ✓ | - |
| `name` | `string` | ✓ | - |
| `active` | `boolean` | ✓ | - |
| `onClick` | `Function` | ✓ | - |
| `muted` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_AssigneeRow_4ab4fea0["AssigneeRow"]
    class component_AssigneeRow_4ab4fea0 rootComponent
```

## Relationships

- RENDERS → `CheckIcon`

## Referenced By

- `FilterPopover` (RENDERS)

<!-- source: class-authendpoints.md -->

# AuthEndpoints

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/auth.ts` (line 35)

Auth endpoints

## Methods

| Method | Signature | Returns |
|---|---|---|
| `login` | `login(email: string, password: string)` | `Promise<AuthResponse>` |
| `register` | `register(dto: RegisterDto)` | `Promise<AuthResponse>` |
| `refresh` | `refresh()` | `Promise<AuthResponse>` |
| `logout` | `logout()` | `Promise<void>` |
| `verify` | `verify()` | `Promise<{ valid: boolean }>` |

<!-- source: interface-bashtooloptions.md -->

# BashToolOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/bash.tool.ts` (line 20)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `timeout` | `number` |
| `maxOutputSize` | `number` |
| `allowedCommands` | `string[]` |
| `blockedPatterns` | `RegExp[]` |
| `env` | `Record<string, string>` |
| `sandbox` | `boolean` |
| `session` | `BashSession` |
| `envTracker` | `EnvTracker` |

<!-- source: service-brandingservice.md -->

# BrandingService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/branding/branding.service.ts` (line 36)

Project branding — identity + colors + support email. One row per project.
Everything is nullable; the frontend falls back to project name + Atloria
palette when a field is blank.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `get` | `get(projectId: string, user: JwtPayload)` | `unknown` |
| `update` | `update(projectId: string, dto: UpdateBrandingDto, user: JwtPayload)` | `unknown` |
| `getPublic` | `getPublic(projectId: string)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: function-buildvisualtaskprompt.md -->

# buildVisualTaskPrompt

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/visual.prompts.ts` (line 44)

## Signature

```ts
function buildVisualTaskPrompt(sectionType: SectionType, contentSummary: string): string
```

## Parameters

| Name | Type |
|---|---|
| `sectionType` | `SectionType` |
| `contentSummary` | `string` |

**Returns:** `string`

<!-- source: class-chatescalatedto.md -->

# ChatEscalateDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/chat-escalate.dto.ts` (line 13)

Body for the PUBLIC chat → human escalation endpoint
(`POST /public/p/:slugWithId/chat/escalate`).

All fields are optional: the widget is anonymous and we never want to block a
"Talk to a human" click on missing data. Email is validated only when present.
`transcript` arrives as newline-joined "role: content" lines from the widget;
the controller parses it back into structured turns before handing off to
IssuesService.createFromChatEscalation.

## Properties

| Property | Type |
|---|---|
| `email` | `string` |
| `note` | `string` |
| `question` | `string` |
| `transcript` | `string` |
| `sessionId` | `string` |

<!-- source: function-classifybashcommand.md -->

# classifyBashCommand

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/session/permission-gate.ts` (line 152)

Classify a bash command into a reversibility tier.
Uses pattern matching — prefers specificity (T3 checked first).

## Signature

```ts
function classifyBashCommand(command: string): ReversibilityResult
```

## Parameters

| Name | Type |
|---|---|
| `command` | `string` |

**Returns:** `ReversibilityResult`

<!-- source: function-classifydoctype.md -->

# classifyDocType

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/doc-type-classifier.ts` (line 184)

Classify a DocumentPlan into a doc type using score-based heuristics.

## Signature

```ts
function classifyDocType(plan: DocumentPlan, categoryName: string): DocTypeClassification
```

## Parameters

| Name | Type |
|---|---|
| `plan` | `DocumentPlan` |
| `categoryName` | `string` |

**Returns:** `DocTypeClassification`

<!-- source: interface-componenttemplate.md -->

# ComponentTemplate

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 101)

## Properties

| Property | Type |
|---|---|
| `component` | `string` |
| `templatePath` | `string` |
| `conditionalRenders` | `ConditionalRender[]` |
| `actions` | `ComponentAction[]` |

<!-- source: interface-copilotaskresult.md -->

# CopilotAskResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/copilotUtils.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `answer` | `string` |
| `citations` | `string[]` |
| `sources` | `CopilotAskSource[]` |

<!-- source: function-createprojectforfiles.md -->

# createProjectForFiles

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/schema-resolver.ts` (line 285)

Build a ts-morph Project scoped to specific files + their import graph (the DTOs those files
reference), NOT the whole repo. This is the memory-bounded path for OpenAPI resolution: the
framework parse already loaded the repo once, so globbing the entire tree here would load a
SECOND full project (a memory doubler that OOMs large monorepos). Loading only the controller
files and resolving their dependencies keeps the second project to the API surface.

## Signature

```ts
function createProjectForFiles(rootDir: string, filePaths: string[]): Project
```

## Parameters

| Name | Type |
|---|---|
| `rootDir` | `string` |
| `filePaths` | `string[]` |

**Returns:** `Project`

<!-- source: function-createtestusers.md -->

# createTestUsers

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 44)

## Signature

```ts
function createTestUsers(count: number): TestUserData[]
```

## Parameters

| Name | Type |
|---|---|
| `count` | `number` |

**Returns:** `TestUserData[]`

<!-- source: constant-default-sections.md -->

# DEFAULT_SECTIONS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/analytics/export/analytics-export.service.ts` (line 15)

## Definition

```ts
ExportSection[]
```

<!-- source: controller-deskcontroller.md -->

# DeskController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/issues/desk.controller.ts` (line 28)

Support desk: Plain-style queue over the existing ticket store. Authed +
org-scoped (service-level organizationId check, like manuals-insights).

`DeskController` exposes authenticated, organization-scoped support desk endpoints backed by the existing ticket store. It provides a plain queue-style interface for retrieving and managing support tickets while delegating organization authorization checks to the service layer.

## Diagram

```mermaid
graph LR
  Client[Authenticated Client] --> Guard[Auth Guard]
  Guard --> Controller[DeskController]
  Controller --> Service[Desk Service]
  Service --> OrgCheck[organizationId Authorization Check]
  OrgCheck --> TicketStore[Existing Ticket Store]
  TicketStore --> Service
  Service --> Controller
  Controller --> Client
```

## Usage

```ts
import { Controller, Get, Param, Req } from '@nestjs/common';
import { DeskService } from './desk.service';

@Controller('desk')
export class DeskController {
  constructor(private readonly deskService: DeskService) {}

  @Get('tickets')
  async listTickets(@Req() request: AuthenticatedRequest) {
    return this.deskService.listTickets({
      organizationId: request.user.organizationId,
      userId: request.user.id,
    });
  }

  @Get('tickets/:ticketId')
  async getTicket(
    @Req() request: AuthenticatedRequest,
    @Param('ticketId') ticketId: string,
  ) {
    return this.deskService.getTicket({
      ticketId,
      organizationId: request.user.organizationId,
      userId: request.user.id,
    });
  }
}
```

## AI Coding Instructions

- Keep controller methods thin: parse request parameters and delegate ticket operations to the desk service.
- Require authenticated requests for every endpoint; derive user and organization context from the authenticated request rather than client-supplied IDs.
- Preserve service-level `organizationId` validation for every ticket read or mutation to prevent cross-organization access.
- Reuse the existing ticket store and ticket domain models instead of introducing a separate support-desk persistence layer.
- Follow the authorization pattern used by `manuals-insights` when adding routes, guards, or organization-scoped service calls.

## Relationships

- MODULE_DECLARES → `listThreads`
- MODULE_DECLARES → `counts`
- MODULE_DECLARES → `getThread`
- MODULE_DECLARES → `transition`
- MODULE_DECLARES → `reply`
- MODULE_DECLARES → `duplicate`
- DEPENDS_ON → `deskservice`

<!-- source: function-destroywebsocketclient.md -->

# destroyWebSocketClient

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/websocket-client.ts` (line 307)

Destroy WebSocket client instance

## Signature

```ts
function destroyWebSocketClient(): void
```

**Returns:** `void`

<!-- source: type-detectionconfidence.md -->

# DetectionConfidence

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/framework-detector.ts` (line 26)

Detection confidence level

## Definition

```ts
'high' | 'medium' | 'low'
```

<!-- source: class-diskbackend.md -->

# DiskBackend

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/context/checkpoint-backend.ts` (line 188)

**Implements:** `CheckpointBackend`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `save` | `save(snap: Snapshot)` | `void` |
| `load` | `load(relPath: string)` | `Snapshot[]` |
| `loadLatest` | `loadLatest(relPath: string)` | `Snapshot | null` |
| `deleteFile` | `deleteFile(relPath: string)` | `void` |
| `deleteFrom` | `deleteFrom(relPath: string, fromIndex: number)` | `void` |
| `getTrackedFiles` | `getTrackedFiles()` | `string[]` |
| `getTotalCount` | `getTotalCount()` | `number` |
| `getSnapshotCount` | `getSnapshotCount(relPath: string)` | `number` |
| `clear` | `clear()` | `void` |
| `evictOldest` | `evictOldest()` | `boolean` |
| `flush` | `flush()` | `void` |

## Properties

| Property | Type |
|---|---|
| `sessionId` | `string` |
| `sessionDir` | `string` |

<!-- source: module-documentmodule.md -->

# DocumentModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/document/document.module.ts` (line 20)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `docsrepomodule`
- MODULE_IMPORTS → `forwardref`
- MODULE_DECLARES → `documentcontroller`
- MODULE_DECLARES → `publicdocumentcontroller`
- MODULE_DECLARES → `categorycontroller`
- MODULE_DECLARES → `categorydocumentscontroller`
- MODULE_PROVIDES → `documentservice`
- MODULE_PROVIDES → `categoryservice`
- MODULE_PROVIDES → `urlservice`
- MODULE_PROVIDES → `tocbuilderservice`
- MODULE_PROVIDES → `documentrevisionservice`
- MODULE_PROVIDES → `documentversionservice`
- MODULE_EXPORTS → `documentservice`
- MODULE_EXPORTS → `categoryservice`
- MODULE_EXPORTS → `urlservice`
- MODULE_EXPORTS → `tocbuilderservice`
- MODULE_EXPORTS → `documentversionservice`

<!-- source: function-generateusercolor-2.md -->

# generateUserColor

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/collaboration/utils/color.ts` (line 29)

Generates a consistent color for a user based on their ID
Uses a hash function to ensure the same user always gets the same color

## Signature

```ts
function generateUserColor(userId: string): string
```

## Parameters

| Name | Type |
|---|---|
| `userId` | `string` |

**Returns:** `string`

<!-- source: component-heroclassicsplit.md -->

# HeroClassicSplit

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/hero/hero-classic-split.tsx` (line 24)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `subheadlineKey` | `string` | ✓ | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `badgeKey` | `string` | - | - |
| `badgeIcon` | `LucideIcon` | - | - |
| `imageSrc` | `string` | ✓ | - |
| `imageAlt` | `string` | ✓ | - |
| `trustItems` | `unknown[]` | - | - |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_HeroClassicSplit_346e4f89["HeroClassicSplit"]
    class component_HeroClassicSplit_346e4f89 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-span`
- RENDERS → `BadgeIcon`
- RENDERS → `motion-h1`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- RENDERS → `motion-ul`
- RENDERS → `Check`
- USES_HOOK → `useTranslation`

<!-- source: interface-impactanalysis.md -->

# ImpactAnalysis

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/relationship.interface.ts` (line 439)

Impact analysis result

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `directDependencies` | `string[]` |
| `directDependents` | `string[]` |
| `allDependencies` | `string[]` |
| `allDependents` | `string[]` |
| `impactScore` | `number` |
| `recommendations` | `string[]` |

<!-- source: constant-metadata-8.md -->

# metadata

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/manuals-benchmark/page.tsx` (line 8)

Public manuals-quality benchmark — the second category-of-one claim (after /groundedness):
no user-manual / help-center vendor publishes a documentation-quality score. Numbers from
the atlorix style-benchmark harness (rubrics per style + structural scorer + 3-judge LLM
median), run against Atloria's own generated doc-sets. Scores are easy to update here as
saas/corporate clear the gate.

<!-- source: interface-navconfig.md -->

# NavConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 55)

## Properties

| Property | Type |
|---|---|
| `links` | `Array<{ labelKey: string; href: string }>` |
| `ctaKey` | `string` |
| `ctaHref` | `string` |

<!-- source: class-openapischemaresolver.md -->

# OpenApiSchemaResolver

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/schema-resolver.ts` (line 35)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `fromTsConfig` | `fromTsConfig(tsConfigFilePath: string)` | `OpenApiSchemaResolver` |
| `getComponents` | `getComponents()` | `Record<string, Record<string, unknown>>` |
| `resolveMethod` | `resolveMethod(method: MethodDeclaration, opts: { httpMethod?: string })` | `ResolvedOperation` |

<!-- source: interface-pmehandofffilterconfig.md -->

# PmeHandoffFilterConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/context/pme-handoff-filter.ts` (line 15)

PME Handoff Input Filter

Filters context passed to sub-agents during handoffs.
Sub-agents (copywriter, layout, visual, qa) don't need the full
coordinator conversation history — they only need:
- The original user request (inputHistory)
- Recent context (last N items from pre-handoff)
- The handoff trigger (newItems)

This reduces sub-agent context by 60-80%, improving response quality
and reducing token costs.

## Properties

| Property | Type |
|---|---|
| `maxPreHandoffItems` | `number` |

<!-- source: type-reversibilitytier.md -->

# ReversibilityTier

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/session/permission-gate.ts` (line 17)

Permission Gate — Bash Command Reversibility Classification

Classifies bash commands into reversibility tiers before execution.
Inspired by Claude Code's blast-radius awareness.

Tiers:
 T0 — Read-only: cat, ls, grep, git log — zero side effects
 T1 — Reversible: mkdir, npm install, git add — easy to undo
 T2 — Hard-to-reverse: git push, npm publish — requires effort to undo
 T3 — Irreversible: rm -rf, DROP TABLE, DELETE without WHERE — blocked

Consumers:
 - bash.tool.ts: annotates outputs with tier, hard-blocks T3

## Definition

```ts
'T0' | 'T1' | 'T2' | 'T3'
```

<!-- source: component-roweditor.md -->

# RowEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/table/TableEditor.tsx` (line 598)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `parentEditor` | `any` | ✓ | - |
| `highlightedCoordinates` | `any` | ✓ | - |
| `lexicalTable` | `any` | ✓ | - |
| `rowIndex` | `any` | ✓ | - |
| `setActiveCellWithBoundaries` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_RowEditor_6a961e3["RowEditor"]
    class component_RowEditor_6a961e3 rootComponent
```

## Relationships

- RENDERS → `RadixPopover-Root`
- RENDERS → `RadixPopover-PopoverTrigger`
- RENDERS → `RadixPopover-Portal`
- RENDERS → `RadixPopover-PopoverContent`
- RENDERS → `RadixToolbar-Root`
- RENDERS → `RadixToolbar-Button`
- RENDERS → `RadixPopover-Arrow`
- USES_HOOK → `useCellValues`
- USES_HOOK → `useCallback`
- USES_HOOK → `useTranslation`

## Referenced By

- `TableEditor` (RENDERS)

<!-- source: function-savedocumentation.md -->

# saveDocumentation

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/utils/screenshot-storage.helper.ts` (line 130)

Save documentation with storage helper

## Signature

```ts
async function saveDocumentation(documentation: {
    title: string;
    slug: string;
    content: string;
    categoryPath: string[];
    type: 'user-docs' | 'tutorial' | 'feature';
    metadata?: Record<string, unknown>;
  }, storage: StorageHelperService, aiModel: string): Promise<{ id: string; url: string }>
```

## Parameters

| Name | Type |
|---|---|
| `documentation` | `{
    title: string;
    slug: string;
    content: string;
    categoryPath: string[];
    type: 'user-docs' | 'tutorial' | 'feature';
    metadata?: Record<string, unknown>;
  }` |
| `storage` | `StorageHelperService` |
| `aiModel` | `string` |

**Returns:** `Promise<{ id: string; url: string }>`

<!-- source: class-screenshotfailuredto.md -->

# ScreenshotFailureDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 721)

Screenshot failure record

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `error` | `string` |
| `retryCount` | `number` |
| `stage` | `string` |
| `failedAt` | `Date` |

<!-- source: service-sessionservice.md -->

# SessionService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-08-sessions/planner.service.ts` (line 1)

<!-- source: interface-taskresult.md -->

# TaskResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/services/batch-screenshot.service.ts` (line 42)

Result of a single screenshot task

## Properties

| Property | Type |
|---|---|
| `success` | `boolean` |
| `url` | `string` |
| `screenshotId` | `string` |
| `specId` | `string` |
| `blobUrl` | `string` |
| `error` | `string` |
| `retryCount` | `number` |
| `isNew` | `boolean` |
| `version` | `number` |
| `featureArea` | `string` |
| `pageType` | `string` |
| `semanticTags` | `string[]` |
| `recoveryAttempts` | `number` |
| `recoverySucceeded` | `boolean` |
| `successfulSelector` | `string` |

<!-- source: type-thememode.md -->

# ThemeMode

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 35)

## Definition

```ts
'dark' | 'light' | 'colorful'
```

<!-- source: type-uistringkey.md -->

# UiStringKey

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/uiStrings.ts` (line 276)

## Definition

```ts
keyof typeof EN
```

<!-- source: api-endpoint-update.md -->

# update

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/src/users/users.controller.ts` (line 57)

## Endpoint

`PUT /users/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `UsersController` (MODULE_DECLARES)

<!-- source: type-updatescheduledreportdto.md -->

# UpdateScheduledReportDto

**Kind:** Type

**Source:** `atloria-monorepo/apps/api/src/analytics/export/scheduled-reports.service.ts` (line 22)

## Definition

```ts
Partial<CreateScheduledReportDto> & {
  enabled?: boolean;
}
```

<!-- source: function-validateparseresult.md -->

# validateParseResult

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 207)

Validate parse result structure

## Signature

```ts
function validateParseResult(result: ParseResult): boolean
```

## Parameters

| Name | Type |
|---|---|
| `result` | `ParseResult` |

**Returns:** `boolean`

<!-- source: interface-analysisresult.md -->

# AnalysisResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/ai/interfaces/ai-provider.interface.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `text` | `string` |
| `suggestions` | `string[]` |
| `metadata` | `Record<string, any>` |
| `usage` | `TokenUsage` |

<!-- source: constant-angular-detection-config.md -->

# ANGULAR_DETECTION_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/angular.patterns.ts` (line 242)

## Definition

```ts
AngularDetectionConfig
```

<!-- source: interface-apiendpoint.md -->

# APIEndpoint

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/APIExplorer.ts` (line 39)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `path` | `string` |
| `method` | `string` |
| `summary` | `string` |
| `description` | `string` |
| `tags` | `string[]` |
| `parameters` | `any[]` |
| `requestBody` | `any` |
| `responses` | `Record<string, any>` |
| `requiresAuth` | `boolean` |
| `security` | `Array<Record<string, string[]>>` |
| `samples` | `Array<{ lang: string; source: string }>` |

<!-- source: api-endpoint-archive.md -->

# archive

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 209)

## Endpoint

`POST /doc-versions/:projectId/:versionId/archive`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-atloriaproviderwrapper.md -->

# AtloriaProviderWrapper

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Providers.tsx` (line 20)

Inner provider that uses the session. The token is exposed through a REF, not a closure over the session snapshot: on a hard navigation NextAuth resolves the session asynchronously, and a fetch started before that resolution must see the token the moment it arrives. The old closure captured `null` forever, so every full page load of data-fetching pages 401'd after the retry budget (the "No technical snapshot yet" bug on generated projects).

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_AtloriaProviderWrapper_5a8540c4["AtloriaProviderWrapper"]
    class component_AtloriaProviderWrapper_5a8540c4 rootComponent
```

## Relationships

- RENDERS → `AtloriaProvider`
- USES_HOOK → `useSession`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`
- USES_HOOK → `useMemo`

## Referenced By

- `Providers` (RENDERS)

<!-- source: class-authenticationerror.md -->

# AuthenticationError

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/types/errors.ts` (line 44)

Authentication error (401 Unauthorized)

**Extends:** `APIError`

<!-- source: interface-benchmarkadapter.md -->

# BenchmarkAdapter

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/types.ts` (line 289)

Interface that benchmark adapters must implement.

<!-- source: service-bundleservice.md -->

# BundleService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/docs-repo/bundle.service.ts` (line 44)

BundleService — S2.5 disaster-recovery bundles for the docs git substrate.

Since S2 the per-project repos hold NON-rebuildable state (CR branches, human-authored
history) — main alone is a projection of Postgres, but the branches are not. PVC loss must
therefore be survivable: once a day (worker only) every repo under DOCS_REPO_ROOT is packed
with `git bundle create <tmp> --all` and shipped to the private Azure Blob container
'docs-repo-bundles' at <projectId>/<yyyy-mm-dd>.bundle, keeping the newest 7 per project.

Restore path (tested in bundle.service.spec.ts, operated via
tasks/docs-repo-bundle-restore-runbook.md): a bundle is a fetchable single-file remote —
clone/fetch it back onto a fresh PVC and every ref + the full history is intact.

Bundles are best-effort by design: if Azure storage is not configured the sweep warns ONCE
and skips; one project's failure never stops the loop; nothing here can crash the worker
or fail boot (the blob client is built lazily, never in the constructor).

`BundleService` creates daily disaster-recovery Git bundles for every project repository under `DOCS_REPO_ROOT`. Running in the worker process, it packages all refs and history with `git bundle create --all`, uploads bundles to the private Azure `docs-repo-bundles` container, and retains the newest seven backups per project.  

Bundles are best-effort: missing Azure configuration causes a one-time warning and skipped sweep, while failures for individual projects are isolated so they cannot crash the worker or block other backups.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `sweep` | `sweep()` | `Promise<void>` |
| `runOnce` | `runOnce()` | `Promise<BundleSweepResult>` |
| `buildContainerClient` | `buildContainerClient()` | `ContainerClient | null` |

## Diagram

```mermaid
sequenceDiagram
  participant Worker
  participant BundleService
  participant GitRepo as Project Git Repository
  participant Azure as Azure Blob Storage

  Worker->>BundleService: runDailyBundleSweep()
  BundleService->>BundleService: Lazily create blob client

  alt Azure storage is not configured
    BundleService-->>Worker: Warn once and skip sweep
  else Storage configured
    loop Each repository under DOCS_REPO_ROOT
      BundleService->>GitRepo: git bundle create <temp>.bundle --all
      GitRepo-->>BundleService: Bundle containing all refs and history
      BundleService->>Azure: Upload <projectId>/<yyyy-mm-dd>.bundle
      BundleService->>Azure: Delete bundles beyond newest 7

      alt Project backup fails
        BundleService-->>BundleService: Log failure and continue
      end
    end
  end
```

## AI Coding Instructions

- Keep bundle creation worker-only; do not invoke backup sweeps from API request paths or application boot.
- Preserve best-effort behavior: Azure configuration failures and individual repository failures must be logged and must not abort the overall sweep.
- Keep Azure Blob client initialization lazy rather than creating it in the constructor, so missing storage configuration cannot fail worker startup.
- Create bundles with `git bundle create <temporary-file> --all`; all refs are required because branch history is non-rebuildable from Postgres.
- Maintain the retention policy of the newest seven bundles per project, using the `<projectId>/<yyyy-mm-dd>.bundle` blob naming convention.

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: class-chatfeedbackdto.md -->

# ChatFeedbackDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/chat-feedback.dto.ts` (line 12)

Body for the PUBLIC chat feedback endpoint
(`POST /public/p/:slugWithId/chat/feedback`).

Anonymous 👍/👎 signal emitted from the support widget under a completed
assistant answer. Persisted as a `chat_feedback` InteractionEvent on the
shared analytics spine — no ChatInteraction row is created (the public
stream doesn't mint one; the event IS the record).

## Properties

| Property | Type |
|---|---|
| `rating` | `'up' | 'down'` |
| `sessionId` | `string` |
| `question` | `string` |
| `comment` | `string` |

<!-- source: function-classifypersona.md -->

# classifyPersona

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-14-meta/generators/category-restructure.ts` (line 29)

Classify a persona as admin or user based on name/description keywords.
Generic "manager" is NOT admin.

## Signature

```ts
function classifyPersona(persona: { name: string; description: string }): PersonaClassification
```

## Parameters

| Name | Type |
|---|---|
| `persona` | `{ name: string; description: string }` |

**Returns:** `PersonaClassification`

<!-- source: function-classifytask.md -->

# classifyTask

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/tool-profiles.ts` (line 94)

Infer a TaskMode from the user's opening message using keyword heuristics.
Returns 'full' when no clear signal is found.

## Signature

```ts
function classifyTask(message: string): TaskMode
```

## Parameters

| Name | Type |
|---|---|
| `message` | `string` |

**Returns:** `TaskMode`

<!-- source: interface-componentusage.md -->

# ComponentUsage

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/template-analysis.interface.ts` (line 163)

Component usage in template

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `tag` | `string` |
| `line` | `number` |
| `inputs` | `Record<string, string>` |
| `outputs` | `Record<string, string>` |
| `conditionalOn` | `string` |

<!-- source: interface-copilotasksource.md -->

# CopilotAskSource

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/copilotUtils.ts` (line 16)

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `path` | `string` |
| `snippet` | `string` |
| `score` | `number` |
| `docType` | `string` |

<!-- source: function-createallvariantagents.md -->

# createAllVariantAgents

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/agents/variant.agent.ts` (line 51)

Create all three variant agents.

## Signature

```ts
function createAllVariantAgents(config: GenerationConfig, deps: VariantDependencies): AgentConfig<PmeContext>[]
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |
| `deps` | `VariantDependencies` |

**Returns:** `AgentConfig<PmeContext>[]`

<!-- source: function-defaultparsers.md -->

# defaultParsers

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/orchestrator/create-default-orchestrator.ts` (line 38)

The standard parser set — every framework parser-core ships auto-detection for.

## Signature

```ts
function defaultParsers(): IParser[]
```

**Returns:** `IParser[]`

<!-- source: constant-desk-buckets.md -->

# DESK_BUCKETS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/issues/dto/desk.dto.ts` (line 14)

Plain-style queue buckets, DERIVED from status + assignee + first_agent_reply_at

<!-- source: type-detectionconfigname.md -->

# DetectionConfigName

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/index.ts` (line 67)

## Definition

```ts
keyof typeof DETECTION_CONFIGS_BY_NAME
```

<!-- source: function-detectprovider.md -->

# detectProvider

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/useNewProjectWizard.ts` (line 123)

## Signature

```ts
function detectProvider(url: string): { provider: 'github' | 'gitlab' | 'bitbucket'; owner: string; repo: string } | null
```

## Parameters

| Name | Type |
|---|---|
| `url` | `string` |

**Returns:** `{ provider: 'github' | 'gitlab' | 'bitbucket'; owner: string; repo: string } | null`

<!-- source: controller-docautomationcontroller.md -->

# DocAutomationController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 38)

## Relationships

- MODULE_DECLARES → `createConfig`
- MODULE_DECLARES → `getConfig`
- MODULE_DECLARES → `getScreenBaseline`
- MODULE_DECLARES → `updateConfig`
- MODULE_DECLARES → `deleteConfig`
- MODULE_DECLARES → `startJob`
- MODULE_DECLARES → `listJobs`
- MODULE_DECLARES → `getJob`
- MODULE_DECLARES → `cancelJob`
- MODULE_DECLARES → `reportExternalProgress`
- MODULE_DECLARES → `reportExternalFailure`
- MODULE_DECLARES → `runUploadOnExistingJob`
- MODULE_DECLARES → `deleteJobDocuments`
- MODULE_DECLARES → `triggerScreenshots`
- MODULE_DECLARES → `getTriggerConfig`
- MODULE_DECLARES → `updateTriggerConfig`
- MODULE_DECLARES → `generateWebhookSecret`
- MODULE_DECLARES → `getDeliveries`
- MODULE_DECLARES → `getWebhookUrl`
- DEPENDS_ON → `docautomationservice`

<!-- source: module-docversionmodule.md -->

# DocVersionModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.module.ts` (line 15)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `auditmodule`
- MODULE_DECLARES → `docversioncontroller`
- MODULE_PROVIDES → `docversionservice`
- MODULE_PROVIDES → `versioncarryforwardservice`
- MODULE_PROVIDES → `screenshotstalenessservice`
- MODULE_PROVIDES → `versiondiffservice`
- MODULE_PROVIDES → `changelogservice`
- MODULE_PROVIDES → `docversionexportservice`
- MODULE_PROVIDES → `docversionretentionservice`
- MODULE_PROVIDES → `versionaccessguard`
- MODULE_EXPORTS → `docversionservice`
- MODULE_EXPORTS → `versioncarryforwardservice`
- MODULE_EXPORTS → `screenshotstalenessservice`
- MODULE_EXPORTS → `versiondiffservice`
- MODULE_EXPORTS → `changelogservice`
- MODULE_EXPORTS → `docversionexportservice`
- MODULE_EXPORTS → `docversionretentionservice`
- MODULE_EXPORTS → `versionaccessguard`

<!-- source: class-embedder.md -->

# Embedder

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/embedder.ts` (line 61)

Azure OpenAI embedding adapter.

Sends texts to the Azure OpenAI embeddings endpoint and returns
vector representations. Handles batching, rate limiting, and
error propagation.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `embedBatch` | `embedBatch(texts: string[])` | `Promise<number[][]>` |
| `embedQuery` | `embedQuery(text: string)` | `Promise<number[]>` |
| `isConfigured` | `isConfigured()` | `boolean` |

<!-- source: function-generateemail.md -->

# generateEmail

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 16)

Generate a unique email

## Signature

```ts
function generateEmail(prefix): string
```

## Parameters

| Name | Type |
|---|---|
| `prefix` | `any` |

**Returns:** `string`

<!-- source: function-getallenableddocs.md -->

# getAllEnabledDocs

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/web-search/data/competitor-docs-index.ts` (line 372)

Get all enabled documentation sites

## Signature

```ts
function getAllEnabledDocs(): CompetitorDoc[]
```

**Returns:** `CompetitorDoc[]`

<!-- source: component-herodarkcentered.md -->

# HeroDarkCentered

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/hero/hero-dark-centered.tsx` (line 34)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `subheadlineKey` | `string` | ✓ | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `badgeKey` | `string` | - | - |
| `floatingStats` | `unknown[]` | - | - |
| `imageSrc` | `string` | - | - |
| `imageAlt` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_HeroDarkCentered_46ad98c9["HeroDarkCentered"]
    class component_HeroDarkCentered_46ad98c9 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h1`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- USES_HOOK → `useTranslation`

<!-- source: interface-indexdefinition.md -->

# IndexDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 680)

Index definition

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `fields` | `string[]` |
| `unique` | `boolean` |
| `type` | `'btree' | 'hash' | 'gin' | 'gist' | 'fulltext'` |

<!-- source: constant-metadata-9.md -->

# metadata

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/pricing/page.tsx` (line 7)

Transparent pricing (Phase 1.4). Deliberate contrast with sales-led competitors
(kapa.ai publishes no pricing; median negotiated deals ~$19k/yr): visible credit
economics, self-serve. Prices map to the live billing constants (1 credit unit set):
technical generation 200cr, RAG index 100cr, enrichment 100cr, chat ask 5cr, assist 10cr.

<!-- source: class-parserorchestrator.md -->

# ParserOrchestrator

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/orchestrator/parser-orchestrator.ts` (line 74)

ParserOrchestrator - Coordinates multiple parsers for project-wide parsing

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(parserConfig: ParserConfig)` | `Promise<void>` |
| `registerParser` | `registerParser(parser: IParser, priority: undefined)` | `void` |
| `unregisterParser` | `unregisterParser(name: string)` | `boolean` |
| `getParser` | `getParser(name: string)` | `IParser | undefined` |
| `getRegisteredParsers` | `getRegisteredParsers()` | `string[]` |
| `findParserForFile` | `findParserForFile(filePath: string)` | `string | null` |
| `findAllParsersForFile` | `findAllParsersForFile(filePath: string)` | `string[]` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFileWithParser` | `parseFileWithParser(parserName: string, filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: string[], onProgress: ProgressCallback)` | `Promise<ParseResult[]>` |
| `parseProject` | `parseProject(config: ParseProjectConfig, onProgress: ProgressCallback)` | `Promise<ProjectParseResult>` |
| `clearCache` | `clearCache()` | `void` |
| `getCacheStats` | `getCacheStats()` | `{ entries: number; size: number }` |
| `destroy` | `destroy()` | `Promise<void>` |

<!-- source: interface-pmemetrics.md -->

# PmeMetrics

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/tracing/pme-metrics.ts` (line 11)

PME Metrics

PME-specific metrics for observability:
- QA scores per section
- Variant generation counts
- Section type distribution
- Generation timing

## Properties

| Property | Type |
|---|---|
| `totalJobs` | `number` |
| `jobsByStatus` | `Record<string, number>` |
| `avgQaScore` | `number` |
| `qaScoresBySection` | `Record<string, number>` |
| `variantSelections` | `Record<string, number>` |
| `avgGenerationTimeMs` | `number` |
| `sectionTypeFrequency` | `Record<string, number>` |
| `tokenUsage` | `{
    totalInput: number;
    totalOutput: number;
  }` |

<!-- source: interface-pricingcomparisontableprops.md -->

# PricingComparisonTableProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/pricing/pricing-comparison-table.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `plans` | `{ nameKey: string; priceKey: string; highlighted?: boolean }[]` |
| `features` | `{ featureKey: string; values: (boolean | string)[] }[]` |

<!-- source: function-savemultipledocuments.md -->

# saveMultipleDocuments

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/utils/screenshot-storage.helper.ts` (line 162)

Save multiple documentation files

## Signature

```ts
async function saveMultipleDocuments(documents: Array<{
    title: string;
    slug: string;
    content: string;
    categoryPath: string[];
    type: 'user-docs' | 'tutorial' | 'feature';
    metadata?: Record<string, unknown>;
  }>, storage: StorageHelperService, aiModel: string): Promise<Array<{ id: string; url: string; title: string }>>
```

## Parameters

| Name | Type |
|---|---|
| `documents` | `Array<{
    title: string;
    slug: string;
    content: string;
    categoryPath: string[];
    type: 'user-docs' | 'tutorial' | 'feature';
    metadata?: Record<string, unknown>;
  }>` |
| `storage` | `StorageHelperService` |
| `aiModel` | `string` |

**Returns:** `Promise<Array<{ id: string; url: string; title: string }>>`

<!-- source: class-screenshotitembuilder.md -->

# ScreenshotItemBuilder

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/test/helpers/batch-builder.ts` (line 133)

Builder for constructing screenshot items

## Methods

| Method | Signature | Returns |
|---|---|---|
| `create` | `create()` | `ScreenshotItemBuilder` |
| `withId` | `withId(id: string)` | `this` |
| `withUrl` | `withUrl(url: string)` | `this` |
| `withDescription` | `withDescription(description: string)` | `this` |
| `withExpectedState` | `withExpectedState(expectedState: string)` | `this` |
| `withWaitForSelector` | `withWaitForSelector(selector: string)` | `this` |
| `withWaitFor` | `withWaitFor(waitFor: WaitForDto)` | `this` |
| `withWaitForTimeout` | `withWaitForTimeout(timeout: number)` | `this` |
| `withActions` | `withActions(actions: Partial<ScreenshotActionDto>[])` | `this` |
| `withClickAction` | `withClickAction(selector: string, options: { waitAfter?: number })` | `this` |
| `withTypeAction` | `withTypeAction(selector: string, value: string, options: { waitAfter?: number })` | `this` |
| `withViewport` | `withViewport(width: number, height: number)` | `this` |
| `withFullPage` | `withFullPage(fullPage: boolean)` | `this` |
| `withStateType` | `withStateType(stateType: 'default' | 'hover' | 'modal' | 'error' | 'success' | 'loading')` | `this` |
| `withPriority` | `withPriority(priority: number)` | `this` |
| `withFlowStepId` | `withFlowStepId(flowStepId: string)` | `this` |
| `build` | `build()` | `Partial<BatchScreenshotItemDto>` |

<!-- source: component-selectcontent.md -->

# SelectContent

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/select.tsx` (line 45)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |
| `className` | `any` | - | unknown |

## Diagram

```mermaid
graph TD
    component_SelectContent_1920d7c2["SelectContent"]
    class component_SelectContent_1920d7c2 rootComponent
```

## Relationships

- RENDERS → `RadixSelect-Portal`
- RENDERS → `RadixSelect-Content`
- RENDERS → `RadixSelect-Viewport`
- USES_HOOK → `useCellValue`

## Referenced By

- `Select` (RENDERS)

<!-- source: type-sessioneventname.md -->

# SessionEventName

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/session/types.ts` (line 88)

All possible session event names

## Definition

```ts
keyof SessionEventMap
```

<!-- source: service-structureservice.md -->

# StructureService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-06-structure/structure.service.ts` (line 1)

<!-- source: api-endpoint-updateuser.md -->

# updateUser

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/fixtures/sample-projects/fullstack-nextjs-nestjs/backend/api/openapi.yaml` (line 1)

Update user

## Endpoint

`PUT /users/{id}`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Relationships

- REFERENCES → `UpdateUser`
- REFERENCES → `User`

## Referenced By

- `User Management API` (IMPLEMENTS_API)

<!-- source: interface-uploadoptions.md -->

# UploadOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/storage/storage.service.ts` (line 5)

## Properties

| Property | Type |
|---|---|
| `filename` | `string` |
| `buffer` | `Buffer` |
| `contentType` | `string` |

<!-- source: type-usercolor.md -->

# UserColor

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/lib/user-colors.ts` (line 148)

## Definition

```ts
(typeof USER_COLORS)[number]
```

<!-- source: function-validaterelationship.md -->

# validateRelationship

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 237)

Validate relationship structure

## Signature

```ts
function validateRelationship(relationship: Relationship): boolean
```

## Parameters

| Name | Type |
|---|---|
| `relationship` | `Relationship` |

**Returns:** `boolean`

<!-- source: type-variantkey.md -->

# VariantKey

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/variant.prompts.ts` (line 9)

## Definition

```ts
'A' | 'B' | 'C'
```

<!-- source: interface-analysistype.md -->

# AnalysisType

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/ai/interfaces/ai-provider.interface.ts` (line 20)

## Properties

| Property | Type |
|---|---|
| `type` | `'enhance' | 'summarize' | 'outline' | 'improve' | 'code-analysis' | 'screenshot-caption'` |
| `context` | `Record<string, any>` |

<!-- source: constant-angular-dotnet-api-patterns.md -->

# ANGULAR_DOTNET_API_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/cross-language.types.ts` (line 263)

Angular + .NET specific API patterns

## Definition

```ts
ApiCallPattern[]
```

<!-- source: interface-apiendpoint-2.md -->

# APIEndpoint

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/EndpointDetail.ts` (line 8)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `path` | `string` |
| `method` | `string` |
| `summary` | `string` |
| `description` | `string` |
| `tags` | `string[]` |
| `parameters` | `Parameter[]` |
| `requestBody` | `RequestBody` |
| `responses` | `Record<string, Response>` |
| `samples` | `Array<{ lang: string; source: string }>` |

<!-- source: api-endpoint-ask.md -->

# ask

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-mcp.controller.ts` (line 284)

## Endpoint

`POST /technical-docs/:projectId/ask`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsMcpController` (MODULE_DECLARES)

<!-- source: class-authorizationerror.md -->

# AuthorizationError

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/types/errors.ts` (line 55)

Authorization error (403 Forbidden)

**Extends:** `APIError`

<!-- source: component-avatar-3.md -->

# Avatar

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Suggestions/SuggestionCard.tsx` (line 112)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `user` | `unknown` | ✓ | - |
| `size` | `unknown | unknown | unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Avatar_789de8b1["Avatar"]
    class component_Avatar_789de8b1 rootComponent
```

## Referenced By

- `SuggestionCard` (RENDERS)

<!-- source: interface-benchmarkmonitoroptions.md -->

# BenchmarkMonitorOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/benchmark-monitor.ts` (line 100)

## Properties

| Property | Type |
|---|---|
| `outputDir` | `string` |
| `live` | `boolean` |
| `refreshMs` | `number` |

<!-- source: service-businesscontextparserservice.md -->

# BusinessContextParserService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/ai/services/business-context-parser.service.ts` (line 41)

Business Context Parser Service

Extracts text from PDF, Markdown, and Word files, then uses AI to summarize
and structure the content into actionable business context for documentation.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `parseContextFiles` | `parseContextFiles(filePaths: string[])` | `Promise<BusinessContext>` |
| `parseRawText` | `parseRawText(rawText: string)` | `Promise<BusinessContext>` |
| `formatContextForPrompt` | `formatContextForPrompt(context: BusinessContext)` | `string` |

## Relationships

- DEPENDS_ON → `azureclaudeprovider`

<!-- source: class-chatresolutiondto.md -->

# ChatResolutionDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/chat-resolution.dto.ts` (line 11)

Body for the PUBLIC chat resolution endpoint
(`POST /public/p/:slugWithId/chat/resolution`).

Answers the "Did this solve it?" prompt shown once per session after an
assistant answer completes. Persisted as a `chat_resolution` InteractionEvent
on the shared analytics spine (manuals-insights + ops cockpit read it).

## Properties

| Property | Type |
|---|---|
| `outcome` | `'yes' | 'no' | 'partly'` |
| `sessionId` | `string` |

<!-- source: function-classifytier.md -->

# classifyTier

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/services/entity-mapper.service.ts` (line 325)

Classify an entity into a tier based on its mapped type and file path.

## Signature

```ts
function classifyTier(type: DocAutoEntityType, relativePath: string): EntityTier
```

## Parameters

| Name | Type |
|---|---|
| `type` | `DocAutoEntityType` |
| `relativePath` | `string` |

**Returns:** `EntityTier`

<!-- source: function-compareconfidence.md -->

# compareConfidence

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/memory/types.ts` (line 140)

Compare confidence levels. Returns positive if a > b.

## Signature

```ts
function compareConfidence(a: string, b: string): number
```

## Parameters

| Name | Type |
|---|---|
| `a` | `string` |
| `b` | `string` |

**Returns:** `number`

<!-- source: interface-conditionalblock.md -->

# ConditionalBlock

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/template-analysis.interface.ts` (line 100)

Conditional block (ngIf, v-if, v-show)

## Properties

| Property | Type |
|---|---|
| `type` | `'if' | 'else-if' | 'else' | 'show' | 'switch'` |
| `condition` | `string` |
| `line` | `number` |
| `elements` | `TemplateElement[]` |

<!-- source: interface-crdiff.md -->

# CrDiff

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/cr-shared.ts` (line 38)

## Properties

| Property | Type |
|---|---|
| `files` | `CrDiffFile[]` |
| `totalAdditions` | `number` |
| `totalDeletions` | `number` |
| `computedAt` | `string` |

<!-- source: function-createassemblehtmltool.md -->

# createAssembleHtmlTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/assemble-html.tool.ts` (line 24)

Create the assemble_html tool.
Accepts a storeFn so it can auto-store the generated HTML and return only a summary
(avoids sending 30K+ chars back through the agent loop which causes API timeouts).

## Signature

```ts
function createAssembleHtmlTool(storeFn: StoreAssetFn, config: GenerationConfig): ToolDefinition<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `storeFn` | `StoreAssetFn` |
| `config` | `GenerationConfig` |

**Returns:** `ToolDefinition<PmeContext>`

<!-- source: constant-desk-transitions.md -->

# DESK_TRANSITIONS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/issues/dto/desk.dto.ts` (line 27)

<!-- source: function-detectapprovalstates.md -->

# detectApprovalStates

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/semantic-detector.ts` (line 232)

Detect approval-related states

Finds state references containing "Approval" in their name:
- AwaitingApproval, RejectedApproval, etc.

## Signature

```ts
function detectApprovalStates(code: string): string[]
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string` |

**Returns:** `string[]`

<!-- source: type-detectorname.md -->

# DetectorName

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/index.ts` (line 84)

## Definition

```ts
keyof typeof ALL_DETECTORS
```

<!-- source: function-dirforlang.md -->

# dirForLang

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/captionRules.ts` (line 11)

## Signature

```ts
function dirForLang(lang: string): 'ltr' | 'rtl'
```

## Parameters

| Name | Type |
|---|---|
| `lang` | `string` |

**Returns:** `'ltr' | 'rtl'`

<!-- source: controller-docsconfigcontroller.md -->

# DocsConfigController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/change-request/docs-config.controller.ts` (line 18)

Per-project docs config (the S2 review gate). Sibling of ChangeRequestController with the
SAME class-level authorizer: every route is keyed on `:projectId`, and OrganizationGuard
no-ops when the request carries no `organizationId`, so ProjectOrgGuard (which loads the
project and enforces org ownership) is what protects GET and PATCH alike.

GET is open to any project member (the editor reads it to decide whether saving must go
through a change request); PATCH is MAINTAINER/ADMIN only.

## Relationships

- MODULE_DECLARES → `get`
- MODULE_DECLARES → `set`
- DEPENDS_ON → `docsconfigservice`

<!-- source: module-draftdocumentmodule.md -->

# DraftDocumentModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/document/draft-document.module.ts` (line 12)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_PROVIDES → `draftdocumentservice`
- MODULE_EXPORTS → `draftdocumentservice`

<!-- source: class-envtracker.md -->

# EnvTracker

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/tools/env-tracker.ts` (line 70)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `isEnvModifyingCommand` | `isEnvModifyingCommand(command: string)` | `boolean` |
| `capture` | `capture()` | `Promise<EnvSnapshot>` |
| `getSnapshot` | `getSnapshot()` | `EnvSnapshot | null` |
| `getChanges` | `getChanges()` | `Record<string, { from?: string; to: string }>` |
| `formatForContext` | `formatForContext()` | `string` |
| `getCaptureCount` | `getCaptureCount()` | `number` |

<!-- source: function-generateid.md -->

# generateId

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/data-factories.ts` (line 9)

Test data factories for E2E tests
Generates realistic test data for P0 features

## Signature

```ts
function generateId(): string
```

**Returns:** `string`

<!-- source: function-getdocsbycategory.md -->

# getDocsByCategory

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/web-search/data/competitor-docs-index.ts` (line 363)

Get competitor docs by category

## Signature

```ts
function getDocsByCategory(category: string): CompetitorDoc[]
```

## Parameters

| Name | Type |
|---|---|
| `category` | `string` |

**Returns:** `CompetitorDoc[]`

<!-- source: component-herogradientsplit.md -->

# HeroGradientSplit

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/hero/hero-gradient-split.tsx` (line 26)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `subheadlineKey` | `string` | ✓ | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `imageSrc` | `string` | ✓ | - |
| `imageAlt` | `string` | ✓ | - |
| `badges` | `unknown[]` | - | - |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_HeroGradientSplit_2b8b2dfb["HeroGradientSplit"]
    class component_HeroGradientSplit_2b8b2dfb rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h1`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- RENDERS → `motion-span`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: interface-iparser.md -->

# IParser

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/parser.interface.ts` (line 60)

Base interface that ALL parsers must implement

Each parser (React, NestJS, Prisma, etc.) implements this interface
to ensure consistent behavior across the system.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `version` | `string` |
| `supportedPatterns` | `string[]` |

<!-- source: constant-metadata-10.md -->

# metadata

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/product/agent-actions/page.tsx` (line 11)

/product/agent-actions — the wedge no competitor can claim: docs agents can
EXECUTE, not just read. Every number/behaviour is live-verified (E2E receipt
captured 2026-07-11 against the dogfood MCP). Voice: receipts, not charm.
Design: light + colorful (document360 / lovable-inspired), dark code panels.

<!-- source: interface-pmeprogressevent.md -->

# PmeProgressEvent

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 200)

WebSocket progress event payload.

## Properties

| Property | Type |
|---|---|
| `jobId` | `string` |
| `progress` | `number` |
| `stage` | `string` |
| `message` | `string` |

<!-- source: interface-pricingfeature.md -->

# PricingFeature

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/pricing-tier-card.tsx` (line 14)

## Properties

| Property | Type |
|---|---|
| `textKey` | `string` |

<!-- source: class-prismaparser-2.md -->

# PrismaParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/database/prisma.parser.ts` (line 74)

Prisma Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: class-screenshotresultdto.md -->

# ScreenshotResultDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 692)

Individual screenshot result

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `screenshotId` | `string` |
| `url` | `string` |
| `blobUrl` | `string` |
| `viewport` | `{ width: number; height: number }` |
| `dimensions` | `{ width: number; height: number }` |
| `size` | `number` |
| `version` | `number` |
| `isNew` | `boolean` |
| `stateType` | `string` |
| `category` | `string` |
| `description` | `string` |
| `capturedAt` | `Date` |
| `featureArea` | `string` |
| `pageType` | `string` |
| `semanticTags` | `string[]` |
| `recoveryAttempts` | `number` |
| `recoverySucceeded` | `boolean` |
| `successfulSelector` | `string` |

<!-- source: component-selecttrigger.md -->

# SelectTrigger

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/select.tsx` (line 25)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `title` | `any` | ✓ | - |
| `placeholder` | `any` | ✓ | - |
| `className` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SelectTrigger_5ec306ff["SelectTrigger"]
    class component_SelectTrigger_5ec306ff rootComponent
```

## Relationships

- RENDERS → `TooltipWrap`
- RENDERS → `RadixSelect-Trigger`
- RENDERS → `RadixSelect-Value`
- RENDERS → `RadixSelect-Icon`
- USES_HOOK → `useCellValues`

## Referenced By

- `Select` (RENDERS)

<!-- source: function-servecommand.md -->

# serveCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/serve.command.ts` (line 33)

## Signature

```ts
async function serveCommand(options: ServeOptions)
```

## Parameters

| Name | Type |
|---|---|
| `options` | `ServeOptions` |

<!-- source: type-sessionstate.md -->

# SessionState

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/session/types.ts` (line 101)

Current state of the session.
- idle: waiting for user input
- running: agent is processing
- completed: session ended normally
- error: session ended with an error

## Definition

```ts
'idle' | 'running' | 'completed' | 'error'
```

<!-- source: service-synthesizerservice.md -->

# SynthesizerService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-05-synthesis/synthesizer.service.ts` (line 1)

<!-- source: interface-uploadresult.md -->

# UploadResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/storage/storage.service.ts` (line 11)

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `filename` | `string` |
| `size` | `number` |
| `uploadedAt` | `Date` |

<!-- source: type-viewmode.md -->

# ViewMode

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/components/Documents/ViewToggle.tsx` (line 5)

## Definition

```ts
'card' | 'list'
```

<!-- source: type-visualstrategy.md -->

# VisualStrategy

**Kind:** Type

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 36)

## Definition

```ts
'none' | 'screenshots' | 'mockups'
```

<!-- source: function-wait.md -->

# wait

**Kind:** Function

**Source:** `atloria-monorepo/apps/parser-orchestrator/test/integration/helpers/test-utils.ts` (line 362)

Wait for a specified duration

## Signature

```ts
function wait(ms: number): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `ms` | `number` |

**Returns:** `Promise<void>`

<!-- source: constant-angular-forms-patterns.md -->

# ANGULAR_FORMS_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/angular.patterns.ts` (line 161)

<!-- source: interface-apiendpoint-3.md -->

# APIEndpoint

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/EndpointList.ts` (line 8)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `path` | `string` |
| `method` | `string` |
| `summary` | `string` |
| `description` | `string` |
| `tags` | `string[]` |

<!-- source: interface-apiexecruntimeconfig.md -->

# ApiExecRuntimeConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.service.ts` (line 14)

Stored Live-API-target config (project.settings.apiExec). authHeaderValue is a server-side secret.

## Properties

| Property | Type |
|---|---|
| `baseUrl` | `string` |
| `authHeaderName` | `string` |
| `authHeaderValue` | `string` |
| `allowWrites` | `boolean` |
| `enabled` | `boolean` |

<!-- source: api-endpoint-assist.md -->

# assist

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-mcp.controller.ts` (line 321)

## Endpoint

`POST /technical-docs/:projectId/pages/:slug/assist`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `slug` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsMcpController` (MODULE_DECLARES)

<!-- source: class-azureresponsesprovider-2.md -->

# AzureResponsesProvider

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/azure-responses.provider.ts` (line 61)

**Implements:** `AIProvider`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generate` | `generate(prompt: string, options: AIGenerateOptions, stage: JobStage)` | `Promise<AIResponse>` |
| `generateWithStreaming` | `generateWithStreaming(prompt: string, options: AIGenerateOptions, stage: JobStage)` | `Promise<AIResponse>` |
| `generateText` | `generateText(prompt: string, options: Omit<AIGenerateOptions, 'messages'>, stage: JobStage)` | `Promise<string>` |
| `generateJSON` | `generateJSON(prompt: string, options: AIGenerateOptions, stage: JobStage)` | `Promise<{ data: T; response: AIResponse }>` |
| `generateWithStructuredOutput` | `generateWithStructuredOutput(options: {
    prompt: string;
    schema: object;
    model?: string;
  })` | `Promise<{ content: T; usage: { inputTokens: number; outputTokens: number } }>` |
| `isAvailable` | `isAvailable()` | `Promise<boolean>` |
| `getThrottlingStatus` | `getThrottlingStatus()` | `{ consecutiveFailures: number; adaptiveDelayMs: number; lastFailureTime: number }` |

## Properties

| Property | Type |
|---|---|
| `name` | `string` |

<!-- source: component-backgrounddecoration.md -->

# BackgroundDecoration

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/issues/[ticketNumber]/page.tsx` (line 1210)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `accent` | `string` | - | unknown |

## Diagram

```mermaid
graph TD
    component_BackgroundDecoration_25478097["BackgroundDecoration"]
    class component_BackgroundDecoration_25478097 rootComponent
```

## Referenced By

- `PublicTicketPage` (RENDERS)

<!-- source: interface-benchmarkreport.md -->

# BenchmarkReport

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/types.ts` (line 214)

Summary of a complete benchmark run.

## Properties

| Property | Type |
|---|---|
| `suite` | `BenchmarkTask['suite']` |
| `model` | `string` |
| `timestamp` | `string` |
| `totalTasks` | `number` |
| `passedTasks` | `number` |
| `passRate` | `number` |
| `totalDurationMs` | `number` |
| `totalTokens` | `{ input: number; output: number; total: number }` |
| `totalCostUsd` | `number` |
| `avgCostPerTask` | `number` |
| `byDifficulty` | `Record<string, { total: number; passed: number; rate: number }>` |
| `byLanguage` | `Record<string, { total: number; passed: number; rate: number }>` |
| `results` | `TaskResult[]` |
| `toolStats` | `Record<string, { count: number; avgDurationMs: number }>` |
| `failureBreakdown` | `Record<string, number>` |
| `byRepo` | `Record<string, { total: number; passed: number; rate: number; topFailure?: string }>` |
| `cumulativePassAtK` | `Record<number, { passed: number; rate: number }>` |
| `marginalGains` | `Record<string, number>` |
| `passAtK` | `{ k: number; passed: number; rate: number }` |
| `passAtKResults` | `PassAtKResult[]` |
| `costEfficiency` | `{
    firstPassSuccess: { avgTokens: number; avgDurationMs: number; avgTurns: number; count: number };
    recoveredSuccess: { avgTokens: number; avgDurationMs: number; avgTurns: number; count: number };
    finalFailure: { avgTokens: number; avgDurationMs: number; avgTurns: number; count: number };
  }` |
| `fileLocalizationStats` | `{
    avgRecall: number;
    avgPrecision: number;
    /** Tasks with >0 overlap that still failed */
    correctAreaButFailed: number;
    /** Tasks with 0 overlap */
    zeroOverlap: number;
  }` |

<!-- source: service-captureservice.md -->

# CaptureService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/capture/capture.service.ts` (line 32)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createFlow` | `createFlow(projectId: string, user: JwtPayload, dto: CreateFlowDto)` | `unknown` |
| `listFlows` | `listFlows(projectId: string, user: JwtPayload)` | `unknown` |
| `deleteFlow` | `deleteFlow(projectId: string, user: JwtPayload, id: string)` | `unknown` |
| `getFlow` | `getFlow(projectId: string, user: JwtPayload, id: string)` | `unknown` |
| `updateSteps` | `updateSteps(projectId: string, user: JwtPayload, id: string, dto: UpdateFlowStepsDto)` | `unknown` |
| `reshootStep` | `reshootStep(projectId: string, user: JwtPayload, id: string, stepIndex: number, opts: ReshootStepDto)` | `unknown` |
| `reshootLocales` | `reshootLocales(projectId: string, user: JwtPayload, id: string, dto: ReshootLocalesDto)` | `unknown` |
| `createDraft` | `createDraft(projectId: string, user: JwtPayload, id: string)` | `unknown` |
| `getPublicFlow` | `getPublicFlow(id: string)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `draftdocumentservice`
- DEPENDS_ON → `flowdraftstitcherservice`

<!-- source: class-checkoutdto.md -->

# CheckoutDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/billing/dto/checkout.dto.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `plan` | `BillingPlanKey` |

<!-- source: function-combinesourcetexts.md -->

# combineSourceTexts

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/services/business-context-extractor.ts` (line 115)

Combine multiple source contents into a single text block.

## Signature

```ts
function combineSourceTexts(sources: ContextSource[]): string
```

## Parameters

| Name | Type |
|---|---|
| `sources` | `ContextSource[]` |

**Returns:** `string`

<!-- source: function-computeactionsignature.md -->

# computeActionSignature

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/circle-detector.ts` (line 118)

Compute an action signature from a set of tool calls.
Order-independent (sorted by toolName).

## Signature

```ts
function computeActionSignature(toolCalls: Array<{ toolName: string; rawInput: string }>): string
```

## Parameters

| Name | Type |
|---|---|
| `toolCalls` | `Array<{ toolName: string; rawInput: string }>` |

**Returns:** `string`

<!-- source: interface-conditionalrender.md -->

# ConditionalRender

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 108)

## Properties

| Property | Type |
|---|---|
| `directive` | `string` |
| `condition` | `string` |
| `renders` | `string` |
| `filePath` | `string` |
| `lineNumber` | `number` |

<!-- source: interface-crdifffile.md -->

# CrDiffFile

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/cr-shared.ts` (line 29)

## Properties

| Property | Type |
|---|---|
| `path` | `string` |
| `status` | `string` |
| `additions` | `number` |
| `deletions` | `number` |
| `hunks` | `CrDiffHunk[]` |
| `sections` | `CrDiffSection[]` |

<!-- source: function-createbrandvoiceguardrail.md -->

# createBrandVoiceGuardrail

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/guardrails/brand-voice.guardrail.ts` (line 51)

## Signature

```ts
function createBrandVoiceGuardrail(config: BrandVoiceConfig): OutputGuardrailDefinition
```

## Parameters

| Name | Type |
|---|---|
| `config` | `BrandVoiceConfig` |

**Returns:** `OutputGuardrailDefinition`

<!-- source: function-detectmodaltriggers.md -->

# detectModalTriggers

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/semantic-detector.ts` (line 171)

Detect modal/dialog trigger methods

Finds methods that open modals/dialogs based on:
- Method names ending with "Prepare"
- Calls to openPopup, showDialog, openModal

## Signature

```ts
function detectModalTriggers(code: string): string[]
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string` |

**Returns:** `string[]`

<!-- source: constant-doc-audience-scopes.md -->

# DOC_AUDIENCE_SCOPES

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/project/audience-scope.util.ts` (line 14)

All known scopes, used to aggregate the landing page across doc sets.

## Definition

```ts
readonly DocAudienceScope[]
```

<!-- source: controller-docsprcontroller.md -->

# DocsPrController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr.controller.ts` (line 24)

Owner surface for Freshness-as-PRs. Every route is membership-scoped to the project.
Nothing here runs unless the owner has explicitly enabled the feature.

## Relationships

- MODULE_DECLARES → `getConfig`
- MODULE_DECLARES → `setConfig`
- MODULE_DECLARES → `listPrs`
- MODULE_DECLARES → `run`
- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `docsprservice`

<!-- source: type-doctype.md -->

# DocType

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/doc-type-classifier.ts` (line 12)

## Definition

```ts
'procedural' | 'conceptual' | 'reference' | 'troubleshooting' | 'workflow'
```

<!-- source: module-emailmodule.md -->

# EmailModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/email/email.module.ts` (line 5)

## Relationships

- MODULE_PROVIDES → `emailservice`
- MODULE_EXPORTS → `emailservice`

<!-- source: function-findcolumnofcard.md -->

# findColumnOfCard

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Boards/helpers.ts` (line 181)

Find the column containing a card, by id

## Signature

```ts
function findColumnOfCard(board: BoardData, cardId: string): BoardColumnData | null
```

## Parameters

| Name | Type |
|---|---|
| `board` | `BoardData` |
| `cardId` | `string` |

**Returns:** `BoardColumnData | null`

<!-- source: function-generateperformancereport.md -->

# generatePerformanceReport

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/performance.ts` (line 305)

Generate performance report

## Signature

```ts
function generatePerformanceReport(metrics: PerformanceMetrics): string
```

## Parameters

| Name | Type |
|---|---|
| `metrics` | `PerformanceMetrics` |

**Returns:** `string`

<!-- source: function-gethighprioritydocs.md -->

# getHighPriorityDocs

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/web-search/data/competitor-docs-index.ts` (line 379)

Get high priority docs

## Signature

```ts
function getHighPriorityDocs(): CompetitorDoc[]
```

**Returns:** `CompetitorDoc[]`

<!-- source: class-gitbackend.md -->

# GitBackend

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/context/git-backend.ts` (line 56)

**Implements:** `CheckpointBackend`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `isGitRepo` | `isGitRepo(dir: string)` | `boolean` |
| `save` | `save(snap: Snapshot)` | `void` |
| `load` | `load(relPath: string)` | `Snapshot[]` |
| `loadLatest` | `loadLatest(relPath: string)` | `Snapshot | null` |
| `deleteFile` | `deleteFile(relPath: string)` | `void` |
| `deleteFrom` | `deleteFrom(relPath: string, fromIndex: number)` | `void` |
| `getTrackedFiles` | `getTrackedFiles()` | `string[]` |
| `getTotalCount` | `getTotalCount()` | `number` |
| `getSnapshotCount` | `getSnapshotCount(relPath: string)` | `number` |
| `clear` | `clear()` | `void` |
| `evictOldest` | `evictOldest()` | `boolean` |

## Properties

| Property | Type |
|---|---|
| `sessionId` | `string` |

<!-- source: component-herominimalcentered.md -->

# HeroMinimalCentered

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/hero/hero-minimal-centered.tsx` (line 28)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `subheadlineKey` | `string` | ✓ | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `badgeKey` | `string` | - | - |
| `badgeIcon` | `LucideIcon` | - | - |
| `dividerIcons` | `LucideIcon[]` | - | - |
| `imageSrc` | `string` | - | - |
| `imageAlt` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_HeroMinimalCentered_3b49a4d3["HeroMinimalCentered"]
    class component_HeroMinimalCentered_3b49a4d3 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `BadgeIcon`
- RENDERS → `motion-h1`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: interface-jobstatus.md -->

# JobStatus

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/config.interface.ts` (line 303)

Job status information

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `status` | `'waiting' | 'active' | 'completed' | 'failed' | 'delayed' | 'paused'` |
| `progress` | `number` |
| `result` | `unknown` |
| `failedReason` | `string` |
| `attemptsMade` | `number` |
| `finishedOn` | `number` |
| `processedOn` | `number` |

<!-- source: constant-metadata-11.md -->

# metadata

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/product/user-manuals/page.tsx` (line 13)

/product/user-manuals — the manuals pillar. The wedge: the agent DRIVES the
running app and captures annotated screenshots per release, per locale, with
PII/secrets redacted — nobody records a human clicking. HONESTY: no video /
screencast claims (we don't do video); no deflection-% claims; only the two
validated headline scores (8.2 enterprise / 8.4 mid-market). Corporate 8.3 is
structural-only — never headlined. Localization is one attribute, not the
headline; Arabic/RTL is one peer among languages. Design matches
/product/agent-actions: light + colorful, dark code panel for the receipt.

<!-- source: interface-pmeturnhookconfig.md -->

# PmeTurnHookConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/context/pme-turn-hook.ts` (line 32)

## Properties

| Property | Type |
|---|---|
| `maxTurns` | `number` |
| `tokenBudget` | `number` |
| `pressureThreshold` | `number` |
| `truncationThreshold` | `number` |
| `truncatedResultMaxChars` | `number` |
| `preserveRecentResults` | `number` |

<!-- source: interface-pricingfeature-2.md -->

# PricingFeature

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/pricing/pricing-hero-card.tsx` (line 12)

## Properties

| Property | Type |
|---|---|
| `textKey` | `string` |
| `included` | `boolean` |

<!-- source: class-projectdetector.md -->

# ProjectDetector

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/detector/project-detector.ts` (line 55)

ProjectDetector class

Detects project type, frameworks, package manager, and build tools
by analyzing project structure and configuration files.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detect` | `detect(rootDir: string)` | `Promise<DetectedProject>` |
| `addFrameworkRule` | `addFrameworkRule(rule: FrameworkRule)` | `void` |
| `getFrameworkRules` | `getFrameworkRules()` | `FrameworkRule[]` |
| `hasFramework` | `hasFramework(rootDir: string, frameworkName: string)` | `Promise<boolean>` |
| `supportsParser` | `supportsParser(rootDir: string, parserName: string)` | `Promise<boolean>` |

<!-- source: class-selectorvalidationresult.md -->

# SelectorValidationResult

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 791)

Result for a single selector validation

## Properties

| Property | Type |
|---|---|
| `selector` | `string` |
| `found` | `boolean` |
| `visible` | `boolean` |
| `tagName` | `string` |
| `attributes` | `Record<string, string>` |
| `suggestion` | `string` |

<!-- source: function-sessionsdeletecommand.md -->

# sessionsDeleteCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/sessions.command.ts` (line 100)

## Signature

```ts
async function sessionsDeleteCommand(options: SessionsDeleteOptions): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `SessionsDeleteOptions` |

**Returns:** `Promise<void>`

<!-- source: component-stepcard-2.md -->

# StepCard

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/how-it-works/how-it-works-timeline.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `step` | `Step` | ✓ | - |
| `t` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StepCard_4524ff8c["StepCard"]
    class component_StepCard_4524ff8c rootComponent
```

## Relationships

- RENDERS → `Icon`

## Referenced By

- `HowItWorksTimeline` (RENDERS)

<!-- source: type-streamevent.md -->

# StreamEvent

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/session/types.ts` (line 201)

Normalized streaming event from the SDK.
Maps SDK's RunStreamEvent types to our domain events.

## Definition

```ts
| { type: 'item'; name: string; item: unknown }
  | { type: 'model_delta'; data: unknown }
  | { type: 'agent_updated'; agentName: string }
```

<!-- source: service-uploadservice.md -->

# UploadService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.service.ts` (line 1)

<!-- source: type-wizardscene.md -->

# WizardScene

**Kind:** Type

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/useNewProjectWizard.ts` (line 5)

## Definition

```ts
'url-input' | 'project-details' | 'connect-provider' | 'browse-repos' | 'doc-types' | 'generation'
```

<!-- source: constant-angular-routing-patterns.md -->

# ANGULAR_ROUTING_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/angular.patterns.ts` (line 201)

<!-- source: interface-apiendpoint-4.md -->

# APIEndpoint

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/RequestPanel.ts` (line 8)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `path` | `string` |
| `method` | `string` |
| `parameters` | `Parameter[]` |
| `requestBody` | `RequestBody` |
| `requiresAuth` | `boolean` |

<!-- source: interface-apiexecutorconfig.md -->

# ApiExecutorConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/mcp/api-executor.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `baseUrl` | `string` |
| `authHeaderName` | `string` |
| `authHeaderValue` | `string` |
| `allowWrites` | `boolean` |

<!-- source: api-endpoint-assistapply.md -->

# assistApply

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-mcp.controller.ts` (line 339)

## Endpoint

`POST /technical-docs/:projectId/pages/:slug/assist/apply`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `slug` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsMcpController` (MODULE_DECLARES)

<!-- source: component-badge.md -->

# Badge

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/all/page.tsx` (line 87)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `bg` | `string` | ✓ | - |
| `text` | `string` | ✓ | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Badge_3d9e3d14["Badge"]
    class component_Badge_3d9e3d14 rootComponent
```

## Referenced By

- `IssuesAllPageInner` (RENDERS)

<!-- source: class-batchedscreenshotprocessor.md -->

# BatchedScreenshotProcessor

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/batched-screenshot-processor.ts` (line 70)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `splitIntoBatches` | `splitIntoBatches(mappings: ScreenshotMapping[], batchSize: number)` | `ScreenshotMapping[][]` |
| `processInBatches` | `processInBatches(mappings: ScreenshotMapping[], documents: GeneratedDocument[], registry: ScreenshotRegistry, capturer: { captureScreenshots: (mappings: ScreenshotMapping[], progressCallback?: any) => Promise<CaptureResult[]> }, replacer: { replaceInDocuments: (documents: GeneratedDocument[], screenshots: CapturedScreenshot[], registry: ScreenshotRegistry, progressCallback?: any) => { documents: GeneratedDocument[]; results: any[] } }, config: BatchConfig)` | `Promise<AggregatedResult>` |

<!-- source: interface-benchmarkrunconfig.md -->

# BenchmarkRunConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/types.ts` (line 153)

Configuration for a full benchmark run.

## Properties

| Property | Type |
|---|---|
| `suite` | `BenchmarkTask['suite']` |
| `taskIds` | `string[]` |
| `maxTasks` | `number` |
| `shuffle` | `boolean` |
| `repoBaseDir` | `string` |
| `outputDir` | `string` |
| `model` | `{
    endpoint: string;
    apiKey: string;
    apiVersion: string;
    model: string;
  }` |
| `maxTurns` | `number` |
| `timeoutSec` | `number` |
| `braveApiKey` | `string` |
| `embedding` | `{
    endpoint: string;
    apiKey: string;
    model: string;
  }` |
| `parallelism` | `number` |
| `costPerMInputTokens` | `number` |
| `costPerMOutputTokens` | `number` |
| `attemptsPerTask` | `number` |
| `preset` | `'starter' | 'full'` |
| `useDockerEval` | `boolean` |
| `costLimitPerTask` | `number` |
| `onEvent` | `(event: BenchmarkEvent) => void` |
| `modelProvider` | `import('@openai/agents').ModelProvider` |

<!-- source: service-categoryservice.md -->

# CategoryService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/document/category.service.ts` (line 14)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `create` | `create(dto: CreateCategoryDto, user: JwtPayload)` | `unknown` |
| `list` | `list(filters: CategoryFiltersDto, user: JwtPayload)` | `unknown` |
| `get` | `get(id: string, user: JwtPayload)` | `unknown` |
| `update` | `update(id: string, dto: UpdateCategoryDto, user: JwtPayload)` | `unknown` |
| `delete` | `delete(id: string, user: JwtPayload)` | `unknown` |
| `reorder` | `reorder(categoryIds: string[], user: JwtPayload)` | `unknown` |
| `getTree` | `getTree(projectId: string, user: JwtPayload, docVersionId: string)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: class-commentfiltersdto.md -->

# CommentFiltersDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/comment/dto/comment-filters.dto.ts` (line 8)

DTO for filtering comments when listing

## Properties

| Property | Type |
|---|---|
| `resolved` | `boolean` |
| `search` | `string` |

<!-- source: function-commentfrommarkdown.md -->

# commentFromMarkdown

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/mdastUtilHtmlComment.ts` (line 38)

## Signature

```ts
function commentFromMarkdown(_options: { ast?: boolean }): Partial<Config>
```

## Parameters

| Name | Type |
|---|---|
| `_options` | `{ ast?: boolean }` |

**Returns:** `Partial<Config>`

<!-- source: function-computecontenthash.md -->

# computeContentHash

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/types.ts` (line 87)

Compute a SHA-256 hash of the content for cache hit detection.

## Signature

```ts
function computeContentHash(content: string): string
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |

**Returns:** `string`

<!-- source: interface-conditionaluipattern.md -->

# ConditionalUIPattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-management.interface.ts` (line 321)

Conditional UI based on state

## Properties

| Property | Type |
|---|---|
| `stateCondition` | `string` |
| `showsElements` | `string[]` |
| `hidesElements` | `string[]` |
| `disablesElements` | `string[]` |
| `stateValues` | `string[]` |

<!-- source: interface-crdiffhunk.md -->

# CrDiffHunk

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/cr-shared.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `header` | `string` |
| `lines` | `CrDiffLine[]` |

<!-- source: function-createcontentsafetyguardrail.md -->

# createContentSafetyGuardrail

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/guardrails/content-safety.guardrail.ts` (line 125)

## Signature

```ts
function createContentSafetyGuardrail(config: ContentSafetyConfig): OutputGuardrailDefinition
```

## Parameters

| Name | Type |
|---|---|
| `config` | `ContentSafetyConfig` |

**Returns:** `OutputGuardrailDefinition`

<!-- source: function-detectngrxactions.md -->

# detectNgRxActions

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ngrx-pattern-detector.ts` (line 157)

Detect NgRx actions from code

## Signature

```ts
function detectNgRxActions(content: string): NgRxActionPattern[]
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |

**Returns:** `NgRxActionPattern[]`

<!-- source: constant-doc-normalize.md -->

# DOC_NORMALIZE

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/docs-repo/docs-repo.service.ts` (line 17)

<!-- source: controller-documentationcontroller.md -->

# DocumentationController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/documentation/documentation.controller.ts` (line 11)

## Relationships

- MODULE_DECLARES → `generateUserDocumentation`
- MODULE_DECLARES → `generateFromNeo4j`
- DEPENDS_ON → `documentationservice`
- DEPENDS_ON → `neo4jdocsorchestratorservice`

<!-- source: type-documenttype.md -->

# DocumentType

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-04.types.ts` (line 50)

## Definition

```ts
| 'guide' // How to do something
  | 'tutorial' // Step-by-step learning
  | 'reference' // Lookup information
  | 'faq' // Common questions
  | 'troubleshooting' // Fix problems
  | 'overview' // High-level explanation
  | 'quickstart'
```

<!-- source: module-eventsmodule.md -->

# EventsModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/events/events.module.ts` (line 9)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_DECLARES → `eventscontroller`
- MODULE_DECLARES → `agentanalyticscontroller`
- MODULE_PROVIDES → `eventsservice`
- MODULE_PROVIDES → `agentanalyticsservice`
- MODULE_EXPORTS → `eventsservice`

<!-- source: function-findsectionrange.md -->

# findSectionRange

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/section-merge.ts` (line 45)

Find the [start, end) line range of the section in `lines`, or null when
the heading is not present.

## Signature

```ts
function findSectionRange(lines: string[], heading: string, level: number): { start: number; end: number } | null
```

## Parameters

| Name | Type |
|---|---|
| `lines` | `string[]` |
| `heading` | `string` |
| `level` | `number` |

**Returns:** `{ start: number; end: number } | null`

<!-- source: function-getperformancemetrics.md -->

# getPerformanceMetrics

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/performance.ts` (line 47)

Get performance metrics from a page

## Signature

```ts
async function getPerformanceMetrics(page: Page): Promise<PerformanceMetrics>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |

**Returns:** `Promise<PerformanceMetrics>`

<!-- source: component-herowavesplit.md -->

# HeroWaveSplit

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/hero/hero-wave-split.tsx` (line 23)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `subheadlineKey` | `string` | ✓ | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `imageSrc` | `string` | ✓ | - |
| `imageAlt` | `string` | ✓ | - |
| `stats` | `unknown[]` | - | - |
| `trustTextKey` | `string` | - | - |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_HeroWaveSplit_3f17960d["HeroWaveSplit"]
    class component_HeroWaveSplit_3f17960d rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h1`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- USES_HOOK → `useTranslation`

<!-- source: class-hookregistry.md -->

# HookRegistry

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/session/hook-registry.ts` (line 76)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `has` | `has(event: HookableEvent)` | `boolean` |
| `run` | `run(event: HookableEvent, data: Record<string, unknown>, toolName: string)` | `Promise<HookRunResult>` |

<!-- source: function-hourbucketstart.md -->

# hourBucketStart

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/analytics/utils/tracking-utils.ts` (line 112)

Compute the start of the hour bucket containing `date`. Used by the
session-dedup logic in the analytics service so that multiple page-view
beacons from the same session+slug within the same hour collapse into
a single row instead of stacking up.

## Signature

```ts
function hourBucketStart(date: Date): Date
```

## Parameters

| Name | Type |
|---|---|
| `date` | `Date` |

**Returns:** `Date`

<!-- source: interface-linkinfo.md -->

# LinkInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 903)

Link information

## Properties

| Property | Type |
|---|---|
| `text` | `string` |
| `url` | `string` |
| `line` | `number` |
| `isInternal` | `boolean` |

<!-- source: constant-metadata-12.md -->

# metadata

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/security/page.tsx` (line 11)

/security — radical openness, not badge theater. Everything here is a control
you can read: server-injected credentials, an SSRF-guarded executor with its
own test suite, layered redaction burned into pixels, and self-host. We state
compliance HONESTLY: what's in place (architecture) vs what we haven't earned
yet (SOC 2 / ISO / pen test). No certifications claimed. No CORS claim made.
Design: light + colorful (matches /product/agent-actions), dark code panels.

<!-- source: interface-pricingherocardprops.md -->

# PricingHeroCardProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/pricing/pricing-hero-card.tsx` (line 27)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `heroPlan` | `PricingPlan` |
| `secondaryPlans` | `PricingPlan[]` |

<!-- source: class-pythonparser-2.md -->

# PythonParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/backend/python.parser.ts` (line 68)

Python Project Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: interface-qaconfig.md -->

# QaConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/agents/qa.agent.ts` (line 20)

## Properties

| Property | Type |
|---|---|
| `htmlQuality` | `HtmlQualityConfig` |
| `contentSafety` | `ContentSafetyConfig` |
| `passThreshold` | `number` |

<!-- source: class-sessionhealthcheckdto.md -->

# SessionHealthCheckDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 472)

Batch authentication configuration DTO

Defines credentials and optional selectors for authentication.
If useSmartDetection is enabled, AI will auto-detect form selectors.

## Properties

| Property | Type |
|---|---|
| `enabled` | `boolean` |
| `loginPageIndicators` | `string[]` |
| `authenticatedIndicators` | `string[]` |
| `loginUrlPatterns` | `string[]` |
| `maxReauthAttempts` | `number` |

<!-- source: function-sessionslistcommand.md -->

# sessionsListCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/sessions.command.ts` (line 20)

## Signature

```ts
async function sessionsListCommand(_options: SessionsListOptions): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `_options` | `SessionsListOptions` |

**Returns:** `Promise<void>`

<!-- source: component-stepcircle-2.md -->

# StepCircle

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/how-it-works/how-it-works-timeline.tsx` (line 43)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `num` | `number` | ✓ | - |
| `variant` | `unknown | unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StepCircle_6fabedb4["StepCircle"]
    class component_StepCircle_6fabedb4 rootComponent
```

## Referenced By

- `HowItWorksTimeline` (RENDERS)

<!-- source: type-taskcategory.md -->

# TaskCategory

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-router.ts` (line 32)

Model Router — Phase 2

Maps task categories to model deployment names.
Enables cost-optimized routing: cheap models for simple tasks,
full models only where quality matters.

Resolution order per call:
  1. Explicit model passed at spawn time (highest priority — always wins)
  2. Category route from routing table
  3. Default model (fallback — zero behavior change when no table configured)

All models must be deployments on the same Azure endpoint.
The router only returns model names — the provider config is unchanged.

Default routing table for atlas-docs-resource (East US 2):
  explore / synthesize / tool_dispatch → gpt-5.6-luna  (150M TPM quota)
  analyze / review / chat              → gpt-5.6-luna  (10M TPM quota)
  plan / implement                     → gpt-5.6-terra       (full reasoning, 1M context)
  default (uncategorized)              → gpt-5.6-terra       (no behavior change)

## Definition

```ts
| 'explore'       // file search, directory listing, reading code — nano
  | 'analyze'       // code understanding, grep, web search — mini
  | 'plan'          // architecture, design decisions — full
  | 'implement'     // writing/editing code — full
  | 'review'        // code review, quality chec…
```

<!-- source: service-v4dstructureservice.md -->

# V4dStructureService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-06-structure/v4d-structure.service.ts` (line 1)

<!-- source: constant-angular-service-detection-patterns.md -->

# ANGULAR_SERVICE_DETECTION_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/angular.patterns.ts` (line 120)

<!-- source: interface-apimapping.md -->

# APIMapping

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/api-call-mapper.ts` (line 66)

A mapped connection between frontend call and backend endpoint

## Properties

| Property | Type |
|---|---|
| `frontendCall` | `DetectedAPICall` |
| `backendEndpoint` | `DetectedEndpoint` |
| `matchConfidence` | `'high' | 'medium' | 'low' | 'none'` |
| `matchReason` | `string` |

<!-- source: interface-apitargetpublicconfig.md -->

# ApiTargetPublicConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.service.ts` (line 23)

What the config read/write endpoints expose — NEVER the auth value (only whether one is set).

## Properties

| Property | Type |
|---|---|
| `baseUrl` | `string` |
| `authHeaderName` | `string` |
| `allowWrites` | `boolean` |
| `enabled` | `boolean` |
| `hasAuth` | `boolean` |

<!-- source: component-badge-2.md -->

# Badge

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/page.tsx` (line 104)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `bg` | `string` | ✓ | - |
| `text` | `string` | ✓ | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Badge_511b3182["Badge"]
    class component_Badge_511b3182 rootComponent
```

## Referenced By

- `RecentTickets` (RENDERS)

<!-- source: interface-benchmarktask.md -->

# BenchmarkTask

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/types.ts` (line 13)

Benchmark Types

Shared interfaces for all benchmark adapters (Aider Polyglot, SWE-bench).
Zero external dependencies.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `suite` | `'aider-polyglot' | 'swe-bench-verified' | 'swe-bench-pro'` |
| `prompt` | `string` |
| `repo` | `string` |
| `baseRef` | `string` |
| `setupPatch` | `string` |
| `languages` | `string[]` |
| `difficulty` | `'easy' | 'medium' | 'hard'` |
| `timeoutSec` | `number` |
| `expectedFiles` | `string[]` |
| `testCommand` | `string` |
| `goldPatch` | `string` |
| `metadata` | `Record<string, unknown>` |

<!-- source: api-endpoint-bulkcapturescreenshots.md -->

# bulkCaptureScreenshots

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/screenshot/screenshot.controller.ts` (line 37)

## Endpoint

`POST /screenshots/bulk`

## Referenced By

- `ScreenshotController` (MODULE_DECLARES)

<!-- source: class-categoryrestructure.md -->

# CategoryRestructure

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-14-meta/generators/category-restructure.ts` (line 46)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `restructure` | `restructure(existingCategories: DocumentCategoryStructure[], existingDocuments: PlannedDocument[], personas: Array<{ name: string; description: string }>)` | `RestructureResult` |

<!-- source: service-changelogservice.md -->

# ChangelogService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/doc-version/changelog.service.ts` (line 5)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generateChangelog` | `generateChangelog(versionAId: string, versionBId: string)` | `Promise<string>` |
| `generateAndStore` | `generateAndStore(versionId: string)` | `Promise<string>` |

## Relationships

- DEPENDS_ON → `versiondiffservice`
- DEPENDS_ON → `prismaservice`

<!-- source: class-commitlockservice.md -->

# CommitLockService

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/docs-repo/commit-lock.ts` (line 48)

Per-project commit mutex for the docs substrate.

FAIL-CLOSED, deliberately the OPPOSITE of the technical-docs org mutex (which fails OPEN
so a Redis blip can't dead-lock the parse lane). Here, committing without the lock could
corrupt a project's git tree with a concurrent write, so if Redis is unreachable we DENY
the commit (throw LockUnavailableError) and let the job requeue. A dedicated ioredis
connection (lazyConnect, maxRetriesPerRequest:1, offline queue off) keeps a Redis outage
from stalling everything else.

**Implements:** `OnModuleDestroy`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `acquire` | `acquire(projectId: string, ttlMs: undefined)` | `Promise<string | null>` |
| `release` | `release(projectId: string, token: string)` | `Promise<void>` |
| `renew` | `renew(projectId: string, token: string, ttlMs: undefined)` | `Promise<boolean>` |
| `withLock` | `withLock(projectId: string, fn: () => Promise<T>, ttlMs: undefined)` | `Promise<T>` |
| `onModuleDestroy` | `onModuleDestroy()` | `void` |

<!-- source: function-compose.md -->

# compose

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/fp.ts` (line 5)

Performs left to right composition of two functions.

## Signature

```ts
function compose(a: (arg: A) => R, b: (arg: I) => A): (arg: I) => R
```

## Parameters

| Name | Type |
|---|---|
| `a` | `(arg: A) => R` |
| `b` | `(arg: I) => A` |

**Returns:** `(arg: I) => R`

<!-- source: function-computeerrorsignature.md -->

# computeErrorSignature

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/circle-detector.ts` (line 130)

Compute an error signature (hash of error text for dedup).

## Signature

```ts
function computeErrorSignature(errorText: string): string
```

## Parameters

| Name | Type |
|---|---|
| `errorText` | `string` |

**Returns:** `string`

<!-- source: interface-configinfo.md -->

# ConfigInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/storybook/types.ts` (line 128)

Configuration detection result

## Properties

| Property | Type |
|---|---|
| `format` | `ConfigFormat` |
| `configDir` | `string` |
| `stories` | `string[]` |
| `excludePatterns` | `string[]` |
| `detected` | `{
    hasStorybookConfig: boolean;
    hasLadleConfig: boolean;
    hasAtloriaConfig: boolean;
  }` |

<!-- source: interface-crdiffline.md -->

# CrDiffLine

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/cr-shared.ts` (line 11)

Shared presentation helpers + local diffCache typing for the change-request
(Docs Change) UI. The api-client ships `diffCache` as `unknown`; the shapes
below mirror the API's CrDiff exactly.

## Properties

| Property | Type |
|---|---|
| `type` | `'add' | 'del' | 'ctx'` |
| `text` | `string` |
| `oldLine` | `number | null` |
| `newLine` | `number | null` |

<!-- source: function-createcoordinatoragent.md -->

# createCoordinatorAgent

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/agents/coordinator.agent.ts` (line 39)

Create the coordinator agent config.
Dependencies are injected — the agent config itself is a plain object.

## Signature

```ts
function createCoordinatorAgent(config: GenerationConfig, deps: CoordinatorDependencies): AgentConfig<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |
| `deps` | `CoordinatorDependencies` |

**Returns:** `AgentConfig<PmeContext>`

<!-- source: function-detectngrxeffects.md -->

# detectNgRxEffects

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ngrx-pattern-detector.ts` (line 480)

Detect NgRx effects from code

## Signature

```ts
function detectNgRxEffects(content: string): NgRxEffectPattern[]
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |

**Returns:** `NgRxEffectPattern[]`

<!-- source: constant-doc-normalizer-version.md -->

# DOC_NORMALIZER_VERSION

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/docs-repo/docs-repo.service.ts` (line 24)

The current

<!-- source: controller-documentcontroller.md -->

# DocumentController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 45)

## Relationships

- MODULE_DECLARES → `create`
- MODULE_DECLARES → `list`
- MODULE_DECLARES → `search`
- MODULE_DECLARES → `get`
- MODULE_DECLARES → `getStats`
- MODULE_DECLARES → `compare`
- MODULE_DECLARES → `update`
- MODULE_DECLARES → `delete`
- MODULE_DECLARES → `getVersions`
- MODULE_DECLARES → `getVersion`
- MODULE_DECLARES → `revert`
- MODULE_DECLARES → `publish`
- MODULE_DECLARES → `unpublish`
- MODULE_DECLARES → `render`
- MODULE_DECLARES → `getTree`
- MODULE_DECLARES → `getRevisions`
- MODULE_DECLARES → `getRevision`
- MODULE_DECLARES → `restoreFromRevision`
- MODULE_DECLARES → `createVersion`
- MODULE_DECLARES → `getNamedVersions`
- MODULE_DECLARES → `getNamedVersion`
- MODULE_DECLARES → `updateVersionMetadata`
- MODULE_DECLARES → `deleteVersion`
- MODULE_DECLARES → `restoreFromVersion`
- MODULE_DECLARES → `bulkDelete`
- MODULE_DECLARES → `bulkMove`
- MODULE_DECLARES → `bulkUpdateVisibility`
- MODULE_DECLARES → `bulkPublish`
- MODULE_DECLARES → `duplicate`
- DEPENDS_ON → `documentservice`
- DEPENDS_ON → `documentrevisionservice`
- DEPENDS_ON → `documentversionservice`

<!-- source: type-editorsubscription.md -->

# EditorSubscription

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 96)

A function that subscribes to Lexical editor updates or events, and retursns an unsubscribe function.

## Definition

```ts
(activeEditor: LexicalEditor) => () => void
```

<!-- source: function-formatdelta.md -->

# formatDelta

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/formatters.ts` (line 26)

## Signature

```ts
function formatDelta(current: number | null | undefined, previous: number | null | undefined): { text: string; direction: 'up' | 'down' | 'flat' }
```

## Parameters

| Name | Type |
|---|---|
| `current` | `number | null | undefined` |
| `previous` | `number | null | undefined` |

**Returns:** `{ text: string; direction: 'up' | 'down' | 'flat' }`

<!-- source: module-gatewaymodule.md -->

# GatewayModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/gateway/gateway.module.ts` (line 6)

## Relationships

- MODULE_PROVIDES → `documentgateway`
- MODULE_PROVIDES → `commentgateway`
- MODULE_EXPORTS → `documentgateway`
- MODULE_EXPORTS → `commentgateway`

<!-- source: function-getvalidationerrors.md -->

# getValidationErrors

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 145)

Get all form validation errors

## Signature

```ts
async function getValidationErrors(page: Page): Promise<string[]>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |

**Returns:** `Promise<string[]>`

<!-- source: component-howitworkscardsgrid.md -->

# HowItWorksCardsGrid

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/how-it-works/how-it-works-cards-grid.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `labelKey` | `string` | - | - |
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `steps` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_HowItWorksCardsGrid_77f322fc["HowItWorksCardsGrid"]
    class component_HowItWorksCardsGrid_77f322fc rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-span`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `StepIndicator`
- USES_HOOK → `useTranslation`

<!-- source: function-ingressname.md -->

# ingressName

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/project/k8s-ingress.service.ts` (line 25)

## Signature

```ts
function ingressName(domain: string): string
```

## Parameters

| Name | Type |
|---|---|
| `domain` | `string` |

**Returns:** `string`

<!-- source: class-injectionturnhook.md -->

# InjectionTurnHook

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/session/injection-hook.ts` (line 15)

**Implements:** `TurnHook`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `enqueue` | `enqueue(message: string)` | `void` |
| `clear` | `clear()` | `void` |
| `updateTokenUsage` | `updateTokenUsage(inputTokens: number)` | `void` |
| `beforeModelCall` | `beforeModelCall(args: TurnHookArgs<TContext>)` | `Promise<{ instructions?: string; input?: AgentInputItem[] }>` |

<!-- source: interface-markdowndocentity.md -->

# MarkdownDocEntity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 853)

Markdown document entity

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.MARKDOWN_DOC` |
| `title` | `string` |
| `headings` | `HeadingInfo[]` |
| `codeBlocks` | `CodeBlockInfo[]` |
| `links` | `LinkInfo[]` |
| `frontMatter` | `Record<string, unknown>` |

<!-- source: constant-metadata-13.md -->

# metadata

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/layout.tsx` (line 12)

## Definition

```ts
Metadata
```

<!-- source: interface-pricingplan.md -->

# PricingPlan

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/pricing/pricing-hero-card.tsx` (line 17)

## Properties

| Property | Type |
|---|---|
| `nameKey` | `string` |
| `priceKey` | `string` |
| `intervalKey` | `string` |
| `descriptionKey` | `string` |
| `features` | `PricingFeature[]` |
| `ctaKey` | `string` |
| `ctaUrl` | `string` |

<!-- source: interface-qadependencies.md -->

# QaDependencies

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/agents/qa.agent.ts` (line 16)

## Properties

| Property | Type |
|---|---|
| `renderAndCaptureFn` | `RenderAndCaptureFn` |

<!-- source: class-reactparser-2.md -->

# ReactParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/frontend/react.parser.ts` (line 95)

React Parser - Pure class implementation (no NestJS dependencies)

Works for both CLI (static) mode and cloud mode.

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `version` | `string` |
| `supportedPatterns` | `string[]` |

<!-- source: function-sessionsshowcommand.md -->

# sessionsShowCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/sessions.command.ts` (line 55)

## Signature

```ts
async function sessionsShowCommand(options: SessionsShowOptions): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `SessionsShowOptions` |

**Returns:** `Promise<void>`

<!-- source: class-stateresolutionconfigdto.md -->

# StateResolutionConfigDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 325)

Individual screenshot item DTO

Defines a single screenshot to capture with:
- Required: id, description, url (route), expectedState
- Optional: actions, viewport, edge case configs

## Properties

| Property | Type |
|---|---|
| `listUrl` | `string` |
| `statusColumnHint` | `string` |
| `targetStatusValue` | `string` |
| `maxRowsToScan` | `number` |
| `rowAction` | `'click' | 'dblclick'` |

<!-- source: component-tableofcontentssidebar.md -->

# TableOfContentsSidebar

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/table-of-contents.tsx` (line 44)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `tocItems` | `TOCItem[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TableOfContentsSidebar_19b83cbf["TableOfContentsSidebar"]
    class component_TableOfContentsSidebar_19b83cbf rootComponent
```

## Referenced By

- `TableOfContents` (RENDERS)

<!-- source: type-taskmode.md -->

# TaskMode

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/tools/tool-profiles.ts` (line 16)

Task-Specific Tool Profiles

Maps task modes to curated tool subsets. Reducing visible tools improves
accuracy — research shows accuracy drops from 96% → 25% as tool count
grows from 1 → 8 (Berkeley tool selection study, 2025).

Modes:
 - explore:   Read-only codebase investigation
 - plan:      Analysis + research, no writes
 - implement: Active coding — file edits, bash, rollback
 - review:    Code quality audit — read + analysis only
 - full:      All tools (default, current behavior)

## Definition

```ts
'explore' | 'plan' | 'implement' | 'review' | 'full'
```

<!-- source: service-verifieragentservice.md -->

# VerifierAgentService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/verifier-agent.service.ts` (line 1)

<!-- source: constant-angular-service-patterns.md -->

# ANGULAR_SERVICE_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/cross-language.types.ts` (line 280)

Service method detection patterns for Angular

<!-- source: interface-apiresponse.md -->

# APIResponse

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/types/config.ts` (line 103)

Response wrapper

## Properties

| Property | Type |
|---|---|
| `data` | `T` |
| `status` | `number` |
| `headers` | `Headers` |

<!-- source: interface-auditeventinput.md -->

# AuditEventInput

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/audit/audit.service.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `organizationId` | `string` |
| `projectId` | `string` |
| `docVersionId` | `string` |
| `actorId` | `string` |
| `actorEmail` | `string` |
| `actorRole` | `string` |
| `action` | `string` |
| `entityType` | `string` |
| `entityId` | `string` |
| `metadata` | `Record<string, any>` |
| `ipAddress` | `string` |
| `userAgent` | `string` |

<!-- source: component-bitbucketicon.md -->

# BitbucketIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/scenes/SceneUrlInput.tsx` (line 20)

## Diagram

```mermaid
graph TD
    component_BitbucketIcon_6a0041d2["BitbucketIcon"]
    class component_BitbucketIcon_6a0041d2 rootComponent
```

## Referenced By

- `SceneUrlInput` (RENDERS)

<!-- source: api-endpoint-bulkdelete.md -->

# bulkDelete

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 793)

## Endpoint

`POST /documents/bulk/delete`

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: class-changerequestendpoints.md -->

# ChangeRequestEndpoints

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/change-requests.ts` (line 122)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `list` | `list(projectId: string, params: ChangeRequestListParams)` | `Promise<ChangeRequest[]>` |
| `get` | `get(projectId: string, crId: string)` | `Promise<ChangeRequest>` |
| `open` | `open(projectId: string, dto: OpenChangeRequestDto)` | `Promise<ChangeRequest>` |
| `close` | `close(projectId: string, crId: string)` | `Promise<ChangeRequest>` |
| `merge` | `merge(projectId: string, crId: string)` | `Promise<ChangeRequest>` |
| `refreshDiff` | `refreshDiff(projectId: string, crId: string)` | `Promise<ChangeRequest>` |
| `resolve` | `resolve(projectId: string, crId: string, dto: ResolveChangeRequestDto)` | `Promise<ChangeRequest>` |

<!-- source: service-changerequestservice.md -->

# ChangeRequestService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.service.ts` (line 66)

ChangeRequestService — DB lifecycle for docs change requests (S2.1).

A change request = a git branch (cr/<id>) holding proposed content + a DocsChangeRequest row
for metadata/status. This service ONLY touches the DB and the queue: api pods cannot reach
the git repo (RWO PVC on the worker), so `open` persists a 'draft' row carrying the proposed
content and enqueues a 'cr-open' job; CrWorker stages the branch and flips the row to 'open'
(markOpen) or 'failed' (markFailed).

`ChangeRequestService` manages the database lifecycle for documentation change requests and coordinates asynchronous Git work through the queue. API pods persist proposed content as a `draft` request, while the worker creates the `cr/<id>` branch and updates the request to `open` or `failed`.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `open` | `open(projectId: string, dto: OpenChangeRequestDto, author: { authorType: string; authorId?: string | null })` | `unknown` |
| `list` | `list(projectId: string, status: string, take: unknown)` | `unknown` |
| `get` | `get(projectId: string, crId: string)` | `unknown` |
| `merge` | `merge(projectId: string, crId: string, mergedById: string)` | `unknown` |
| `refreshDiff` | `refreshDiff(projectId: string, crId: string)` | `unknown` |
| `resolve` | `resolve(projectId: string, crId: string, dto: ResolveChangeRequestDto, resolvedById: string | null)` | `unknown` |
| `close` | `close(projectId: string, crId: string)` | `unknown` |
| `markOpen` | `markOpen(crId: string, data: {
      baseCommit: string | null;
      headCommit: string;
      files?: CrCommittedFile[];
      diffCache?: CrDiff | null;
    })` | `unknown` |
| `markFailed` | `markFailed(crId: string, error: string)` | `unknown` |
| `reclaimMerging` | `reclaimMerging(crId: string)` | `Promise<boolean>` |
| `markMerged` | `markMerged(crId: string)` | `Promise<boolean>` |
| `abortMergeWithConflicts` | `abortMergeWithConflicts(crId: string, conflictState: CrConflictState, error: string)` | `unknown` |
| `markMergeFailed` | `markMergeFailed(crId: string, error: string)` | `unknown` |
| `recordRefresh` | `recordRefresh(crId: string, diffCache: CrDiff, conflictState: CrConflictState | null)` | `unknown` |
| `recordRestage` | `recordRestage(crId: string, data: {
      baseCommit: string | null;
      headCommit: string;
      diffCache: CrDiff;
      conflictState: CrConflictState | null;
    })` | `unknown` |

## Diagram

```mermaid
sequenceDiagram
  participant Client
  participant API as ChangeRequestService
  participant DB as Database
  participant Queue as Job Queue
  participant Worker as CrWorker
  participant Git as Git Repository

  Client->>API: open(proposed content)
  API->>DB: Create DocsChangeRequest(status: "draft")
  API->>Queue: Enqueue cr-open job(requestId)
  API-->>Client: Return draft change request

  Worker->>Queue: Consume cr-open job
  Worker->>DB: Load draft request
  Worker->>Git: Create branch cr/<id> and stage content

  alt Branch creation succeeds
    Worker->>API: markOpen(requestId)
    API->>DB: Update status to "open"
  else Branch creation fails
    Worker->>API: markFailed(requestId, error)
    API->>DB: Update status to "failed"
  end
```

## Usage

```ts
import { ChangeRequestService } from './change-request.service';

@Injectable()
export class DocsController {
  constructor(
    private readonly changeRequestService: ChangeRequestService,
  ) {}

  @Post('change-requests')
  async createChangeRequest(
    @Body() body: {
      documentId: string;
      title: string;
      proposedContent: string;
      authorId: string;
    },
  ) {
    // Persists a draft row and queues the worker job.
    // Git branch creation happens asynchronously on the worker.
    return this.changeRequestService.open({
      documentId: body.documentId,
      title: body.title,
      proposedContent: body.proposedContent,
      authorId: body.authorId,
    });
  }
}
```

## AI Coding Instructions

- Keep API-side operations limited to database persistence and queue dispatch; do not add direct Git repository access to this service.
- Create new requests in the `draft` state before enqueueing the `cr-open` job so the worker has durable proposed content to process.
- Use `markOpen` only after the worker successfully creates and stages the `cr/<id>` branch.
- Use `markFailed` to persist worker errors and make failures visible to callers rather than leaving requests in `draft`.
- Preserve the worker/API boundary: the Git repository is mounted on the worker through an RWO PVC and is not available to API pods.

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `docscrqueue`

<!-- source: interface-checkpointbackend.md -->

# CheckpointBackend

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/checkpoint-backend.ts` (line 25)

<!-- source: class-committerworker.md -->

# CommitterWorker

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/docs-repo/committer.worker.ts` (line 21)

CommitterWorker — the single, gated consumer of the 'docs-repo' queue.

Only spins up where DOCS_REPO_WORKER==='true' (a dedicated 1-replica deployment); api pods
enqueue-only. Concurrency 1 per project is enforced by the FAIL-CLOSED commit lock, not by
BullMQ groups: a job takes the per-project lock, drains that project's outbox, writes a
single coalesced commit (DB-wins rebuild), then marks the drained rows processed. If the
lock is held (another commit in flight) or Redis is down (fail-closed), the job is re-delayed
rather than committing.

**Implements:** `OnModuleInit`, `OnModuleDestroy`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `void` |
| `commitUnderLock` | `commitUnderLock(projectId: string)` | `Promise<string | null>` |
| `commitProject` | `commitProject(projectId: string)` | `Promise<string | null>` |
| `onModuleDestroy` | `onModuleDestroy()` | `Promise<void>` |

<!-- source: interface-controllerentity-2.md -->

# ControllerEntity

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 873)

Controller entity

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.CONTROLLER` |
| `basePath` | `string` |
| `guards` | `string[]` |
| `interceptors` | `string[]` |
| `endpoints` | `string[]` |
| `dependencies` | `DependencyInfo[]` |

<!-- source: function-controlormeta.md -->

# controlOrMeta

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/detectMac.ts` (line 14)

Returns true if the user is pressing the control key on Windows or the meta key on Mac.

## Signature

```ts
function controlOrMeta(metaKey: boolean, ctrlKey: boolean): boolean
```

## Parameters

| Name | Type |
|---|---|
| `metaKey` | `boolean` |
| `ctrlKey` | `boolean` |

**Returns:** `boolean`

<!-- source: function-cosinesimilarity.md -->

# cosineSimilarity

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/vector-store.ts` (line 32)

Compute cosine similarity between two vectors.
Returns 0 if either vector is zero-length or they differ in dimensionality.

## Signature

```ts
function cosineSimilarity(a: number[], b: number[]): number
```

## Parameters

| Name | Type |
|---|---|
| `a` | `number[]` |
| `b` | `number[]` |

**Returns:** `number`

<!-- source: interface-crdiffsection.md -->

# CrDiffSection

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/cr-shared.ts` (line 23)

## Properties

| Property | Type |
|---|---|
| `heading` | `string` |
| `level` | `number` |
| `changed` | `boolean` |

<!-- source: function-createcopywriteragent.md -->

# createCopywriterAgent

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/agents/copywriter.agent.ts` (line 20)

## Signature

```ts
function createCopywriterAgent(config: GenerationConfig, deps: CopywriterDependencies): AgentConfig<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |
| `deps` | `CopywriterDependencies` |

**Returns:** `AgentConfig<PmeContext>`

<!-- source: function-detectngrxreducers.md -->

# detectNgRxReducers

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ngrx-pattern-detector.ts` (line 297)

Detect NgRx reducers from code

## Signature

```ts
function detectNgRxReducers(content: string): NgRxReducerPattern[]
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |

**Returns:** `NgRxReducerPattern[]`

<!-- source: constant-docs-cr-queue.md -->

# DOCS_CR_QUEUE

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/change-request/docs-cr-queue.service.ts` (line 14)

<!-- source: controller-docversioncontroller.md -->

# DocVersionController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 35)

## Relationships

- MODULE_DECLARES → `list`
- MODULE_DECLARES → `getActive`
- MODULE_DECLARES → `compareVersions`
- MODULE_DECLARES → `diffDocument`
- MODULE_DECLARES → `applyEdit`
- MODULE_DECLARES → `listPendingApprovals`
- MODULE_DECLARES → `get`
- MODULE_DECLARES → `create`
- MODULE_DECLARES → `update`
- MODULE_DECLARES → `activate`
- MODULE_DECLARES → `publish`
- MODULE_DECLARES → `archive`
- MODULE_DECLARES → `deprecate`
- MODULE_DECLARES → `delete`
- MODULE_DECLARES → `getReview`
- MODULE_DECLARES → `resolve`
- MODULE_DECLARES → `resolveAll`
- MODULE_DECLARES → `getScreenshots`
- MODULE_DECLARES → `bulkScreenshotAction`
- MODULE_DECLARES → `previewScreenshot`
- MODULE_DECLARES → `captureScreenshot`
- MODULE_DECLARES → `uploadScreenshot`
- MODULE_DECLARES → `updatePlaceholder`
- MODULE_DECLARES → `getChangelog`
- MODULE_DECLARES → `cherryPick`
- MODULE_DECLARES → `exportMarkdown`
- MODULE_DECLARES → `exportHTML`
- MODULE_DECLARES → `exportPDF`
- MODULE_DECLARES → `getAccess`
- MODULE_DECLARES → `updateAccess`
- MODULE_DECLARES → `requestApproval`
- MODULE_DECLARES → `approve`
- MODULE_DECLARES → `reject`
- MODULE_DECLARES → `getApproval`
- DEPENDS_ON → `docversionservice`
- DEPENDS_ON → `versioncarryforwardservice`
- DEPENDS_ON → `versiondiffservice`
- DEPENDS_ON → `changelogservice`
- DEPENDS_ON → `docversionexportservice`

<!-- source: type-entitytier.md -->

# EntityTier

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 163)

Entity tiers control how much context is included in AI prompts.
This is how we manage the 32K token limit.

TIER_1: User-facing code -> FULL source code included
        Examples: Controllers, React components, Pages
        Why: These define what users can do

TIER_2: Business logic -> Only signatures + JSDoc
        Examples: Services, Utilities, Helpers
        Why: Implementation details aren't needed for user docs

TIER_3: Data structures -> Names only
        Examples: Types, Interfaces, DTOs
        Why: Users don't care about data shapes

TIER_4: Infrastructure -> EXCLUDED completely
        Examples: Tests, Configs, Migrations
        Why: Not relevant to user documentation

## Definition

```ts
'TIER_1' | 'TIER_2' | 'TIER_3' | 'TIER_4'
```

<!-- source: function-formatduration.md -->

# formatDuration

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/formatters.ts` (line 13)

## Signature

```ts
function formatDuration(seconds: number | null | undefined): string
```

## Parameters

| Name | Type |
|---|---|
| `seconds` | `number | null | undefined` |

**Returns:** `string`

<!-- source: module-githubappmodule.md -->

# GithubAppModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/github-app/github-app.module.ts` (line 7)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `forwardref`
- MODULE_DECLARES → `githubappcontroller`
- MODULE_PROVIDES → `githubappservice`
- MODULE_EXPORTS → `githubappservice`

<!-- source: component-howitworkshorizontal.md -->

# HowItWorksHorizontal

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/how-it-works/how-it-works-horizontal.tsx` (line 16)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `labelKey` | `string` | - | - |
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `steps` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_HowItWorksHorizontal_4c471783["HowItWorksHorizontal"]
    class component_HowItWorksHorizontal_4c471783 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-span`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `StepIndicator`
- USES_HOOK → `useTranslation`

<!-- source: class-instructionloader.md -->

# InstructionLoader

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/context/instruction-loader.ts` (line 99)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `addPersistent` | `addPersistent(layer: InstructionLayer)` | `void` |
| `removePersistent` | `removePersistent(id: string)` | `void` |
| `addTurn` | `addTurn(layer: InstructionLayer)` | `void` |
| `getInstructions` | `getInstructions(_context: RunContext<TContext>)` | `string` |
| `createDynamicInstructions` | `createDynamicInstructions()` | `(context: RunContext<TContext>) => string` |
| `addConditional` | `addConditional(layer: ConditionalLayer)` | `void` |
| `removeConditional` | `removeConditional(id: string)` | `void` |
| `setActiveTools` | `setActiveTools(toolNames: string[])` | `void` |
| `hasActiveTool` | `hasActiveTool(name: string)` | `boolean` |
| `addToZone` | `addToZone(zone: InstructionZone, layer: Omit<InstructionLayer, 'priority'>, offset: undefined)` | `void` |
| `discover` | `discover(rootDir: string, options: DiscoveryOptions)` | `DiscoveredInstruction[]` |
| `loadFromDirectory` | `loadFromDirectory(rootDir: string, options: DiscoveryOptions)` | `DiscoveredInstruction[]` |

<!-- source: function-isbot.md -->

# isBot

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/analytics/utils/tracking-utils.ts` (line 20)

Returns true if the given user-agent string looks like a bot/crawler/automation tool.
Empty strings are treated as bots — a real browser always sends a UA.

## Signature

```ts
function isBot(userAgent: string | null | undefined): boolean
```

## Parameters

| Name | Type |
|---|---|
| `userAgent` | `string | null | undefined` |

**Returns:** `boolean`

<!-- source: function-isvisible.md -->

# isVisible

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 54)

Check if an element is visible

## Signature

```ts
async function isVisible(page: Page, selector: string): Promise<boolean>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |
| `selector` | `string` |

**Returns:** `Promise<boolean>`

<!-- source: interface-methoddefinition.md -->

# MethodDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 767)

Method definition

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `returnType` | `string` |
| `parameters` | `ParameterDefinition[]` |
| `isAsync` | `boolean` |
| `description` | `string` |
| `decorators` | `string[]` |

<!-- source: constant-position-step.md -->

# POSITION_STEP

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/components/Boards/helpers.ts` (line 47)

<!-- source: interface-pricingtiercardprops.md -->

# PricingTierCardProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/pricing-tier-card.tsx` (line 18)

## Properties

| Property | Type |
|---|---|
| `nameKey` | `string` |
| `priceKey` | `string` |
| `intervalKey` | `string` |
| `descriptionKey` | `string` |
| `features` | `PricingFeature[]` |
| `ctaKey` | `string` |
| `ctaUrl` | `string` |
| `highlighted` | `boolean` |
| `badgeKey` | `string` |

<!-- source: interface-qaresult.md -->

# QaResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/tools/visual-qa.tool.ts` (line 30)

## Properties

| Property | Type |
|---|---|
| `screenshots` | `QaScreenshot[]` |
| `renderTimeMs` | `number` |

<!-- source: class-searchindexgenerator.md -->

# SearchIndexGenerator

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/search-index.generator.ts` (line 81)

Search index generator

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generate` | `generate(entities: Entity[], version: string, options: SearchIndexOptions)` | `SearchIndex` |
| `generateJSON` | `generateJSON(index: SearchIndex, pretty: undefined)` | `string` |
| `search` | `search(index: SearchIndex, query: string, limit: undefined)` | `SearchIndexEntry[]` |

<!-- source: function-synccommand.md -->

# syncCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/sync.command.ts` (line 29)

Sync command handler
Reads existing documentation output and syncs to API

## Signature

```ts
async function syncCommand(options: SyncOptions): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `SyncOptions` |

**Returns:** `Promise<void>`

<!-- source: class-takeauthenticatedscreenshotdto.md -->

# TakeAuthenticatedScreenshotDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.controller.ts` (line 91)

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `capturedBy` | `string` |
| `auth` | `AuthConfigDto` |
| `viewport` | `{ width: number; height: number }` |
| `fullPage` | `boolean` |
| `waitForSelector` | `string` |
| `browser` | `'chromium' | 'firefox' | 'webkit'` |

<!-- source: component-timelinedot-2.md -->

# TimelineDot

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/social-proof/social-proof-timeline.tsx` (line 37)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `variant` | `unknown | unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TimelineDot_50dd9318["TimelineDot"]
    class component_TimelineDot_50dd9318 rootComponent
```

## Referenced By

- `SocialProofTimeline` (RENDERS)

<!-- source: type-toolpreexecutionhook.md -->

# ToolPreExecutionHook

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 397)

Called BEFORE a tool executes. Can block execution entirely and return
an error/guidance message instead — the tool never runs.

This enables hard tool blocking (e.g., plan mode) where write tools
are genuinely prevented from executing, matching Claude Code's behavior.

Return `undefined` or `null` to allow execution.
Return a string to BLOCK execution and use that string as the tool output.

## Definition

```ts
(
  toolName: string,
  toolInput: string,
) => string | null | undefined | Promise<string | null | undefined>
```

<!-- source: service-verifierservice.md -->

# VerifierService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/verifier.service.ts` (line 1)

<!-- source: constant-angular-template-patterns.md -->

# ANGULAR_TEMPLATE_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/angular.patterns.ts` (line 54)

<!-- source: interface-apiresponse-2.md -->

# APIResponse

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/ResponsePanel.ts` (line 8)

## Properties

| Property | Type |
|---|---|
| `status` | `number` |
| `statusText` | `string` |
| `headers` | `Record<string, string>` |
| `body` | `any` |
| `time` | `number` |
| `size` | `number` |

<!-- source: interface-awarenessstate-2.md -->

# AwarenessState

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/collaboration/interfaces/collaboration.interfaces.ts` (line 19)

Awareness state for a user's cursor and selection

## Properties

| Property | Type |
|---|---|
| `userId` | `string` |
| `userName` | `string` |
| `color` | `string` |
| `cursor` | `CursorPosition` |
| `selection` | `SelectionRange` |

<!-- source: component-boardlistcard.md -->

# BoardListCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/boards/page.tsx` (line 302)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `board` | `BoardSummary` | ✓ | - |
| `onSettings` | `Function` | ✓ | - |
| `onDuplicate` | `Function` | ✓ | - |
| `onDelete` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_BoardListCard_35986edf["BoardListCard"]
    class component_BoardListCard_35986edf rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `EllipsisHorizontalIcon`
- RENDERS → `MenuItem`
- RENDERS → `Cog6ToothIcon`
- RENDERS → `DocumentDuplicateIcon`
- RENDERS → `TrashIcon`
- USES_HOOK → `useState`

## Referenced By

- `BoardsIndexContent` (RENDERS)

<!-- source: api-endpoint-bulkmove.md -->

# bulkMove

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 827)

## Endpoint

`POST /documents/bulk/move`

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: service-chatratelimitguard.md -->

# ChatRateLimitGuard

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/support-agent/chat-rate-limit.guard.ts` (line 11)

Phase 7: In-memory rate limiter for public chat endpoints.

Three independent limits:
 - Per IP:           10 messages / minute
 - Per project:    1000 messages / hour
 - Per session:      50 messages total (TTL: 24 h)

`ChatRateLimitGuard` is a NestJS guard that enforces in-memory rate limits for public chat endpoints to prevent abuse and protect backend resources. It applies three independent limits—per IP (10/min), per project (1000/hour), and per session (50 total with a 24h TTL)—and blocks requests that exceed any threshold.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `canActivate` | `canActivate(context: ExecutionContext)` | `boolean` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant C as Client
  participant G as ChatRateLimitGuard
  participant R as In-memory Rate Store
  participant H as Controller/Handler

  C->>G: HTTP request (public chat endpoint)
  G->>R: Increment/check counters (IP, project, session)
  alt Any limit exceeded
    R-->>G: Reject (rate limit hit)
    G-->>C: 429 Too Many Requests
  else Within limits
    R-->>G: Allow
    G->>H: canActivate() passes
    H-->>C: Normal response
  end
```

## Usage

```ts
import { Controller, Post, UseGuards, Body } from '@nestjs/common';
import { ChatRateLimitGuard } from './chat-rate-limit.guard';

@Controller('public/chat')
@UseGuards(ChatRateLimitGuard)
export class PublicChatController {
  @Post('message')
  async sendMessage(
    @Body() body: { projectId: string; sessionId: string; message: string },
  ) {
    // If any rate limit is exceeded, the guard will block before reaching here.
    return { ok: true };
  }
}
```

## AI Coding Instructions

- Keep limits independent: evaluate IP, project, and session constraints separately and fail fast if any one is exceeded.
- Ensure stable identifiers: extract IP (respecting proxy setup), projectId, and sessionId consistently; mismatched keys will silently weaken or over-tighten limits.
- Remember this is in-memory: it resets on process restart and does not coordinate across multiple instances; avoid assuming global enforcement in distributed deployments.
- Session limit is total with TTL: do not accidentally implement it as “per window” like the IP/project limits; preserve the 24h TTL semantics.
- When integrating new endpoints, apply the guard only to public-facing chat routes and ensure required identifiers (projectId/sessionId) are present before the guard runs.

<!-- source: class-checkpointerror.md -->

# CheckpointError

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/errors.ts` (line 150)

Error thrown when checkpoint save/load fails

**Extends:** `PipelineError`

## Properties

| Property | Type |
|---|---|
| `checkpointId` | `string` |
| `operation` | `'save' | 'load'` |

<!-- source: interface-checkpointmanagerconfig.md -->

# CheckpointManagerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/checkpoint-manager.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `maxSnapshotsPerFile` | `number` |
| `maxTotalSnapshots` | `number` |
| `backend` | `CheckpointBackend` |

<!-- source: class-comparedocumentdto.md -->

# CompareDocumentDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/compare-document.dto.ts` (line 12)

DTO for comparing two versions or revisions of a document

## Properties

| Property | Type |
|---|---|
| `from` | `string` |
| `to` | `string` |
| `type` | `CompareType` |

<!-- source: function-convertspecstomappings.md -->

# convertSpecsToMappings

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/spec-to-mapping-converter.ts` (line 81)

Convert an array of ScreenshotSpecs into ScreenshotMappings.

## Signature

```ts
function convertSpecsToMappings(specs: ScreenshotSpec[]): ScreenshotMapping[]
```

## Parameters

| Name | Type |
|---|---|
| `specs` | `ScreenshotSpec[]` |

**Returns:** `ScreenshotMapping[]`

<!-- source: interface-coveragecolorscheme.md -->

# CoverageColorScheme

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/state-machine-diagram.generator.ts` (line 24)

Color scheme for coverage visualization

## Properties

| Property | Type |
|---|---|
| `covered` | `string` |
| `partial` | `string` |
| `uncovered` | `string` |
| `unknown` | `string` |

<!-- source: function-createapplypatchtool.md -->

# createApplyPatchTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/apply-patch.tool.ts` (line 654)

Create an `apply_patch` tool definition.

This tool accepts a patch in the Codex `apply_patch` format and applies
it to the filesystem. It supports creating, updating, and deleting files
in a single patch, with fuzzy context matching for reliable hunk application.

## Signature

```ts
function createApplyPatchTool(options: ApplyPatchOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `ApplyPatchOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: interface-createconfigdto.md -->

# CreateConfigDto

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationConfig.ts` (line 58)

DTO for creating config

## Properties

| Property | Type |
|---|---|
| `repositoryUrl` | `string` |
| `repositoryBranch` | `string` |
| `frontendPath` | `string` |
| `backendPath` | `string` |
| `siteUrl` | `string` |
| `siteLoginUrl` | `string` |
| `siteEmail` | `string` |
| `sitePassword` | `string` |
| `repoUsername` | `string` |
| `repoPassword` | `string` |
| `skeletonStructure` | `SkeletonStructure` |
| `targetAudience` | `string` |
| `autoPublish` | `boolean` |

<!-- source: function-createfindscreenshotstool.md -->

# createFindScreenshotsTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/find-screenshots.tool.ts` (line 26)

## Signature

```ts
function createFindScreenshotsTool(findFn: FindScreenshotsFn): ToolDefinition<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `findFn` | `FindScreenshotsFn` |

**Returns:** `ToolDefinition<PmeContext>`

<!-- source: function-detectngrxselectors.md -->

# detectNgRxSelectors

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ngrx-pattern-detector.ts` (line 415)

Detect NgRx selectors from code

## Signature

```ts
function detectNgRxSelectors(content: string): NgRxSelectorPattern[]
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |

**Returns:** `NgRxSelectorPattern[]`

<!-- source: constant-docs-repo-queue.md -->

# DOCS_REPO_QUEUE

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/docs-repo/docs-repo-queue.service.ts` (line 11)

<!-- source: type-entitytype.md -->

# EntityType

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 165)

## Definition

```ts
| 'CLASS'
  | 'FUNCTION'
  | 'COMPONENT' // React/Vue/Angular component
  | 'CONTROLLER' // API endpoint handler
  | 'SERVICE'
  | 'INTERFACE'
  | 'TYPE'
  | 'ENUM'
  | 'CONSTANT'
  | 'HOOK' // React hook
  | 'MIDDLEWARE'
  | 'MODULE'
```

<!-- source: controller-eventscontroller.md -->

# EventsController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/events/events.controller.ts` (line 15)

Public event-ingest endpoint for browser surfaces (docs viewer, chat widget). Anonymous
allowed (public docs visitors give feedback too); userId is attached when authenticated.
Throttled — it's an append-only signal sink, not an API.

`EventsController` exposes a public, anonymous-friendly event ingestion endpoint used by browser surfaces like the docs viewer and chat widget. It accepts append-only telemetry/feedback signals, attaching a `userId` when the caller is authenticated, and is intentionally throttled because it is a signal sink rather than a general-purpose API. It routes incoming event payloads into the backend event pipeline/storage without exposing read/query capabilities.

## Diagram

```mermaid
graph LR
  A[Browser Surface<br/>Docs Viewer / Chat Widget] -->|POST /events| B[EventsController]
  B -->|Apply throttling / validation| C[Events Service / Ingestion Pipeline]
  C --> D[(Event Store / Queue)]
  B -->|If authenticated| E[Auth Context]
  E -->|Attach userId| C
```

## Usage

```ts
// Browser-side: send an event from docs viewer / chat widget.
// This endpoint is designed to be callable without auth (anonymous),
// but if you include credentials (cookie/JWT), the backend may attach userId.

type PublicEventPayload = {
  name: string;                 // e.g. "docs_feedback_submitted"
  source: "docs" | "chat";
  timestamp?: string;           // ISO string; optional if server sets
  metadata?: Record<string, any>;
};

async function ingestEvent(payload: PublicEventPayload) {
  const res = await fetch("https://api.example.com/events", {
    method: "POST",
    headers: { "content-type": "application/json" },
    // If your app uses cookies for auth, keep credentials enabled.
    credentials: "include",
    body: JSON.stringify(payload),
  });

  if (!res.ok) {
    // Because this endpoint is throttled, 429 is a common response during bursts.
    // Your UI should treat failures as non-blocking.
    const text = await res.text().catch(() => "");
    throw new Error(`Event ingest failed (${res.status}): ${text}`);
  }

  // Often returns a simple ack; treat as fire-and-forget.
  return res.json().catch(() => ({}));
}

// Example calls
ingestEvent({
  name: "docs_page_viewed",
  source: "docs",
  metadata: { path: "/getting-started", referrer: document.referrer },
});

ingestEvent({
  name: "chat_widget_opened",
  source: "chat",
  metadata: { location: window.location.href },
});
```

## AI Coding Instructions

- Keep this controller **write-only / append-only**: do not add read/query endpoints here; route analytics reads through a separate, secured API.
- Preserve **anonymous access** while enriching events opportunistically: attach `userId` only when an authenticated context is present; never require auth for basic ingest.
- Maintain and test **throttling behavior** (429 responses are expected); client-side usage should be best-effort and non-blocking.
- Validate and sanitize incoming payloads defensively (size limits, allowed fields) to avoid turning the endpoint into a general data dump surface.
- Integrate with the existing ingestion pipeline/service rather than adding persistence logic inside the controller; keep controller thin and side-effect routing centralized.

## Relationships

- MODULE_DECLARES → `record`
- DEPENDS_ON → `eventsservice`
- DEPENDS_ON → `prismaservice`

<!-- source: function-formatnumber.md -->

# formatNumber

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/formatters.ts` (line 6)

Number / duration / percent formatters shared across all chart primitives.
Kept tiny on purpose — no Intl.NumberFormat instances created on every render.

## Signature

```ts
function formatNumber(value: number | null | undefined): string
```

## Parameters

| Name | Type |
|---|---|
| `value` | `number | null | undefined` |

**Returns:** `string`

<!-- source: module-githubmodule.md -->

# GitHubModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/github/github.module.ts` (line 10)

## Relationships

- MODULE_IMPORTS → `configmodule`
- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_DECLARES → `githubcontroller`
- MODULE_PROVIDES → `githubservice`
- MODULE_EXPORTS → `githubservice`

<!-- source: component-howitworkstimeline.md -->

# HowItWorksTimeline

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/how-it-works/how-it-works-timeline.tsx` (line 59)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `steps` | `Step[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_HowItWorksTimeline_61216c09["HowItWorksTimeline"]
    class component_HowItWorksTimeline_61216c09 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `StepCircle`
- RENDERS → `StepCard`
- USES_HOOK → `useTranslation`

<!-- source: function-isprivateip.md -->

# isPrivateIp

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/ssrf.ts` (line 12)

Private/link-local/loopback ranges — IPv4, IPv6 and IPv4-mapped IPv6.

## Signature

```ts
function isPrivateIp(addr: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `addr` | `string` |

**Returns:** `boolean`

<!-- source: class-jsonstore.md -->

# JsonStore

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/memory/json-store.ts` (line 33)

**Implements:** `MemoryStore`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `save` | `save(record: MemoryRecord)` | `void` |
| `load` | `load(id: string)` | `MemoryRecord | null` |
| `query` | `query(query: MemoryQuery)` | `MemoryRecord[]` |
| `delete` | `delete(id: string)` | `boolean` |
| `getAll` | `getAll(projectId: string)` | `MemoryRecord[]` |
| `count` | `count(projectId: string)` | `number` |
| `touch` | `touch(id: string)` | `void` |

<!-- source: function-measuretimetointeractive.md -->

# measureTimeToInteractive

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/performance.ts` (line 224)

Measure time to interactive

## Signature

```ts
async function measureTimeToInteractive(page: Page): Promise<number>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |

**Returns:** `Promise<number>`

<!-- source: interface-moduleentity.md -->

# ModuleEntity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 812)

Module entity (NestJS, Angular)

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.MODULE` |
| `imports` | `string[]` |
| `controllers` | `string[]` |
| `providers` | `string[]` |
| `exports` | `string[]` |
| `isGlobal` | `boolean` |

<!-- source: constant-priority-cfg.md -->

# PRIORITY_CFG

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 125)

## Definition

```ts
Record<string, { stripe: string; label: string; bg: string; text: string }>
```

<!-- source: interface-problemsplitvisualprops.md -->

# ProblemSplitVisualProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/problem/problem-split-visual.tsx` (line 19)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `problems` | `Problem[]` |
| `imageSrc` | `string` |
| `imageAlt` | `string` |
| `imagePosition` | `'start' | 'end'` |

<!-- source: interface-qascreenshot.md -->

# QaScreenshot

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/tools/visual-qa.tool.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `viewport` | `string` |
| `width` | `number` |
| `height` | `number` |
| `screenshotBase64` | `string` |

<!-- source: class-sequelizeparser-2.md -->

# SequelizeParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/database/sequelize.parser.ts` (line 32)

Sequelize Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: class-takebatchscreenshotsdto.md -->

# TakeBatchScreenshotsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 617)

Main batch screenshot request DTO

Combines all configuration for a batch screenshot job:
- Multi-tenancy identifiers (projectId, organizationId, capturedBy)
- Optional batch metadata (name, description)
- Optional authentication configuration
- Required screenshots array (minimum 1 item)
- Optional batch configuration

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `organizationId` | `string` |
| `capturedBy` | `string` |
| `name` | `string` |
| `description` | `string` |
| `auth` | `BatchAuthConfigDto` |
| `screenshots` | `BatchScreenshotItemDto[]` |
| `config` | `BatchConfigDto` |
| `runDiscovery` | `boolean` |
| `discoverySiteUrl` | `string` |

<!-- source: type-toolverificationhook.md -->

# ToolVerificationHook

**Kind:** Type

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 377)

Called after a tool executes. Can block the tool output from reaching the
model and inject corrective feedback instead.

Inspired by Claude Code's hooks system (exit code 2 = block + correct).

Return `null` to pass through normally.
Return a string to REPLACE the tool output with corrective feedback.

## Definition

```ts
(
  toolName: string,
  toolInput: string,
  toolOutput: string,
) => string | null | Promise<string | null>
```

<!-- source: function-triggercommand.md -->

# triggerCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/trigger.command.ts` (line 26)

## Signature

```ts
async function triggerCommand(options: TriggerOptions): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `TriggerOptions` |

**Returns:** `Promise<void>`

<!-- source: service-workercapturerservice.md -->

# WorkerCapturerService

**Kind:** Service

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/worker-capturer.service.ts` (line 1)

<!-- source: component-youtubebutton.md -->

# YouTubeButton

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/directives.tsx` (line 64)

## Diagram

```mermaid
graph TD
    component_YouTubeButton_62e9bfd4["YouTubeButton"]
    class component_YouTubeButton_62e9bfd4 rootComponent
```

## Relationships

- RENDERS → `DialogButton`
- USES_HOOK → `usePublisher`

## Referenced By

- `Youtube` (RENDERS)

<!-- source: component-accordionitem-3.md -->

# AccordionItem

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/accordion-item.tsx` (line 19)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `questionKey` | `string` | ✓ | - |
| `answerKey` | `string` | ✓ | - |
| `defaultOpen` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_AccordionItem_5fc5ba74["AccordionItem"]
    class component_AccordionItem_5fc5ba74 rootComponent
```

## Relationships

- RENDERS → `ChevronDown`
- RENDERS → `AnimatePresence`
- RENDERS → `motion-div`
- USES_HOOK → `useTranslation`
- USES_HOOK → `useState`

<!-- source: constant-antd-component-patterns.md -->

# ANTD_COMPONENT_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/antd.patterns.ts` (line 11)

Ant Design Pattern Detection

Patterns for detecting Ant Design components, forms, and tables.

<!-- source: interface-applicationprofile.md -->

# ApplicationProfile

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-05-synthesis/synthesizer.service.ts` (line 33)

## Properties

| Property | Type |
|---|---|
| `domain` | `string` |
| `moduleAreas` | `string[]` |
| `description` | `string` |

<!-- source: interface-awarenessupdatedata.md -->

# AwarenessUpdateData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/collaboration/interfaces/collaboration.interfaces.ts` (line 67)

Awareness update payload

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `awarenessUpdate` | `Uint8Array` |

<!-- source: component-boardpagecontent.md -->

# BoardPageContent

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/boards/[boardId]/page.tsx` (line 61)

## Diagram

```mermaid
graph TD
    component_BoardPageContent_62371551["BoardPageContent"]
    class component_BoardPageContent_62371551 rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `ArrowLeftIcon`
- RENDERS → `BoardFiltersButton`
- RENDERS → `PlusIcon`
- RENDERS → `Cog6ToothIcon`
- RENDERS → `ArrowPathIcon`
- RENDERS → `ActiveFilterChips`
- RENDERS → `BoardView`
- RENDERS → `BoardSettingsDialog`
- RENDERS → `AddIssuesToBoardDialog`
- RENDERS → `ColumnEditor`
- USES_HOOK → `useParams`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useMemo`
- USES_HOOK → `useCallback`

## Referenced By

- `BoardPage` (RENDERS)

<!-- source: api-endpoint-bulkpublish.md -->

# bulkPublish

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 886)

## Endpoint

`POST /documents/bulk/publish`

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: class-checkpointservice.md -->

# CheckpointService

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/pipeline/checkpoint.ts` (line 27)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `save` | `save(jobState: JobState, stageData: Record<string, unknown>)` | `Promise<string>` |
| `load` | `load(jobId: string)` | `Promise<CheckpointData | null>` |
| `exists` | `exists(jobId: string)` | `Promise<boolean>` |
| `delete` | `delete(jobId: string)` | `Promise<void>` |
| `startAutoSave` | `startAutoSave(getState: () => { jobState: JobState; stageData: Record<string, unknown> })` | `void` |
| `stopAutoSave` | `stopAutoSave()` | `void` |
| `listJobs` | `listJobs()` | `Promise<string[]>` |
| `getHistory` | `getHistory(jobId: string)` | `Promise<{ path: string; timestamp: Date }[]>` |

<!-- source: interface-circledetectionresult.md -->

# CircleDetectionResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/circle-detector.ts` (line 53)

## Properties

| Property | Type |
|---|---|
| `confidence` | `number` |
| `isStuck` | `boolean` |
| `message` | `string` |
| `signals` | `CircleSignal[]` |

<!-- source: service-codeanalysisservice.md -->

# CodeAnalysisService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/ai/services/code-analysis.service.ts` (line 28)

Code Analysis Service using optimized file context

Implements Claude Code & Cursor style optimizations:
- Lazy loading of files
- Token budget management
- Relevance-based file selection
- Chunked reading for large codebases

`CodeAnalysisService` is a NestJS service that analyzes source code using an optimized “file context” approach similar to Claude Code/Cursor. It lazily loads and chunks files, manages an explicit token budget, and selects the most relevant files to include in the analysis context. This service typically sits behind API endpoints or other AI orchestration services to prepare high-signal code context for LLM prompts.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `analyzeCodebase` | `analyzeCodebase(options: {
    baseDir: string;
    patterns: string[];
    query: string;
    tokenBudget?: number;
    keywords?: string[];
    provider?: string;
  })` | `Promise<CodeAnalysisResult>` |
| `analyzeFiles` | `analyzeFiles(options: {
    files: Array<{ path: string; lines?: [number, number] }>;
    query: string;
    provider?: string;
  })` | `Promise<CodeAnalysisResult>` |
| `streamCodebaseAnalysis` | `streamCodebaseAnalysis(options: {
    baseDir: string;
    patterns: string[];
    query: string;
    tokenBudget?: number;
    keywords?: string[];
    provider?: string;
  })` | `AsyncIterableIterator<string>` |
| `getCacheStats` | `getCacheStats()` | `unknown` |
| `clearCache` | `clearCache(filePath: string)` | `unknown` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant Caller as API/Orchestrator
  participant CAS as CodeAnalysisService
  participant FS as File System/Repo
  participant TB as Token Budget Manager
  participant RS as Relevance Selector
  participant CH as Chunk Reader

  Caller->>CAS: analyze(query, repoRoot, options)
  CAS->>RS: rankCandidateFiles(query, repoIndex)
  RS-->>CAS: relevantFiles[]
  CAS->>TB: init(budget, model)
  TB-->>CAS: remainingTokens

  loop for each relevant file (until budget exhausted)
    CAS->>FS: stat/read metadata (lazy)
    FS-->>CAS: size/mtime
    alt small file
      CAS->>FS: readFile(path)
      FS-->>CAS: content
    else large file
      CAS->>CH: readChunks(path, chunkSize)
      CH->>FS: stream/read ranges
      FS-->>CH: chunkContent
      CH-->>CAS: chunkContent
    end
    CAS->>TB: estimateTokens(content)
    TB-->>CAS: allow/trim/stop
  end

  CAS-->>Caller: analysisContext (selected files + excerpts)
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { CodeAnalysisService } from './ai/services/code-analysis.service';

@Injectable()
export class AiOrchestrationService {
  constructor(private readonly codeAnalysis: CodeAnalysisService) {}

  async buildPromptContext() {
    const repoRoot = process.cwd();
    const query = 'Find where authentication is enforced and how JWT is validated';

    // Options are illustrative; use the service’s actual option names/types.
    const context = await this.codeAnalysis.analyze(query, repoRoot, {
      tokenBudget: 12000,
      maxFiles: 20,
      chunkSize: 4000,
      includePatterns: ['apps/api/src/**'],
      excludePatterns: ['**/dist/**', '**/node_modules/**'],
    });

    // `context` can then be appended to an LLM prompt.
    return {
      system: 'You are a codebase assistant.',
      user: `Question: ${query}\n\nCode Context:\n${context}`,
    };
  }
}
```

## AI Coding Instructions

- Preserve the optimization pipeline: relevance ranking → lazy loading → chunked reads → token-budget enforcement; avoid eager full-repo reads.
- When modifying file selection, ensure exclude/include patterns are applied before reading content to prevent wasted IO and token usage.
- Be careful with token estimation: always budget using the final text actually sent (post-trim/post-chunk) to avoid prompt overflow.
- Integration point: return a deterministic, ordered context (stable sorting/ranking) so repeated runs produce similar prompts and diff-friendly outputs.
- For large files, prefer excerpting relevant regions over adding more files; adding too many low-signal files is a common quality pitfall.

## Relationships

- DEPENDS_ON → `filecontextservice`
- DEPENDS_ON → `aiservice`

<!-- source: class-conversationmessagedto.md -->

# ConversationMessageDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/support-agent/dto/chat.dto.ts` (line 5)

## Properties

| Property | Type |
|---|---|
| `role` | `string` |
| `content` | `string` |

<!-- source: function-convertspecstomappingsflattened.md -->

# convertSpecsToMappingsFlattened

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/spec-to-mapping-converter.ts` (line 92)

Convert specs to mappings, flattening workflow sequences into individual
step mappings. Each step gets its own mapping with `parentPlaceholderId`
and `sequenceOrder` so the replacer can reassemble them.

## Signature

```ts
function convertSpecsToMappingsFlattened(specs: ScreenshotSpec[]): ScreenshotMapping[]
```

## Parameters

| Name | Type |
|---|---|
| `specs` | `ScreenshotSpec[]` |

**Returns:** `ScreenshotMapping[]`

<!-- source: interface-coveragereport.md -->

# CoverageReport

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/coverage-calculator.ts` (line 98)

Overall coverage report

## Properties

| Property | Type |
|---|---|
| `overallStateCoverage` | `number` |
| `overallTransitionCoverage` | `number` |
| `stateMachines` | `StateMachineCoverage[]` |
| `totalScreenshots` | `number` |
| `totalInteractions` | `number` |
| `recommendedScreenshotCount` | `number` |
| `recommendations` | `string[]` |
| `qualityScore` | `number` |

<!-- source: function-createbashtool.md -->

# createBashTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/bash.tool.ts` (line 84)

## Signature

```ts
function createBashTool(options: BashToolOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `BashToolOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: function-creategeneratecontenttool.md -->

# createGenerateContentTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/generate-content.tool.ts` (line 22)

## Signature

```ts
function createGenerateContentTool(generateFn: ContentGenerateFn): ToolDefinition<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `generateFn` | `ContentGenerateFn` |

**Returns:** `ToolDefinition<PmeContext>`

<!-- source: interface-createjobparams.md -->

# CreateJobParams

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/usePme.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `targetAudience` | `string` |
| `brandVoice` | `string` |
| `language` | `string` |
| `pageType` | `string` |
| `sections` | `string[]` |
| `model` | `string` |

<!-- source: function-detectpiniaactions.md -->

# detectPiniaActions

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/pinia-pattern-detector.ts` (line 389)

Detect Pinia actions from stores

## Signature

```ts
function detectPiniaActions(stores: PiniaStorePattern[]): PiniaActionPattern[]
```

## Parameters

| Name | Type |
|---|---|
| `stores` | `PiniaStorePattern[]` |

**Returns:** `PiniaActionPattern[]`

<!-- source: constant-enrich-credit-cost.md -->

# ENRICH_CREDIT_COST

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/billing/billing.constants.ts` (line 21)

<!-- source: type-errorcode.md -->

# ErrorCode

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 304)

## Definition

```ts
| 'PARSE_FAILED'
  | 'TOKEN_LIMIT_EXCEEDED'
  | 'AI_PROVIDER_ERROR'
  | 'CHECKPOINT_FAILED'
  | 'VERIFICATION_FAILED'
  | 'UPLOAD_FAILED'
  | 'TIMEOUT'
  | 'UNKNOWN'
```

<!-- source: function-formatpercent.md -->

# formatPercent

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/formatters.ts` (line 21)

## Signature

```ts
function formatPercent(value: number | null | undefined): string
```

## Parameters

| Name | Type |
|---|---|
| `value` | `number | null | undefined` |

**Returns:** `string`

<!-- source: controller-freshnesscontroller.md -->

# FreshnessController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/technical-docs/freshness.controller.ts` (line 14)

Owner "Docs freshness cockpit" — which published pages went stale when the project's
code changed (from technical_snapshots.staleInfo, written on every push by
TechnicalDocsService.checkStaleness). Org-scoped + member-gated, mirroring
ManualsInsightsController's authed surfaces. The public per-page reader badge lives
separately in ManualsInsightsController.freshness.

## Relationships

- MODULE_DECLARES → `stale`
- MODULE_DECLARES → `reshoot`
- DEPENDS_ON → `freshnessservice`

<!-- source: module-gitlabmodule.md -->

# GitLabModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/gitlab/gitlab.module.ts` (line 10)

## Relationships

- MODULE_IMPORTS → `configmodule`
- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_DECLARES → `gitlabcontroller`
- MODULE_PROVIDES → `gitlabservice`
- MODULE_EXPORTS → `gitlabservice`

<!-- source: function-isrtl.md -->

# isRtl

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/project/language.util.ts` (line 90)

True when the code is written right-to-left.

## Signature

```ts
function isRtl(code: string | null): boolean
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string | null` |

**Returns:** `boolean`

<!-- source: class-lastnobservationsprocessor.md -->

# LastNObservationsProcessor

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/context/history-processors.ts` (line 127)

Keeps the last N tool outputs in full detail.
Older ones are replaced with extractive summaries.

Directly extracted from the existing elideOldObservations() function
in autonomous-loop.ts — same logic, now composable.

SWE-agent default: n=5.

**Implements:** `HistoryProcessor`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `process` | `process(items: AgentInputItem[])` | `AgentInputItem[]` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |

<!-- source: function-mockapiresponse.md -->

# mockAPIResponse

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 165)

Intercept and mock API responses

## Signature

```ts
async function mockAPIResponse(page: Page, urlPattern: string | RegExp, response: {
    status?: number;
    body?: unknown;
    headers?: Record<string, string>;
  }): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |
| `urlPattern` | `string | RegExp` |
| `response` | `{
    status?: number;
    body?: unknown;
    headers?: Record<string, string>;
  }` |

**Returns:** `Promise<void>`

<!-- source: interface-neo4jconfig.md -->

# Neo4jConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/config.interface.ts` (line 46)

Neo4j configuration

## Properties

| Property | Type |
|---|---|
| `uri` | `string` |
| `user` | `string` |
| `password` | `string` |
| `database` | `string` |
| `maxConnectionPoolSize` | `number` |
| `connectionTimeout` | `number` |

<!-- source: component-pricingcolumns.md -->

# PricingColumns

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/pricing/pricing-columns.tsx` (line 27)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `labelKey` | `string` | - | - |
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `tiers` | `PricingTier[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PricingColumns_1eeb178a["PricingColumns"]
    class component_PricingColumns_1eeb178a rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-span`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `PricingTierCard`
- USES_HOOK → `useTranslation`

<!-- source: constant-priority-cfg-2.md -->

# PRIORITY_CFG

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/components/Boards/helpers.ts` (line 15)

## Definition

```ts
Record<
  string,
  { bg: string; text: string; label: string }
>
```

<!-- source: interface-productaudience.md -->

# ProductAudience

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 217)

A target audience defined for the project's documentation.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `documentCount` | `number` |

<!-- source: interface-resolvedtheme.md -->

# ResolvedTheme

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/tools/theme.ts` (line 31)

## Properties

| Property | Type |
|---|---|
| `mode` | `ThemeMode` |
| `vars` | `ThemeVars` |
| `fontFamily` | `string` |
| `primaryColor` | `string` |

<!-- source: class-takeresponsivescreenshotsdto.md -->

# TakeResponsiveScreenshotsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.controller.ts` (line 53)

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `capturedBy` | `string` |

<!-- source: class-typeormparser-2.md -->

# TypeORMParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/database/typeorm.parser.ts` (line 70)

TypeORM Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: function-validatecoveragecommand.md -->

# validateCoverageCommand

**Kind:** Function

**Source:** `atloria-monorepo/apps/cli/src/commands/validate-coverage.command.ts` (line 113)

Execute coverage validation

## Signature

```ts
async function validateCoverageCommand(options: ValidateCoverageOptions): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `ValidateCoverageOptions` |

**Returns:** `Promise<void>`

<!-- source: component-admonitions.md -->

# Admonitions

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/directives.tsx` (line 148)

## Diagram

```mermaid
graph TD
    component_Admonitions_21c8a80a["Admonitions"]
    class component_Admonitions_21c8a80a rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`

<!-- source: constant-antd-detection-config.md -->

# ANTD_DETECTION_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/antd.patterns.ts` (line 285)

## Definition

```ts
AntdDetectionConfig
```

<!-- source: interface-applicationprofile-2.md -->

# ApplicationProfile

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-06-structure/structure.service.ts` (line 31)

## Properties

| Property | Type |
|---|---|
| `domain` | `string` |
| `moduleAreas` | `string[]` |
| `description` | `string` |

<!-- source: component-boardsindexcontent.md -->

# BoardsIndexContent

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/boards/page.tsx` (line 70)

## Diagram

```mermaid
graph TD
    component_BoardsIndexContent_56ce5809["BoardsIndexContent"]
    class component_BoardsIndexContent_56ce5809 rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `ArrowLeftIcon`
- RENDERS → `IssuesViewTabs`
- RENDERS → `ViewColumnsIcon`
- RENDERS → `PlusIcon`
- RENDERS → `ArrowPathIcon`
- RENDERS → `BoardListCard`
- RENDERS → `CreateBoardDialog`
- RENDERS → `BoardSettingsDialog`
- RENDERS → `DeleteBoardDialog`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`
- USES_HOOK → `useMemo`

## Referenced By

- `BoardsIndexPage` (RENDERS)

<!-- source: interface-brandedemailoptions.md -->

# BrandedEmailOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/email/email-template.ts` (line 9)

Branded transactional-email layout — ONE look for every platform email.

Email-client-safe by construction: table layout, fully inline styles, solid
colors (no CSS vars/flex/grid), 600px column, bulletproof button. Callers pass
content; this owns the chrome (wordmark bar, card, footer).

## Properties

| Property | Type |
|---|---|
| `preheader` | `string` |
| `heading` | `string` |
| `bodyHtml` | `string` |
| `cta` | `{ label: string; url: string }` |
| `footerNote` | `string` |

<!-- source: api-endpoint-bulkscreenshotaction.md -->

# bulkScreenshotAction

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 310)

## Endpoint

`POST /doc-versions/:projectId/:versionId/screenshots/bulk`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: interface-circledetectoroptions.md -->

# CircleDetectorOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/circle-detector.ts` (line 16)

Circle/Loop Detector

Detects when an agent gets stuck in repetitive cycles:
editing the same files without progress, running the same
failing commands, or alternating between approaches.

Standalone class, consumed by AutonomousTurnHook.
Called every turn with O(windowSize) cost.

## Properties

| Property | Type |
|---|---|
| `windowSize` | `number` |
| `minTurnsBeforeDetection` | `number` |
| `signatureRepetitionThreshold` | `number` |
| `fileRepetitionThreshold` | `number` |
| `testStagnationCount` | `number` |

<!-- source: class-claudeprovider.md -->

# ClaudeProvider

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/claude.provider.ts` (line 205)

**Implements:** `AIProvider`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generate` | `generate(prompt: string, options: ClaudeGenerateOptions, stage: JobStage)` | `Promise<ClaudeResponse>` |
| `generateWithStreaming` | `generateWithStreaming(prompt: string, options: ClaudeGenerateOptions, stage: JobStage)` | `Promise<ClaudeResponse>` |
| `generateText` | `generateText(prompt: string, options: Omit<ClaudeGenerateOptions, 'messages'>, stage: JobStage)` | `Promise<string>` |
| `generateJSON` | `generateJSON(prompt: string, options: ClaudeGenerateOptions, stage: JobStage)` | `Promise<{ data: T; response: ClaudeResponse }>` |
| `generateWithStructuredOutput` | `generateWithStructuredOutput(options: {
    prompt: string;
    schema: object;
    model?: string;
    maxTokens?: number;
  })` | `Promise<{ content: T; usage: { inputTokens: number; outputTokens: number } }>` |
| `isAvailable` | `isAvailable()` | `Promise<boolean>` |
| `getThrottlingStatus` | `getThrottlingStatus()` | `{ consecutiveFailures: number; adaptiveDelayMs: number; lastFailureTime: number }` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |

<!-- source: service-collaborationmetricsservice.md -->

# CollaborationMetricsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/collaboration/collaboration-metrics.service.ts` (line 28)

Service for tracking and reporting collaboration metrics

`CollaborationMetricsService` tracks and reports collaboration-related metrics for the backend application. It centralizes metric collection, aggregation, and retrieval so collaboration features can expose consistent usage and activity insights without duplicating reporting logic.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `void` |
| `onModuleDestroy` | `onModuleDestroy()` | `void` |
| `recordMetrics` | `recordMetrics(documentId: string, metrics: Partial<Omit<CollaborationMetrics, 'documentId'>>)` | `Promise<void>` |
| `recordSyncLatency` | `recordSyncLatency(documentId: string, latencyMs: number)` | `Promise<void>` |
| `recordActiveSessions` | `recordActiveSessions(documentId: string, count: number)` | `Promise<void>` |
| `getMetrics` | `getMetrics(documentId: string)` | `Promise<CollaborationMetrics | null>` |
| `getActiveSessions` | `getActiveSessions(documentId: string)` | `Promise<number>` |
| `getSyncLatency` | `getSyncLatency(documentId: string)` | `Promise<number>` |
| `getP95SyncLatency` | `getP95SyncLatency(documentId: string)` | `Promise<number>` |
| `getTotalActiveSessions` | `getTotalActiveSessions()` | `Promise<number>` |
| `getGlobalAverageSyncLatency` | `getGlobalAverageSyncLatency()` | `Promise<number>` |
| `clearMetrics` | `clearMetrics(documentId: string)` | `Promise<void>` |
| `getMetricsSummary` | `getMetricsSummary()` | `Promise<{
    totalActiveDocuments: number;
    totalActiveSessions: number;
    averageSyncLatencyMs: number;
    documentsAboveLatencyThreshold: number;
  }>` |

## Diagram

```mermaid
sequenceDiagram
    participant Controller as Collaboration Controller
    participant Service as CollaborationMetricsService
    participant Repository as Metrics Repository
    participant Database as Database

    Controller->>Service: recordMetric(metricData)
    Service->>Repository: persist(metricData)
    Repository->>Database: INSERT metric record
    Database-->>Repository: saved record
    Repository-->>Service: persisted metric
    Service-->>Controller: metric recorded

    Controller->>Service: getMetrics(filters)
    Service->>Repository: aggregate(filters)
    Repository->>Database: Query and aggregate metrics
    Database-->>Repository: aggregated results
    Repository-->>Service: metrics report
    Service-->>Controller: metrics response
```

## AI Coding Instructions

- Inject `CollaborationMetricsService` through NestJS dependency injection rather than constructing it directly.
- Keep metric recording calls close to the collaboration action that produced the event, such as edits, comments, invitations, or presence updates.
- Use consistent metric names and payload fields so aggregation queries and dashboards remain reliable.
- Avoid blocking primary collaboration workflows on expensive reporting queries; record metrics asynchronously when the surrounding architecture supports it.
- Apply authorization and tenant/workspace filters before returning metric reports to prevent cross-organization data exposure.

## Relationships

- DEPENDS_ON → `redisservice`

<!-- source: function-convertspectomapping.md -->

# convertSpecToMapping

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/spec-to-mapping-converter.ts` (line 34)

Convert a single ScreenshotSpec into a ScreenshotMapping.

Translates captureType-specific metadata (modal, tab, form) into concrete
action sequences that the screenshot capturer can execute.

## Signature

```ts
function convertSpecToMapping(spec: ScreenshotSpec): ScreenshotMapping
```

## Parameters

| Name | Type |
|---|---|
| `spec` | `ScreenshotSpec` |

**Returns:** `ScreenshotMapping`

<!-- source: interface-coveragethresholds.md -->

# CoverageThresholds

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/coverage-validator.ts` (line 26)

Coverage validation thresholds

## Properties

| Property | Type |
|---|---|
| `minStateCoverage` | `number` |
| `minTransitionCoverage` | `number` |
| `minQualityScore` | `number` |
| `requireTerminalStatesCoverage` | `boolean` |
| `requireApprovalStatesCoverage` | `boolean` |

<!-- source: class-createactivitydto.md -->

# CreateActivityDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/activity/dto/create-activity.dto.ts` (line 3)

## Properties

| Property | Type |
|---|---|
| `organizationId` | `string` |
| `projectId` | `string` |
| `userId` | `string` |
| `actionType` | `string` |
| `entityType` | `string` |
| `entityId` | `string` |
| `metadata` | `Record<string, any>` |

<!-- source: function-createchunkid.md -->

# createChunkId

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/types.ts` (line 79)

Create a deterministic chunk ID from file path, start line, and content.
Returns first 12 hex chars of a SHA-256 hash.

## Signature

```ts
function createChunkId(file: string, startLine: number, content: string): string
```

## Parameters

| Name | Type |
|---|---|
| `file` | `string` |
| `startLine` | `number` |
| `content` | `string` |

**Returns:** `string`

<!-- source: function-creategenerateimagetool.md -->

# createGenerateImageTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/generate-image.tool.ts` (line 28)

## Signature

```ts
function createGenerateImageTool(generateFn: ImageGenerateFn): ToolDefinition<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `generateFn` | `ImageGenerateFn` |

**Returns:** `ToolDefinition<PmeContext>`

<!-- source: interface-cursorposition.md -->

# CursorPosition

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useCollaboration.ts` (line 32)

Cursor position in the document

## Properties

| Property | Type |
|---|---|
| `index` | `number` |
| `length` | `number` |

<!-- source: function-detectpiniagetters.md -->

# detectPiniaGetters

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/pinia-pattern-detector.ts` (line 446)

Detect Pinia getters from stores

## Signature

```ts
function detectPiniaGetters(stores: PiniaStorePattern[]): PiniaGetterPattern[]
```

## Parameters

| Name | Type |
|---|---|
| `stores` | `PiniaStorePattern[]` |

**Returns:** `PiniaGetterPattern[]`

<!-- source: type-errorinterceptor.md -->

# ErrorInterceptor

**Kind:** Type

**Source:** `atloria-monorepo/packages/api-client/src/types/config.ts` (line 120)

## Definition

```ts
(error: Error) => Error | Promise<Error>
```

<!-- source: constant-event-types.md -->

# EVENT_TYPES

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/events/events.service.ts` (line 9)

Foundation F2: ONE append-only interaction-event stream. Chat feedback, escalations,
answered/refused signals, page feedback and search misses all land here — the deflection
dashboard, admin cockpit and "thin page" insights are just queries over this table.

<!-- source: function-formatrelativetime.md -->

# formatRelativeTime

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/uiStrings.ts` (line 602)

Localized relative time ("3 hours ago" / "قبل ٣ ساعات").
Uses Intl.RelativeTimeFormat so ANY documentation language gets correct
plural/dual forms for free; <60s uses the catalog's "just now".

## Signature

```ts
function formatRelativeTime(input: string | Date, lang: string | null): string
```

## Parameters

| Name | Type |
|---|---|
| `input` | `string | Date` |
| `lang` | `string | null` |

**Returns:** `string`

<!-- source: controller-githubappcontroller.md -->

# GithubAppController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/github-app/github-app.controller.ts` (line 13)

GitHub App webhook receiver (Foundation F1). Handles installation lifecycle (the install
registry) and push events (delegates to the existing push pipeline: staleness fan-out +
optional auto-regen trigger). Verified by the APP's HMAC secret — one secret for all
customers, unlike per-project manual webhooks.

`GithubAppController` is the NestJS webhook receiver for the Atloria GitHub App (Foundation F1). It verifies incoming webhook requests using the GitHub App HMAC secret, manages the installation lifecycle via the install registry, and handles `push` events by delegating into the existing push pipeline (staleness fan-out and optional auto-regeneration triggers). This centralizes webhook handling under a single shared secret (per app) instead of per-project manual webhook secrets.

## Diagram

```mermaid
graph LR
  GH[GitHub App Webhooks] -->|HTTP POST + HMAC signature| C[GithubAppController]
  C --> V[HMAC Verification]
  V -->|invalid| R401[Reject 401/403]
  V -->|valid| D{Event type}
  D -->|installation / lifecycle| IR[Install Registry]
  D -->|push| PP[Push Pipeline]
  PP --> SF[Staleness Fan-out]
  PP --> AR[Optional Auto-Regen Trigger]
  IR --> OK[200 OK]
  AR --> OK
  SF --> OK
```

## Usage

```ts
import { Controller, Post, Headers, Body, Req, Res } from '@nestjs/common';
import type { Request, Response } from 'express';

// This shows how GithubAppController is typically used: it's mounted as a NestJS controller
// and receives GitHub App webhook POSTs. The verification + routing is handled inside.
@Controller('/github-app')
export class GithubAppController {
  @Post('/webhook')
  async webhook(
    @Headers('x-github-event') event: string,
    @Headers('x-hub-signature-256') signature: string,
    @Body() payload: any,
    @Req() req: Request,
    @Res() res: Response,
  ) {
    // Internally (in the real implementation):
    // 1) Verify signature using the GitHub App webhook secret
    // 2) If installation event: update install registry
    // 3) If push event: delegate to push pipeline (staleness fan-out, optional auto-regen)
    // 4) Return 2xx quickly to GitHub
    return res.status(200).send({ ok: true, event });
  }
}

// Example HTTP call (for local testing) using fetch:
async function sendTestWebhook() {
  await fetch('http://localhost:3000/github-app/webhook', {
    method: 'POST',
    headers: {
      'content-type': 'application/json',
      'x-github-event': 'push',
      // In real GitHub delivery this is computed HMAC SHA-256 of the raw request body:
      'x-hub-signature-256': 'sha256=...',
    },
    body: JSON.stringify({ ref: 'refs/heads/main', repository: { full_name: 'acme/repo' } }),
  });
}
```

## AI Coding Instructions

- Preserve **raw request body** access for HMAC validation; don’t JSON-transform/pretty-print before computing the signature or verification will fail.
- Keep webhook handlers **fast and idempotent**: acknowledge GitHub with 2xx quickly and push heavy work into the existing push pipeline/queues.
- Route by GitHub headers (`x-github-event`, delivery id) and ensure installation lifecycle events update the **install registry** consistently (handle install, uninstall, suspend/unsuspend).
- Treat the webhook secret as **app-wide** (not per project); avoid introducing per-customer secret branching unless the architecture changes explicitly.
- When adding new event types, follow the existing delegation pattern: controller validates + normalizes → service/pipeline performs domain work (staleness fan-out, auto-regen, etc.).

## Relationships

- MODULE_DECLARES → `handle`
- DEPENDS_ON → `githubappservice`
- DEPENDS_ON → `webhookservice`
- DEPENDS_ON → `docsprtrigger`

<!-- source: module-graphmodule.md -->

# GraphModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/graph/graph.module.ts` (line 17)

## Relationships

- MODULE_IMPORTS → `configmodule`
- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `aimodule`
- MODULE_DECLARES → `graphcontroller`
- MODULE_DECLARES → `kgsynccontroller`
- MODULE_PROVIDES → `neo4jservice`
- MODULE_PROVIDES → `knowledgegraphservice`
- MODULE_PROVIDES → `kgsyncservice`
- MODULE_PROVIDES → `entityextractorservice`
- MODULE_PROVIDES → `flowdetectorservice`
- MODULE_PROVIDES → `workflowdiscoveryservice`
- MODULE_PROVIDES → `workflowstorageservice`
- MODULE_EXPORTS → `neo4jservice`
- MODULE_EXPORTS → `knowledgegraphservice`
- MODULE_EXPORTS → `kgsyncservice`
- MODULE_EXPORTS → `entityextractorservice`
- MODULE_EXPORTS → `flowdetectorservice`
- MODULE_EXPORTS → `workflowdiscoveryservice`
- MODULE_EXPORTS → `workflowstorageservice`

<!-- source: function-issensitivefield.md -->

# isSensitiveField

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/capture/capture.redact.ts` (line 34)

True when the target element (by role/selector) implies a secret input.

## Signature

```ts
function isSensitiveField(hint: string | null): boolean
```

## Parameters

| Name | Type |
|---|---|
| `hint` | `string | null` |

**Returns:** `boolean`

<!-- source: class-linttestloop.md -->

# LintTestLoop

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/lint-test-loop.ts` (line 50)

Tracks edit-then-verify cycles and generates appropriate nudges.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `recordEdit` | `recordEdit(filePath: string)` | `void` |
| `recordVerification` | `recordVerification(passed: boolean, turnNumber: number)` | `void` |
| `getNudge` | `getNudge()` | `string | null` |
| `getState` | `getState()` | `Readonly<LintTestState>` |
| `reset` | `reset()` | `void` |
| `isEditTool` | `isEditTool(toolName: string)` | `boolean` |
| `isVerificationCommand` | `isVerificationCommand(command: string)` | `boolean` |

<!-- source: interface-orchestratorconfig.md -->

# OrchestratorConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/config.interface.ts` (line 183)

Parser orchestration configuration

## Properties

| Property | Type |
|---|---|
| `defaultParsers` | `string[]` |
| `maxConcurrency` | `number` |
| `jobTimeout` | `number` |
| `autoSyncToKG` | `boolean` |
| `kgSyncBatchSize` | `number` |

<!-- source: component-pricingcomparisontable.md -->

# PricingComparisonTable

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/pricing/pricing-comparison-table.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `plans` | `unknown[]` | ✓ | - |
| `features` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PricingComparisonTable_54b4f697["PricingComparisonTable"]
    class component_PricingComparisonTable_54b4f697 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `motion-table`
- RENDERS → `ComparisonRow`
- USES_HOOK → `useTranslation`

<!-- source: interface-productcategory.md -->

# ProductCategory

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 180)

A document category from the generated documentation tree.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `icon` | `string` |
| `documentCount` | `number` |
| `parentId` | `string` |
| `children` | `ProductCategory[]` |

<!-- source: constant-publicapi.md -->

# publicApi

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/lib/public-api.ts` (line 31)

<!-- source: function-retry.md -->

# retry

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 240)

Retry an action until it succeeds or times out

## Signature

```ts
async function retry(action: () => Promise<T>, options: {
    maxAttempts?: number;
    delayMs?: number;
    timeout?: number;
  }): Promise<T>
```

## Parameters

| Name | Type |
|---|---|
| `action` | `() => Promise<T>` |
| `options` | `{
    maxAttempts?: number;
    delayMs?: number;
    timeout?: number;
  }` |

**Returns:** `Promise<T>`

<!-- source: interface-screenshotinfo-2.md -->

# ScreenshotInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 160)

Screenshot info from the existing Screenshot model.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `url` | `string` |
| `title` | `string` |
| `description` | `string` |
| `assetUrl` | `string` |
| `width` | `number` |
| `height` | `number` |
| `viewport` | `string` |
| `featureArea` | `string` |
| `pageType` | `string` |
| `semanticTags` | `string[]` |

<!-- source: class-takescreenshotdto.md -->

# TakeScreenshotDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.controller.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `capturedBy` | `string` |
| `viewport` | `{ width: number; height: number }` |
| `fullPage` | `boolean` |
| `waitForSelector` | `string` |
| `stateType` | `'default' | 'hover' | 'modal' | 'error' | 'success' | 'loading'` |
| `flowStepId` | `string` |
| `browser` | `'chromium' | 'firefox' | 'webkit'` |

<!-- source: class-typescriptsymbolparser.md -->

# TypeScriptSymbolParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/backend/typescript-symbol.parser.ts` (line 40)

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: component-admonitionswithcodeblocks.md -->

# AdmonitionsWithCodeBlocks

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/directives.tsx` (line 190)

## Diagram

```mermaid
graph TD
    component_AdmonitionsWithCodeBlocks_321ab331["AdmonitionsWithCodeBlocks"]
    class component_AdmonitionsWithCodeBlocks_321ab331 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: constant-antd-form-patterns.md -->

# ANTD_FORM_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/antd.patterns.ts` (line 179)

<!-- source: interface-applicationsummary.md -->

# ApplicationSummary

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-05.types.ts` (line 40)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `purpose` | `string` |
| `description` | `string` |
| `targetUsers` | `string[]` |
| `keyBenefits` | `string[]` |

<!-- source: component-branchpickermodal.md -->

# BranchPickerModal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/scenes/SceneProjectDetails.tsx` (line 547)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `provider` | `unknown | unknown | unknown` | ✓ | - |
| `owner` | `string` | ✓ | - |
| `repo` | `string` | ✓ | - |
| `repoUrl` | `string` | ✓ | - |
| `currentBranch` | `string` | ✓ | - |
| `repoUsername` | `string` | - | - |
| `accessToken` | `string` | - | - |
| `onSelect` | `Function` | ✓ | - |
| `onClose` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_BranchPickerModal_72a5444f["BranchPickerModal"]
    class component_BranchPickerModal_72a5444f rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-svg`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useMemo`

## Referenced By

- `SceneProjectDetails` (RENDERS)

<!-- source: interface-bulkoperationresult.md -->

# BulkOperationResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/dto/bulk-operations.dto.ts` (line 99)

Result of bulk operation

## Properties

| Property | Type |
|---|---|
| `success` | `number` |
| `failed` | `number` |
| `errors` | `Array<{
    documentId: string;
    error: string;
  }>` |

<!-- source: api-endpoint-bulkupdate.md -->

# bulkUpdate

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/issues.controller.ts` (line 75)

## Endpoint

`PATCH /projects/:projectId/issues/bulk`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `IssuesController` (MODULE_DECLARES)

<!-- source: interface-circlesignal.md -->

# CircleSignal

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/circle-detector.ts` (line 64)

## Properties

| Property | Type |
|---|---|
| `type` | `'action_repetition' | 'file_repetition' | 'test_stagnation' |
        'error_repetition' | 'oscillation'` |
| `weight` | `number` |
| `detail` | `string` |

<!-- source: class-codeblocknode.md -->

# CodeBlockNode

**Kind:** Class

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/CodeBlockNode.tsx` (line 47)

**Extends:** `DecoratorNode`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getType` | `getType()` | `string` |
| `clone` | `clone(node: CodeBlockNode)` | `CodeBlockNode` |
| `importJSON` | `importJSON(serializedNode: SerializedCodeBlockNode)` | `CodeBlockNode` |
| `importDOM` | `importDOM()` | `DOMConversionMap` |
| `exportJSON` | `exportJSON()` | `SerializedCodeBlockNode` |
| `createDOM` | `createDOM(_config: EditorConfig)` | `HTMLDivElement` |
| `updateDOM` | `updateDOM()` | `false` |
| `getCode` | `getCode()` | `string` |
| `getMeta` | `getMeta()` | `string` |
| `getLanguage` | `getLanguage()` | `string` |
| `decorate` | `decorate(editor: LexicalEditor)` | `JSX.Element` |
| `isInline` | `isInline()` | `boolean` |

## Properties

| Property | Type |
|---|---|
| `__code` | `string` |
| `__meta` | `string` |
| `__language` | `string` |
| `__focusEmitter` | `any` |
| `setCode` | `any` |
| `setMeta` | `any` |
| `setLanguage` | `any` |
| `select` | `any` |

<!-- source: service-collaborationservice.md -->

# CollaborationService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/collaboration/collaboration.service.ts` (line 39)

Service for managing collaboration sessions and document persistence

`CollaborationService` manages real-time collaboration sessions and persists shared document state for the API. It coordinates session lifecycle operations, document updates, and storage integration so connected clients can collaborate on a consistent document version.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `verifyDocumentAccess` | `verifyDocumentAccess(documentId: string, userId: string)` | `Promise<boolean>` |
| `getDocumentContent` | `getDocumentContent(documentId: string)` | `Promise<string | null>` |
| `getCurrentVersion` | `getCurrentVersion(documentId: string)` | `Promise<number>` |
| `getNextVersion` | `getNextVersion(documentId: string)` | `Promise<number>` |
| `saveDocumentState` | `saveDocumentState(documentId: string, content: string, userId: string)` | `Promise<SaveDocumentResult>` |
| `appendPendingUpdate` | `appendPendingUpdate(documentId: string, update: Uint8Array)` | `Promise<void>` |
| `loadRecoveryState` | `loadRecoveryState(documentId: string)` | `Promise<{ snapshot: Uint8Array | null; updates: Uint8Array[] }>` |
| `persistSnapshot` | `persistSnapshot(documentId: string, state: Uint8Array, coveredUpdateCount: number)` | `Promise<void>` |
| `getPendingUpdateCount` | `getPendingUpdateCount(documentId: string)` | `Promise<number>` |
| `clearRecoveryState` | `clearRecoveryState(documentId: string)` | `Promise<void>` |
| `createSession` | `createSession(documentId: string, userId: string)` | `Promise<void>` |
| `endSession` | `endSession(documentId: string, userId: string)` | `Promise<void>` |
| `updateSessionActivity` | `updateSessionActivity(documentId: string, userId: string)` | `Promise<void>` |
| `getActiveUsers` | `getActiveUsers(documentId: string)` | `Promise<CollaborationUser[]>` |
| `getSessionCount` | `getSessionCount(documentId: string)` | `Promise<number>` |
| `updateCursorPosition` | `updateCursorPosition(documentId: string, userId: string, cursorPosition: number, selectionStart: number, selectionEnd: number)` | `Promise<void>` |

## Diagram

```mermaid
sequenceDiagram
  participant Client
  participant Controller
  participant Service as CollaborationService
  participant Session as Collaboration Session
  participant Storage as Document Persistence

  Client->>Controller: Join or update collaboration document
  Controller->>Service: create/join session or apply update
  Service->>Session: Resolve active session state
  Session-->>Service: Current document state
  Service->>Storage: Persist document changes
  Storage-->>Service: Saved document/version
  Service-->>Controller: Updated collaboration state
  Controller-->>Client: Return state or broadcast update
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { CollaborationService } from './collaboration.service';

@Injectable()
export class DocumentWorkflowService {
  constructor(
    private readonly collaborationService: CollaborationService,
  ) {}

  async updateDocument(
    documentId: string,
    userId: string,
    update: Uint8Array,
  ) {
    // Use the collaboration service as the single entry point for
    // session-aware document updates and persistence.
    return this.collaborationService.applyUpdate(
      documentId,
      userId,
      update,
    );
  }
}
```

## AI Coding Instructions

- Keep collaboration state changes inside `CollaborationService`; controllers and gateways should delegate session and persistence logic to this service.
- Persist document updates through the established storage integration rather than mutating in-memory session state only.
- Treat updates as concurrent: preserve the service's synchronization/versioning patterns when adding new write operations.
- Ensure session cleanup occurs when clients disconnect or sessions become inactive to prevent stale in-memory state.
- Validate document and user access before joining sessions or applying updates, using the existing authentication and authorization integration points.

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `redisservice`
- DEPENDS_ON → `outboxservice`

<!-- source: function-core.md -->

# core

**Kind:** Function

**Source:** `atloria-monorepo/packages/core/src/lib/core.ts` (line 1)

## Signature

```ts
function core(): string
```

**Returns:** `string`

<!-- source: interface-crawledcompetitorpage.md -->

# CrawledCompetitorPage

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/competitor.interface.ts` (line 13)

## Properties

| Property | Type |
|---|---|
| `competitor` | `string` |
| `url` | `string` |
| `title` | `string` |
| `content` | `string` |
| `textLength` | `number` |
| `crawledAt` | `Date` |

<!-- source: class-createaudiencedto.md -->

# CreateAudienceDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/audience/dto/create-audience.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `color` | `string` |
| `icon` | `string` |
| `description` | `string` |

<!-- source: function-createcodeanalysistool.md -->

# createCodeAnalysisTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/code-analysis.tool.ts` (line 53)

## Signature

```ts
function createCodeAnalysisTool(options: CodeAnalysisOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `CodeAnalysisOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: function-createhtmlqualityguardrail.md -->

# createHtmlQualityGuardrail

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/guardrails/html-quality.guardrail.ts` (line 118)

## Signature

```ts
function createHtmlQualityGuardrail(config: HtmlQualityConfig): OutputGuardrailDefinition
```

## Parameters

| Name | Type |
|---|---|
| `config` | `HtmlQualityConfig` |

**Returns:** `OutputGuardrailDefinition`

<!-- source: interface-customdomainview.md -->

# CustomDomainView

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/lib/api-client.ts` (line 58)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `domain` | `string` |
| `status` | `DomainStatus` |
| `records` | `DnsRecordSpec[]` |
| `lastError` | `string | null` |
| `lastCheckedAt` | `string | null` |
| `verifiedAt` | `string | null` |
| `createdAt` | `string` |

<!-- source: function-detectpiniastores.md -->

# detectPiniaStores

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/pinia-pattern-detector.ts` (line 122)

Detect Pinia stores from code

## Signature

```ts
function detectPiniaStores(content: string): PiniaStorePattern[]
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |

**Returns:** `PiniaStorePattern[]`

<!-- source: type-explorermode.md -->

# ExplorerMode

**Kind:** Type

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/APIExplorer.ts` (line 61)

## Definition

```ts
'documentation' | 'playground'
```

<!-- source: constant-faqtemplate.md -->

# faqTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/faq.template.ts` (line 3)

<!-- source: function-formatshortdate.md -->

# formatShortDate

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/formatters.ts` (line 55)

Format a YYYY-MM-DD date string as a short month/day label for chart axes.
Uses UTC parsing to avoid the local-timezone day boundary surprise.

## Signature

```ts
function formatShortDate(isoDay: string): string
```

## Parameters

| Name | Type |
|---|---|
| `isoDay` | `string` |

**Returns:** `string`

<!-- source: controller-githubcontroller.md -->

# GitHubController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/github/github.controller.ts` (line 10)

## Relationships

- MODULE_DECLARES → `getAuthUrl`
- MODULE_DECLARES → `handleCallback`
- MODULE_DECLARES → `getStatus`
- MODULE_DECLARES → `listRepos`
- MODULE_DECLARES → `listBranches`
- MODULE_DECLARES → `disconnect`
- DEPENDS_ON → `githubservice`

<!-- source: module-invitationmodule.md -->

# InvitationModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/invitation/invitation.module.ts` (line 10)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `emailmodule`
- MODULE_IMPORTS → `configmodule`
- MODULE_DECLARES → `invitationcontroller`
- MODULE_PROVIDES → `invitationservice`
- MODULE_EXPORTS → `invitationservice`

<!-- source: function-issensitivevalue.md -->

# isSensitiveValue

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/capture/capture.redact.ts` (line 28)

True when a value looks like a secret and must never be stored.

## Signature

```ts
function isSensitiveValue(value: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `value` | `string` |

**Returns:** `boolean`

<!-- source: class-livesweloop.md -->

# LiveSweLoop

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/live-swe-loop.ts` (line 85)

**Implements:** `IAgentLoop`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `run` | `run(config: AgentConfig<TContext>, input: string | AgentInputItem[], options: RunOptions<TContext>)` | `Promise<RunResult>` |
| `runStreamed` | `runStreamed(config: AgentConfig<TContext>, input: string | AgentInputItem[], options: RunOptions<TContext>)` | `Promise<StreamedRunHandle>` |

<!-- source: interface-parameterdefinition.md -->

# ParameterDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 493)

Parameter definition (path, query, header)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `required` | `boolean` |
| `description` | `string` |
| `example` | `unknown` |
| `defaultValue` | `unknown` |

<!-- source: component-pricingherocard.md -->

# PricingHeroCard

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/pricing/pricing-hero-card.tsx` (line 34)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `heroPlan` | `PricingPlan` | ✓ | - |
| `secondaryPlans` | `PricingPlan[]` | - | - |

## Diagram

```mermaid
graph TD
    component_PricingHeroCard_40302ff7["PricingHeroCard"]
    class component_PricingHeroCard_40302ff7 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `Check`
- RENDERS → `ArrowRight`
- USES_HOOK → `useTranslation`

<!-- source: interface-productdocument.md -->

# ProductDocument

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 192)

A document from the generated user documentation.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `slug` | `string` |
| `content` | `string` |
| `category` | `string` |
| `documentType` | `string` |
| `audience` | `string` |
| `difficulty` | `string` |
| `keywords` | `string[]` |

<!-- source: constant-revalidate.md -->

# revalidate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/api/stats/route.ts` (line 3)

<!-- source: function-runaccessibilitycheck.md -->

# runAccessibilityCheck

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/accessibility.ts` (line 39)

Run accessibility check on a page

## Signature

```ts
async function runAccessibilityCheck(page: Page, options: {
    level?: WCAGLevel;
    include?: string[];
    exclude?: string[];
    disabledRules?: string[];
  }): Promise<AccessibilityResult>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |
| `options` | `{
    level?: WCAGLevel;
    include?: string[];
    exclude?: string[];
    disabledRules?: string[];
  }` |

**Returns:** `Promise<AccessibilityResult>`

<!-- source: interface-sectioncontent.md -->

# SectionContent

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 100)

## Properties

| Property | Type |
|---|---|
| `type` | `SectionType` |
| `layout` | `string` |
| `content` | `Record<string, unknown>` |
| `html` | `string` |

<!-- source: class-takesmartauthenticatedscreenshotdto.md -->

# TakeSmartAuthenticatedScreenshotDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/screenshot.controller.ts` (line 141)

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `capturedBy` | `string` |
| `auth` | `SmartAuthConfigDto` |
| `viewport` | `{ width: number; height: number }` |
| `fullPage` | `boolean` |
| `waitForSelector` | `string` |
| `browser` | `'chromium' | 'firefox' | 'webkit'` |

<!-- source: class-versiondiffgenerator.md -->

# VersionDiffGenerator

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/version-diff.generator.ts` (line 34)

Version Diff Generator

## Methods

| Method | Signature | Returns |
|---|---|---|
| `compare` | `compare(oldEntities: Entity[], newEntities: Entity[], fromVersion: string, toVersion: string, options: VersionDiffOptions)` | `VersionDiff` |
| `generateReport` | `generateReport(diff: VersionDiff, options: VersionDiffOptions)` | `string` |
| `generateChangelog` | `generateChangelog(diff: VersionDiff)` | `string` |

<!-- source: constant-antd-hooks-patterns.md -->

# ANTD_HOOKS_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/antd.patterns.ts` (line 230)

<!-- source: component-app.md -->

# App

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/controlled-mode.tsx` (line 14)

## Diagram

```mermaid
graph TD
    component_App_7b96f1d2["App"]
    class component_App_7b96f1d2 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `BoldItalicUnderlineToggles`
- RENDERS → `ListsToggle`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `Fragment`
- USES_HOOK → `useState`

<!-- source: interface-approvalcategory.md -->

# ApprovalCategory

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 86)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `subcategories` | `ApprovalSubcategory[]` |
| `canDelete` | `boolean` |

<!-- source: component-brandingproviderwrapper.md -->

# BrandingProviderWrapper

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/PublicLayoutShell.tsx` (line 247)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_BrandingProviderWrapper_36c4b574["BrandingProviderWrapper"]
    class component_BrandingProviderWrapper_36c4b574 rootComponent
```

## Relationships

- RENDERS → `BrandingProvider`
- USES_HOOK → `usePathname`

## Referenced By

- `PublicLayoutShell` (RENDERS)

<!-- source: api-endpoint-bulkupdatevisibility.md -->

# bulkUpdateVisibility

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 857)

## Endpoint

`POST /documents/bulk/visibility`

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: interface-bundlesweepresult.md -->

# BundleSweepResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/bundle.service.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `bundled` | `number` |
| `bytes` | `number` |
| `failures` | `number` |

<!-- source: interface-codeanalysisoptions.md -->

# CodeAnalysisOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/code-analysis.tool.ts` (line 20)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `maxFileSize` | `number` |
| `tsconfigPath` | `string` |

<!-- source: class-commentendpoints.md -->

# CommentEndpoints

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/comments.ts` (line 22)

Comment endpoints

## Methods

| Method | Signature | Returns |
|---|---|---|
| `list` | `list(documentId: string, params: Omit<CommentListParams, 'documentId'>)` | `Promise<CommentWithUser[]>` |
| `get` | `get(commentId: string)` | `Promise<CommentWithUser>` |
| `create` | `create(documentId: string, dto: CreateCommentDto)` | `Promise<CommentWithUser>` |
| `update` | `update(commentId: string, dto: UpdateCommentDto)` | `Promise<CommentWithUser>` |
| `delete` | `delete(commentId: string)` | `Promise<void>` |
| `resolve` | `resolve(commentId: string)` | `Promise<CommentWithUser>` |
| `unresolve` | `unresolve(commentId: string)` | `Promise<CommentWithUser>` |
| `reply` | `reply(parentCommentId: string, dto: Omit<CreateCommentDto, 'parentCommentId'>)` | `Promise<CommentWithUser>` |
| `getReplies` | `getReplies(parentCommentId: string)` | `Promise<CommentWithUser[]>` |

<!-- source: service-commentservice.md -->

# CommentService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/comment/comment.service.ts` (line 14)

Service for managing document comments with threading,

## Methods

| Method | Signature | Returns |
|---|---|---|
| `create` | `create(documentId: string, dto: CreateCommentDto, user: JwtPayload)` | `unknown` |
| `list` | `list(documentId: string, filters: CommentFiltersDto)` | `unknown` |
| `update` | `update(id: string, dto: UpdateCommentDto, user: JwtPayload)` | `unknown` |
| `delete` | `delete(id: string, user: JwtPayload, isAdmin: unknown)` | `unknown` |
| `resolve` | `resolve(id: string, user: JwtPayload)` | `unknown` |
| `unresolve` | `unresolve(id: string, user: JwtPayload)` | `unknown` |
| `addReply` | `addReply(commentId: string, dto: CreateReplyDto, user: JwtPayload)` | `unknown` |
| `getById` | `getById(id: string)` | `unknown` |
| `extractMentions` | `extractMentions(content: string)` | `string[]` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `documentgateway`
- DEPENDS_ON → `activityservice`
- DEPENDS_ON → `notificationservice`

<!-- source: function-countselectors.md -->

# countSelectors

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 168)

Count total selectors in an ExtractedSelectors object

## Signature

```ts
function countSelectors(selectors: ExtractedSelectors): number
```

## Parameters

| Name | Type |
|---|---|
| `selectors` | `ExtractedSelectors` |

**Returns:** `number`

<!-- source: interface-crawledpage-2.md -->

# CrawledPage

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/web-crawler.ts` (line 10)

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `title` | `string` |
| `content` | `string` |
| `textLength` | `number` |
| `crawledAt` | `Date` |

<!-- source: class-createboarddto.md -->

# CreateBoardDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/boards/dto/create-board.dto.ts` (line 5)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `color` | `string` |
| `templateColumns` | `BoardTemplate` |
| `seedFromIssues` | `boolean` |
| `duplicateFromBoardId` | `string` |
| `includeCards` | `boolean` |

<!-- source: function-createcoordinationtool.md -->

# createCoordinationTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/coordination.tool.ts` (line 16)

## Signature

```ts
function createCoordinationTool(options: CoordinationToolOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `CoordinationToolOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: function-createimagequalityguardrail.md -->

# createImageQualityGuardrail

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/guardrails/image-quality.guardrail.ts` (line 111)

## Signature

```ts
function createImageQualityGuardrail(config: ImageQualityConfig): OutputGuardrailDefinition
```

## Parameters

| Name | Type |
|---|---|
| `config` | `ImageQualityConfig` |

**Returns:** `OutputGuardrailDefinition`

<!-- source: interface-dashboardlayoutprops.md -->

# DashboardLayoutProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Layout/DashboardLayout.tsx` (line 15)

Props for DashboardLayout

## Properties

| Property | Type |
|---|---|
| `children` | `ReactNode` |

<!-- source: function-detectreduxactions.md -->

# detectReduxActions

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/redux-pattern-detector.ts` (line 122)

Detect Redux actions from code

## Signature

```ts
function detectReduxActions(content: string): ReduxActionPattern[]
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |

**Returns:** `ReduxActionPattern[]`

<!-- source: type-explorermode-2.md -->

# ExplorerMode

**Kind:** Type

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/EndpointDetail.ts` (line 62)

## Definition

```ts
'documentation' | 'playground'
```

<!-- source: constant-featuredocumentationtemplate.md -->

# featureDocumentationTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/feature-documentation.template.ts` (line 3)

<!-- source: function-gaptokens.md -->

# gapTokens

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/copilotUtils.ts` (line 95)

Case-insensitive tokens, length ≥ 3, stopwords removed, deduped.

## Signature

```ts
function gapTokens(text: string): string[]
```

## Parameters

| Name | Type |
|---|---|
| `text` | `string` |

**Returns:** `string[]`

<!-- source: controller-gitlabcontroller.md -->

# GitLabController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/gitlab/gitlab.controller.ts` (line 10)

## Relationships

- MODULE_DECLARES → `getAuthUrl`
- MODULE_DECLARES → `handleCallback`
- MODULE_DECLARES → `getStatus`
- MODULE_DECLARES → `listRepos`
- MODULE_DECLARES → `listBranches`
- MODULE_DECLARES → `disconnect`
- DEPENDS_ON → `gitlabservice`

<!-- source: module-issuesmodule.md -->

# IssuesModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/issues/issues.module.ts` (line 13)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `emailmodule`
- MODULE_IMPORTS → `eventsmodule`
- MODULE_DECLARES → `issuescontroller`
- MODULE_DECLARES → `publicissuescontroller`
- MODULE_DECLARES → `deskcontroller`
- MODULE_PROVIDES → `issuesservice`
- MODULE_PROVIDES → `deskservice`
- MODULE_EXPORTS → `issuesservice`

<!-- source: function-lookupcountry.md -->

# lookupCountry

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/analytics/utils/tracking-utils.ts` (line 176)

Resolve a client IP to a 2-letter ISO country code using the bundled
MaxMind GeoLite2 database (via `geoip-lite`). This is the same approach
Umami, Plausible, and Matomo all use for server-side geolocation.

Returns null for:
  - localhost / private IPs (127.*, 10.*, 192.168.*, etc.)
  - IPs not found in the database
  - malformed inputs

The GeoLite2 database is loaded into RAM once at startup (~2MB). All
subsequent lookups are pure memory reads — sub-microsecond latency.

## Signature

```ts
function lookupCountry(ip: string | null): string | null
```

## Parameters

| Name | Type |
|---|---|
| `ip` | `string | null` |

**Returns:** `string | null`

<!-- source: class-mcpclient.md -->

# McpClient

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/mcp/mcp-client.ts` (line 87)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize()` | `Promise<McpServerInfo>` |
| `listTools` | `listTools()` | `Promise<McpToolDefinition[]>` |
| `callTool` | `callTool(name: string, args: Record<string, unknown>)` | `Promise<McpCallResult>` |
| `close` | `close()` | `Promise<void>` |

<!-- source: interface-parseerror.md -->

# ParseError

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/parse-result.interface.ts` (line 53)

Error encountered during parsing

## Properties

| Property | Type |
|---|---|
| `message` | `string` |
| `code` | `string` |
| `severity` | `'error' | 'warning'` |
| `line` | `number` |
| `column` | `number` |
| `filePath` | `string` |
| `stack` | `string` |
| `suggestion` | `string` |

<!-- source: component-pricingtiercard.md -->

# PricingTierCard

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/pricing-tier-card.tsx` (line 30)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `nameKey` | `string` | ✓ | - |
| `priceKey` | `string` | ✓ | - |
| `intervalKey` | `string` | - | - |
| `descriptionKey` | `string` | - | - |
| `features` | `PricingFeature[]` | ✓ | - |
| `ctaKey` | `string` | ✓ | - |
| `ctaUrl` | `string` | ✓ | - |
| `highlighted` | `boolean` | - | false |
| `badgeKey` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_PricingTierCard_32721740["PricingTierCard"]
    class component_PricingTierCard_32721740 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `Check`
- USES_HOOK → `useTranslation`

<!-- source: interface-productfeature.md -->

# ProductFeature

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 155)

A user-facing feature extracted from the codebase.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `actions` | `Array<{
    name: string;
    description: string;
    httpMethod?: string;
    path?: string;
    component?: string;
  }>` |
| `confidence` | `number` |
| `relatedFeatures` | `string[]` |

<!-- source: function-scrollintoview.md -->

# scrollIntoView

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 119)

Scroll element into view

## Signature

```ts
async function scrollIntoView(locator: Locator): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `locator` | `Locator` |

**Returns:** `Promise<void>`

<!-- source: interface-seodependencies.md -->

# SeoDependencies

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/agents/seo.agent.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `generateFn` | `ContentGenerateFn` |

<!-- source: constant-size.md -->

# size

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/opengraph-image.tsx` (line 9)

<!-- source: class-timingconfigdto.md -->

# TimingConfigDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 215)

Timing configuration for animations and waits

## Properties

| Property | Type |
|---|---|
| `waitStrategy` | `string` |
| `animationHandling` | `'disable' | 'waitForCompletion'` |
| `networkWait` | `string` |

<!-- source: class-versionselectorgenerator.md -->

# VersionSelectorGenerator

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/version-selector.generator.ts` (line 17)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generate` | `generate(config: VersionConfig, options: VersionSelectorOptions)` | `string` |
| `generateBanner` | `generateBanner(config: VersionConfig, options: VersionSelectorOptions)` | `string` |
| `generateDropdown` | `generateDropdown(config: VersionConfig, options: Required<Pick<VersionSelectorOptions, 'showLabels'>> & VersionSelectorOptions)` | `string` |
| `generateFrontmatter` | `generateFrontmatter(config: VersionConfig)` | `Record<string, unknown>` |
| `generateEntityVersionSwitcher` | `generateEntityVersionSwitcher(config: VersionConfig, entityPath: string, _options: VersionSelectorOptions)` | `string` |

<!-- source: constant-antd-table-patterns.md -->

# ANTD_TABLE_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/antd.patterns.ts` (line 132)

<!-- source: component-app-2.md -->

# App

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/App.tsx` (line 50)

## Diagram

```mermaid
graph TD
    component_App_68175d70["App"]
    class component_App_68175d70 rootComponent
```

## Relationships

- RENDERS → `Nav`
- RENDERS → `Routes`
- RENDERS → `Route`
- RENDERS → `LandingPage`
- RENDERS → `PrivacyPolicy`
- RENDERS → `TermsOfService`
- RENDERS → `Footer`
- RENDERS → `CookieBanner`

<!-- source: interface-approvalcheckpoint.md -->

# ApprovalCheckpoint

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 58)

## Properties

| Property | Type |
|---|---|
| `checkpointId` | `string` |
| `createdAt` | `Date` |
| `expiresAt` | `Date` |
| `discoveredStructure` | `{
    categories: ApprovalCategory[];
    totalDocuments: number;
    totalScreenshots: number;
    estimatedDurationMinutes: number;
  }` |
| `costEstimate` | `{
    claudeTokens: number;
    openaiTokens: number;
    estimatedCostUsd: number;
    costRange: { min: number; max: number };
  }` |
| `userAction` | `'approved' | 'modified' | 'cancelled'` |
| `userModifications` | `StructureModification[]` |
| `approvedAt` | `Date` |
| `approvedBy` | `string` |

<!-- source: interface-businesscontext.md -->

# BusinessContext

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/ai/services/business-context-parser.service.ts` (line 11)

Structured business context extracted from files

## Properties

| Property | Type |
|---|---|
| `productName` | `string` |
| `productType` | `string` |
| `description` | `string` |
| `features` | `Feature[]` |
| `workflows` | `WorkflowHint[]` |
| `terminology` | `Record<string, string>` |
| `urls` | `string[]` |
| `rawText` | `string` |

<!-- source: api-endpoint-callback.md -->

# callback

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/saml/saml.controller.ts` (line 41)

SAML callback - IdP redirects here after authentication

## Endpoint

`POST /auth/saml/callback`

## Referenced By

- `SamlController` (MODULE_DECLARES)

<!-- source: component-card.md -->

# Card

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/page.tsx` (line 548)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `title` | `string` | - | - |
| `subtitle` | `string` | - | - |
| `action` | `unknown` | - | - |
| `children` | `unknown` | ✓ | - |
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_Card_5a3d2af["Card"]
    class component_Card_5a3d2af rootComponent
```

## Referenced By

- `IssuesListPage` (RENDERS)

<!-- source: interface-codechunk.md -->

# CodeChunk

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/types.ts` (line 12)

A chunk of source code for indexing.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `file` | `string` |
| `startLine` | `number` |
| `endLine` | `number` |
| `kind` | `'function' | 'class' | 'method' | 'interface' | 'type' | 'block' | 'module'` |
| `name` | `string` |
| `content` | `string` |
| `context` | `string` |
| `embedding` | `number[]` |
| `contentHash` | `string` |

<!-- source: service-competitordiscoveryservice.md -->

# CompetitorDiscoveryService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/competitor-discovery.service.ts` (line 15)

Discovers competitor documentation using AI
No search APIs needed - Claude already knows!

## Methods

| Method | Signature | Returns |
|---|---|---|
| `discoverCompetitors` | `discoverCompetitors(projectDescription: string, projectType: string, limit: unknown)` | `Promise<CompetitorInfo[]>` |
| `getCompetitorsForType` | `getCompetitorsForType(projectType: string)` | `Promise<CompetitorInfo[]>` |
| `validateCompetitors` | `validateCompetitors(competitors: CompetitorInfo[])` | `CompetitorInfo[]` |

## Relationships

- DEPENDS_ON → `azureclaudeprovider`

<!-- source: class-consistencychecker.md -->

# ConsistencyChecker

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/consistency-checker.ts` (line 32)

ConsistencyChecker - Checks consistency across all documents

After individual document verification, this checker reviews all
documents together to catch inconsistencies that wouldn't be visible
when looking at documents in isolation.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `check` | `check(documents: GeneratedDocument[])` | `ConsistencyReport` |

<!-- source: function-createazureresponsesprovider.md -->

# createAzureResponsesProvider

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/azure-responses.provider.ts` (line 493)

Create an Azure Responses provider from environment configuration

## Signature

```ts
function createAzureResponsesProvider(config: Partial<AzureResponsesConfig>): AzureResponsesProvider
```

## Parameters

| Name | Type |
|---|---|
| `config` | `Partial<AzureResponsesConfig>` |

**Returns:** `AzureResponsesProvider`

<!-- source: class-createcategorydto.md -->

# CreateCategoryDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/category.dto.ts` (line 7)

DTO for creating a new category

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `icon` | `string` |
| `color` | `string` |
| `projectId` | `string` |
| `parentId` | `string` |
| `defaultDocId` | `string` |
| `order` | `number` |
| `docVersionId` | `string` |

<!-- source: function-createcrontools.md -->

# createCronTools

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/cron.tool.ts` (line 129)

## Signature

```ts
function createCronTools(options: CronToolsOptions): CronTools<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `CronToolsOptions` |

**Returns:** `CronTools<TContext>`

<!-- source: function-createlayoutagent.md -->

# createLayoutAgent

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/agents/layout.agent.ts` (line 13)

## Signature

```ts
function createLayoutAgent(config: GenerationConfig): AgentConfig<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |

**Returns:** `AgentConfig<PmeContext>`

<!-- source: interface-databasemodelentity-2.md -->

# DatabaseModelEntity

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 703)

Database Model entity

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.DATABASE_MODEL` |
| `tableName` | `string` |
| `fields` | `FieldDefinition[]` |
| `indexes` | `IndexDefinition[]` |
| `relations` | `RelationDefinition[]` |
| `orm` | `'prisma' | 'typeorm' | 'sequelize' | 'mongoose' | 'drizzle' | 'raw'` |
| `primaryKey` | `string[]` |
| `uniqueConstraints` | `UniqueConstraint[]` |

<!-- source: interface-dependencygraphprops.md -->

# DependencyGraphProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Parser/DependencyGraph.tsx` (line 5)

## Properties

| Property | Type |
|---|---|
| `dependencies` | `Dependency[]` |
| `className` | `string` |

<!-- source: function-detectreduxreducers.md -->

# detectReduxReducers

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/redux-pattern-detector.ts` (line 240)

Detect Redux reducers from code

## Signature

```ts
function detectReduxReducers(content: string): ReduxReducerPattern[]
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |

**Returns:** `ReduxReducerPattern[]`

<!-- source: type-explorermode-3.md -->

# ExplorerMode

**Kind:** Type

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/ModeSwitcher.ts` (line 8)

## Definition

```ts
'documentation' | 'playground'
```

<!-- source: constant-featurerequesttemplate.md -->

# featureRequestTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/feature-request.template.ts` (line 3)

<!-- source: function-generatemetadata.md -->

# generateMetadata

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/layout.tsx` (line 15)

SERVER layout for published docs sites: crawlers get real <title>/description/OG/
canonical in the initial HTML (the interactive shell stayed a client component —
see PublicLayoutShell). Metadata degrades gracefully when the API is unreachable.

## Signature

```ts
async function generateMetadata({ params }: { params: Promise<{ slugId: string }> }): Promise<Metadata>
```

## Parameters

| Name | Type |
|---|---|
| `{ params }` | `{ params: Promise<{ slugId: string }> }` |

**Returns:** `Promise<Metadata>`

<!-- source: controller-graphcontroller.md -->

# GraphController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/graph/graph.controller.ts` (line 28)

SECURITY (cross-tenant): the knowledge graph is a single shared Neo4j store, so every operation
here is scoped to an org-verified `projectId`. The ResourceOrgGuard resolves that projectId to
its owning organization and 403s if it isn't the caller's — the id arrives via the request body
(writes) or a required `projectId` query param (reads). The service then filters every Cypher by
that projectId, so no route can read, mutate, or delete another tenant's graph. `document/:id/
extract` is scoped by the DOCUMENT instead (org-resolvable), and persists into the document's own
project.

## Relationships

- MODULE_DECLARES → `createEntity`
- MODULE_DECLARES → `createRelation`
- MODULE_DECLARES → `getEntity`
- MODULE_DECLARES → `getRelated`
- MODULE_DECLARES → `getRelationships`
- MODULE_DECLARES → `findPath`
- MODULE_DECLARES → `search`
- MODULE_DECLARES → `extractEntities`
- MODULE_DECLARES → `detectFlow`
- MODULE_DECLARES → `detectImpact`
- MODULE_DECLARES → `getStatistics`
- MODULE_DECLARES → `deleteEntity`
- DEPENDS_ON → `knowledgegraphservice`
- DEPENDS_ON → `entityextractorservice`
- DEPENDS_ON → `flowdetectorservice`

<!-- source: module-manualsinsightsmodule.md -->

# ManualsInsightsModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/manuals-insights/manuals-insights.module.ts` (line 15)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `technicaldocsmodule`
- MODULE_IMPORTS → `draftdocumentmodule`
- MODULE_DECLARES → `manualsinsightscontroller`
- MODULE_PROVIDES → `manualsinsightsservice`

<!-- source: class-mcpmanager.md -->

# McpManager

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/mcp/mcp-manager.ts` (line 60)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `connect` | `connect()` | `Promise<void>` |
| `getTools` | `getTools()` | `ToolDefinition<any>[]` |
| `listServers` | `listServers()` | `string[]` |
| `close` | `close()` | `Promise<void>` |

<!-- source: function-mdtonotionblocks.md -->

# mdToNotionBlocks

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/md-to-notion-blocks.ts` (line 61)

## Signature

```ts
function mdToNotionBlocks(md: string): NotionBlock[]
```

## Parameters

| Name | Type |
|---|---|
| `md` | `string` |

**Returns:** `NotionBlock[]`

<!-- source: interface-parsefileinput.md -->

# ParseFileInput

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/parser.interface.ts` (line 43)

Input for parsing a file

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `content` | `string` |
| `metadata` | `Record<string, unknown>` |

<!-- source: component-problemcentered.md -->

# ProblemCentered

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/problem/problem-centered.tsx` (line 21)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `problems` | `Problem[]` | ✓ | - |
| `solutionKey` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_ProblemCentered_978d3b1["ProblemCentered"]
    class component_ProblemCentered_978d3b1 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: interface-productknowledgedeps.md -->

# ProductKnowledgeDeps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/tools/query-product-knowledge.tool.ts` (line 77)

## Properties

| Property | Type |
|---|---|
| `fetchFeatures` | `FetchFeaturesFn` |
| `fetchWorkflows` | `FetchWorkflowsFn` |
| `fetchCategories` | `FetchCategoriesFn` |
| `searchDocs` | `SearchDocsFn` |
| `fetchStats` | `FetchStatsFn` |
| `fetchAudiences` | `FetchAudiencesFn` |
| `fetchScreenshots` | `FetchScreenshotsFn` |

<!-- source: interface-seometadata.md -->

# SeoMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/tools/seo-metadata.tool.ts` (line 12)

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `metaDescription` | `string` |
| `canonicalSlug` | `string` |
| `ogTags` | `Record<string, string>` |
| `jsonLd` | `Record<string, unknown>` |
| `keywords` | `string[]` |

<!-- source: function-setupconsoleerrorcollection.md -->

# setupConsoleErrorCollection

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 216)

Set up console error collection for a page.
Call this before navigating to collect errors during the action.
Returns a function to get collected errors.

## Signature

```ts
function setupConsoleErrorCollection(page: Page): { getErrors: () => string[]; cleanup: () => void }
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |

**Returns:** `{ getErrors: () => string[]; cleanup: () => void }`

<!-- source: constant-sla-tone-styles.md -->

# SLA_TONE_STYLES

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 231)

## Definition

```ts
Record<'ok' | 'warn' | 'breach', { bg: string; text: string }>
```

<!-- source: class-validateselectorsrequestdto.md -->

# ValidateSelectorsRequestDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 774)

Request to validate selectors on a page

Used to verify login form selectors exist before batch processing

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `selectors` | `Record<string, string>` |
| `timeout` | `number` |

<!-- source: class-versionutils.md -->

# VersionUtils

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/version-config.ts` (line 65)

Version utilities

## Methods

| Method | Signature | Returns |
|---|---|---|
| `parseVersion` | `parseVersion(version: string)` | `[number, number, number] | null` |
| `compare` | `compare(a: string, b: string)` | `VersionComparison` |
| `sort` | `sort(versions: VersionInfo[], ascending: undefined)` | `VersionInfo[]` |
| `findLatest` | `findLatest(versions: VersionInfo[], includePrerelease: undefined)` | `VersionInfo | null` |
| `isPrerelease` | `isPrerelease(version: string)` | `boolean` |
| `isEOL` | `isEOL(version: VersionInfo)` | `boolean` |
| `generateLabel` | `generateLabel(version: VersionInfo, isLatest: boolean)` | `string` |
| `groupByMajor` | `groupByMajor(versions: VersionInfo[])` | `Map<number, VersionInfo[]>` |
| `getBadgeColor` | `getBadgeColor(version: VersionInfo)` | `string` |

<!-- source: constant-appendcodeblockeditordescriptor.md -->

# appendCodeBlockEditorDescriptor$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/index.ts` (line 101)

A signal that appends a code block editor descriptor to the list of descriptors.

<!-- source: interface-approvaldocument.md -->

# ApprovalDocument

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 100)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `type` | `| 'overview'
    | 'how-to'
    | 'walkthrough'
    | 'reference'
    | 'faq'
    | 'troubleshoot'` |
| `estimatedReadTime` | `number` |
| `screenshotsNeeded` | `number` |
| `canDelete` | `boolean` |
| `canModify` | `boolean` |

<!-- source: component-atloriaprovider.md -->

# AtloriaProvider

**Kind:** Component

**Source:** `atloria-monorepo/packages/ui-react/src/providers/AtloriaProvider.tsx` (line 47)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |
| `apiClient` | `APIClient` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_AtloriaProvider_377dd335["AtloriaProvider"]
    class component_AtloriaProvider_377dd335 rootComponent
```

## Relationships

- RENDERS → `AtloriaContext-Provider`

<!-- source: api-endpoint-canceljob-2.md -->

# cancelJob

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 163)

## Endpoint

`POST /doc-automation/jobs/:id/cancel`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: interface-carryforwardresult.md -->

# CarryForwardResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/doc-version/carry-forward.service.ts` (line 5)

## Properties

| Property | Type |
|---|---|
| `carried` | `number` |
| `flagged` | `number` |
| `carriedCategories` | `number` |
| `details` | `{
    carriedDocs: Array<{ id: string; title: string; slug: string }>;
    flaggedDocs: Array<{
      previousDocId: string;
      title: string;
      slug: string;
      newVersionDocId: string | null;
    }>;
  }` |

<!-- source: component-categorybadge.md -->

# CategoryBadge

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/PromptLibrary.tsx` (line 288)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `category` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CategoryBadge_72613ef3["CategoryBadge"]
    class component_CategoryBadge_72613ef3 rootComponent
```

## Referenced By

- `PromptCard` (RENDERS)

<!-- source: interface-commanddefinition.md -->

# CommandDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/plugins/plugin-types.ts` (line 37)

A slash command contributed by a plugin.

Each `.md` file in a plugin's `commands/` directory produces one
CommandDefinition. The filename (without extension) becomes the command name.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `instructions` | `string` |
| `allowedTools` | `string[]` |
| `model` | `string` |
| `argumentHint` | `string` |

<!-- source: service-competitorresearchservice.md -->

# CompetitorResearchService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/competitor-research.service.ts` (line 18)

Main orchestrator for competitor research
Combines AI discovery + web crawling

`CompetitorResearchService` is the main orchestration layer for competitor research in the backend. It coordinates AI-based competitor discovery with web crawling to gather and normalize data about identified competitors. This service typically sits above lower-level AI/crawler providers and returns consolidated research results to calling modules/controllers.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `researchCompetitors` | `researchCompetitors(projectType: string, projectDescription: string, options: {
      maxCompetitors?: number;
      useCache?: boolean;
      crawlConcurrency?: number;
    })` | `Promise<CompetitorResearchResult>` |
| `formatForAIContext` | `formatForAIContext(research: CompetitorResearchResult)` | `string` |
| `clearCache` | `clearCache()` | `Promise<void>` |
| `onModuleDestroy` | `onModuleDestroy()` | `unknown` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  actor Client
  participant CRS as CompetitorResearchService
  participant AI as AI Discovery Provider
  participant Crawler as Web Crawler
  participant Store as Persistence/Repository

  Client->>CRS: runResearch(input)
  CRS->>AI: discoverCompetitors(input)
  AI-->>CRS: competitorCandidates[]
  loop for each competitor
    CRS->>Crawler: crawl(competitor.url)
    Crawler-->>CRS: pages/content/metadata
    CRS->>CRS: extract + normalize signals
  end
  CRS->>Store: saveResearchResult(result)
  Store-->>CRS: savedResult
  CRS-->>Client: researchResult
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { CompetitorResearchService } from './documentation/services/competitor-research.service';

@Injectable()
export class ResearchRunner {
  constructor(private readonly competitorResearch: CompetitorResearchService) {}

  async run() {
    // Shape depends on your implementation; keep it aligned with the DTO/interface used by the service.
    const input = {
      companyName: 'Atloria',
      domain: 'atloria.com',
      market: 'B2B SaaS',
      maxCompetitors: 10,
    };

    const result = await this.competitorResearch.runResearch(input);

    // e.g., competitors with evidence/links and extracted positioning signals
    return {
      count: result.competitors?.length ?? 0,
      competitors: result.competitors,
      generatedAt: result.generatedAt,
    };
  }
}
```

## AI Coding Instructions

- Keep `CompetitorResearchService` focused on orchestration: delegate AI discovery and crawling details to dedicated providers/services rather than embedding implementation logic here.
- Treat external calls (LLM + crawling) as unreliable: add timeouts, retries/backoff, and graceful partial results instead of failing the entire run on one competitor.
- Normalize outputs at the boundary: ensure AI-discovered competitors and crawled artifacts are mapped into consistent internal DTOs before persistence/return.
- Avoid unbounded loops and crawling: enforce limits (`maxCompetitors`, max pages/depth, allowed domains) to prevent runaway requests and high costs.
- Maintain clear integration points: when changing discovery prompts/schema or crawler extraction, update the parsing/validation in this service to keep downstream consumers stable.

## Relationships

- DEPENDS_ON → `competitordiscoveryservice`
- DEPENDS_ON → `webcrawlerservice`

<!-- source: class-contextresolver.md -->

# ContextResolver

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/context-resolver.ts` (line 38)

ContextResolver - Resolves cross-chunk entity references

When generating documentation for a document, we may need entities
that exist in OTHER chunks. This resolver fetches them from the
global entity map without loading everything into memory.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `setEntityMap` | `setEntityMap(entityMap: Map<string, Entity>)` | `void` |
| `resolveForPlan` | `resolveForPlan(plan: DocumentPlan)` | `Promise<Entity[]>` |
| `resolveByName` | `resolveByName(entityName: string)` | `Entity | undefined` |
| `resolveById` | `resolveById(entityId: string)` | `Entity | undefined` |
| `handleDeepLoadRequest` | `handleDeepLoadRequest(request: DeepLoadRequest)` | `Promise<DeepLoadResponse>` |
| `getByFilePath` | `getByFilePath(pattern: string)` | `Entity[]` |
| `getByType` | `getByType(type: Entity['type'])` | `Entity[]` |
| `clearCache` | `clearCache()` | `void` |
| `getCacheStats` | `getCacheStats()` | `{ size: number; hits: string[] }` |
| `hasEntity` | `hasEntity(entityId: string)` | `boolean` |
| `getEntityCount` | `getEntityCount()` | `number` |

<!-- source: function-createcheckpointservice.md -->

# createCheckpointService

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/pipeline/checkpoint.ts` (line 300)

Create a checkpoint service with default configuration

## Signature

```ts
function createCheckpointService(checkpointDir: string, options: Partial<Omit<CheckpointServiceConfig, 'checkpointDir'>>): CheckpointService
```

## Parameters

| Name | Type |
|---|---|
| `checkpointDir` | `string` |
| `options` | `Partial<Omit<CheckpointServiceConfig, 'checkpointDir'>>` |

**Returns:** `CheckpointService`

<!-- source: class-createcolumndto.md -->

# CreateColumnDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/boards/dto/column.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `color` | `string` |
| `mapsToStatus` | `IssueStatus | null` |
| `wipLimit` | `number | null` |
| `afterColumnId` | `string` |

<!-- source: function-createdefaultprocessors.md -->

# createDefaultProcessors

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/context/history-processors.ts` (line 274)

Default processor pipeline order:
1. SourceTruncation — bound individual item sizes
2. LastNObservations — elide old observations
3. ClosedWindow — dedup file reads

## Signature

```ts
function createDefaultProcessors(): HistoryProcessor[]
```

**Returns:** `HistoryProcessor[]`

<!-- source: function-createpmehandofffilter.md -->

# createPmeHandoffFilter

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/context/pme-handoff-filter.ts` (line 28)

Create a handoff input filter for PME agents.

The filter keeps:
- Full inputHistory (original user request — usually small)
- Last N items from preHandoffItems (recent coordinator context)
- All newItems (the handoff trigger with task details)

## Signature

```ts
function createPmeHandoffFilter(config: PmeHandoffFilterConfig)
```

## Parameters

| Name | Type |
|---|---|
| `config` | `PmeHandoffFilterConfig` |

<!-- source: interface-databaseschemadiagramoptions.md -->

# DatabaseSchemaDiagramOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/database-schema-diagram.generator.ts` (line 19)

Options for database schema diagram generation

## Properties

| Property | Type |
|---|---|
| `showFieldTypes` | `boolean` |
| `showConstraints` | `boolean` |
| `showNullable` | `boolean` |
| `showIndexes` | `boolean` |
| `showFieldDescriptions` | `boolean` |
| `maxFieldsPerModel` | `number` |
| `includeModels` | `string[]` |
| `excludeModels` | `string[]` |

<!-- source: interface-deskactivity.md -->

# DeskActivity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 53)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `action` | `string` |
| `fromValue` | `string | null` |
| `toValue` | `string | null` |
| `actorName` | `string | null` |
| `label` | `string` |
| `createdAt` | `string` |
| `local` | `boolean` |

<!-- source: function-detectreduxselectors.md -->

# detectReduxSelectors

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/redux-pattern-detector.ts` (line 443)

Detect Redux selectors from code

## Signature

```ts
function detectReduxSelectors(content: string): ReduxSelectorPattern[]
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |

**Returns:** `ReduxSelectorPattern[]`

<!-- source: type-format-2.md -->

# FORMAT

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/FormatConstants.ts` (line 12)

## Definition

```ts
| typeof DEFAULT_FORMAT
  | typeof IS_BOLD
  | typeof IS_ITALIC
  | typeof IS_STRIKETHROUGH
  | typeof IS_UNDERLINE
  | typeof IS_CODE
  | typeof IS_SUBSCRIPT
  | typeof IS_SUPERSCRIPT
  | typeof IS_HIGHLIGHT
```

<!-- source: function-generateslug.md -->

# generateSlug

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/useNewProjectWizard.ts` (line 134)

## Signature

```ts
function generateSlug(name: string): string
```

## Parameters

| Name | Type |
|---|---|
| `name` | `string` |

**Returns:** `string`

<!-- source: constant-generation-credit-cost.md -->

# GENERATION_CREDIT_COST

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/billing/billing.constants.ts` (line 10)

Billing constants.

Credits are an abstract unit: 1 documentation generation = 1,000 credits.
Monthly grants per plan:
  FREE     →   5 generations =   5,000 credits
  PRO      →  50 generations =  50,000 credits
  BUSINESS → 200 generations = 200,000 credits

<!-- source: controller-invitationcontroller.md -->

# InvitationController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/invitation/invitation.controller.ts` (line 21)

Public invitation endpoints (token IS the credential — no JWT required).

## Relationships

- MODULE_DECLARES → `get`
- MODULE_DECLARES → `accept`
- DEPENDS_ON → `invitationservice`

<!-- source: function-mdtostoragehtml.md -->

# mdToStorageHtml

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/techdocs-export.service.ts` (line 19)

Minimal markdown → XHTML for Confluence storage format. Covers what our generated
pages actually use (headings, paragraphs, fenced code, lists, bold/italic/inline
code, links, tables degrade to paragraphs). Dependency-free on purpose: `marked`
is ESM-only and breaks the CJS server build.

## Signature

```ts
function mdToStorageHtml(md: string): string
```

## Parameters

| Name | Type |
|---|---|
| `md` | `string` |

**Returns:** `string`

<!-- source: class-memorybackend.md -->

# MemoryBackend

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/context/checkpoint-backend.ts` (line 83)

**Implements:** `CheckpointBackend`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `save` | `save(snap: Snapshot)` | `void` |
| `load` | `load(relPath: string)` | `Snapshot[]` |
| `loadLatest` | `loadLatest(relPath: string)` | `Snapshot | null` |
| `deleteFile` | `deleteFile(relPath: string)` | `void` |
| `deleteFrom` | `deleteFrom(relPath: string, fromIndex: number)` | `void` |
| `getTrackedFiles` | `getTrackedFiles()` | `string[]` |
| `getTotalCount` | `getTotalCount()` | `number` |
| `getSnapshotCount` | `getSnapshotCount(relPath: string)` | `number` |
| `clear` | `clear()` | `void` |
| `evictOldest` | `evictOldest()` | `boolean` |

<!-- source: module-notificationmodule.md -->

# NotificationModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/notification/notification.module.ts` (line 9)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_DECLARES → `notificationcontroller`
- MODULE_PROVIDES → `notificationservice`
- MODULE_EXPORTS → `notificationservice`

<!-- source: interface-parsejobpayload.md -->

# ParseJobPayload

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/config.interface.ts` (line 262)

Job payload for parse queue

## Properties

| Property | Type |
|---|---|
| `jobId` | `string` |
| `projectId` | `string` |
| `files` | `string[]` |
| `parserType` | `string` |
| `config` | `Record<string, unknown>` |
| `priority` | `number` |
| `createdAt` | `Date` |

<!-- source: component-problemsplitvisual.md -->

# ProblemSplitVisual

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/problem/problem-split-visual.tsx` (line 28)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `problems` | `Problem[]` | ✓ | - |
| `imageSrc` | `string` | ✓ | - |
| `imageAlt` | `string` | ✓ | - |
| `imagePosition` | `unknown | unknown` | - | "start" |

## Diagram

```mermaid
graph TD
    component_ProblemSplitVisual_1b95cbc["ProblemSplitVisual"]
    class component_ProblemSplitVisual_1b95cbc rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: interface-productknowledgeresult.md -->

# ProductKnowledgeResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 240)

Unified result shape from query_product_knowledge.

## Properties

| Property | Type |
|---|---|
| `mode` | `ProductKnowledgeMode` |
| `projectId` | `string` |
| `found` | `number` |
| `features` | `ProductFeature[]` |
| `workflows` | `ProductWorkflow[]` |
| `categories` | `ProductCategory[]` |
| `documents` | `ProductDocument[]` |
| `stats` | `ProductStats` |
| `audiences` | `ProductAudience[]` |
| `screenshots` | `ProductScreenshot[]` |

<!-- source: constant-status-cfg.md -->

# STATUS_CFG

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/components/Boards/helpers.ts` (line 5)

## Definition

```ts
Record<
  string,
  { bg: string; text: string; label: string; dot: string }
>
```

<!-- source: interface-strategydependencies.md -->

# StrategyDependencies

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/agents/strategy.agent.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `searchFn` | `DocSearchFn` |
| `findScreenshotsFn` | `FindScreenshotsFn` |

<!-- source: function-takescreenshot.md -->

# takeScreenshot

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 41)

Take a screenshot with a descriptive name

## Signature

```ts
async function takeScreenshot(page: Page, name: string): Promise<Buffer>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |
| `name` | `string` |

**Returns:** `Promise<Buffer>`

<!-- source: class-validateselectorsresponsedto.md -->

# ValidateSelectorsResponseDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 803)

Response from selector validation

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `success` | `boolean` |
| `results` | `Record<string, SelectorValidationResult>` |
| `allFound` | `boolean` |
| `allVisible` | `boolean` |
| `missingSelectors` | `string[]` |
| `suggestions` | `Record<string, string>` |

<!-- source: class-visibilityfilter.md -->

# VisibilityFilter

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/visibility-filter.ts` (line 35)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `filter` | `filter(entities: Entity[], config: VisibilityFilterConfig)` | `FilteredEntities` |
| `generateFilterUI` | `generateFilterUI(config: VisibilityFilterConfig)` | `string` |
| `generateFrontmatter` | `generateFrontmatter(entity: Entity)` | `Record<string, unknown>` |

<!-- source: constant-applyblocktype.md -->

# applyBlockType$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 791)

Allows you to change the block type of the current selection.

<!-- source: interface-approvalsubcategory.md -->

# ApprovalSubcategory

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 94)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `documents` | `ApprovalDocument[]` |

<!-- source: component-bare.md -->

# Bare

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 36)

## Diagram

```mermaid
graph TD
    component_Bare_f48fc["Bare"]
    class component_Bare_f48fc rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useRef`

<!-- source: api-endpoint-canceljob-3.md -->

# cancelJob

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/sync.controller.ts` (line 172)

## Endpoint

`POST /projects/sync/jobs/:jobId/cancel`

| Parameter | In | Type | Required |
|---|---|---|---|
| `jobId` | query | `string` | ✓ |

## Referenced By

- `SyncController` (MODULE_DECLARES)

<!-- source: interface-categorydiffentry.md -->

# CategoryDiffEntry

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/doc-version/version-diff.service.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `slug` | `string` |
| `name` | `string` |

<!-- source: component-categoryitem.md -->

# CategoryItem

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/DocAutomation/SkeletonBuilder.tsx` (line 258)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `category` | `SkeletonCategory` | ✓ | - |
| `isExpanded` | `boolean` | ✓ | - |
| `isEditing` | `boolean` | ✓ | - |
| `addingDocument` | `boolean` | ✓ | - |
| `newDocumentName` | `string` | ✓ | - |
| `editingDocument` | `unknown | null` | ✓ | - |
| `onToggle` | `Function` | ✓ | - |
| `onStartEdit` | `Function` | ✓ | - |
| `onEndEdit` | `Function` | ✓ | - |
| `onUpdate` | `Function` | ✓ | - |
| `onRemove` | `Function` | ✓ | - |
| `onStartAddDocument` | `Function` | ✓ | - |
| `onCancelAddDocument` | `Function` | ✓ | - |
| `onNewDocumentNameChange` | `Function` | ✓ | - |
| `onAddDocument` | `Function` | ✓ | - |
| `onRemoveDocument` | `Function` | ✓ | - |
| `onUpdateDocument` | `Function` | ✓ | - |
| `onStartEditDocument` | `Function` | ✓ | - |
| `onEndEditDocument` | `Function` | ✓ | - |
| `onReorderDocuments` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CategoryItem_184a0b3["CategoryItem"]
    class component_CategoryItem_184a0b3 rootComponent
```

## Relationships

- RENDERS → `Reorder-Item`
- RENDERS → `GripVertical`
- RENDERS → `ChevronDown`
- RENDERS → `ChevronRight`
- RENDERS → `FilePlus`
- RENDERS → `Trash2`
- RENDERS → `AnimatePresence`
- RENDERS → `motion-div`
- RENDERS → `Button`
- RENDERS → `Reorder-Group`
- RENDERS → `DocumentItem`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`

## Referenced By

- `SkeletonBuilder` (RENDERS)

<!-- source: interface-compactionevent.md -->

# CompactionEvent

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/compaction-types.ts` (line 139)

## Properties

| Property | Type |
|---|---|
| `version` | `number` |
| `timestamp` | `number` |
| `itemsCompacted` | `number` |
| `tokensBefore` | `number` |
| `tokensAfter` | `number` |
| `method` | `'model' | 'heuristic'` |
| `durationMs` | `number` |

<!-- source: class-contextretriever.md -->

# ContextRetriever

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/context-retriever.ts` (line 22)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `retrieveForDocument` | `retrieveForDocument(plan: DocumentPlan, featureIds: string[])` | `RetrievedContext` |

<!-- source: function-createclaudeprovider.md -->

# createClaudeProvider

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/claude.provider.ts` (line 623)

Create a Claude provider from environment configuration

## Signature

```ts
function createClaudeProvider(config: Partial<ClaudeConfig>): ClaudeProvider
```

## Parameters

| Name | Type |
|---|---|
| `config` | `Partial<ClaudeConfig>` |

**Returns:** `ClaudeProvider`

<!-- source: class-createcommentdto.md -->

# CreateCommentDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/comment/dto/create-comment.dto.ts` (line 15)

DTO for creating a new comment on a document

## Properties

| Property | Type |
|---|---|
| `content` | `string` |
| `selectionText` | `string` |
| `positionStart` | `number` |
| `positionEnd` | `number` |
| `parentCommentId` | `string` |

<!-- source: function-createeditfiletool.md -->

# createEditFileTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/edit-file.tool.ts` (line 61)

## Signature

```ts
function createEditFileTool(options: EditFileOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `EditFileOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: function-createqaagent.md -->

# createQaAgent

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/agents/qa.agent.ts` (line 27)

## Signature

```ts
function createQaAgent(config: GenerationConfig, deps: QaDependencies, qaConfig: QaConfig): AgentConfig<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |
| `deps` | `QaDependencies` |
| `qaConfig` | `QaConfig` |

**Returns:** `AgentConfig<PmeContext>`

<!-- source: service-dashboardservice.md -->

# DashboardService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/dashboard/dashboard.service.ts` (line 7)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getStats` | `getStats(user: JwtPayload)` | `unknown` |
| `getProjectStats` | `getProjectStats(user: JwtPayload)` | `unknown` |
| `getUserActivity` | `getUserActivity(user: JwtPayload)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: interface-databaseschemadiagramresult.md -->

# DatabaseSchemaDiagramResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/database-schema-diagram.generator.ts` (line 72)

Result of database schema diagram generation

## Properties

| Property | Type |
|---|---|
| `mermaidCode` | `string` |
| `stats` | `{
    /** Number of models in diagram */
    modelCount: number;
    /** Total number of fields across all models */
    totalFields: number;
    /** Number of relationships */
    relationshipCount: number;
    /** Number of indexes */
    indexCount: number;
    /** Models included */
    modelsIncluded: string[];
  }` |

<!-- source: interface-deskcomment.md -->

# DeskComment

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 43)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `body` | `string` |
| `isInternal` | `boolean` |
| `authorName` | `string | null` |
| `createdAt` | `string` |
| `pending` | `boolean` |

<!-- source: function-detectsemanticpatterns.md -->

# detectSemanticPatterns

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/semantic-detector.ts` (line 273)

Detect all semantic patterns in code

Main entry point that runs all detection algorithms and
returns comprehensive semantic metadata.

## Signature

```ts
function detectSemanticPatterns(code: string): SemanticMetadata
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string` |

**Returns:** `SemanticMetadata`

<!-- source: type-frameworktype.md -->

# FrameworkType

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 39)

## Definition

```ts
(typeof FRAMEWORK_TYPES)[number]
```

<!-- source: function-generateslugpreview.md -->

# generateSlugPreview

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/url-utils.ts` (line 101)

Generate an SEO-friendly slug from a title (client-side)
Note: Use the backend UrlService for authoritative slug generation

## Signature

```ts
function generateSlugPreview(title: string): string
```

## Parameters

| Name | Type |
|---|---|
| `title` | `string` |

**Returns:** `string`

<!-- source: constant-generator-author.md -->

# GENERATOR_AUTHOR

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/docs-repo/docs-repo.service.ts` (line 33)

atloria-generator — deterministic generation / reconcile commits.

## Definition

```ts
CommitAuthor
```

<!-- source: controller-issuescontroller.md -->

# IssuesController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/issues/issues.controller.ts` (line 19)

## Relationships

- MODULE_DECLARES → `list`
- MODULE_DECLARES → `getStats`
- MODULE_DECLARES → `getOne`
- MODULE_DECLARES → `bulkUpdate`
- MODULE_DECLARES → `update`
- MODULE_DECLARES → `addComment`
- MODULE_DECLARES → `getDuplicates`
- DEPENDS_ON → `issuesservice`

<!-- source: class-memorymanager.md -->

# MemoryManager

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/memory/memory-manager.ts` (line 45)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `mark` | `mark(memory: SessionMemory, relatedFiles: string[])` | `string` |
| `recall` | `recall(query: Partial<Omit<MemoryQuery, 'projectId'>>)` | `MemoryRecord[]` |
| `extractAndPersist` | `extractAndPersist(ctx: SessionContext)` | `Promise<number>` |
| `formatForContext` | `formatForContext(memories: MemoryRecord[])` | `string` |
| `get` | `get(id: string)` | `MemoryRecord | null` |
| `delete` | `delete(id: string)` | `boolean` |
| `search` | `search(search: string, limit: number)` | `MemoryRecord[]` |
| `consolidate` | `consolidate()` | `ConsolidationReport` |
| `count` | `count()` | `number` |
| `getProjectId` | `getProjectId()` | `string` |

<!-- source: function-mergeslugregistry.md -->

# mergeSlugRegistry

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/docs-repo/sidecar.ts` (line 185)

Merge the current served set into the existing registry and return the deterministic string.

For each page (keyed by docUuid): upsert slug/scope/lang/kgEntityId. If the slug CHANGED from
the stored one, append the old slug to previousSlugs (dedup, keep order). Entries for docUuids
no longer served are RETAINED — the ledger is an identity history, not a mirror of the live set
(a page can be unpublished then republished under the same identity, and rename history must
survive a doc dropping out of the served set for a version).

## Signature

```ts
function mergeSlugRegistry(existingJson: string | null | undefined, pages: PageIdentity[]): string
```

## Parameters

| Name | Type |
|---|---|
| `existingJson` | `string | null | undefined` |
| `pages` | `PageIdentity[]` |

**Returns:** `string`

<!-- source: module-opsmodule.md -->

# OpsModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/ops/ops.module.ts` (line 9)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `emailmodule`
- MODULE_DECLARES → `opscontroller`
- MODULE_PROVIDES → `opsservice`
- MODULE_PROVIDES → `opsalertsservice`

<!-- source: interface-parsemetadata.md -->

# ParseMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/parse-result.interface.ts` (line 144)

Metadata about the parse operation

## Properties

| Property | Type |
|---|---|
| `duration` | `number` |
| `linesOfCode` | `number` |
| `fileSize` | `number` |
| `language` | `string` |
| `framework` | `string` |
| `fileHash` | `string` |
| `complexity` | `number` |

<!-- source: interface-productscreenshot.md -->

# ProductScreenshot

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 226)

A product screenshot linked to a feature/page.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `url` | `string` |
| `title` | `string` |
| `description` | `string` |
| `width` | `number` |
| `height` | `number` |
| `viewport` | `string` |
| `featureArea` | `string` |
| `pageType` | `string` |
| `tags` | `string[]` |

<!-- source: component-socialproofstatsgrid.md -->

# SocialProofStatsGrid

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/social-proof/social-proof-stats-grid.tsx` (line 14)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | - | - |
| `descriptionKey` | `string` | - | - |
| `stats` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SocialProofStatsGrid_d1dcef0["SocialProofStatsGrid"]
    class component_SocialProofStatsGrid_d1dcef0 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `StatCard`
- USES_HOOK → `useTranslation`

<!-- source: interface-strategydocument.md -->

# StrategyDocument

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 239)

Output from the strategy agent — feeds into generation config.

## Properties

| Property | Type |
|---|---|
| `audience` | `{
    primary: string;
    painPoints: string[];
    goals: string[];
  }` |
| `valueProposition` | `string` |
| `tone` | `{
    voice: string;
    adjectives: string[];
    avoidTerms: string[];
  }` |
| `differentiators` | `string[]` |
| `sections` | `{
    priority: SectionType[];
    emphasis: Partial<Record<SectionType, string>>;
  }` |
| `visual` | `{
    theme: ThemeConfig;
    strategy: VisualStrategy;
    mockupTypes: MockupType[];
    enableVariants: boolean;
    enableThemeToggle: boolean;
    layouts?: Partial<Record<SectionType, string>>;
  }` |
| `confirmed` | `boolean` |

<!-- source: constant-template-categories.md -->

# TEMPLATE_CATEGORIES

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/constants/templateCategories.ts` (line 66)

All available template categories derived from the enum

<!-- source: class-viewportdto.md -->

# ViewportDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 161)

Viewport configuration DTO

Defines browser viewport dimensions and device characteristics

## Properties

| Property | Type |
|---|---|
| `width` | `number` |
| `height` | `number` |
| `deviceScaleFactor` | `number` |
| `isMobile` | `boolean` |
| `hasTouch` | `boolean` |

<!-- source: class-vueparser-2.md -->

# VueParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/frontend/vue.parser.ts` (line 108)

Vue Parser

Pure TypeScript class that parses Vue Single File Components.
No NestJS dependencies required.

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `version` | `string` |
| `supportedPatterns` | `string[]` |

<!-- source: function-waitforapirequest.md -->

# waitForAPIRequest

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 187)

Wait for API request to complete

## Signature

```ts
async function waitForAPIRequest(page: Page, urlPattern: string | RegExp): Promise<{ request: Request; response: Response | null }>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |
| `urlPattern` | `string | RegExp` |

**Returns:** `Promise<{ request: Request; response: Response | null }>`

<!-- source: constant-applyformat.md -->

# applyFormat$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 194)

Applies the published format to the current selection.

<!-- source: interface-atloriaconfig.md -->

# AtloriaConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/types/api-client.ts` (line 265)

Configuration for the Atloria provider

## Properties

| Property | Type |
|---|---|
| `apiUrl` | `string` |
| `token` | `string` |

<!-- source: component-bare-2.md -->

# Bare

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/maxlength.tsx` (line 5)

## Diagram

```mermaid
graph TD
    component_Bare_43abf273["Bare"]
    class component_Bare_43abf273 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: api-endpoint-cancelparsing.md -->

# cancelParsing

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/parsing/parsing.controller.ts` (line 74)

## Endpoint

`DELETE /projects/:projectId/parse/:jobId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `jobId` | query | `string` | ✓ |

## Referenced By

- `ParsingController` (MODULE_DECLARES)

<!-- source: component-categorynode.md -->

# CategoryNode

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Categories/CategoryTreeSidebar.tsx` (line 59)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `category` | `unknown` | ✓ | - |
| `selectedCategoryId` | `string | null` | - | - |
| `onSelect` | `Function` | ✓ | - |
| `onEdit` | `Function` | - | - |
| `onDelete` | `Function` | - | - |
| `editMode` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_CategoryNode_70f0830f["CategoryNode"]
    class component_CategoryNode_70f0830f rootComponent
```

## Relationships

- RENDERS → `GripVertical`
- RENDERS → `CategoryIcon`
- RENDERS → `FolderIcon`
- RENDERS → `PencilIcon`
- RENDERS → `TrashIcon`
- USES_HOOK → `useSortable`

## Referenced By

- `CategoryTreeSidebar` (RENDERS)

<!-- source: interface-checkedrecord.md -->

# CheckedRecord

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/project/domain-dns.service.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `observed` | `string[]` |
| `ok` | `boolean` |
| `hint` | `string` |

<!-- source: interface-compactionstrategy.md -->

# CompactionStrategy

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/context-manager.ts` (line 26)

Pluggable strategy for deciding what to preserve during compaction.
Domain-specific — agent-core provides the interface, pme-core implements it.

<!-- source: class-createdocautomationconfigdto.md -->

# CreateDocAutomationConfigDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/documentation/dto/doc-automation.dto.ts` (line 77)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `repositoryUrl` | `string` |
| `repositoryBranch` | `string` |
| `frontendPath` | `string` |
| `backendPath` | `string` |
| `siteUrl` | `string` |
| `siteLoginUrl` | `string` |
| `siteEmail` | `string` |
| `sitePassword` | `string` |
| `repoUsername` | `string` |
| `repoPassword` | `string` |
| `skeletonStructure` | `SkeletonStructureDto` |
| `includeApiDocs` | `boolean` |
| `includeDiagrams` | `boolean` |
| `includeScreenshots` | `boolean` |
| `aiEnhancement` | `boolean` |
| `outputFormat` | `string` |
| `screenshotFormat` | `string` |
| `screenshotQuality` | `number` |
| `maxConcurrency` | `number` |
| `timeout` | `number` |
| `excludePatterns` | `string[]` |
| `targetAudience` | `string` |
| `autoPublish` | `boolean` |
| `businessDomain` | `string` |
| `contextSources` | `{ type: 'pdf' | 'url' | 'file' | 'text'; path: string }[]` |

<!-- source: function-createemptyselectors.md -->

# createEmptySelectors

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 133)

Create an empty selectors object

## Signature

```ts
function createEmptySelectors(): ExtractedSelectors
```

**Returns:** `ExtractedSelectors`

<!-- source: function-createemptysummary.md -->

# createEmptySummary

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/context/model-compactor.ts` (line 155)

## Signature

```ts
function createEmptySummary(): CompactionSummary
```

**Returns:** `CompactionSummary`

<!-- source: function-createquerydocstool.md -->

# createQueryDocsTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/query-docs.tool.ts` (line 24)

## Signature

```ts
function createQueryDocsTool(searchFn: DocSearchFn): ToolDefinition<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `searchFn` | `DocSearchFn` |

**Returns:** `ToolDefinition<PmeContext>`

<!-- source: class-crossstackmapper.md -->

# CrossStackMapper

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-03-features/cross-stack-mapper.ts` (line 89)

Cross-Stack Mapper

Maps frontend to backend features to understand full-stack data flow.

**Implements:** `ICrossStackMapper`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `mapCrossStackFeatures` | `mapCrossStackFeatures(chunks: Chunk[], features: UserFeature[])` | `CrossStackMappingResult` |

<!-- source: interface-defaultexport.md -->

# DefaultExport

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/storybook/types.ts` (line 84)

Default export metadata

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `component` | `string` |
| `subcomponents` | `Record<string, string>` |
| `args` | `Record<string, unknown>` |
| `argTypes` | `Record<string, ArgType>` |
| `parameters` | `Record<string, unknown>` |
| `decorators` | `string[]` |
| `tags` | `string[]` |
| `locStart` | `number` |
| `locEnd` | `number` |

<!-- source: interface-deskcounts.md -->

# DeskCounts

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 73)

## Properties

| Property | Type |
|---|---|
| `triage` | `CountValue` |
| `needs_first` | `CountValue` |
| `needs_next` | `CountValue` |
| `investigating` | `CountValue` |
| `waiting` | `CountValue` |
| `paused` | `CountValue` |
| `done_today` | `CountValue` |
| `mine` | `CountValue` |
| `unassigned` | `CountValue` |

<!-- source: service-deskservice.md -->

# DeskService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/issues/desk.service.ts` (line 46)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `listThreads` | `listThreads(projectId: string, user: JwtPayload, bucket: DeskBucket, limit: unknown)` | `unknown` |
| `getCounts` | `getCounts(projectId: string, user: JwtPayload)` | `unknown` |
| `getThread` | `getThread(projectId: string, issueId: string, user: JwtPayload)` | `unknown` |
| `transition` | `transition(projectId: string, issueId: string, dto: DeskTransitionDto, user: JwtPayload)` | `unknown` |
| `reply` | `reply(projectId: string, issueId: string, dto: DeskReplyDto, user: JwtPayload)` | `unknown` |
| `markDuplicate` | `markDuplicate(projectId: string, issueId: string, dto: DeskDuplicateDto, user: JwtPayload)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `issuesservice`

<!-- source: function-detectstateenums.md -->

# detectStateEnums

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/semantic-detector.ts` (line 69)

Detect state enum definitions

Finds enums with "Stage", "Status", or "State" in their name.

## Signature

```ts
function detectStateEnums(code: string): string[]
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string` |

**Returns:** `string[]`

<!-- source: type-frontendframework.md -->

# FrontendFramework

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/framework.types.ts` (line 15)

Framework Detection Types

Types for auto-detecting project tech stacks.
Supports React, Vue, Angular, Next.js, Svelte, and various backends.

## Definition

```ts
| 'react'
  | 'nextjs'
  | 'vue'
  | 'nuxt'
  | 'angular'
  | 'svelte'
  | 'sveltekit'
  | 'solid'
  | 'qwik'
  | 'unknown'
```

<!-- source: function-generateusercolor.md -->

# generateUserColor

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/user-colors.ts` (line 66)

Generate a consistent color for a user based on their userId
The same userId will always return the same color

## Signature

```ts
function generateUserColor(userId: string): string
```

## Parameters

| Name | Type |
|---|---|
| `userId` | `string` |

**Returns:** `string`

<!-- source: constant-gettingstartedtemplate.md -->

# gettingStartedTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/getting-started.template.ts` (line 3)

<!-- source: controller-kgsynccontroller.md -->

# KgSyncController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/graph/kg-sync.controller.ts` (line 38)

Knowledge Graph Sync Controller

Handles CLI dynamic mode sync operations.
Provides endpoints for bulk entity and relationship sync.

## Relationships

- MODULE_DECLARES → `getEntities`
- MODULE_DECLARES → `getEntityById`
- MODULE_DECLARES → `syncEntities`
- MODULE_DECLARES → `getRelationships`
- MODULE_DECLARES → `getRelationshipsForEntity`
- MODULE_DECLARES → `syncRelationships`
- DEPENDS_ON → `kgsyncservice`
- DEPENDS_ON → `workflowdiscoveryservice`
- DEPENDS_ON → `workflowstorageservice`

<!-- source: class-messagebus.md -->

# MessageBus

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/tools/send-message.tool.ts` (line 23)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `registerAgent` | `registerAgent(name: string, hook: InjectionTurnHook<any>)` | `void` |
| `unregisterAgent` | `unregisterAgent(name: string)` | `void` |
| `getHook` | `getHook(name: string)` | `InjectionTurnHook<any> | undefined` |
| `listAgents` | `listAgents()` | `string[]` |
| `enqueue` | `enqueue(name: string, message: string)` | `boolean` |

<!-- source: function-normalizecuration.md -->

# normalizeCuration

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/curation.ts` (line 17)

Coerce whatever is stored in settings JSON into a safe, capped curation object.

## Signature

```ts
function normalizeCuration(raw: unknown): TechdocsCuration
```

## Parameters

| Name | Type |
|---|---|
| `raw` | `unknown` |

**Returns:** `TechdocsCuration`

<!-- source: module-organizationmodule.md -->

# OrganizationModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/organization/organization.module.ts` (line 10)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `invitationmodule`
- MODULE_DECLARES → `organizationcontroller`
- MODULE_PROVIDES → `organizationservice`
- MODULE_EXPORTS → `organizationservice`

<!-- source: interface-parseprojectconfig.md -->

# ParseProjectConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/config.interface.ts` (line 217)

Project parse configuration

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `parsers` | `string[]` |
| `includePatterns` | `string[]` |
| `excludePatterns` | `string[]` |
| `incremental` | `boolean` |
| `maxFiles` | `number` |
| `parallel` | `boolean` |
| `metadata` | `Record<string, unknown>` |

<!-- source: interface-productstats.md -->

# ProductStats

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 205)

Aggregate product stats from the knowledge graph.

## Properties

| Property | Type |
|---|---|
| `entityCount` | `number` |
| `apiEndpointCount` | `number` |
| `componentCount` | `number` |
| `modelCount` | `number` |
| `featureCount` | `number` |
| `documentCount` | `number` |
| `screenshotCount` | `number` |
| `categoryCount` | `number` |

<!-- source: component-socialprooftestimonials.md -->

# SocialProofTestimonials

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/social-proof/social-proof-testimonials.tsx` (line 22)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | - | - |
| `descriptionKey` | `string` | - | - |
| `testimonials` | `Testimonial[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SocialProofTestimonials_19216229["SocialProofTestimonials"]
    class component_SocialProofTestimonials_19216229 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `TestimonialCard`
- USES_HOOK → `useTranslation`

<!-- source: constant-templategallery.md -->

# TemplateGallery

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/components/Templates/TemplateGallery.tsx` (line 26)

TemplateGallery - Main component for browsing and selecting templates

Displays a filterable gallery of document templates with category filtering,
search, preview functionality, and template selection.

<!-- source: interface-themeconfig.md -->

# ThemeConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 39)

## Properties

| Property | Type |
|---|---|
| `mode` | `ThemeMode` |
| `primaryColor` | `string` |
| `fontFamily` | `string` |

<!-- source: class-waitfordto.md -->

# WaitForDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/screenshot-worker/src/app/screenshot/dto/batch-screenshot.dto.ts` (line 123)

Wait condition DTO for page readiness

Supports various wait strategies:
- selector: Wait for element to appear
- timeout: Wait for fixed duration
- networkIdle: Wait for network to be idle
- loadState: Wait for page load state
- function: Wait for JS expression to be truthy

## Properties

| Property | Type |
|---|---|
| `type` | `WaitType` |
| `selector` | `string` |
| `duration` | `number` |
| `state` | `LoadState` |
| `function` | `string` |
| `timeout` | `number` |

<!-- source: function-waitforelement.md -->

# waitForElement

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 14)

Wait for an element to be visible and stable

## Signature

```ts
async function waitForElement(page: Page, selector: string, options: { timeout?: number }): Promise<Locator>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |
| `selector` | `string` |
| `options` | `{ timeout?: number }` |

**Returns:** `Promise<Locator>`

<!-- source: class-yamlparser-2.md -->

# YamlParser

**Kind:** Class

**Source:** `atloria-monorepo/libs/parser-core/src/parsers/config-docs/yaml.parser.ts` (line 44)

YAML Parser implementation

**Implements:** `IParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `initialize` | `initialize(_config: ParserConfig)` | `Promise<void>` |
| `canParse` | `canParse(filePath: string)` | `boolean` |
| `parseFile` | `parseFile(filePath: string, content: string)` | `Promise<ParseResult>` |
| `parseFiles` | `parseFiles(files: ParseFileInput[])` | `Promise<ParseResult[]>` |
| `destroy` | `destroy()` | `Promise<void>` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |
| `version` | `any` |
| `supportedPatterns` | `any` |

<!-- source: constant-applylinkchanges.md -->

# applyLinkChanges$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 278)

A signal that confirms the updated values of the current link.

<!-- source: interface-atloriaproviderprops.md -->

# AtloriaProviderProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/providers/AtloriaProvider.tsx` (line 21)

Props for AtloriaProvider

## Properties

| Property | Type |
|---|---|
| `children` | `ReactNode` |
| `apiClient` | `APIClient` |

<!-- source: component-basics.md -->

# Basics

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/link-dialog.tsx` (line 17)

## Diagram

```mermaid
graph TD
    component_Basics_5674c091["Basics"]
    class component_Basics_5674c091 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: api-endpoint-capturescreenshot.md -->

# captureScreenshot

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 343)

## Endpoint

`POST /doc-versions/:projectId/:versionId/screenshots/capture`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-changepairblock.md -->

# ChangePairBlock

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/documents/[id]/compare/page.tsx` (line 903)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `pair` | `ChangePair` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ChangePairBlock_32a6f2c["ChangePairBlock"]
    class component_ChangePairBlock_32a6f2c rootComponent
```

## Relationships

- RENDERS → `MarkdownRenderer`

## Referenced By

- `TimelineCard` (RENDERS)

<!-- source: interface-cloneoptions.md -->

# CloneOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/parsing/git-clone.service.ts` (line 11)

## Properties

| Property | Type |
|---|---|
| `repositoryUrl` | `string` |
| `provider` | `RepositoryProvider` |
| `branch` | `string` |
| `credentials` | `RepositoryCredentialsDto` |

<!-- source: interface-compactionsummary.md -->

# CompactionSummary

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/compaction-types.ts` (line 25)

Smart Compaction Types

Structured schema for model-based context compaction.
The CompactionSummary is a persistent, evolving document that captures
everything the agent needs to continue working after context compression.

Anchored Iterative Summarization (Factory.ai pattern):
- First compaction: summarize full history into CompactionSummary v1
- Subsequent compactions: merge NEW items into existing summary (delta merge)
- Code snippets are NEVER summarized — preserved verbatim

## Properties

| Property | Type |
|---|---|
| `sessionGoal` | `string` |
| `progress` | `{
    /** Tasks/steps already completed */
    completed: string[];
    /** What the agent is currently working on */
    inProgress: string;
    /** Known remaining steps */
    remaining: string[];
    /** Things preventing progress */
    blockers: string[];
  }` |
| `fileOperations` | `Array<{
    path: string;
    action: 'created' | 'modified' | 'read' | 'deleted';
    /** What was done or learned from this file */
    keyDetails: string;
  }>` |
| `decisions` | `Array<{
    decision: string;
    rationale: string;
  }>` |
| `errors` | `Array<{
    error: string;
    resolved: boolean;
    resolution?: string;
  }>` |
| `preservedCode` | `Array<{
    file: string;
    snippet: string;
    why: string;
  }>` |
| `domainState` | `Record<string, string>` |

<!-- source: class-createdocumentdto.md -->

# CreateDocumentDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/create-document.dto.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `slug` | `string` |
| `content` | `string` |
| `type` | `DocumentType` |
| `audiences` | `string[]` |
| `projectId` | `string` |
| `categoryId` | `string` |
| `source` | `DocumentSource` |
| `canRegenerate` | `boolean` |
| `kgEntityId` | `string` |
| `kgEntityType` | `string` |

<!-- source: function-createerrorfromresponse.md -->

# createErrorFromResponse

**Kind:** Function

**Source:** `atloria-monorepo/packages/api-client/src/types/errors.ts` (line 110)

Create appropriate error from HTTP response

## Signature

```ts
function createErrorFromResponse(status: number, data: unknown): APIError
```

## Parameters

| Name | Type |
|---|---|
| `status` | `number` |
| `data` | `unknown` |

**Returns:** `APIError`

<!-- source: function-createglobsearchtool.md -->

# createGlobSearchTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/glob-search.tool.ts` (line 23)

## Signature

```ts
function createGlobSearchTool(options: GlobSearchOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `GlobSearchOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: function-createseoagent.md -->

# createSeoAgent

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/agents/seo.agent.ts` (line 18)

## Signature

```ts
function createSeoAgent(config: GenerationConfig, deps: SeoDependencies): AgentConfig<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |
| `deps` | `SeoDependencies` |

**Returns:** `AgentConfig<PmeContext>`

<!-- source: interface-dependencyinfo-2.md -->

# DependencyInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 833)

Dependency injection info

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `token` | `string` |
| `optional` | `boolean` |

<!-- source: interface-deskthread.md -->

# DeskThread

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `ticketNumber` | `number` |
| `title` | `string` |
| `description` | `string` |
| `ticketType` | `string` |
| `status` | `string` |
| `priority` | `string` |
| `assignee` | `{ id: string; name: string } | null` |
| `reporterEmail` | `string | null` |
| `chatSessionId` | `string | null` |
| `pageUrl` | `string | null` |
| `createdAt` | `string` |
| `updatedAt` | `string` |
| `commentCount` | `number` |
| `snoozedUntil` | `string | null` |
| `firstAgentReplyAt` | `string | null` |
| `slaDueAt` | `string | null` |
| `slaState` | `SlaState` |

<!-- source: function-detecttransitionmethods.md -->

# detectTransitionMethods

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/semantic-detector.ts` (line 106)

Detect state transition methods

Finds methods that likely change state based on naming patterns:
- convert*, approve*, reject*, cancel*, regret*, submit*, activate*

## Signature

```ts
function detectTransitionMethods(code: string): string[]
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string` |

**Returns:** `string[]`

<!-- source: service-diffservice.md -->

# DiffService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/change-request/diff.service.ts` (line 35)

DiffService — the CR diff engine over the per-project docs git substrate (S2.2).

Two capabilities:
 - diffRefs: a structured two-ref diff (per-file status, +/- counts, unified hunks with
   old/new line numbers, and heading-level SectionDiffs so the UI can say "§Setup changed").
 - threeWaySections: a pure, heading-aligned three-way section classifier for CR merge
   (base vs mine vs theirs → unchanged / take-theirs / keep-mine / conflict).

ALL git invocation is via promisified execFile('git', [argv]) — never a shell string —
mirroring DocsRepoService. Renames are reported as delete+add for v1 (`--no-renames`).

## Methods

| Method | Signature | Returns |
|---|---|---|
| `diffRefs` | `diffRefs(projectId: string, baseRef: string, headRef: string, paths: string[])` | `Promise<CrDiff>` |
| `threeWaySections` | `threeWaySections(base: string, mine: string, theirs: string)` | `ThreeWaySection[]` |

## Relationships

- DEPENDS_ON → `docsreposervice`

<!-- source: class-directivenode.md -->

# DirectiveNode

**Kind:** Class

**Source:** `atloria-monorepo/packages/editor/src/plugins/directives/DirectiveNode.tsx` (line 27)

**Extends:** `DecoratorNode`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getType` | `getType()` | `string` |
| `clone` | `clone(node: DirectiveNode)` | `DirectiveNode` |
| `importJSON` | `importJSON(serializedNode: SerializedDirectiveNode)` | `DirectiveNode` |
| `getMdastNode` | `getMdastNode()` | `Directives` |
| `exportJSON` | `exportJSON()` | `SerializedDirectiveNode` |
| `createDOM` | `createDOM()` | `HTMLElement` |
| `updateDOM` | `updateDOM()` | `false` |
| `setMdastNode` | `setMdastNode(mdastNode: Directives)` | `void` |
| `decorate` | `decorate(parentEditor: LexicalEditor, config: EditorConfig)` | `JSX.Element` |
| `isInline` | `isInline()` | `boolean` |
| `isKeyboardSelectable` | `isKeyboardSelectable()` | `boolean` |

## Properties

| Property | Type |
|---|---|
| `__mdastNode` | `Directives` |
| `__focusEmitter` | `any` |
| `select` | `any` |

<!-- source: function-get.md -->

# GET

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/.well-known/llms.txt/route.ts` (line 14)

Tenant-level agent discovery: /.well-known/llms.txt — a short "About Atloria" section (so agents
reading Atloria's own llms.txt learn what Atloria IS), followed by an INDEX (not one site's
content) of every published docs site's per-site llms.txt. On a multi-tenant single origin (many
sites under /p/<slug>) a root content file can't represent all sites, so this is the honest,
discoverable entrypoint: one fetch → the list of per-site llms.txt / llms-full.txt URLs. Each
site also carries its own <link rel="alternate"> hints (see p/[slugId]/layout.tsx).

<!-- source: constant-global-throttle.md -->

# GLOBAL_THROTTLE

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/common/throttling.module.ts` (line 17)

Global rate-limiting configuration.

- GLOBAL_THROTTLE: sane per-IP default applied to every HTTP route.
- AUTH_LOGIN_THROTTLE: strict limit on credential endpoints to slow
  brute-force attacks.
- PUBLIC_SSE_THROTTLE: strict per-IP quota on the public, unauthenticated
  SSE LLM endpoint (each request costs real AI tokens).

Values are exported so specs can assert the exact quotas the guard
enforces on real routes.

<!-- source: type-heading-level.md -->

# HEADING_LEVEL

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/headings/index.ts` (line 27)

## Definition

```ts
1 | 2 | 3 | 4 | 5 | 6
```

<!-- source: controller-manualsinsightscontroller.md -->

# ManualsInsightsController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/manuals-insights/manuals-insights.controller.ts` (line 12)

Content-Intelligence loop (M1). Two surfaces:
 - authed, org-scoped insights for the manual-authoring cockpit
 - a PUBLIC per-slug freshness check for the reader-facing "may be out of date" badge

## Relationships

- MODULE_DECLARES → `insights`
- MODULE_DECLARES → `deflection`
- MODULE_DECLARES → `ticketTopics`
- MODULE_DECLARES → `draftTicketTopic`
- MODULE_DECLARES → `freshness`
- DEPENDS_ON → `manualsinsightsservice`

<!-- source: class-modelcompactor.md -->

# ModelCompactor

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/context/model-compactor.ts` (line 176)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `compact` | `compact(items: unknown[])` | `Promise<string>` |
| `getSummary` | `getSummary()` | `CompactionSummary | null` |
| `setSummary` | `setSummary(summary: CompactionSummary)` | `void` |
| `getEvents` | `getEvents()` | `readonly CompactionEvent[]` |
| `formatSummaryForContext` | `formatSummaryForContext()` | `string` |
| `hasPendingCompaction` | `hasPendingCompaction()` | `boolean` |
| `flush` | `flush()` | `Promise<void>` |
| `reset` | `reset()` | `void` |

<!-- source: function-normalizeforcompare.md -->

# normalizeForCompare

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr.service.ts` (line 333)

Normalize markdown for equality: ignore CRLF, trailing whitespace, and blank-line runs.

## Signature

```ts
function normalizeForCompare(md: string): string
```

## Parameters

| Name | Type |
|---|---|
| `md` | `string` |

**Returns:** `string`

<!-- source: interface-parserconfig.md -->

# ParserConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/parser.interface.ts` (line 17)

Configuration for parser initialization

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `tsconfigPath` | `string` |
| `options` | `Record<string, unknown>` |
| `debug` | `boolean` |
| `excludePatterns` | `string[]` |
| `maxFileSize` | `number` |
| `timeout` | `number` |

<!-- source: module-parsermodule.md -->

# ParserModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/parser/parser.module.ts` (line 12)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_DECLARES → `parsercontroller`
- MODULE_PROVIDES → `parserservice`
- MODULE_PROVIDES → `typescriptparser`
- MODULE_PROVIDES → `javascriptparser`
- MODULE_PROVIDES → `pythonparser`
- MODULE_PROVIDES → `symbolindexservice`
- MODULE_EXPORTS → `parserservice`
- MODULE_EXPORTS → `symbolindexservice`

<!-- source: interface-productworkflow.md -->

# ProductWorkflow

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 171)

A user workflow (step-by-step journey through the product).

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `steps` | `Array<{ order: number; action: string; component?: string }>` |
| `featureIds` | `string[]` |

<!-- source: component-socialprooftimeline.md -->

# SocialProofTimeline

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/social-proof/social-proof-timeline.tsx` (line 78)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `milestones` | `Milestone[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SocialProofTimeline_4ebf2c89["SocialProofTimeline"]
    class component_SocialProofTimeline_4ebf2c89 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `TimelineDot`
- RENDERS → `MilestoneCard`
- USES_HOOK → `useTranslation`

<!-- source: constant-theme-presets.md -->

# THEME_PRESETS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/theme-presets.ts` (line 21)

## Definition

```ts
Record<string, { label: string; tokens: ThemeTokens }>
```

<!-- source: interface-themevars.md -->

# ThemeVars

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/tools/theme.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `'--bg-page'` | `string` |
| `'--bg-surface'` | `string` |
| `'--bg-surface-alt'` | `string` |
| `'--bg-nav'` | `string` |
| `'--text-heading'` | `string` |
| `'--text-body'` | `string` |
| `'--text-muted'` | `string` |
| `'--text-on-accent'` | `string` |
| `'--accent'` | `string` |
| `'--accent-hover'` | `string` |
| `'--accent-subtle'` | `string` |
| `'--accent-glow'` | `string` |
| `'--border'` | `string` |
| `'--border-hover'` | `string` |

<!-- source: function-waitforloadingcomplete.md -->

# waitForLoadingComplete

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 126)

Wait for loading state to complete

## Signature

```ts
async function waitForLoadingComplete(page: Page): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |

**Returns:** `Promise<void>`

<!-- source: constant-applylisttype.md -->

# applyListType$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/lists/index.ts` (line 91)

Converts the current selection to the specified list type.

<!-- source: interface-audienceandnode.md -->

# AudienceAndNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 110)

## Properties

| Property | Type |
|---|---|
| `type` | `'and'` |
| `operands` | `AudienceLogicTree[]` |

<!-- source: component-basics-2.md -->

# Basics

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/print.stories.tsx` (line 24)

## Diagram

```mermaid
graph TD
    component_Basics_27f741e8["Basics"]
    class component_Basics_27f741e8 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useRef`

<!-- source: api-endpoint-capturescreenshot-2.md -->

# captureScreenshot

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/screenshot/screenshot.controller.ts` (line 26)

## Endpoint

`POST /screenshots`

## Referenced By

- `ScreenshotController` (MODULE_DECLARES)

<!-- source: component-checkicon.md -->

# CheckIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/CodeViewer.tsx` (line 127)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_CheckIcon_5dee0bde["CheckIcon"]
    class component_CheckIcon_5dee0bde rootComponent
```

## Referenced By

- `CodeViewer` (RENDERS)

<!-- source: interface-cloneresult.md -->

# CloneResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/parsing/git-clone.service.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `success` | `boolean` |
| `localPath` | `string` |
| `error` | `string` |

<!-- source: interface-compactoroptions.md -->

# CompactorOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 405)

Options for the context compactor (reactive compaction).

## Properties

| Property | Type |
|---|---|
| `tokenThreshold` | `number` |
| `compact` | `(items: AgentInputItem[]) => AgentInputItem[] | Promise<AgentInputItem[]>` |

<!-- source: class-createdocversiondto.md -->

# CreateDocVersionDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/doc-version/dto/doc-version.dto.ts` (line 5)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `label` | `string` |
| `description` | `string` |
| `commitHash` | `string` |
| `branch` | `string` |
| `gitTag` | `string` |
| `previousVersionId` | `string` |

<!-- source: function-createfileloader.md -->

# createFileLoader

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-04-analysis/iterative-deep-loader.ts` (line 398)

Create a default file loader that reads from the file system

## Signature

```ts
function createFileLoader(basePath: string): (filePath: string, startLine?: number, endLine?: number) => Promise<string>
```

## Parameters

| Name | Type |
|---|---|
| `basePath` | `string` |

**Returns:** `(filePath: string, startLine?: number, endLine?: number) => Promise<string>`

<!-- source: function-creategrepsearchtool.md -->

# createGrepSearchTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/grep-search.tool.ts` (line 42)

## Signature

```ts
function createGrepSearchTool(options: GrepSearchOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `GrepSearchOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: function-createseometadatatool.md -->

# createSeoMetadataTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/seo-metadata.tool.ts` (line 21)

## Signature

```ts
function createSeoMetadataTool(_generateFn: ContentGenerateFn): ToolDefinition<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `_generateFn` | `ContentGenerateFn` |

**Returns:** `ToolDefinition<PmeContext>`

<!-- source: interface-dependencynode-2.md -->

# DependencyNode

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/relationship.interface.ts` (line 371)

Node in a dependency tree

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `type` | `string` |
| `relationshipType` | `RelationshipType` |
| `children` | `DependencyNode[]` |
| `depth` | `number` |

<!-- source: interface-deskthreaddetail.md -->

# DeskThreadDetail

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 65)

## Properties

| Property | Type |
|---|---|
| `comments` | `DeskComment[]` |
| `activities` | `DeskActivity[]` |

<!-- source: function-detectuiinteractions.md -->

# detectUIInteractions

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ui-interaction-detector.ts` (line 78)

Extract UI interactions from component template code

Analyzes HTML/JSX templates to find interactive elements (buttons, links)
and maps them to state machine transitions.

## Signature

```ts
function detectUIInteractions(templateCode: string, stateMachines: StateMachine[], componentName: string): UIInteraction[]
```

## Parameters

| Name | Type |
|---|---|
| `templateCode` | `string` |
| `stateMachines` | `StateMachine[]` |
| `componentName` | `string` |

**Returns:** `UIInteraction[]`

<!-- source: class-directiveparser.md -->

# DirectiveParser

**Kind:** Class

**Source:** `atloria-monorepo/packages/core/src/rendering/directive-parser.ts` (line 61)

Directive Parser

## Methods

| Method | Signature | Returns |
|---|---|---|
| `parse` | `parse(content: string)` | `DocumentAST` |

<!-- source: service-docautomationschedulerservice.md -->

# DocAutomationSchedulerService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/doc-automation-scheduler.service.ts` (line 8)

Phase 5: Cron-based scheduled documentation regeneration.
Uses setInterval-based scheduling (no external cron dependency needed).

`DocAutomationSchedulerService` manages scheduled documentation regeneration for the API using in-process `setInterval` timers rather than an external cron dependency. It coordinates recurring automation runs, triggers the documentation generation workflow, and ensures scheduled jobs are started and cleaned up with the NestJS application lifecycle.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `unknown` |
| `onModuleDestroy` | `onModuleDestroy()` | `unknown` |

## Diagram

```mermaid
sequenceDiagram
  participant App as NestJS Application
  participant Scheduler as DocAutomationSchedulerService
  participant Timer as setInterval Timer
  participant Generator as Documentation Generator
  participant Storage as Documentation Storage

  App->>Scheduler: onModuleInit()
  Scheduler->>Timer: register scheduled interval

  loop At configured interval
    Timer->>Scheduler: execute scheduled job
    Scheduler->>Generator: regenerate documentation
    Generator->>Storage: persist generated docs
    Storage-->>Generator: saved
    Generator-->>Scheduler: generation result
  end

  App->>Scheduler: onModuleDestroy()
  Scheduler->>Timer: clearInterval()
```

## Usage

```ts
import { Injectable, OnModuleInit } from '@nestjs/common';
import { DocAutomationSchedulerService } from './documentation/services/doc-automation-scheduler.service';

@Injectable()
export class AppBootstrapService implements OnModuleInit {
  constructor(
    private readonly docScheduler: DocAutomationSchedulerService,
  ) {}

  onModuleInit(): void {
    // Start the configured recurring documentation regeneration job.
    this.docScheduler.start();
  }
}
```

## AI Coding Instructions

- Keep scheduling in-process with `setInterval`; do not introduce an external cron dependency unless the deployment architecture requires distributed scheduling.
- Ensure every created interval is cleared during module/application shutdown to prevent dangling timers and test-process hangs.
- Guard against overlapping regeneration runs when an execution takes longer than the configured interval.
- Route generation through the existing documentation automation/generation service rather than duplicating generation or persistence logic in the scheduler.
- Make schedule intervals configurable through application configuration, and use shorter intervals or mocked timers in tests.

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: function-get-2.md -->

# GET

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/api/hello/route.ts` (line 1)

## Signature

```ts
async function GET(_request: Request)
```

## Parameters

| Name | Type |
|---|---|
| `_request` | `Request` |

<!-- source: constant-graphqlapitemplate.md -->

# graphqlApiTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/graphql-api.template.ts` (line 3)

<!-- source: type-imagepreviewhandler.md -->

# ImagePreviewHandler

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 51)

## Definition

```ts
((imageSource: string) => Promise<string>) | null
```

<!-- source: class-modelrouter.md -->

# ModelRouter

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-router.ts` (line 118)

Resolves the model to use for a given task.

Usage:
```typescript
const router = new ModelRouter(GPT54_FAMILY_ROUTING_TABLE, 'gpt-5.6-terra');
const model = router.route('explore');  // → 'gpt-5.6-luna'
const model = router.route('plan');     // → 'gpt-5.6-terra'
const model = router.route();           // → 'gpt-5.6-terra' (default)
```

## Methods

| Method | Signature | Returns |
|---|---|---|
| `route` | `route(category: TaskCategory, explicitModel: string)` | `string` |
| `isActive` | `isActive()` | `boolean` |
| `summary` | `summary()` | `Record<string, string>` |

<!-- source: function-normalizeicon.md -->

# normalizeIcon

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/document/utils/icon-mapper.ts` (line 246)

Convert an Ant Design icon name to emoji
Returns null if no icon provided, returns emoji if found, otherwise returns original value

## Signature

```ts
function normalizeIcon(icon: string | null | undefined): string | null
```

## Parameters

| Name | Type |
|---|---|
| `icon` | `string | null | undefined` |

**Returns:** `string | null`

<!-- source: controller-notificationcontroller.md -->

# NotificationController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/notification/notification.controller.ts` (line 13)

Reader API for the in-app notification feed (navbar bell). The producers
(comments, mentions, docs-generation completion hooks) already write rows;
this controller is what finally makes them readable — journey fix P1.d
"The Silent Factory". Every route is scoped to the JWT caller.

`NotificationController` is a NestJS reader API for the in-app notification feed (the navbar bell). It exposes JWT-scoped endpoints that let the authenticated caller list/read their notification rows and update read state, while producers (comments, mentions, doc-generation hooks) only write the underlying records. This controller is the “last mile” that makes notification data consumable per user.

## Diagram

```mermaid
graph LR
  A[Producers<br/>(comments, mentions, docs hooks)] -->|write rows| B[(Notifications Store)]
  C[JWT Caller<br/>(web app)] -->|HTTP requests| D[NotificationController]
  D -->|auth scope: caller| E[NotificationService/Queries]
  E -->|read / update read state| B
  D -->|DTO response| C
```

## Usage

```ts
// Client-side example (e.g., web app) calling the NotificationController endpoints.
// Assumes the controller is mounted under /notification (common NestJS convention).
// Adjust paths to match your actual route decorators.

async function fetchNotifications(jwt: string) {
  const res = await fetch(`${process.env.API_URL}/notification`, {
    method: "GET",
    headers: { Authorization: `Bearer ${jwt}` },
  });

  if (!res.ok) throw new Error(`Failed to fetch notifications: ${res.status}`);
  return (await res.json()) as {
    items: Array<{ id: string; title?: string; createdAt: string; readAt?: string }>;
    nextCursor?: string;
  };
}

async function markNotificationRead(jwt: string, id: string) {
  const res = await fetch(`${process.env.API_URL}/notification/${id}/read`, {
    method: "POST",
    headers: { Authorization: `Bearer ${jwt}` },
  });

  if (!res.ok) throw new Error(`Failed to mark read: ${res.status}`);
  return res.json();
}

async function markAllRead(jwt: string) {
  const res = await fetch(`${process.env.API_URL}/notification/read-all`, {
    method: "POST",
    headers: { Authorization: `Bearer ${jwt}` },
  });

  if (!res.ok) throw new Error(`Failed to mark all read: ${res.status}`);
  return res.json();
}
```

## AI Coding Instructions

- Keep every route strictly scoped to the JWT caller (never accept a `userId` param/body for reads or mutations; derive identity from the auth context/guard).
- Follow the existing read-model pattern: producers write notification rows; the controller should only read/ack/update read state, not generate notifications.
- Ensure pagination/filtering is stable and deterministic (e.g., cursor-based by `createdAt`/`id`), and always apply the caller scope before ordering/limits.
- Be careful with “mark as read” operations: enforce ownership checks at the query level to prevent cross-user updates and avoid leaking existence via error messages.
- Maintain contract consistency for the navbar bell: lightweight list endpoint + unread count/read-state updates; coordinate DTO changes with frontend consumers.

## Relationships

- MODULE_DECLARES → `list`
- MODULE_DECLARES → `markRead`
- MODULE_DECLARES → `readAll`
- DEPENDS_ON → `notificationservice`

<!-- source: interface-parseresult.md -->

# ParseResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/parse-result.interface.ts` (line 208)

Result of parsing a single file

## Properties

| Property | Type |
|---|---|
| `parserName` | `string` |
| `filePath` | `string` |
| `timestamp` | `Date` |
| `status` | `ParseStatus` |
| `entities` | `Entity[]` |
| `relationships` | `Relationship[]` |
| `errors` | `ParseError[]` |
| `warnings` | `ParseWarning[]` |
| `metadata` | `ParseMetadata` |

<!-- source: module-parsingmodule.md -->

# ParsingModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/parsing/parsing.module.ts` (line 9)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_DECLARES → `parsingcontroller`
- MODULE_DECLARES → `testconnectioncontroller`
- MODULE_PROVIDES → `parsingservice`
- MODULE_PROVIDES → `parsingqueue`
- MODULE_PROVIDES → `gitcloneservice`
- MODULE_EXPORTS → `parsingservice`
- MODULE_EXPORTS → `gitcloneservice`

<!-- source: interface-sectionselection.md -->

# SectionSelection

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 48)

## Properties

| Property | Type |
|---|---|
| `sectionId` | `string` |
| `props` | `Record<string, unknown>` |

<!-- source: component-socialprooftrustbadges.md -->

# SocialProofTrustBadges

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/social-proof/social-proof-trust-badges.tsx` (line 36)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | - | - |
| `descriptionKey` | `string` | - | - |
| `badges` | `TrustBadge[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SocialProofTrustBadges_46d5741c["SocialProofTrustBadges"]
    class component_SocialProofTrustBadges_46d5741c rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: constant-ticket-type-cfg.md -->

# TICKET_TYPE_CFG

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 117)

## Definition

```ts
Record<string, { bg: string; text: string; label: string }>
```

<!-- source: interface-variantdependencies.md -->

# VariantDependencies

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/agents/variant.agent.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `searchFn` | `DocSearchFn` |
| `generateFn` | `ContentGenerateFn` |

<!-- source: function-waitformodal.md -->

# waitForModal

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 89)

Wait for a modal/dialog to appear

## Signature

```ts
async function waitForModal(page: Page): Promise<Locator>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |

**Returns:** `Promise<Locator>`

<!-- source: interface-audienceleaf.md -->

# AudienceLeaf

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 100)

## Properties

| Property | Type |
|---|---|
| `type` | `'audience'` |
| `slug` | `string` |

<!-- source: constant-auto-generated-file-patterns.md -->

# AUTO_GENERATED_FILE_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 498)

<!-- source: component-basics-3.md -->

# Basics

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/site-demo.tsx` (line 9)

## Diagram

```mermaid
graph TD
    component_Basics_52672bf["Basics"]
    class component_Basics_52672bf rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useRef`

<!-- source: api-endpoint-chat.md -->

# chat

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.controller.ts` (line 148)

## Endpoint

`POST /support-agent/:projectId/agents/:agentId/chat`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `agentId` | query | `string` | ✓ |

## Referenced By

- `SupportAgentController` (MODULE_DECLARES)

<!-- source: component-chip.md -->

# Chip

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/ThreadView.tsx` (line 41)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `bg` | `string` | ✓ | - |
| `text` | `string` | ✓ | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Chip_620c5139["Chip"]
    class component_Chip_620c5139 rootComponent
```

## Referenced By

- `ThreadView` (RENDERS)

<!-- source: interface-codeexample.md -->

# CodeExample

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/feature-detector.service.ts` (line 6)

Code example extracted from component

## Properties

| Property | Type |
|---|---|
| `language` | `string` |
| `code` | `string` |
| `description` | `string` |
| `source` | `string` |
| `lineStart` | `number` |
| `lineEnd` | `number` |

<!-- source: interface-conditionallayer.md -->

# ConditionalLayer

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/instruction-loader.ts` (line 42)

## Properties

| Property | Type |
|---|---|
| `condition` | `() => boolean` |

<!-- source: class-createentitydto.md -->

# CreateEntityDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/graph/dto/create-entity.dto.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `id` | `string` |
| `type` | `EntityType` |
| `name` | `string` |
| `description` | `string` |
| `documentId` | `string` |
| `metadata` | `Record<string, any>` |

<!-- source: function-createinvalidresult.md -->

# createInvalidResult

**Kind:** Function

**Source:** `atloria-monorepo/packages/core/src/validators/validation-result.ts` (line 19)

Create a failed validation result with errors

## Signature

```ts
function createInvalidResult(errors: string[]): ValidationResult
```

## Parameters

| Name | Type |
|---|---|
| `errors` | `string[]` |

**Returns:** `ValidationResult`

<!-- source: function-createjournaltool.md -->

# createJournalTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/journal.tool.ts` (line 29)

## Signature

```ts
function createJournalTool(options: JournalToolOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `JournalToolOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: function-createstoreassettool.md -->

# createStoreAssetTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/store-asset.tool.ts` (line 20)

## Signature

```ts
function createStoreAssetTool(storeFn: StoreAssetFn): ToolDefinition<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `storeFn` | `StoreAssetFn` |

**Returns:** `ToolDefinition<PmeContext>`

<!-- source: interface-dependencytree-2.md -->

# DependencyTree

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/relationship.interface.ts` (line 336)

Dependency tree structure

## Properties

| Property | Type |
|---|---|
| `rootId` | `string` |
| `rootName` | `string` |
| `rootType` | `string` |
| `children` | `DependencyNode[]` |
| `depth` | `number` |
| `totalNodes` | `number` |

<!-- source: function-diffentities.md -->

# diffEntities

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/staleness.ts` (line 60)

Diff a previous hash map against the current entities → what to regenerate/upsert/delete.

## Signature

```ts
function diffEntities(prevHashes: Record<string, string>, entities: Entity[]): EntityDiff
```

## Parameters

| Name | Type |
|---|---|
| `prevHashes` | `Record<string, string>` |
| `entities` | `Entity[]` |

**Returns:** `EntityDiff`

<!-- source: class-discoveryclient.md -->

# DiscoveryClient

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/discovery.client.ts` (line 32)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `scan` | `scan(request: DiscoveryScanRequest)` | `Promise<SiteMap>` |

<!-- source: interface-dnsrecordspec.md -->

# DnsRecordSpec

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/lib/api-client.ts` (line 52)

## Properties

| Property | Type |
|---|---|
| `type` | `'CNAME' | 'TXT'` |
| `name` | `string` |
| `expected` | `string` |

<!-- source: service-docautomationservice.md -->

# DocAutomationService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/doc-automation.service.ts` (line 99)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `Promise<void>` |
| `onModuleDestroy` | `onModuleDestroy()` | `Promise<void>` |
| `createConfig` | `createConfig(dto: CreateDocAutomationConfigDto, user: JwtPayload)` | `unknown` |
| `getConfig` | `getConfig(projectId: string, user: JwtPayload)` | `unknown` |
| `getScreenBaseline` | `getScreenBaseline(projectId: string, user: JwtPayload)` | `Promise<{ screens: unknown[]; generatorFingerprint: string | null }>` |
| `updateConfig` | `updateConfig(projectId: string, dto: UpdateDocAutomationConfigDto, user: JwtPayload)` | `unknown` |
| `deleteConfig` | `deleteConfig(projectId: string, user: JwtPayload)` | `unknown` |
| `triggerJobFromWebhook` | `triggerJobFromWebhook(opts: {
    projectId: string;
    organizationId: string;
    branch?: string;
    commitHash?: string;
    provider: string;          // 'github' | 'gitlab' | 'azure-devops'
    event: string;             // 'push' | 'tag_create' | 'release'
  })` | `Promise<{ jobId: string; status: string }>` |
| `startJob` | `startJob(dto: StartDocJobDto, user: JwtPayload)` | `unknown` |
| `getJob` | `getJob(jobId: string, user: JwtPayload)` | `unknown` |
| `listJobs` | `listJobs(filters: JobFiltersDto, user: JwtPayload)` | `unknown` |
| `reportExternalProgress` | `reportExternalProgress(jobId: string, body: {
      stage: string;
      progress: number;
      stageProgress?: number;
      currentItem?: string;
      eventType?: string;
    }, user: JwtPayload)` | `Promise<{ ok: true }>` |
| `reportExternalFailure` | `reportExternalFailure(jobId: string, body: { error: string; errorStage?: string; errorStack?: string }, user: JwtPayload)` | `Promise<{ ok: true }>` |
| `runUploadOnExistingJob` | `runUploadOnExistingJob(jobId: string, externalOutputPath: string, user: JwtPayload, options: {
      updateAssetsOnly?: boolean;
      onlySlugs?: string[];
      // S3.1 delta: forwarded to runExternalOutputUpload so a change-aware run patches the
      // ACTIVE version in place (partial-merge) instead of a full replace (page loss).
      deltaMerge?: boolean;
      removedSlugs?: string[];
    })` | `Promise<{ ok: true }>` |
| `cancelJob` | `cancelJob(jobId: string, user: JwtPayload)` | `unknown` |
| `updateJobProgress` | `updateJobProgress(jobId: string, update: JobProgressUpdate)` | `unknown` |
| `completeJob` | `completeJob(jobId: string, data: JobCompletionData)` | `unknown` |
| `failJob` | `failJob(jobId: string, data: JobFailureData)` | `unknown` |
| `deleteJobDocuments` | `deleteJobDocuments(jobId: string, user: JwtPayload)` | `unknown` |
| `triggerBackgroundScreenshots` | `triggerBackgroundScreenshots(jobId: string, user: JwtPayload)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `docautomationgateway`
- DEPENDS_ON → `urlservice`
- DEPENDS_ON → `assetsservice`
- DEPENDS_ON → `documentindexingservice`
- DEPENDS_ON → `aiusageservice`
- DEPENDS_ON → `queue`
- DEPENDS_ON → `azureclaudeprovider`
- DEPENDS_ON → `docversionservice`
- DEPENDS_ON → `versioncarryforwardservice`
- DEPENDS_ON → `notificationservice`
- DEPENDS_ON → `emailservice`
- DEPENDS_ON → `outboxservice`
- DEPENDS_ON → `changerequestservice`

<!-- source: function-get-3.md -->

# GET

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/api/stats/route.ts` (line 5)

<!-- source: type-imageuploadfn.md -->

# ImageUploadFn

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 20)

Image upload function type
Takes image buffer and filename, returns CDN URL

## Definition

```ts
(
  buffer: Buffer,
  filename: string,
  mimeType: string
) => Promise<string>
```

<!-- source: constant-integrationspectemplate.md -->

# integrationSpecTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/integration-spec.template.ts` (line 3)

<!-- source: function-normalizereferrer.md -->

# normalizeReferrer

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/analytics/utils/tracking-utils.ts` (line 76)

Map a raw referrer URL into a small, normalized source bucket so that
`https://www.google.com/search?q=foo` and `https://google.com/` both
roll up under "google" in the dashboard. Unknown hosts collapse to
the bare hostname so we can still see long-tail sources.

## Signature

```ts
function normalizeReferrer(referrer: string | null | undefined): string
```

## Parameters

| Name | Type |
|---|---|
| `referrer` | `string | null | undefined` |

**Returns:** `string`

<!-- source: controller-opscontroller.md -->

# OpsController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/ops/ops.controller.ts` (line 8)

Admin cockpit (Phase 2.3) — org-scoped operational overview.

## Relationships

- MODULE_DECLARES → `overview`
- DEPENDS_ON → `opsservice`

<!-- source: class-orchestrator.md -->

# Orchestrator

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/orchestrator.ts` (line 174)

Multi-agent orchestrator that executes phased workflows.
Within each phase, agents run in parallel. Between phases, execution is sequential.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `execute` | `execute(plan: OrchestrationPlan, context: string, baseModel: string)` | `Promise<OrchestrationResult>` |

<!-- source: interface-parsermetadata.md -->

# ParserMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/parser.interface.ts` (line 105)

Parser metadata for registration

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `version` | `string` |
| `supportedPatterns` | `string[]` |
| `description` | `string` |
| `category` | `ParserCategory` |
| `languages` | `string[]` |
| `author` | `string` |

<!-- source: module-pmemodule.md -->

# PmeModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/pme/pme.module.ts` (line 9)

## Relationships

- MODULE_DECLARES → `pmecontroller`
- MODULE_PROVIDES → `pmeservice`
- MODULE_PROVIDES → `pmegateway`
- MODULE_EXPORTS → `pmeservice`
- MODULE_EXPORTS → `pmegateway`

<!-- source: interface-seoconfig.md -->

# SeoConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 79)

## Properties

| Property | Type |
|---|---|
| `titleKey` | `string` |
| `descriptionKey` | `string` |
| `ogImage` | `string` |

<!-- source: component-statcard-4.md -->

# StatCard

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/stat-card.tsx` (line 19)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `valueKey` | `string` | ✓ | - |
| `labelKey` | `string` | ✓ | - |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_StatCard_14cf6351["StatCard"]
    class component_StatCard_14cf6351 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- USES_HOOK → `useTranslation`

<!-- source: constant-ticket-type-cfg-2.md -->

# TICKET_TYPE_CFG

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/components/Boards/helpers.ts` (line 25)

## Definition

```ts
Record<
  string,
  { bg: string; text: string; label: string }
>
```

<!-- source: interface-variantstyle.md -->

# VariantStyle

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/prompts/variant.prompts.ts` (line 11)

## Properties

| Property | Type |
|---|---|
| `key` | `VariantKey` |
| `name` | `string` |
| `description` | `string` |
| `instructions` | `string` |

<!-- source: function-waitfornavigation.md -->

# waitForNavigation

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 62)

Wait for navigation to complete

## Signature

```ts
async function waitForNavigation(page: Page, urlPattern: string | RegExp): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |
| `urlPattern` | `string | RegExp` |

**Returns:** `Promise<void>`

<!-- source: interface-audiencenode.md -->

# AudienceNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 29)

Audience block node
Represents content wrapped in AUDIENCE directives

## Properties

| Property | Type |
|---|---|
| `type` | `'audience_block'` |
| `logic` | `string` |
| `parsedLogic` | `AudienceLogicTree` |
| `children` | `ASTNode[]` |

<!-- source: constant-autofocus.md -->

# autoFocus$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 157)

<!-- source: component-basics-4.md -->

# Basics

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/toolbar.tsx` (line 44)

## Diagram

```mermaid
graph TD
    component_Basics_5df2b6f["Basics"]
    class component_Basics_5df2b6f rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: api-endpoint-chatstream.md -->

# chatStream

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.controller.ts` (line 190)

## Endpoint

`POST /support-agent/:projectId/agents/:agentId/chat-stream`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `agentId` | query | `string` | ✓ |

## Referenced By

- `SupportAgentController` (MODULE_DECLARES)

<!-- source: component-chip-2.md -->

# Chip

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 279)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `label` | `string` | ✓ | - |
| `value` | `string` | ✓ | - |
| `onRemove` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Chip_157f3617["Chip"]
    class component_Chip_157f3617 rootComponent
```

## Relationships

- RENDERS → `XMarkIcon`

## Referenced By

- `ActiveFilterChips` (RENDERS)

<!-- source: interface-codeparser.md -->

# CodeParser

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/parser/interfaces/code-parser.interface.ts` (line 1)

## Properties

| Property | Type |
|---|---|
| `language` | `string` |
| `supportedExtensions` | `string[]` |

<!-- source: interface-consolidationreport.md -->

# ConsolidationReport

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/memory/types.ts` (line 120)

## Properties

| Property | Type |
|---|---|
| `staleCount` | `number` |
| `prunedCount` | `number` |
| `mergedCount` | `number` |
| `totalRemaining` | `number` |

<!-- source: class-createflowdto.md -->

# CreateFlowDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/capture/dto/create-flow.dto.ts` (line 106)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `startUrl` | `string` |
| `steps` | `CapturedStepDto[]` |

<!-- source: function-createlearningpathtemplate.md -->

# createLearningPathTemplate

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 396)

Generate a learning path doc template for a given persona.
Learning paths are dynamic (per-persona), so they use this template factory.

## Signature

```ts
function createLearningPathTemplate(persona: { name: string; description: string }): FixedDocTemplate
```

## Parameters

| Name | Type |
|---|---|
| `persona` | `{ name: string; description: string }` |

**Returns:** `FixedDocTemplate`

<!-- source: function-createlistdirectorytool.md -->

# createListDirectoryTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/list-directory.tool.ts` (line 22)

## Signature

```ts
function createListDirectoryTool(options: ListDirectoryOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `ListDirectoryOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: function-createstrategyagent.md -->

# createStrategyAgent

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/agents/strategy.agent.ts` (line 19)

## Signature

```ts
function createStrategyAgent(config: GenerationConfig, deps: StrategyDependencies): AgentConfig<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |
| `deps` | `StrategyDependencies` |

**Returns:** `AgentConfig<PmeContext>`

<!-- source: interface-deploymentconnection.md -->

# DeploymentConnection

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/deployment-diagram.generator.ts` (line 62)

Represents a connection between deployment nodes

## Properties

| Property | Type |
|---|---|
| `from` | `string` |
| `to` | `string` |
| `type` | `ConnectionType` |
| `port` | `number` |
| `protocol` | `string` |
| `bidirectional` | `boolean` |

<!-- source: function-discoverauthconfig.md -->

# discoverAuthConfig

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/permission-extractor.ts` (line 267)

Discover authentication configuration from source code files.

Analyzes routing modules, auth services, and role definitions
to build a picture of the app's auth system.

## Signature

```ts
function discoverAuthConfig(files: Map<string, string>, _framework: 'angular' | 'vue' | 'react' | 'nextjs' | 'jquery' | 'unknown'): AuthConfigDiscovery
```

## Parameters

| Name | Type |
|---|---|
| `files` | `Map<string, string>` |
| `_framework` | `'angular' | 'vue' | 'react' | 'nextjs' | 'jquery' | 'unknown'` |

**Returns:** `AuthConfigDiscovery`

<!-- source: class-djangodetector.md -->

# DjangoDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/django-detector.ts` (line 119)

Django Detector

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectViews` | `detectViews(entities: Entity[])` | `DetectedDjangoView[]` |
| `detectSerializers` | `detectSerializers(entities: Entity[])` | `DetectedDjangoSerializer[]` |
| `detectModels` | `detectModels(entities: Entity[])` | `DetectedDjangoModel[]` |
| `getViewSummary` | `getViewSummary(view: DetectedDjangoView)` | `string` |

<!-- source: service-docsconfigservice.md -->

# DocsConfigService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/change-request/docs-config.service.ts` (line 18)

DocsConfigService — exposes the per-project docs review gate (ProjectDocsRepo.requireReview,
the S2 author-time protection toggle). A project with an EXPLICIT config row uses its stored
value; a project with NO row falls back to the platform default, which is governed by the
`DOCS_REVIEW_DEFAULT` env flag. That makes widening the S2 rollout a reversible flag flip
(DOCS_REVIEW_DEFAULT=true → every un-configured project protects published public docs via
propose→CR; the per-project toggle remains the opt-out). Reads never write.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `get` | `get(projectId: string)` | `Promise<DocsConfig>` |
| `set` | `set(projectId: string, requireReview: boolean)` | `Promise<DocsConfig>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `configservice`

<!-- source: interface-documentationconfig.md -->

# DocumentationConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationConfig.ts` (line 34)

Project auto-doc configuration

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `repositoryUrl` | `string` |
| `repositoryBranch` | `string` |
| `frontendPath` | `string` |
| `backendPath` | `string` |
| `siteUrl` | `string` |
| `siteLoginUrl` | `string` |
| `siteEmail` | `string` |
| `sitePassword` | `string` |
| `repoUsername` | `string` |
| `repoPassword` | `string` |
| `skeletonStructure` | `SkeletonStructure` |
| `targetAudience` | `string` |
| `autoPublish` | `boolean` |
| `createdAt` | `string` |
| `updatedAt` | `string` |

<!-- source: function-get-4.md -->

# GET

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/[audienceSlug]/[documentSlug]/md/route.ts` (line 9)

Same-origin per-page markdown twin: GET /p/<slug>/<audience>/<document>/md — the raw markdown
of a published page for agents / "View as Markdown". Proxies the API's urlId-keyed .md endpoint.

## Signature

```ts
async function GET(req: Request, ctx: { params: Promise<{ slugId: string; audienceSlug: string; documentSlug: string }> })
```

## Parameters

| Name | Type |
|---|---|
| `req` | `Request` |
| `ctx` | `{ params: Promise<{ slugId: string; audienceSlug: string; documentSlug: string }> }` |

<!-- source: type-imageuploadhandler.md -->

# ImageUploadHandler

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 46)

## Definition

```ts
((image: File) => Promise<string>) | null
```

<!-- source: constant-is-public-key.md -->

# IS_PUBLIC_KEY

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/auth/decorators/public.decorator.ts` (line 3)

<!-- source: controller-organizationcontroller.md -->

# OrganizationController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/organization/organization.controller.ts` (line 31)

## Relationships

- MODULE_DECLARES → `list`
- MODULE_DECLARES → `get`
- MODULE_DECLARES → `update`
- MODULE_DECLARES → `getMembers`
- MODULE_DECLARES → `inviteMember`
- MODULE_DECLARES → `getSettings`
- MODULE_DECLARES → `updateSettings`
- MODULE_DECLARES → `getUserAudiences`
- MODULE_DECLARES → `updateUserAudiences`
- DEPENDS_ON → `organizationservice`
- DEPENDS_ON → `invitationservice`

<!-- source: class-otlpexporter.md -->

# OtlpExporter

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/tracing/otlp-exporter.ts` (line 51)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `startSpan` | `startSpan(operationName: string, parentSpanId: string)` | `TraceSpan` |
| `endSpan` | `endSpan(span: TraceSpan, status: 'ok' | 'error')` | `void` |
| `addEvent` | `addEvent(span: TraceSpan, name: string, attributes: Record<string, string | number | boolean>)` | `void` |
| `setAttributes` | `setAttributes(span: TraceSpan, attributes: Record<string, string | number | boolean>)` | `void` |
| `flush` | `flush()` | `Promise<void>` |
| `getPendingCount` | `getPendingCount()` | `number` |
| `shutdown` | `shutdown()` | `Promise<void>` |

<!-- source: function-parseconfidence.md -->

# parseConfidence

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/docs-pr/agent-regen.service.ts` (line 171)

Parse the trailing "CONFIDENCE: 0.NN" line; 0 if absent/unparseable (→ fail-safe fallback).

## Signature

```ts
function parseConfidence(text: string): number
```

## Parameters

| Name | Type |
|---|---|
| `text` | `string` |

**Returns:** `number`

<!-- source: interface-parserstats.md -->

# ParserStats

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/parse-result.interface.ts` (line 383)

Statistics for a single parser

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `filesProcessed` | `number` |
| `entitiesFound` | `number` |
| `relationshipsFound` | `number` |
| `duration` | `number` |
| `errors` | `number` |
| `warnings` | `number` |

<!-- source: module-projectmodule.md -->

# ProjectModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/project/project.module.ts` (line 27)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `aimodule`
- MODULE_IMPORTS → `brandingmodule`
- MODULE_IMPORTS → `emailmodule`
- MODULE_IMPORTS → `eventsmodule`
- MODULE_IMPORTS → `graphmodule`
- MODULE_IMPORTS → `issuesmodule`
- MODULE_IMPORTS → `supportagentmodule`
- MODULE_IMPORTS → `workflowmodule`
- MODULE_IMPORTS → `forwardref`
- MODULE_IMPORTS → `forwardref`
- MODULE_IMPORTS → `forwardref`
- MODULE_DECLARES → `projectcontroller`
- MODULE_DECLARES → `publicprojectcontroller`
- MODULE_DECLARES → `synccontroller`
- MODULE_PROVIDES → `projectservice`
- MODULE_PROVIDES → `projectdomainsservice`
- MODULE_PROVIDES → `domaindnsservice`
- MODULE_PROVIDES → `k8singressservice`
- MODULE_PROVIDES → `syncservice`
- MODULE_PROVIDES → `syncjobservice`
- MODULE_EXPORTS → `projectservice`
- MODULE_EXPORTS → `syncservice`
- MODULE_EXPORTS → `syncjobservice`

<!-- source: interface-siteassemblyconfig.md -->

# SiteAssemblyConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 10)

Site Assembler Types

All interfaces for the deterministic site assembly pipeline.
The AI agent provides a SiteAssemblyConfig; the assembler produces a working site.

## Properties

| Property | Type |
|---|---|
| `assemblyId` | `string` |
| `outputDir` | `string` |
| `site` | `SiteConfig` |
| `sections` | `SectionSelection[]` |
| `nav` | `NavConfig` |
| `footer` | `FooterConfig` |
| `locales` | `LocaleConfig[]` |
| `seo` | `SeoConfig` |

<!-- source: component-stepindicator-2.md -->

# StepIndicator

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/step-indicator.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `step` | `number` | ✓ | - |
| `icon` | `LucideIcon` | ✓ | - |
| `titleKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StepIndicator_42b507fd["StepIndicator"]
    class component_StepIndicator_42b507fd rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: constant-time-periods.md -->

# TIME_PERIODS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/TimePeriodSelector.tsx` (line 5)

## Definition

```ts
{ label: string; value: TimePeriod }[]
```

<!-- source: interface-visualconfig.md -->

# VisualConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/types/index.ts` (line 48)

## Properties

| Property | Type |
|---|---|
| `strategy` | `VisualStrategy` |
| `screenshots` | `Record<string, string>` |

<!-- source: function-waitforpageload.md -->

# waitForPageLoad

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 6)

Wait for a page to be fully loaded

## Signature

```ts
async function waitForPageLoad(page: Page): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |

**Returns:** `Promise<void>`

<!-- source: interface-audiencenotnode.md -->

# AudienceNotNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 105)

## Properties

| Property | Type |
|---|---|
| `type` | `'not'` |
| `operand` | `AudienceLogicTree` |

<!-- source: component-blocktypeselect.md -->

# BlockTypeSelect

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/BlockTypeSelect.tsx` (line 14)

## Diagram

```mermaid
graph TD
    component_BlockTypeSelect_6ec587df["BlockTypeSelect"]
    class component_BlockTypeSelect_6ec587df rootComponent
```

## Relationships

- RENDERS → `Select`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useCellValue`
- USES_HOOK → `useTranslation`

<!-- source: constant-bottomareachildren.md -->

# bottomAreaChildren$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 749)

<!-- source: api-endpoint-checkcustomdomain.md -->

# checkCustomDomain

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 382)

## Endpoint

`POST /projects/:id/custom-domain/check`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: component-chipactive.md -->

# ChipActive

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/all/page.tsx` (line 132)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `label` | `string` | ✓ | - |
| `value` | `string` | ✓ | - |
| `onClear` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ChipActive_7cc233a1["ChipActive"]
    class component_ChipActive_7cc233a1 rootComponent
```

## Relationships

- RENDERS → `XMarkIcon`

## Referenced By

- `IssuesAllPageInner` (RENDERS)

<!-- source: interface-collaborationmetrics.md -->

# CollaborationMetrics

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/collaboration/interfaces/collaboration.interfaces.ts` (line 100)

Metrics for collaboration session

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `activeSessionsCount` | `number` |
| `syncLatencyMs` | `number` |
| `lastUpdatedAt` | `Date` |

<!-- source: interface-consolidatorconfig.md -->

# ConsolidatorConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/memory/consolidator.ts` (line 20)

## Properties

| Property | Type |
|---|---|
| `stalenessDays` | `number` |
| `mergeThreshold` | `number` |
| `maxMemories` | `number` |

<!-- source: class-createfromtemplatedto.md -->

# CreateFromTemplateDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/template/dto/create-from-template.dto.ts` (line 8)

DTO for creating a new document from a template.
Contains the necessary information to instantiate a template as a document.

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |

<!-- source: function-createlogger.md -->

# createLogger

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/logger.ts` (line 250)

## Signature

```ts
function createLogger(config: Partial<LoggerConfig>): Logger
```

## Parameters

| Name | Type |
|---|---|
| `config` | `Partial<LoggerConfig>` |

**Returns:** `Logger`

<!-- source: function-creatememorytool.md -->

# createMemoryTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/memory.tool.ts` (line 24)

## Signature

```ts
function createMemoryTool(options: MemoryToolOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `MemoryToolOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: function-createvalidatehtmltool.md -->

# createValidateHtmlTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/validate-html.tool.ts` (line 17)

## Signature

```ts
function createValidateHtmlTool(): ToolDefinition<PmeContext>
```

**Returns:** `ToolDefinition<PmeContext>`

<!-- source: interface-deploymentdiagramoptions.md -->

# DeploymentDiagramOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/deployment-diagram.generator.ts` (line 94)

Options for deployment diagram generation

## Properties

| Property | Type |
|---|---|
| `showPorts` | `boolean` |
| `showTechnology` | `boolean` |
| `showNetworkZones` | `boolean` |
| `showInstanceCounts` | `boolean` |
| `showExternalServices` | `boolean` |
| `direction` | `'TB' | 'BT' | 'LR' | 'RL'` |
| `includeNodeTypes` | `DeploymentNodeType[]` |
| `environment` | `string` |

<!-- source: function-discovercompetitorswithai.md -->

# discoverCompetitorsWithAI

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/competitor-discovery.ts` (line 16)

Ask AI to discover competitors and their documentation URLs

## Signature

```ts
async function discoverCompetitorsWithAI(aiProvider: { generateText: (prompt: string, options?: any) => Promise<string> }, projectDescription: string, projectType: string, limit): Promise<CompetitorInfo[]>
```

## Parameters

| Name | Type |
|---|---|
| `aiProvider` | `{ generateText: (prompt: string, options?: any) => Promise<string> }` |
| `projectDescription` | `string` |
| `projectType` | `string` |
| `limit` | `any` |

**Returns:** `Promise<CompetitorInfo[]>`

<!-- source: class-docsconfigendpoints.md -->

# DocsConfigEndpoints

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/docs-config.ts` (line 19)

Docs config endpoints

Routes are nested under the owning project (`/projects/:projectId/docs-config`) to match
the API's DocsConfigController. Reading a project that has no config row returns the
default ({ requireReview: false }); setting upserts the row (MAINTAINER/ADMIN only).

## Methods

| Method | Signature | Returns |
|---|---|---|
| `get` | `get(projectId: string)` | `Promise<DocsConfig>` |
| `set` | `set(projectId: string, config: DocsConfig)` | `Promise<DocsConfig>` |

<!-- source: service-docscrqueue.md -->

# DocsCrQueue

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/change-request/docs-cr-queue.service.ts` (line 32)

The 'docs-cr' queue registration. Present in EVERY api pod for ENQUEUE (the request path
only adds a job) — api pods cannot touch the git repo (the RWO PVC is mounted only on the
worker), so every CR git operation travels through this queue to CrWorker, gated by
DOCS_REPO_WORKER. Mirrors the docs-repo enqueue/worker split exactly.

Jobs are DEDUPED per change request via a deterministic jobId (`cr-open-<crId>`): a retried
POST for one CR collapses to a single pending job. Never blocks boot — an unavailable queue
just means the caller's enqueue returns false.

removeOnComplete AND removeOnFail are BOTH `true` (NOT {age,count}): a RETAINED completed OR
failed job with the same jobId makes BullMQ silently ignore a later add(), blocking a
re-drive of the same CR (e.g. re-opening after a transient failure was fixed). Removing both
immediately keeps coalescing (a WAITING/ACTIVE job still absorbs duplicates) while the CR row
status ('draft'/'failed') owns retry semantics.

`DocsCrQueue` registers and enqueues documentation change-request jobs for processing by `CrWorker`. It runs in every API pod so request handlers can enqueue work without accessing the Git repository, while the worker—guarded by `DOCS_REPO_WORKER` and mounted with the repository PVC—performs all Git operations. Jobs are deduplicated per CR using `cr-open-<crId>`, and completed or failed jobs are removed immediately so a failed CR can be re-driven later.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `void` |
| `enqueueOpen` | `enqueueOpen(crId: string)` | `Promise<boolean>` |
| `enqueueMerge` | `enqueueMerge(crId: string)` | `Promise<boolean>` |
| `enqueueRefresh` | `enqueueRefresh(crId: string)` | `Promise<boolean>` |
| `enqueueRestage` | `enqueueRestage(crId: string)` | `Promise<boolean>` |
| `onModuleDestroy` | `onModuleDestroy()` | `Promise<void>` |

## Diagram

```mermaid
sequenceDiagram
    participant Client
    participant API as API Pod
    participant Queue as DocsCrQueue
    participant Redis as BullMQ / Redis
    participant Worker as CrWorker
    participant Git as Docs Git Repository

    Client->>API: POST change request
    API->>Queue: enqueueOpen(crId)
    Queue->>Redis: add("cr-open", { crId }, jobId: "cr-open-<crId>")

    alt Existing waiting/active job
        Redis-->>Queue: Deduplicate job
        Queue-->>API: enqueue result
    else Queue unavailable
        Queue-->>API: enqueue returns false
    else New job
        Redis-->>Queue: Job queued
        Queue-->>API: enqueue returns true
        Worker->>Redis: Consume job
        Worker->>Git: Perform CR Git operations
        Worker->>Redis: Complete or fail job
        Redis->>Redis: Remove completed/failed job immediately
    end
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { DocsCrQueue } from './docs-cr-queue.service';

@Injectable()
export class ChangeRequestService {
  constructor(private readonly docsCrQueue: DocsCrQueue) {}

  async openChangeRequest(crId: string) {
    // Persist the CR row and its initial status first.
    // The database status owns retry/re-drive semantics.
    const queued = await this.docsCrQueue.enqueueOpen(crId);

    if (!queued) {
      // Queue availability must not prevent the API request from completing.
      // Leave the CR in a state that can be retried or re-driven later.
      return {
        crId,
        queued: false,
        message: 'Change request created; processing will be retried later.',
      };
    }

    return {
      crId,
      queued: true,
      message: 'Change request queued for processing.',
    };
  }
}
```

## AI Coding Instructions

- Use a deterministic BullMQ job ID of `cr-open-<crId>` when enqueueing CR-open work so duplicate requests collapse into one waiting or active job.
- Keep Git and repository operations out of API pods; API code should only enqueue jobs, while `CrWorker` performs repository work when `DOCS_REPO_WORKER` is enabled.
- Treat queue failures as non-fatal: return `false` from enqueue paths rather than blocking API boot or failing the CR creation request.
- Preserve `removeOnComplete: true` and `removeOnFail: true`; retaining terminal jobs with the same job ID prevents BullMQ from accepting a later re-drive.
- Store retry state in the change-request database row (such as `draft` or `failed`), not in retained BullMQ job history.

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: interface-documentationjob.md -->

# DocumentationJob

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationGenerator.ts` (line 14)

Documentation job data

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `status` | `JobStatus` |
| `progress` | `number` |
| `currentStage` | `string | null` |
| `stageProgress` | `number` |
| `currentItem` | `string | null` |
| `documentsCreated` | `number` |
| `documentsUpdated` | `number` |
| `screenshotsCaptured` | `number` |
| `createdAt` | `string` |
| `updatedAt` | `string` |
| `completedAt` | `string` |

<!-- source: function-get-5.md -->

# GET

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/llms-full.txt/route.ts` (line 9)

Slug-fronted, same-origin llms-full.txt: /p/<slug>/llms-full.txt — the whole published
corpus concatenated for single-fetch ingestion by an agent. Proxies the API generator.

## Signature

```ts
async function GET(req: Request, ctx: { params: Promise<{ slugId: string }> })
```

## Parameters

| Name | Type |
|---|---|
| `req` | `Request` |
| `ctx` | `{ params: Promise<{ slugId: string }> }` |

<!-- source: type-inputstate.md -->

# InputState

**Kind:** Type

**Source:** `atloria-monorepo/packages/ui-core/src/components/input/Input.ts` (line 9)

## Definition

```ts
'default' | 'error' | 'success'
```

<!-- source: constant-max-proposed-bytes.md -->

# MAX_PROPOSED_BYTES

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.service.ts` (line 24)

Total proposedContent budget per CR — keeps the draft row (and one commit) bounded.

<!-- source: function-parsedevice.md -->

# parseDevice

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/analytics/utils/tracking-utils.ts` (line 60)

Derive a coarse device class from the user-agent string. Order matters:
we check mobile first (since "Android Mobile" includes both keywords),
then tablet, then desktop, then fall back to unknown.

## Signature

```ts
function parseDevice(userAgent: string | null | undefined): DeviceClass
```

## Parameters

| Name | Type |
|---|---|
| `userAgent` | `string | null | undefined` |

**Returns:** `DeviceClass`

<!-- source: controller-parsercontroller.md -->

# ParserController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/parser/parser.controller.ts` (line 9)

## Relationships

- MODULE_DECLARES → `parse`
- MODULE_DECLARES → `parseDocument`
- MODULE_DECLARES → `getSupportedLanguages`
- DEPENDS_ON → `parserservice`

<!-- source: interface-parsesummary.md -->

# ParseSummary

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/parse-result.interface.ts` (line 328)

Summary statistics for a project parse

## Properties

| Property | Type |
|---|---|
| `totalFiles` | `number` |
| `successfulFiles` | `number` |
| `failedFiles` | `number` |
| `skippedFiles` | `number` |
| `totalEntities` | `number` |
| `totalRelationships` | `number` |
| `totalDuration` | `number` |
| `entitiesByType` | `Record<string, number>` |
| `relationshipsByType` | `Record<string, number>` |
| `parserStats` | `Record<string, ParserStats>` |

<!-- source: class-pluginloader.md -->

# PluginLoader

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/plugins/plugin-loader.ts` (line 28)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `loadFromDirectory` | `loadFromDirectory(pluginsDir: string)` | `Promise<LoadedPlugin[]>` |
| `loadPlugin` | `loadPlugin(pluginDir: string)` | `Promise<LoadedPlugin>` |

<!-- source: module-samlmodule.md -->

# SamlModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/auth/saml/saml.module.ts` (line 9)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `passportmodule`
- MODULE_DECLARES → `samlcontroller`
- MODULE_PROVIDES → `samlservice`
- MODULE_PROVIDES → `samlstrategy`
- MODULE_EXPORTS → `samlservice`

<!-- source: interface-siteconfig.md -->

# SiteConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/types.ts` (line 36)

## Properties

| Property | Type |
|---|---|
| `brandName` | `string` |
| `defaultLocale` | `string` |
| `defaultTheme` | `'light' | 'dark' | 'colorful'` |
| `primaryColor` | `string` |
| `fonts` | `{ heading: string; body: string; mono: string }` |
| `analytics` | `{
    provider: 'none' | 'azure-app-insights' | 'google-analytics' | 'meta-pixel';
    trackingId: string;
  }` |

<!-- source: component-testimonialcard.md -->

# TestimonialCard

**Kind:** Component

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/testimonial-card.tsx` (line 21)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `quoteKey` | `string` | ✓ | - |
| `authorNameKey` | `string` | ✓ | - |
| `authorRoleKey` | `string` | - | - |
| `avatarSrc` | `string` | - | - |
| `rating` | `number` | - | - |

## Diagram

```mermaid
graph TD
    component_TestimonialCard_731cdbc1["TestimonialCard"]
    class component_TestimonialCard_731cdbc1 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `Star`
- USES_HOOK → `useTranslation`

<!-- source: constant-usepmestore.md -->

# usePmeStore

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/stores/pmeStore.ts` (line 73)

<!-- source: interface-visualdependencies.md -->

# VisualDependencies

**Kind:** Interface

**Source:** `atloria-monorepo/libs/pme-core/src/agents/visual.agent.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `generateImageFn` | `ImageGenerateFn` |
| `findScreenshotsFn` | `FindScreenshotsFn` |

<!-- source: function-waitfortoast.md -->

# waitForToast

**Kind:** Function

**Source:** `atloria-monorepo/apps/web-e2e/src/utils/test-helpers.ts` (line 72)

Wait for a toast/notification to appear

## Signature

```ts
async function waitForToast(page: Page, text: string): Promise<Locator>
```

## Parameters

| Name | Type |
|---|---|
| `page` | `Page` |
| `text` | `string` |

**Returns:** `Promise<Locator>`

<!-- source: interface-audienceornode.md -->

# AudienceOrNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 115)

## Properties

| Property | Type |
|---|---|
| `type` | `'or'` |
| `operands` | `AudienceLogicTree[]` |

<!-- source: component-bolditalicunderlinetoggles.md -->

# BoldItalicUnderlineToggles

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/BoldItalicUnderlineToggles.tsx` (line 44)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `options` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_BoldItalicUnderlineToggles_326c3a3b["BoldItalicUnderlineToggles"]
    class component_BoldItalicUnderlineToggles_326c3a3b rootComponent
```

## Relationships

- RENDERS → `FormatButton`
- USES_HOOK → `useTranslation`

<!-- source: constant-button.md -->

# Button

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/toolbar.tsx` (line 58)

A toolbar button primitive.

<!-- source: api-endpoint-checkout.md -->

# checkout

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/billing/billing.controller.ts` (line 29)

## Endpoint

`POST /billing/checkout`

## Referenced By

- `BillingController` (MODULE_DECLARES)

<!-- source: interface-collaborationuser-2.md -->

# CollaborationUser

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/collaboration/interfaces/collaboration.interfaces.ts` (line 8)

Interfaces and types for real-time collaboration module

## Properties

| Property | Type |
|---|---|
| `userId` | `string` |
| `userName` | `string` |
| `email` | `string` |
| `avatar` | `string` |
| `color` | `string` |

<!-- source: component-coloredselect.md -->

# ColoredSelect

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/[ticketId]/page.tsx` (line 262)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `value` | `string` | ✓ | - |
| `onChange` | `Function` | ✓ | - |
| `options` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ColoredSelect_5e72e597["ColoredSelect"]
    class component_ColoredSelect_5e72e597 rootComponent
```

## Referenced By

- `IssueDetailPageInner` (RENDERS)

<!-- source: interface-contextitem.md -->

# ContextItem

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/context-manager.ts` (line 12)

Context Manager

Generic context window management:
- Token tracking per turn
- Auto-compaction at configurable threshold
- Pluggable compaction strategy

Zero SDK imports — operates on our own interfaces.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `role` | `'system' | 'user' | 'assistant' | 'tool'` |
| `content` | `string` |
| `turn` | `number` |
| `tokenEstimate` | `number` |
| `tags` | `string[]` |

<!-- source: class-createissuecommentdto.md -->

# CreateIssueCommentDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/issues/dto/issue-comment.dto.ts` (line 3)

## Properties

| Property | Type |
|---|---|
| `body` | `string` |
| `isInternal` | `boolean` |

<!-- source: function-createmultiedittool.md -->

# createMultiEditTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/multi-edit.tool.ts` (line 58)

## Signature

```ts
function createMultiEditTool(options: MultiEditOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `MultiEditOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: function-createopenaiprovider.md -->

# createOpenAIProvider

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/openai.provider.ts` (line 501)

Create an OpenAI provider from environment configuration

## Signature

```ts
function createOpenAIProvider(config: Partial<OpenAIConfig>): OpenAIProvider
```

## Parameters

| Name | Type |
|---|---|
| `config` | `Partial<OpenAIConfig>` |

**Returns:** `OpenAIProvider`

<!-- source: function-createvariantagent.md -->

# createVariantAgent

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/agents/variant.agent.ts` (line 23)

Create a variant agent for a specific style (A, B, or C).

## Signature

```ts
function createVariantAgent(config: GenerationConfig, deps: VariantDependencies, variantKey: VariantKey): AgentConfig<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |
| `deps` | `VariantDependencies` |
| `variantKey` | `VariantKey` |

**Returns:** `AgentConfig<PmeContext>`

<!-- source: interface-deploymentdiagramresult.md -->

# DeploymentDiagramResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/deployment-diagram.generator.ts` (line 147)

Result of deployment diagram generation

## Properties

| Property | Type |
|---|---|
| `mermaidCode` | `string` |
| `nodes` | `DeploymentNode[]` |
| `connections` | `DeploymentConnection[]` |
| `zones` | `NetworkZone[]` |
| `stats` | `{
    /** Total number of nodes */
    nodeCount: number;
    /** Number of connections */
    connectionCount: number;
    /** Number of services */
    serviceCount: number;
    /** Number of databases */
    databaseCount: number;
    /** Number of external services */
    externalServiceCount: number;
    /** Node types distribution */
    nodeTypeDistribution: Record<DeploymentNodeType, number>;
  }` |

<!-- source: service-docsprqueue.md -->

# DocsPrQueue

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr-queue.service.ts` (line 18)

Durable queue for the automatic docs-PR flow. Turns the webhook's fire-and-forget run into a
Redis-backed job: it survives pod restarts, retries on transient failures (a GitHub blip), and
is observable. The worker runs in-process (low volume, seconds per job). Redundant jobs are
harmless — the adapter's deterministic branch makes every run idempotent.

The processor is registered by DocsPrService (callback, not DI) so there's no module cycle.
If Redis is unavailable, `enqueue` returns false and the caller runs inline (behavior preserved).

`DocsPrQueue` provides a durable Redis-backed queue for the automatic documentation pull request workflow. It converts webhook-triggered work into retryable, observable jobs that survive pod restarts, while allowing callers to fall back to inline processing when Redis is unavailable. The queue worker runs in-process and invokes a processor registered by `DocsPrService`, avoiding a NestJS module dependency cycle.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `registerProcessor` | `registerProcessor(fn: (job: DocsPrJob) => Promise<void>)` | `void` |
| `enqueue` | `enqueue(job: DocsPrJob)` | `Promise<boolean>` |
| `onModuleInit` | `onModuleInit()` | `unknown` |
| `onModuleDestroy` | `onModuleDestroy()` | `unknown` |

## Diagram

```mermaid
sequenceDiagram
  participant Webhook as GitHub Webhook
  participant Service as DocsPrService
  participant Queue as DocsPrQueue
  participant Redis as Redis Queue
  participant Worker as In-process Worker
  participant GitHub as GitHub API

  Webhook->>Service: Receive docs-PR event
  Service->>Queue: enqueue(job)

  alt Redis available
    Queue->>Redis: Persist job
    Redis-->>Queue: Job accepted
    Queue-->>Service: true

    Worker->>Redis: Claim queued job
    Worker->>Service: Invoke registered processor
    Service->>GitHub: Create or update deterministic PR branch
    GitHub-->>Service: PR result
    Service-->>Worker: Job complete
    Worker->>Redis: Mark job complete
  else Redis unavailable
    Queue-->>Service: false
    Service->>GitHub: Run docs-PR flow inline
  end
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { DocsPrQueue } from './docs-pr-queue.service';

@Injectable()
export class DocsPrService {
  constructor(private readonly docsPrQueue: DocsPrQueue) {
    this.docsPrQueue.registerProcessor(async (job) => {
      await this.createOrUpdateDocsPullRequest(job);
    });
  }

  async handleWebhook(repositoryId: string, commitSha: string) {
    const queued = await this.docsPrQueue.enqueue({
      repositoryId,
      commitSha,
    });

    if (!queued) {
      // Preserve webhook behavior if Redis is unavailable.
      await this.createOrUpdateDocsPullRequest({
        repositoryId,
        commitSha,
      });
    }
  }

  private async createOrUpdateDocsPullRequest(job: {
    repositoryId: string;
    commitSha: string;
  }) {
    // Use a deterministic branch name so repeated jobs remain idempotent.
    // await this.githubAdapter.createOrUpdateDocsPr(job);
  }
}
```

## AI Coding Instructions

- Register the queue processor from `DocsPrService` via callback rather than injecting `DocsPrService` into the queue; this prevents a NestJS module cycle.
- Always handle `enqueue()` returning `false` by executing the docs-PR flow inline, preserving behavior during Redis outages.
- Keep queued jobs small, serializable, and sufficient to retry the operation after a pod restart.
- Treat job execution as idempotent: redundant jobs are expected, and GitHub operations should use deterministic branch/PR behavior.
- Classify transient GitHub or network failures as retryable; avoid retrying permanent validation or authorization failures indefinitely.

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: interface-documentationjobentry.md -->

# DocumentationJobEntry

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationJobs.ts` (line 11)

Job entry with expanded fields returned from the API

## Properties

| Property | Type |
|---|---|
| `error` | `string` |
| `errorStage` | `string` |
| `durationMs` | `number` |
| `completedAt` | `string` |
| `categoriesCreated` | `number` |

<!-- source: class-documentendpoints.md -->

# DocumentEndpoints

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/documents.ts` (line 78)

Document endpoints

## Methods

| Method | Signature | Returns |
|---|---|---|
| `list` | `list(params: DocumentListParams)` | `Promise<DocumentListResponse>` |
| `get` | `get(id: string)` | `Promise<Document>` |
| `getBySlug` | `getBySlug(projectId: string, slug: string)` | `Promise<Document>` |
| `create` | `create(dto: CreateDocumentDto)` | `Promise<Document>` |
| `update` | `update(id: string, dto: UpdateDocumentDto)` | `Promise<Document>` |
| `delete` | `delete(id: string)` | `Promise<void>` |
| `publish` | `publish(id: string)` | `Promise<Document>` |
| `unpublish` | `unpublish(id: string)` | `Promise<Document>` |
| `regenerate` | `regenerate(id: string)` | `Promise<Document>` |
| `getRevisions` | `getRevisions(id: string, limit: number, offset: number)` | `Promise<DocumentRevision[]>` |
| `getRevision` | `getRevision(id: string, revisionId: string)` | `Promise<DocumentRevision>` |
| `restoreRevision` | `restoreRevision(id: string, revisionId: string)` | `Promise<Document>` |

<!-- source: function-enhancedocumentationwithcompetitors.md -->

# enhanceDocumentationWithCompetitors

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ai-enhancement.ts` (line 27)

Main orchestrator for Stage 2: Competitor Enhancement

## Signature

```ts
async function enhanceDocumentationWithCompetitors(aiProvider: { generateText: (prompt: string, options?: any) => Promise<string> }, documentation: string, projectType: string, projectDescription: string, options: AIEnhancementOptions): Promise<EnhancedDocumentation>
```

## Parameters

| Name | Type |
|---|---|
| `aiProvider` | `{ generateText: (prompt: string, options?: any) => Promise<string> }` |
| `documentation` | `string` |
| `projectType` | `string` |
| `projectDescription` | `string` |
| `options` | `AIEnhancementOptions` |

**Returns:** `Promise<EnhancedDocumentation>`

<!-- source: function-get-6.md -->

# GET

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/llms.txt/route.ts` (line 10)

Slug-fronted, same-origin llms.txt for a published site: /p/<slug>/llms.txt —
the discoverable agent-native index (Mintlify/GitBook parity). Proxies the API's
urlId-keyed generator so crawlers/agents never touch the internal projectId/API origin.

## Signature

```ts
async function GET(req: Request, ctx: { params: Promise<{ slugId: string }> })
```

## Parameters

| Name | Type |
|---|---|
| `req` | `Request` |
| `ctx` | `{ params: Promise<{ slugId: string }> }` |

<!-- source: type-inputtype.md -->

# InputType

**Kind:** Type

**Source:** `atloria-monorepo/packages/ui-core/src/components/input/Input.ts` (line 8)

## Definition

```ts
'text' | 'email' | 'password' | 'number' | 'tel' | 'url'
```

<!-- source: constant-max-time-on-page-seconds.md -->

# MAX_TIME_ON_PAGE_SECONDS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/analytics/utils/tracking-utils.ts` (line 31)

Maximum reasonable time-on-page in seconds. Tabs left open overnight
would otherwise produce values like 80,000 seconds and destroy averages.
30 minutes is generous for "actively reading a long doc" while still
filtering out the long tail of forgotten tabs.

<!-- source: function-parseenrichment.md -->

# parseEnrichment

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/docs-pr/page-regen.service.ts` (line 131)

Parse a stored AI_ENRICHMENT document body into an `EntityEnrichment`.

Mirrors the canonical `parseEnrichmentContent` in
`technical-docs/technical-docs-materializer.service.ts` (kept local so this module
stays decoupled from the heavy materializer graph). The enrichment format is a set
of `### <section>` blocks; unstructured text falls back to a description.

## Signature

```ts
function parseEnrichment(raw: string): EntityEnrichment | undefined
```

## Parameters

| Name | Type |
|---|---|
| `raw` | `string` |

**Returns:** `EntityEnrichment | undefined`

<!-- source: interface-parsewarning.md -->

# ParseWarning

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/parse-result.interface.ts` (line 108)

Warning encountered during parsing (non-blocking)

## Properties

| Property | Type |
|---|---|
| `message` | `string` |
| `code` | `string` |
| `line` | `number` |
| `suggestion` | `string` |

<!-- source: controller-parsingcontroller.md -->

# ParsingController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/parsing/parsing.controller.ts` (line 9)

## Relationships

- MODULE_DECLARES → `parseProject`
- MODULE_DECLARES → `getStatus`
- MODULE_DECLARES → `cancelParsing`
- MODULE_DECLARES → `getProjectJobs`
- DEPENDS_ON → `parsingservice`

<!-- source: class-pluginmanager.md -->

# PluginManager

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/plugins/plugin-manager.ts` (line 18)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `register` | `register(plugin: LoadedPlugin)` | `void` |
| `unregister` | `unregister(pluginName: string)` | `void` |
| `getCommands` | `getCommands()` | `CommandDefinition[]` |
| `getAgents` | `getAgents()` | `AgentDefinition[]` |
| `getSkills` | `getSkills()` | `SkillDefinition[]` |
| `getPluginNames` | `getPluginNames()` | `string[]` |
| `getCommand` | `getCommand(name: string)` | `CommandDefinition | undefined` |
| `getAgent` | `getAgent(name: string)` | `AgentDefinition | undefined` |
| `activateSkill` | `activateSkill(skillName: string)` | `void` |
| `deactivateSkill` | `deactivateSkill(skillName: string)` | `void` |
| `isSkillActive` | `isSkillActive(skillName: string)` | `boolean` |
| `getSkillDescriptions` | `getSkillDescriptions()` | `string` |

<!-- source: module-screenshotmodule-2.md -->

# ScreenshotModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/screenshot/screenshot.module.ts` (line 9)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `assetsmodule`
- MODULE_DECLARES → `screenshotcontroller`
- MODULE_PROVIDES → `screenshotservice`
- MODULE_EXPORTS → `screenshotservice`

<!-- source: interface-sitegenconfig.md -->

# SiteGenConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/agents/site-gen.agent.ts` (line 47)

## Properties

| Property | Type |
|---|---|
| `brandName` | `string` |
| `targetAudience` | `string` |
| `brandVoice` | `string` |
| `language` | `string` |
| `theme` | `'light' | 'dark' | 'colorful'` |
| `model` | `string` |

<!-- source: constant-useprojectcontext.md -->

# useProjectContext

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/stores/projectContext.ts` (line 103)

Project Context Store

Usage:
```tsx
const { currentProject, setCurrentProject } = useProjectContext();
```

<!-- source: interface-authconfig-3.md -->

# AuthConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 218)

Authentication configuration

Selectors are optional - if not provided and useSmartDetection is true,
the screenshot-worker will use AI to auto-detect form selectors.

## Properties

| Property | Type |
|---|---|
| `loginUrl` | `string` |
| `username` | `string` |
| `password` | `string` |
| `usernameSelector` | `string` |
| `passwordSelector` | `string` |
| `submitSelector` | `string` |
| `successIndicator` | `string` |
| `useSmartDetection` | `boolean` |

<!-- source: component-breakexample.md -->

# BreakExample

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 110)

## Diagram

```mermaid
graph TD
    component_BreakExample_5d835bb5["BreakExample"]
    class component_BreakExample_5d835bb5 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: constant-buttonwithtooltip.md -->

# ButtonWithTooltip

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/toolbar.tsx` (line 64)

A toolbar button with tooltip primitive.

<!-- source: api-endpoint-checksubdomain.md -->

# checkSubdomain

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 337)

## Endpoint

`GET /projects/:id/subdomain/check`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `slug` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: component-columnslist.md -->

# ColumnsList

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardSettingsDialog.tsx` (line 277)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `boardId` | `string` | ✓ | - |
| `columns` | `BoardColumnLite[]` | ✓ | - |
| `onEdit` | `Function` | ✓ | - |
| `onReorder` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ColumnsList_668bb1f6["ColumnsList"]
    class component_ColumnsList_668bb1f6 rootComponent
```

## Relationships

- RENDERS → `Bars3Icon`
- RENDERS → `PencilIcon`
- USES_HOOK → `useState`

## Referenced By

- `BoardSettingsDialog` (RENDERS)

<!-- source: interface-commitauthor.md -->

# CommitAuthor

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/docs-repo.service.ts` (line 27)

A commit author identity. The substrate only ever uses one of three TYPED authors.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `email` | `string` |

<!-- source: interface-contextmanagerconfig.md -->

# ContextManagerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/context-manager.ts` (line 36)

## Properties

| Property | Type |
|---|---|
| `maxTokens` | `number` |
| `compactionThreshold` | `number` |
| `minItemsToKeep` | `number` |
| `strategy` | `CompactionStrategy` |

<!-- source: class-createissuedto.md -->

# CreateIssueDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/issues/dto/create-issue.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `projectSlugId` | `string` |
| `pageUrl` | `string` |
| `pageTitle` | `string` |
| `sectionHeading` | `string` |
| `ticketType` | `TicketType` |
| `category` | `IssueCategory` |
| `description` | `string` |
| `reporterEmail` | `string` |
| `reporterSessionId` | `string` |
| `scrollPosition` | `number` |
| `userAgent` | `string` |

<!-- source: function-createnotebookedittool.md -->

# createNotebookEditTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/notebook-edit.tool.ts` (line 29)

## Signature

```ts
function createNotebookEditTool(options: NotebookEditOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `NotebookEditOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: function-createprogresstracker.md -->

# createProgressTracker

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/progress-tracker.ts` (line 191)

Create a progress tracker for a stage

## Signature

```ts
function createProgressTracker(stageName: string, totalItems: number, batchSize: number): ProgressTracker
```

## Parameters

| Name | Type |
|---|---|
| `stageName` | `string` |
| `totalItems` | `number` |
| `batchSize` | `number` |

**Returns:** `ProgressTracker`

<!-- source: function-createvisualagent.md -->

# createVisualAgent

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/agents/visual.agent.ts` (line 20)

## Signature

```ts
function createVisualAgent(config: GenerationConfig, deps: VisualDependencies, imageQualityConfig: ImageQualityConfig): AgentConfig<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `config` | `GenerationConfig` |
| `deps` | `VisualDependencies` |
| `imageQualityConfig` | `ImageQualityConfig` |

**Returns:** `AgentConfig<PmeContext>`

<!-- source: interface-deploymentnode.md -->

# DeploymentNode

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/deployment-diagram.generator.ts` (line 35)

Represents a deployment node in the infrastructure

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `type` | `DeploymentNodeType` |
| `technology` | `string` |
| `port` | `number` |
| `environment` | `string` |
| `instances` | `number` |
| `entity` | `Entity` |

<!-- source: service-docsprservice.md -->

# DocsPrService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr.service.ts` (line 39)

Orchestrates one docs-fix PR for a project: resolve the stale pages (from the shipped
staleness signal) → regenerate each from code (Rung 1) → open or update a single
deduped PR in the customer's repo. Nothing merges automatically; the PR is the review
surface. Every path is guarded so a project with the feature OFF, no repo, nothing
stale, or an un-consented App simply no-ops — the repo is never touched on failure.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `void` |
| `runForProject` | `runForProject(projectId: string, opts: { actorUserId?: string })` | `Promise<DocsPrRunResult>` |
| `handlePrClosed` | `handlePrClosed(repoUrl: string, prNumber: number, merged: boolean)` | `Promise<void>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `pageregenservice`
- DEPENDS_ON → `gitwriteadapter`
- DEPENDS_ON → `docsprtrigger`
- DEPENDS_ON → `docsprqueue`
- DEPENDS_ON → `agentregenservice`
- DEPENDS_ON → `gitcloneservice`
- DEPENDS_ON → `githubappservice`

<!-- source: interface-documentlayoutprops.md -->

# DocumentLayoutProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Layout/DocumentLayout.tsx` (line 12)

Props for DocumentLayout

## Properties

| Property | Type |
|---|---|
| `children` | `ReactNode` |
| `organizationId` | `string` |
| `projectId` | `string` |
| `activeDocumentId` | `string` |
| `className` | `string` |
| `onNavigate` | `(node: DocumentTreeNode) => void` |

<!-- source: class-documentmanager.md -->

# DocumentManager

**Kind:** Class

**Source:** `atloria-monorepo/packages/core/src/managers/document-manager.ts` (line 13)

DocumentManager handles document business logic
This class is framework-agnostic and can be used in any environment

## Methods

| Method | Signature | Returns |
|---|---|---|
| `validate` | `validate(doc: Partial<Document>)` | `ValidationResult` |
| `canEdit` | `canEdit(user: User, doc: Document)` | `boolean` |
| `canPublish` | `canPublish(user: User, _doc: Document)` | `boolean` |
| `canDelete` | `canDelete(user: User, _doc: Document)` | `boolean` |
| `createVersion` | `createVersion(doc: Document)` | `Partial<Document>` |
| `applyAudienceFilter` | `applyAudienceFilter(docs: Document[], audience: string)` | `Document[]` |
| `applyAudiencesFilter` | `applyAudiencesFilter(docs: Document[], audiences: string[])` | `Document[]` |
| `isOutdated` | `isOutdated(doc: Document, allVersions: Document[])` | `boolean` |
| `getLatestPublishedVersion` | `getLatestPublishedVersion(slug: string, allVersions: Document[])` | `Document | null` |
| `canView` | `canView(user: User | null, doc: Document)` | `boolean` |

<!-- source: function-enrichscreenshotmetadata.md -->

# enrichScreenshotMetadata

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/screenshot-metadata-enricher.ts` (line 45)

Enrich screenshot metadata with state machine context

Takes a screenshot URL and parsed entities, finds the matching component,
and adds state machine and UI interaction information.

## Signature

```ts
function enrichScreenshotMetadata(screenshotUrl: string, route: string, entities: Entity[], options: {
    title?: string;
    viewport?: { width: number; height: number };
    capturedAt?: Date;
    isModal?: boolean;
    parentUrl?: string;
  }): EnhancedScreenshotMetadata
```

## Parameters

| Name | Type |
|---|---|
| `screenshotUrl` | `string` |
| `route` | `string` |
| `entities` | `Entity[]` |
| `options` | `{
    title?: string;
    viewport?: { width: number; height: number };
    capturedAt?: Date;
    isModal?: boolean;
    parentUrl?: string;
  }` |

**Returns:** `EnhancedScreenshotMetadata`

<!-- source: function-get-7.md -->

# GET

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/mcp/route.ts` (line 38)

<!-- source: type-insertimageparameters.md -->

# InsertImageParameters

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 76)

## Definition

```ts
FileImageParameters | SrcImageParameters
```

<!-- source: constant-merge-conflict-error.md -->

# MERGE_CONFLICT_ERROR

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.service.ts` (line 27)

The error recorded when a merge attempt aborts on conflicting sections.

<!-- source: function-parseenrichmentcontent.md -->

# parseEnrichmentContent

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-materializer.service.ts` (line 190)

Parse an AI_ENRICHMENT Document's MDX (written by TechnicalDocsEnrichmentService — a
fingerprint comment, then `### Description / ### Diagram / ### Usage Example /
### AI Coding Instructions` sections) into the EntityEnrichment shape renderEntityPage
merges. Server-side twin of the web entity page's fingerprint-strip + section renderer.

## Signature

```ts
function parseEnrichmentContent(content: string): EntityEnrichment | null
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |

**Returns:** `EntityEnrichment | null`

<!-- source: controller-pmecontroller.md -->

# PmeController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/pme/pme.controller.ts` (line 27)

## Relationships

- MODULE_DECLARES → `createJob`
- MODULE_DECLARES → `getJob`
- MODULE_DECLARES → `getJobsByProject`
- MODULE_DECLARES → `getVariants`
- MODULE_DECLARES → `selectVariant`
- MODULE_DECLARES → `startStrategy`
- MODULE_DECLARES → `finalizePage`
- DEPENDS_ON → `pmeservice`

<!-- source: interface-projectparseresult.md -->

# ProjectParseResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/parse-result.interface.ts` (line 278)

Result of parsing an entire project

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `rootDir` | `string` |
| `parsers` | `string[]` |
| `timestamp` | `Date` |
| `status` | `ParseStatus` |
| `results` | `ParseResult[]` |
| `summary` | `ParseSummary` |
| `entities` | `Entity[]` |
| `relationships` | `Relationship[]` |

<!-- source: class-promptsectionregistry.md -->

# PromptSectionRegistry

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/prompt-sections.ts` (line 46)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `register` | `register(section: PromptSection)` | `this` |
| `unregister` | `unregister(id: string)` | `this` |
| `build` | `build(ctx: SectionContext)` | `string` |
| `activeIds` | `activeIds(ctx: SectionContext)` | `string[]` |

<!-- source: interface-sitegencontext.md -->

# SiteGenContext

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/agents/site-gen.agent.ts` (line 28)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `userId` | `string` |
| `outputDir` | `string` |

<!-- source: module-suggestionmodule.md -->

# SuggestionModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.module.ts` (line 12)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `gatewaymodule`
- MODULE_IMPORTS → `activitymodule`
- MODULE_IMPORTS → `notificationmodule`
- MODULE_IMPORTS → `documentmodule`
- MODULE_DECLARES → `suggestioncontroller`
- MODULE_DECLARES → `suggestionaliascontroller`
- MODULE_PROVIDES → `suggestionservice`
- MODULE_EXPORTS → `suggestionservice`

<!-- source: constant-useversioncontext.md -->

# useVersionContext

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/stores/versionContext.ts` (line 33)

<!-- source: interface-authconfigdiscovery-2.md -->

# AuthConfigDiscovery

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 194)

Authentication configuration discovered in source code

## Properties

| Property | Type |
|---|---|
| `loginRoute` | `string` |
| `roles` | `string[]` |
| `roleSource` | `RoleSourceType` |
| `templatePermissions` | `string[]` |
| `guardNames` | `string[]` |

<!-- source: component-buggymarkdown.md -->

# BuggyMarkdown

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/error-handling.tsx` (line 23)

## Diagram

```mermaid
graph TD
    component_BuggyMarkdown_623cb9fa["BuggyMarkdown"]
    class component_BuggyMarkdown_623cb9fa rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: constant-can-use-dom.md -->

# CAN_USE_DOM

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/utils/detectMac.ts` (line 2)

## Definition

```ts
boolean
```

<!-- source: api-endpoint-cherrypick.md -->

# cherryPick

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 482)

## Endpoint

`POST /doc-versions/:projectId/:versionId/cherry-pick`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-commentform.md -->

# CommentForm

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Comments/CommentForm.tsx` (line 47)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `documentId` | `string` | ✓ | - |
| `projectId` | `string` | - | - |
| `parentId` | `string` | - | - |
| `onSubmit` | `Function` | ✓ | - |
| `onCancel` | `Function` | - | - |
| `placeholder` | `string` | - | "Add a comment..." |
| `compact` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_CommentForm_7859ca39["CommentForm"]
    class component_CommentForm_7859ca39 rootComponent
```

## Relationships

- RENDERS → `MentionsInput`
- RENDERS → `Mention`
- RENDERS → `AtSign`
- RENDERS → `Loader2`
- RENDERS → `Send`
- USES_HOOK → `useState`
- USES_HOOK → `useDocumentCollaborators`
- USES_HOOK → `useMemo`
- USES_HOOK → `useCallback`

## Referenced By

- `ReplyForm` (RENDERS)

<!-- source: interface-commitoptions.md -->

# CommitOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/docs-repo.service.ts` (line 41)

S2.0 attribution options for a commit. Default (absent) keeps the existing single-identity
behaviour: the TYPED author is recorded as BOTH git author and committer.

## Properties

| Property | Type |
|---|---|
| `committer` | `CommitAuthor` |
| `coAuthors` | `CommitAuthor[]` |

<!-- source: interface-coordinationsection.md -->

# CoordinationSection

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/coordination-doc.ts` (line 13)

Shared Coordination Document (Multi-Agent)

A thread-safe in-memory markdown document that multiple agents can read/write
for coordinated work. Each section is keyed by a case-insensitive title and
tracks who last updated it and when.

Usage: create one CoordinationDoc instance and share it across agents via
createCoordinationTool(). Agents use the tool to post status updates,
decisions, blockers, and hand-off notes visible to all other agents.

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `content` | `string` |
| `updatedBy` | `string` |
| `updatedAt` | `string` |

<!-- source: function-createnotebookreadtool.md -->

# createNotebookReadTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/notebook-read.tool.ts` (line 131)

## Signature

```ts
function createNotebookReadTool(options: NotebookReadOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `NotebookReadOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: class-createpmejobdto.md -->

# CreatePmeJobDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/pme/dto/pme.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `targetAudience` | `string` |
| `brandVoice` | `string` |
| `language` | `string` |
| `pageType` | `string` |
| `sections` | `string[]` |
| `model` | `string` |

<!-- source: function-createratelimiter.md -->

# createRateLimiter

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/rate-limiter.ts` (line 155)

Create a rate limiter from environment configuration

## Signature

```ts
function createRateLimiter(config: Partial<RateLimiterConfig>): RateLimiter
```

## Parameters

| Name | Type |
|---|---|
| `config` | `Partial<RateLimiterConfig>` |

**Returns:** `RateLimiter`

<!-- source: function-createvisualqatool.md -->

# createVisualQaTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/visual-qa.tool.ts` (line 35)

## Signature

```ts
function createVisualQaTool(renderFn: RenderAndCaptureFn): ToolDefinition<PmeContext>
```

## Parameters

| Name | Type |
|---|---|
| `renderFn` | `RenderAndCaptureFn` |

**Returns:** `ToolDefinition<PmeContext>`

<!-- source: interface-detectedframework.md -->

# DetectedFramework

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/config.interface.ts` (line 156)

Detected framework information

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `version` | `string` |
| `category` | `'frontend' | 'backend' | 'database' | 'testing' | 'build' | 'other'` |
| `detectedFrom` | `string` |
| `confidence` | `number` |
| `parser` | `string` |

<!-- source: service-docsrepoqueue.md -->

# DocsRepoQueue

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/docs-repo/docs-repo-queue.service.ts` (line 30)

The 'docs-repo' queue registration. Present in EVERY api pod for ENQUEUE (the request path
only adds a job). Processing lives in CommitterWorker, gated by DOCS_REPO_WORKER so only a
dedicated 1-replica worker deployment commits — mirroring the technical-docs enqueue/worker
split.

Jobs are DEDUPED per project via a deterministic jobId (`commit-<projectId>`): a burst of
publish events for one project collapses to a single pending job, which the committer then
coalesces into one commit. Never blocks boot — an unavailable queue just means the caller's
enqueue returns false.

removeOnComplete AND removeOnFail are BOTH `true` (NOT {age,count}): a RETAINED completed OR
failed job with the same jobId makes BullMQ silently ignore a later add(), dropping the next
project's commit (completed side) or blocking a once-poisoned project from ever being re-driven
after its cause is fixed (failed side). Removing both immediately keeps coalescing (a
WAITING/ACTIVE job still absorbs duplicates) while the outbox (attempts + poller) owns retry.

`DocsRepoQueue` registers the `docs-repo` BullMQ queue in every API pod and provides the enqueue path for documentation repository commit jobs. Jobs are deduplicated per project using a deterministic `commit-<projectId>` ID, while actual processing is handled only by the dedicated `CommitterWorker` deployment when `DOCS_REPO_WORKER` is enabled. Queue failures never block application startup or publishing flows: an unavailable queue causes enqueue to return `false`.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `void` |
| `enqueueCommit` | `enqueueCommit(projectId: string)` | `Promise<boolean>` |
| `onModuleDestroy` | `onModuleDestroy()` | `Promise<void>` |

## Diagram

```mermaid
sequenceDiagram
  participant API as API Pod
  participant Queue as DocsRepoQueue
  participant BullMQ as BullMQ / Redis
  participant Worker as CommitterWorker<br/>(DOCS_REPO_WORKER=true)
  participant Repo as Documentation Repository

  API->>Queue: enqueue(projectId)
  Queue->>BullMQ: add("commit", job, { jobId: "commit-<projectId>" })

  alt Queue available
    BullMQ-->>Queue: Job accepted or deduplicated
    Queue-->>API: true
  else Queue unavailable
    Queue-->>API: false
  end

  Note over BullMQ: WAITING/ACTIVE jobs absorb duplicate<br/>publish events for the same project

  Worker->>BullMQ: Consume commit job
  Worker->>Repo: Coalesce changes and create commit
  Repo-->>Worker: Commit result
  Worker->>BullMQ: Complete or fail job

  Note over BullMQ: removeOnComplete=true<br/>removeOnFail=true
```

## AI Coding Instructions

- Keep enqueue logic lightweight and non-blocking; callers must handle a `false` result without failing the publish request.
- Always use the deterministic job ID format `commit-<projectId>` so bursts of events coalesce into one pending or active job.
- Do not move commit processing into API pods; `CommitterWorker` owns processing and must remain gated by `DOCS_REPO_WORKER`.
- Preserve `removeOnComplete: true` and `removeOnFail: true`; retained jobs with the same ID can cause BullMQ to silently drop future enqueue attempts.
- Treat the outbox retry attempts and poller as the recovery mechanism for failed or unavailable queue submissions.

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: interface-docversion.md -->

# DocVersion

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/stores/versionContext.ts` (line 8)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `versionNumber` | `number` |
| `label` | `string` |
| `status` | `string` |
| `createdAt` | `string` |

<!-- source: class-dotnetdetector.md -->

# DotNetDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/dotnet-detector.ts` (line 88)

.NET Detector

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectControllers` | `detectControllers(entities: Entity[])` | `DetectedDotNetController[]` |
| `detectServices` | `detectServices(entities: Entity[])` | `DetectedDotNetService[]` |
| `getControllerSummary` | `getControllerSummary(controller: DetectedDotNetController)` | `string` |

<!-- source: function-entitymethodnames.md -->

# entityMethodNames

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/example-grounding.ts` (line 12)

Grounding check for AI-written usage examples: a code example must not call methods that
don't exist on the entity it documents. This catches the classic enrichment hallucination
(e.g. a page for `RagChatModelService` whose example calls `createChatCompletion()` — a method
that isn't on the class). Pure + conservative: it only inspects calls on variables PROVABLY
bound to the entity, and no-ops when the entity exposes no method list to ground against.

## Signature

```ts
function entityMethodNames(entity: Pick<Entity, 'name'> & Record<string, any>): string[]
```

## Parameters

| Name | Type |
|---|---|
| `entity` | `Pick<Entity, 'name'> & Record<string, any>` |

**Returns:** `string[]`

<!-- source: function-get-8.md -->

# GET

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/sitemap.xml/route.ts` (line 10)

Per-published-site sitemap: /p/<slug>/sitemap.xml — landing + every audience +
every published document URL. Table stakes for public docs SEO.

## Signature

```ts
async function GET(_req: Request, ctx: { params: Promise<{ slugId: string }> })
```

## Parameters

| Name | Type |
|---|---|
| `_req` | `Request` |
| `ctx` | `{ params: Promise<{ slugId: string }> }` |

<!-- source: type-insertimagepayload.md -->

# InsertImagePayload

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 414)

## Definition

```ts
Readonly<CreateImageNodeParameters>
```

<!-- source: constant-merge-midmerge-error.md -->

# MERGE_MIDMERGE_ERROR

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.service.ts` (line 33)

The error recorded when a concurrent write races the merge writeback (CAS lost mid-merge).

<!-- source: function-parsegithubrepo.md -->

# parseGitHubRepo

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/docs-pr/git-write/github-write.adapter.ts` (line 132)

Parse an owner/repo out of a GitHub repo URL (https or ssh, optional .git).

## Signature

```ts
function parseGitHubRepo(repoUrl: string): { owner: string; repo: string }
```

## Parameters

| Name | Type |
|---|---|
| `repoUrl` | `string` |

**Returns:** `{ owner: string; repo: string }`

<!-- source: controller-projectcontroller.md -->

# ProjectController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 35)

## Relationships

- MODULE_DECLARES → `create`
- MODULE_DECLARES → `list`
- MODULE_DECLARES → `get`
- MODULE_DECLARES → `update`
- MODULE_DECLARES → `updatePut`
- MODULE_DECLARES → `delete`
- MODULE_DECLARES → `getMembers`
- MODULE_DECLARES → `addMember`
- MODULE_DECLARES → `updateMemberRole`
- MODULE_DECLARES → `removeMember`
- MODULE_DECLARES → `getSettings`
- MODULE_DECLARES → `updateSettings`
- MODULE_DECLARES → `getStats`
- MODULE_DECLARES → `publish`
- MODULE_DECLARES → `checkSubdomain`
- MODULE_DECLARES → `setSubdomain`
- MODULE_DECLARES → `getCustomDomain`
- MODULE_DECLARES → `createCustomDomain`
- MODULE_DECLARES → `checkCustomDomain`
- MODULE_DECLARES → `retryCustomDomain`
- MODULE_DECLARES → `removeCustomDomain`
- MODULE_DECLARES → `unpublish`
- MODULE_DECLARES → `getProjectAudiences`
- DEPENDS_ON → `projectservice`
- DEPENDS_ON → `projectdomainsservice`

<!-- source: interface-propdefinition.md -->

# PropDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 343)

Prop definition for a component

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `required` | `boolean` |
| `defaultValue` | `string` |
| `description` | `string` |

<!-- source: class-repomap.md -->

# RepoMap

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/context/repo-map.ts` (line 106)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generate` | `generate(focusQuery: string, recentFiles: string[])` | `Promise<RepoMapResult>` |
| `invalidate` | `invalidate(files: string[])` | `void` |
| `clearCache` | `clearCache()` | `void` |

<!-- source: interface-sitegendependencies.md -->

# SiteGenDependencies

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/agents/site-gen.agent.ts` (line 36)

## Properties

| Property | Type |
|---|---|
| `componentLibraryDir` | `string` |
| `templateDir` | `string` |
| `productKnowledge` | `ProductKnowledgeDeps` |

<!-- source: module-supportagentmodule.md -->

# SupportAgentModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.module.ts` (line 11)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `forwardref`
- MODULE_IMPORTS → `aimodule`
- MODULE_DECLARES → `supportagentcontroller`
- MODULE_PROVIDES → `supportagentservice`
- MODULE_PROVIDES → `languagedetectorservice`
- MODULE_PROVIDES → `agentadapterservice`
- MODULE_EXPORTS → `supportagentservice`

<!-- source: constant-viewport.md -->

# viewport

**Kind:** Constant

**Source:** `atloria-monorepo/apps/web/src/app/layout.tsx` (line 29)

## Definition

```ts
Viewport
```

<!-- source: interface-authresponse.md -->

# AuthResponse

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/auth.ts` (line 20)

## Properties

| Property | Type |
|---|---|
| `user` | `{
    id: string;
    email: string;
    name: string;
    role: string;
    organizationId: string;
  }` |
| `accessToken` | `string` |
| `refreshToken` | `string` |

<!-- source: component-buttonordropdownbutton.md -->

# ButtonOrDropdownButton

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/toolbar.tsx` (line 185)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |
| `title` | `string` | ✓ | - |
| `onChoose` | `Function` | ✓ | - |
| `items` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ButtonOrDropdownButton_88ad2ca["ButtonOrDropdownButton"]
    class component_ButtonOrDropdownButton_88ad2ca rootComponent
```

## Relationships

- RENDERS → `ButtonWithTooltip`
- RENDERS → `RadixSelect-Root`
- RENDERS → `SelectButtonTrigger`
- RENDERS → `SelectContent`
- RENDERS → `SelectItem`
- USES_HOOK → `useCellValue`

<!-- source: constant-cancellinkedit.md -->

# cancelLinkEdit$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 273)

An action that cancel the edit of the current link.

<!-- source: api-endpoint-claim.md -->

# claim

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/trial/trial.controller.ts` (line 35)

## Endpoint

`POST /trial/:projectId/claim`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TrialController` (MODULE_DECLARES)

<!-- source: component-commentpreview.md -->

# CommentPreview

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/CommentMarkers.tsx` (line 158)

CommentPreview - Tooltip showing comment preview on hover

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `comments` | `CommentWithUser[]` | ✓ | - |
| `onCommentClick` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CommentPreview_4043f539["CommentPreview"]
    class component_CommentPreview_4043f539 rootComponent
```

## Referenced By

- `CommentMarkers` (RENDERS)

<!-- source: interface-comparedocumentresult.md -->

# CompareDocumentResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/dto/compare-document.dto.ts` (line 74)

Comparison result response

## Properties

| Property | Type |
|---|---|
| `from` | `{
    id: string;
    version?: number;
    title: string;
    content: string;
    createdAt: Date;
    createdBy: {
      id: string;
      name: string;
      email: string;
    };
    metadata?: any;
  }` |
| `to` | `{
    id: string;
    version?: number;
    title: string;
    content: string;
    createdAt: Date;
    createdBy: {
      id: string;
      name: string;
      email: string;
    };
    metadata?: any;
  }` |
| `diff` | `{
    title: {
      changed: boolean;
      from: string;
      to: string;
    };
    content: DiffChange[];
    metadata: MetadataDiff[];
    stats: {
      additions: number;
      deletions: number;
      modifications: number;
    };
  }` |

<!-- source: interface-coordinationtooloptions.md -->

# CoordinationToolOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/coordination.tool.ts` (line 11)

## Properties

| Property | Type |
|---|---|
| `doc` | `CoordinationDoc` |

<!-- source: function-createnotetool.md -->

# createNoteTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/note.tool.ts` (line 15)

## Signature

```ts
function createNoteTool(noteStore: AgentNoteStore): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `noteStore` | `AgentNoteStore` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: class-createprojectdto.md -->

# CreateProjectDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/create-project.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `repoUrl` | `string` |
| `repoBranch` | `string` |
| `themeId` | `string` |

<!-- source: function-createretryconfig.md -->

# createRetryConfig

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/retry.ts` (line 152)

Merge partial config with defaults

## Signature

```ts
function createRetryConfig(partial: Partial<RetryConfig>): RetryConfig
```

## Parameters

| Name | Type |
|---|---|
| `partial` | `Partial<RetryConfig>` |

**Returns:** `RetryConfig`

<!-- source: interface-detectedproject.md -->

# DetectedProject

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/config.interface.ts` (line 111)

Project detection result

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `projectType` | `'monorepo' | 'single-app' | 'library' | 'unknown'` |
| `frameworks` | `DetectedFramework[]` |
| `packageManager` | `'npm' | 'yarn' | 'pnpm' | 'bun' | 'unknown'` |
| `buildTools` | `string[]` |
| `recommendedParsers` | `string[]` |
| `projectName` | `string` |
| `confidence` | `number` |

<!-- source: service-docsreposervice.md -->

# DocsRepoService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/docs-repo/docs-repo.service.ts` (line 69)

DocsRepoService — the low-level git primitive for the per-project docs substrate.

One NON-BARE git repo per project lives at `${DOCS_REPO_ROOT}/<projectId>` (default
/work/docs-repos, overridable for tests). Every mutation goes through git so the repo
IS the source of record for content history; Postgres remains the authority the repo is
rebuildable from (see ReconcilerService).

ALL git invocation is via promisified execFile('git', [args], { cwd }) — an argv array,
never a shell string — so a slug/path/message can never inject a shell command.

`DocsRepoService` manages the per-project non-bare Git repository used as the durable content-history substrate for documentation. It creates and mutates repositories under `${DOCS_REPO_ROOT}/<projectId>`, ensuring all Git commands use `execFile` argument arrays rather than shell strings; PostgreSQL remains the rebuildable authority through `ReconcilerService`.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `normalizerVersionTag` | `normalizerVersionTag()` | `string` |
| `repoRoot` | `repoRoot()` | `string` |
| `repoPath` | `repoPath(projectId: string)` | `string` |
| `normalizeContent` | `normalizeContent(markdown: string)` | `string` |
| `repoRelPath` | `repoRelPath(p: string)` | `string` |
| `exists` | `exists(projectId: string)` | `Promise<boolean>` |
| `ensureRepo` | `ensureRepo(projectId: string)` | `Promise<void>` |
| `writeFiles` | `writeFiles(projectId: string, files: RepoFile[], author: CommitAuthor, message: string, branch: string, opts: CommitOptions)` | `Promise<string>` |
| `writeTree` | `writeTree(projectId: string, files: RepoFile[], author: CommitAuthor, message: string, branch: string, sidecar: RepoFile[], opts: CommitOptions)` | `Promise<string>` |
| `headNormalizerVersion` | `headNormalizerVersion(projectId: string)` | `Promise<string | null>` |
| `readFile` | `readFile(projectId: string, filePath: string, ref: unknown)` | `Promise<string>` |
| `listFiles` | `listFiles(projectId: string, ref: unknown)` | `Promise<string[]>` |
| `headCommit` | `headCommit(projectId: string)` | `Promise<string | null>` |
| `checkout` | `checkout(projectId: string, ref: string)` | `Promise<void>` |
| `checkoutForce` | `checkoutForce(projectId: string, ref: string)` | `Promise<void>` |
| `createBranch` | `createBranch(projectId: string, name: string, fromRef: string)` | `Promise<void>` |
| `merge` | `merge(projectId: string, branch: string, message: string)` | `Promise<void>` |
| `tag` | `tag(projectId: string, name: string, ref: string, message: string)` | `Promise<void>` |

## Diagram

```mermaid
sequenceDiagram
    participant Caller as Application Service
    participant DocsRepo as DocsRepoService
    participant FS as Project Repo Filesystem
    participant Git as git CLI
    participant DB as PostgreSQL / ReconcilerService

    Caller->>DocsRepo: mutate project documentation
    DocsRepo->>FS: resolve ${DOCS_REPO_ROOT}/<projectId>
    DocsRepo->>Git: execFile("git", argv, { cwd })
    Git->>FS: write files, commits, and history
    Git-->>DocsRepo: command result
    DocsRepo-->>Caller: mutation result

    Note over DB,FS: PostgreSQL is authoritative;<br/>repositories can be rebuilt by reconciliation.
```

## AI Coding Instructions

- Route every documentation repository mutation through `DocsRepoService`; do not write directly to `${DOCS_REPO_ROOT}/<projectId>` from callers.
- Invoke Git only through promisified `execFile('git', args, { cwd })` with an argv array—never construct shell command strings.
- Treat `projectId`, file paths, branch names, and commit messages as untrusted input; validate or constrain paths before using them in repository operations.
- Keep repositories non-bare and scoped to one project at `${DOCS_REPO_ROOT}/<projectId>`; preserve the configurable root for test isolation.
- Remember that Git stores content history, while PostgreSQL is the authoritative source used by `ReconcilerService` to rebuild repositories.

## Relationships

- DEPENDS_ON → `configservice`
- DEPENDS_ON → `normalizefn`

<!-- source: interface-domaincheckresult.md -->

# DomainCheckResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/lib/api-client.ts` (line 69)

## Properties

| Property | Type |
|---|---|
| `status` | `DomainStatus` |
| `registrar` | `{ name: string; url?: string } | null` |
| `records` | `Array<DnsRecordSpec & { observed: string[]; ok: boolean; hint?: string }>` |
| `issues` | `Array<{ code: string; message: string }>` |

<!-- source: class-entityselector.md -->

# EntitySelector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/entity-selector.ts` (line 45)

EntitySelector - Smart entity selection for document generation

Selects entities based on:
1. Tier priority (TIER_1 > TIER_2 > TIER_3)
2. User-facing status
3. Document plan requirements
4. Token budget constraints

## Methods

| Method | Signature | Returns |
|---|---|---|
| `selectForDocument` | `selectForDocument(plan: DocumentPlan, entities: Entity[])` | `Entity[]` |
| `selectRelated` | `selectRelated(entityId: string, entities: Entity[])` | `Entity[]` |
| `selectByType` | `selectByType(entities: Entity[], types: Entity['type'][])` | `Entity[]` |
| `selectUserFacing` | `selectUserFacing(entities: Entity[])` | `Entity[]` |
| `selectByFeatureArea` | `selectByFeatureArea(entities: Entity[], featureArea: string)` | `Entity[]` |

<!-- source: function-entitysignaturehash.md -->

# entitySignatureHash

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/staleness.ts` (line 21)

A stable hash of an entity's PUBLIC SIGNATURE (not its body/formatting). Two parses of the
same logical API produce the same hash; a signature change (new method, changed return type,
new field, new endpoint shape) changes it. Moves/renames of unrelated code do not.

## Signature

```ts
function entitySignatureHash(entity: Entity): string
```

## Parameters

| Name | Type |
|---|---|
| `entity` | `Entity` |

**Returns:** `string`

<!-- source: function-escapehtml.md -->

# escapeHtml

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/assemble-html.tool.ts` (line 366)

## Signature

```ts
function escapeHtml(str: string): string
```

## Parameters

| Name | Type |
|---|---|
| `str` | `string` |

**Returns:** `string`

<!-- source: function-getallpendingupdates.md -->

# getAllPendingUpdates

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useOfflineSync.ts` (line 338)

Get all pending updates across all documents
Useful for showing a global offline indicator

## Signature

```ts
function getAllPendingUpdates(): Map<string, PendingUpdate[]>
```

**Returns:** `Map<string, PendingUpdate[]>`

<!-- source: type-jobid.md -->

# JobId

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 10)

Common types shared across all pipeline stages.
IMPLEMENT THIS FILE FIRST - all other types depend on it.

## Definition

```ts
string
```

<!-- source: constant-merge-vanished-error.md -->

# MERGE_VANISHED_ERROR

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.service.ts` (line 30)

The error recorded when a merge aborts because a targeted page no longer exists in Postgres.

<!-- source: function-parseslugregistry.md -->

# parseSlugRegistry

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/docs-repo/sidecar.ts` (line 149)

Parse an existing registry file; tolerate absent/corrupt input by starting empty. "Corrupt"
covers BOTH syntactic (bad JSON) AND structural (valid JSON, wrong shape) corruption: every
entry is COERCED to the expected shape so a hand-edited/partial-write/migration-renamed file
with, say, a missing `previousSlugs` can never make a later `[...entry.previousSlugs]` throw
and wedge the committer on every reconcile. A malformed entry is repaired, not trusted.

## Signature

```ts
function parseSlugRegistry(json: string | null | undefined): SlugRegistry
```

## Parameters

| Name | Type |
|---|---|
| `json` | `string | null | undefined` |

**Returns:** `SlugRegistry`

<!-- source: interface-propertydefinition.md -->

# PropertyDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 533)

Property definition within a schema

## Properties

| Property | Type |
|---|---|
| `type` | `string` |
| `description` | `string` |
| `example` | `unknown` |
| `format` | `string` |
| `enum` | `string[]` |

<!-- source: controller-publiccapturecontroller.md -->

# PublicCaptureController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/capture/public-capture.controller.ts` (line 12)

PUBLIC capture endpoint — consumed by the tour player embedded on the
customer's site. Returns the full recipe (selectors + step titles) so the
player can highlight the customer's REAL elements. Secret input values are
re-redacted here; nothing fabricated is ever served.

`PublicCaptureController` exposes a **public** capture endpoint consumed by the embedded tour player running on a customer’s site. It returns the full tour “recipe” (selectors plus step titles) so the player can match and highlight the customer’s real DOM elements. Before responding, it **re-redacts secret input values** to ensure no sensitive data is ever served.

## Diagram

```mermaid
graph LR
  A[Tour Player (embedded on customer site)] -->|HTTP request| B[PublicCaptureController]
  B --> C[Capture/Recipe Service Layer]
  C --> D[(Persistence: capture/recipe data)]
  C --> E[Redaction/Re-redaction]
  E -->|sanitized recipe| B
  B -->|JSON: selectors + step titles (sanitized)| A
```

## Usage

```ts
// Example: the embedded tour player fetching the public capture recipe
// (run in the browser on the customer's site)

type PublicCaptureStep = {
  title: string;
  selector: string;
};

type PublicCaptureRecipeResponse = {
  captureId: string;
  steps: PublicCaptureStep[];
};

async function fetchPublicCaptureRecipe(captureId: string) {
  const res = await fetch(`https://api.example.com/public/capture/${captureId}`, {
    method: "GET",
    headers: {
      "Accept": "application/json",
    },
    credentials: "omit", // typically public/anonymous
  });

  if (!res.ok) {
    throw new Error(`Failed to load recipe (${res.status})`);
  }

  const recipe = (await res.json()) as PublicCaptureRecipeResponse;

  // Use selectors to find and highlight real elements on the customer page
  for (const step of recipe.steps) {
    const el = document.querySelector(step.selector);
    if (el) {
      el.setAttribute("data-tour-highlight", "true");
      // render step.title in your UI
    }
  }

  return recipe;
}

// Usage
fetchPublicCaptureRecipe("cap_12345").catch(console.error);
```

## AI Coding Instructions

- Preserve the contract: the public endpoint must only return what the tour player needs (selectors + step titles + minimal identifiers); avoid adding internal fields.
- Always apply **re-redaction** before responding; never leak original captured input values, even if already stored redacted.
- Keep this controller thin: delegate data fetching/assembly to a service and keep response shaping/sanitization explicit and testable.
- Validate public inputs carefully (e.g., `captureId` format) and return consistent HTTP errors; assume callers are anonymous/untrusted.
- When changing selector/step structures, update the embedded player expectations and version/compatibility behavior together.

## Relationships

- MODULE_DECLARES → `getFlow`
- DEPENDS_ON → `captureservice`

<!-- source: class-sdkmodelproviderbridge.md -->

# SdkModelProviderBridge

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/sdk-model-bridge.ts` (line 40)

Wraps an existing SDK ModelProvider (AzureModelProvider, AnthropicModelProvider)
as our IModelProvider interface. This lets the Live-SWE loop use the existing
Azure adapter with all its optimizations (retries, incremental input, fallback).

**Implements:** `IModelProvider`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getResponse` | `getResponse(request: ModelProviderRequest)` | `Promise<ModelProviderResponse>` |
| `getStreamedResponse` | `getStreamedResponse(request: ModelProviderRequest)` | `AsyncIterable<unknown>` |
| `getProfile` | `getProfile()` | `ModelCapabilityProfile` |

<!-- source: interface-sitegenpromptconfig.md -->

# SiteGenPromptConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/agents/site-gen.prompts.ts` (line 8)

Site Generation Agent — System Prompt

Instructions for the AI agent that builds a complete Vite+React site
from product knowledge and the component library.

## Properties

| Property | Type |
|---|---|
| `brandName` | `string` |
| `targetAudience` | `string` |
| `brandVoice` | `string` |
| `language` | `string` |
| `theme` | `'light' | 'dark' | 'colorful'` |

<!-- source: module-technicaldocsmodule.md -->

# TechnicalDocsModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.module.ts` (line 37)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `emailmodule`
- MODULE_IMPORTS → `docversionmodule`
- MODULE_IMPORTS → `parsingmodule`
- MODULE_IMPORTS → `aimodule`
- MODULE_IMPORTS → `graphmodule`
- MODULE_IMPORTS → `eventsmodule`
- MODULE_IMPORTS → `issuesmodule`
- MODULE_IMPORTS → `draftdocumentmodule`
- MODULE_IMPORTS → `notificationmodule`
- MODULE_IMPORTS → `forwardref`
- MODULE_DECLARES → `technicaldocscontroller`
- MODULE_DECLARES → `technicaldocsmcpcontroller`
- MODULE_DECLARES → `technicaldocschatcontroller`
- MODULE_DECLARES → `freshnesscontroller`
- MODULE_PROVIDES → `freshnessservice`
- MODULE_PROVIDES → `technicaldocsservice`
- MODULE_PROVIDES → `technicaldocsparserservice`
- MODULE_PROVIDES → `technicaldocsenrichmentservice`
- MODULE_PROVIDES → `technicaldocsmaterializerservice`
- MODULE_PROVIDES → `technicaldocsgenerationservice`
- MODULE_PROVIDES → `technicaldocsqueue`
- MODULE_PROVIDES → `embeddingsservice`
- MODULE_PROVIDES → `ragchatmodelservice`
- MODULE_PROVIDES → `techdocsragservice`
- MODULE_PROVIDES → `techdocschatservice`
- MODULE_PROVIDES → `techdocssourcesservice`
- MODULE_PROVIDES → `techdocsconnectorsservice`
- MODULE_PROVIDES → `techdocsexportservice`
- MODULE_PROVIDES → `techdocsnotionexportservice`
- MODULE_PROVIDES → `opsalertservice`
- MODULE_PROVIDES → `stalealertservice`
- MODULE_PROVIDES → `aicostratelimitguard`
- MODULE_EXPORTS → `technicaldocsservice`
- MODULE_EXPORTS → `technicaldocsparserservice`
- MODULE_EXPORTS → `technicaldocsenrichmentservice`
- MODULE_EXPORTS → `technicaldocsmaterializerservice`
- MODULE_EXPORTS → `techdocsragservice`
- MODULE_EXPORTS → `technicaldocsqueue`

<!-- source: interface-autogeneratedfileinfo.md -->

# AutoGeneratedFileInfo

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-02.types.ts` (line 108)

AutoGeneratedFileInfo - Info about auto-generated files
These files need special handling to avoid including repetitive boilerplate.

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `generator` | `string` |
| `uniqueEndpoints` | `Array<{
    // For API clients
    method: string;
    path: string;
    operationId: string;
  }>` |
| `uniqueTypes` | `Array<{
    // For type files
    name: string;
    fields: string[];
  }>` |
| `templateSummary` | `string` |

<!-- source: component-callouteditor.md -->

# CalloutEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/directives.tsx` (line 238)

## Diagram

```mermaid
graph TD
    component_CalloutEditor_4947da6c["CalloutEditor"]
    class component_CalloutEditor_4947da6c rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: api-endpoint-clearchathistory.md -->

# clearChatHistory

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.controller.ts` (line 180)

## Endpoint

`DELETE /support-agent/:projectId/agents/:agentId/history`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `agentId` | query | `string` | ✓ |

## Referenced By

- `SupportAgentController` (MODULE_DECLARES)

<!-- source: constant-closeimagedialog.md -->

# closeImageDialog$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 336)

Close the image dialog.

<!-- source: component-commentreply.md -->

# CommentReply

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Comments/CommentThread.tsx` (line 161)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `reply` | `CommentWithUser` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CommentReply_41229965["CommentReply"]
    class component_CommentReply_41229965 rootComponent
```

## Relationships

- RENDERS → `Avatar`

## Referenced By

- `CommentThread` (RENDERS)

<!-- source: interface-competitordoc.md -->

# CompetitorDoc

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/web-search/data/competitor-docs-index.ts` (line 8)

Curated index of popular software documentation sites
Used for competitor research during documentation generation

Categories match common software types we encounter

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `category` | `string[]` |
| `docsUrl` | `string` |
| `apiDocsUrl` | `string` |
| `priority` | `'high' | 'medium' | 'low'` |
| `lastCrawled` | `Date` |
| `crawlEnabled` | `boolean` |

<!-- source: function-createplanmodefilter.md -->

# createPlanModeFilter

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/session/plan-mode-filter.ts` (line 55)

Create a ToolPreExecutionHook that blocks write/mutation tools during plan mode.

When plan mode is active, any tool not in the allowed set gets a clear error
message explaining that it's blocked and suggesting the agent continue with
investigation. The tool never executes — it's blocked before running.

Returns the hook and a `setPlanMode` function to toggle blocking on/off.

## Signature

```ts
function createPlanModeFilter(options: PlanModeFilterOptions): { hook: ToolPreExecutionHook; setPlanMode: (active: boolean) => void }
```

## Parameters

| Name | Type |
|---|---|
| `options` | `PlanModeFilterOptions` |

**Returns:** `{ hook: ToolPreExecutionHook; setPlanMode: (active: boolean) => void }`

<!-- source: class-createrelationdto.md -->

# CreateRelationDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/graph/dto/create-relation.dto.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `from` | `string` |
| `to` | `string` |
| `type` | `RelationType` |
| `metadata` | `Record<string, any>` |
| `weight` | `number` |

<!-- source: function-createroutemapping.md -->

# createRouteMapping

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 147)

Create a route mapping with defaults

## Signature

```ts
function createRouteMapping(options: Pick<RouteMapping, 'path' | 'routeFile' | 'framework'> &
    Partial<Omit<RouteMapping, 'path' | 'routeFile' | 'framework'>>): RouteMapping
```

## Parameters

| Name | Type |
|---|---|
| `options` | `Pick<RouteMapping, 'path' | 'routeFile' | 'framework'> &
    Partial<Omit<RouteMapping, 'path' | 'routeFile' | 'framework'>>` |

**Returns:** `RouteMapping`

<!-- source: interface-cronscheduleroptions.md -->

# CronSchedulerOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/cron.tool.ts` (line 30)

## Properties

| Property | Type |
|---|---|
| `inject` | `(message: string) => void` |

<!-- source: interface-diagramgenerationresult.md -->

# DiagramGenerationResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/state-machine-diagram.generator.ts` (line 87)

Result of diagram generation

## Properties

| Property | Type |
|---|---|
| `mermaidCode` | `string` |
| `coverageStats` | `{
    stateCoverage: number;
    transitionCoverage: number;
    qualityScore: number;
  }` |
| `cssClasses` | `string[]` |

<!-- source: service-documentationservice.md -->

# DocumentationService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/documentation.service.ts` (line 10)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generateUserDocumentation` | `generateUserDocumentation(dto: GenerateUserDocsDto, user: JwtPayload)` | `Promise<GeneratedDocumentation | SyncBatchResponseDto>` |

## Relationships

- DEPENDS_ON → `workflowdetectorservice`
- DEPENDS_ON → `userdocsgeneratorservice`
- DEPENDS_ON → `azureclaudeprovider`

<!-- source: interface-donutchartprops.md -->

# DonutChartProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/DonutChart.tsx` (line 12)

## Properties

| Property | Type |
|---|---|
| `data` | `DonutDatum[]` |
| `loading` | `boolean` |
| `centerLabel` | `string` |
| `colors` | `string[]` |
| `emptyMessage` | `string` |
| `maxSlices` | `number` |

<!-- source: class-expressdetector.md -->

# ExpressDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/express-detector.ts` (line 53)

Express Detector

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectRoutes` | `detectRoutes(entities: Entity[])` | `DetectedExpressRoute[]` |
| `detectMiddleware` | `detectMiddleware(entities: Entity[])` | `DetectedExpressMiddleware[]` |
| `getRouteSummary` | `getRouteSummary(route: DetectedExpressRoute)` | `string` |

<!-- source: function-extractcitations.md -->

# extractCitations

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/grounded-ask.ts` (line 38)

The `[path]` citations present in the answer text.

## Signature

```ts
function extractCitations(answer: string): string[]
```

## Parameters

| Name | Type |
|---|---|
| `answer` | `string` |

**Returns:** `string[]`

<!-- source: function-getalllayoutinfo.md -->

# getAllLayoutInfo

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/layouts/registry.ts` (line 55)

Get all registered layouts grouped by section type.

## Signature

```ts
function getAllLayoutInfo(): Record<string, string[]>
```

**Returns:** `Record<string, string[]>`

<!-- source: function-getalltypeslabel.md -->

# getAllTypesLabel

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/PublishingSidebar/pageTypeLabels.ts` (line 49)

Localized label for the "All" filter chip.

## Signature

```ts
function getAllTypesLabel(lang: string | null): string
```

## Parameters

| Name | Type |
|---|---|
| `lang` | `string | null` |

**Returns:** `string`

<!-- source: type-jobstage.md -->

# JobStage

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/orchestrator.ts` (line 34)

## Definition

```ts
| 'parse'
  | 'chunk'
  | 'extract-features'
  | 'analyze'
  | 'synthesize'
  | 'structure'
  | 'divide-phases'
  | 'plan-sessions'
  | 'plan-documents'
  | 'generate'
  | 'verify'
  | 'meta-docs'
  | 'upload'
  | 'screenshots'
```

<!-- source: constant-migrationguidetemplate.md -->

# migrationGuideTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/migration-guide.template.ts` (line 3)

<!-- source: function-public.md -->

# Public

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/auth/decorators/public.decorator.ts` (line 4)

<!-- source: controller-publicdocumentcontroller.md -->

# PublicDocumentController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/document/public-document.controller.ts` (line 8)

## Relationships

- MODULE_DECLARES → `getByUrlWithAudience`
- MODULE_DECLARES → `getByUrl`
- MODULE_DECLARES → `getPublicDocument`
- MODULE_DECLARES → `getPublicTree`
- DEPENDS_ON → `documentservice`
- DEPENDS_ON → `urlservice`

<!-- source: interface-queueconfig.md -->

# QueueConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/config.interface.ts` (line 144)

Queue configuration

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `defaultJobOptions` | `{
    /**
     * Number of retry attempts
     * @default 3
     */
    attempts: number;

    /**
     * Backoff strategy
     */
    backoff: {
      type: 'exponential' | 'fixed';
      delay: number;
    };

    /**
     * Remove job on completion
     */
    removeOnComplete: boolean | number;

    /**
     * Remove job on failure
     */
    removeOnFail: boolean | number;
  }` |

<!-- source: class-semanticindex.md -->

# SemanticIndex

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/semantic-index.ts` (line 31)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `index` | `index()` | `Promise<IndexStats>` |
| `reindexFiles` | `reindexFiles(files: string[])` | `Promise<void>` |
| `search` | `search(query: string, topK: number)` | `Promise<SearchResult[]>` |
| `isIndexed` | `isIndexed()` | `boolean` |

<!-- source: interface-socialprooftimelineprops.md -->

# SocialProofTimelineProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/social-proof/social-proof-timeline.tsx` (line 17)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `milestones` | `Milestone[]` |

<!-- source: module-templatemodule.md -->

# TemplateModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/template/template.module.ts` (line 13)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_DECLARES → `templatecontroller`
- MODULE_PROVIDES → `templateservice`
- MODULE_EXPORTS → `templateservice`

<!-- source: interface-azureresponsesconfig.md -->

# AzureResponsesConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/azure-responses.provider.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `endpoint` | `string` |
| `apiKey` | `string` |
| `apiVersion` | `string` |
| `useV1Endpoint` | `boolean` |
| `model` | `string` |
| `maxTokens` | `number` |
| `temperature` | `number` |
| `reasoningEffort` | `string` |
| `verbosity` | `string` |
| `timeout` | `number` |
| `retry` | `Partial<RetryConfig>` |

<!-- source: component-catchall.md -->

# CatchAll

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/bug-97.stories.tsx` (line 7)

## Diagram

```mermaid
graph TD
    component_CatchAll_a10f227["CatchAll"]
    class component_CatchAll_a10f227 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: api-endpoint-close.md -->

# close

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.controller.ts` (line 66)

## Endpoint

`POST /projects/:projectId/change-requests/:crId/close`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `crId` | query | `string` | ✓ |

## Referenced By

- `ChangeRequestController` (MODULE_DECLARES)

<!-- source: constant-codeblockeditordescriptors.md -->

# codeBlockEditorDescriptors$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 319)

Contains the currently registered code block descriptors.

<!-- source: component-commentskeleton.md -->

# CommentSkeleton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Comments/CommentSkeleton.tsx` (line 8)

## Diagram

```mermaid
graph TD
    component_CommentSkeleton_236c699["CommentSkeleton"]
    class component_CommentSkeleton_236c699 rootComponent
```

## Referenced By

- `CommentSkeletonList` (RENDERS)

<!-- source: interface-competitorinfo.md -->

# CompetitorInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/competitor-discovery.service.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `docsUrl` | `string` |
| `apiDocsUrl` | `string` |
| `reason` | `string` |

<!-- source: function-createqualitygatetool.md -->

# createQualityGateTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/quality-gate.tool.ts` (line 13)

## Signature

```ts
function createQualityGateTool(qualityGates: QualityGate[]): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `qualityGates` | `QualityGate[]` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: class-createreplydto.md -->

# CreateReplyDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/comment/dto/create-reply.dto.ts` (line 7)

DTO for creating a reply to an existing comment

## Properties

| Property | Type |
|---|---|
| `content` | `string` |

<!-- source: function-createtokentracker.md -->

# createTokenTracker

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/pipeline/token-tracker.ts` (line 274)

Create a token tracker with default budget

## Signature

```ts
function createTokenTracker(budget: Partial<TokenBudget>): TokenTracker
```

## Parameters

| Name | Type |
|---|---|
| `budget` | `Partial<TokenBudget>` |

**Returns:** `TokenTracker`

<!-- source: interface-crontools.md -->

# CronTools

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/cron.tool.ts` (line 123)

## Properties

| Property | Type |
|---|---|
| `cronCreateTool` | `ToolDefinition<TContext>` |
| `cronDeleteTool` | `ToolDefinition<TContext>` |
| `cronListTool` | `ToolDefinition<TContext>` |

<!-- source: interface-diffstatistics.md -->

# DiffStatistics

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/version-diff.ts` (line 77)

Diff statistics

## Properties

| Property | Type |
|---|---|
| `total` | `number` |
| `added` | `number` |
| `removed` | `number` |
| `modified` | `number` |
| `breaking` | `number` |
| `byType` | `Record<string, number>` |
| `bySeverity` | `Record<ChangeSeverity, number>` |

<!-- source: service-documentindexingservice.md -->

# DocumentIndexingService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/document-indexing.service.ts` (line 20)

Document Indexing Service

Coordinates documentation indexing to Azure AI Search.

**Synchronization Strategy**:
1. Event-driven: Index immediately after document create/update
2. Batch fallback: Hourly cron job syncs any missed documents

**Multi-Tenancy**: All indexed documents include projectId for filtering

**Database as Source of Truth**: PostgreSQL is authoritative, Azure AI Search is read-optimized replica

`DocumentIndexingService` coordinates synchronizing documentation records from PostgreSQL (source of truth) into Azure AI Search (read-optimized index). It supports immediate, event-driven indexing on document create/update and an hourly batch fallback cron job to catch missed changes. All indexed records include `projectId` to enforce multi-tenant filtering in search queries.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `unknown` |
| `indexWorkflow` | `indexWorkflow(documentId: string, workflow: any, projectId: string, organizationId: string, versionInfo: { docVersionId?: string; versionNumber?: number })` | `Promise<void>` |
| `indexFeature` | `indexFeature(documentId: string, feature: any, projectId: string, organizationId: string, versionInfo: { docVersionId?: string; versionNumber?: number })` | `Promise<void>` |
| `indexTutorial` | `indexTutorial(documentId: string, tutorial: any, projectId: string, organizationId: string, versionInfo: { docVersionId?: string; versionNumber?: number })` | `Promise<void>` |
| `indexMdxDocument` | `indexMdxDocument(documentId: string, document: { title: string; content: string; type?: string; audienceIds?: string[] }, projectId: string, organizationId: string, docVersionId: string, versionNumber: number)` | `Promise<void>` |
| `updateIndexedDocument` | `updateIndexedDocument(documentId: string, documentType: 'workflow' | 'feature' | 'tutorial', content: any, projectId: string, organizationId: string, versionInfo: { docVersionId?: string; versionNumber?: number })` | `Promise<void>` |
| `deleteIndexedDocument` | `deleteIndexedDocument(documentId: string)` | `Promise<void>` |
| `deleteProjectIndex` | `deleteProjectIndex(projectId: string)` | `Promise<void>` |
| `removeVersionsFromIndex` | `removeVersionsFromIndex(projectId: string, docVersionIds: string[])` | `Promise<void>` |
| `syncUnindexedDocuments` | `syncUnindexedDocuments()` | `Promise<void>` |
| `reindexProject` | `reindexProject(projectId: string)` | `Promise<void>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant App as API/NestJS
  participant DB as PostgreSQL
  participant DIS as DocumentIndexingService
  participant Search as Azure AI Search
  participant Cron as Hourly Cron

  App->>DB: Create/Update Document (projectId, content, metadata)
  DB-->>App: Commit OK
  App->>DIS: Emit/Handle document.changed event
  DIS->>DB: Load authoritative document by id
  DB-->>DIS: Document payload
  DIS->>Search: Upsert document into index (includes projectId)
  Search-->>DIS: Ack

  Cron->>DIS: Run hourly sync job
  DIS->>DB: Query for missed/out-of-sync documents
  DB-->>DIS: List of documents
  loop For each document
    DIS->>Search: Upsert document into index (includes projectId)
    Search-->>DIS: Ack
  end
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { DocumentIndexingService } from './documentation/services/document-indexing.service';

@Injectable()
export class DocumentsEventsHandler {
  constructor(private readonly indexing: DocumentIndexingService) {}

  // Example: called after a document is created/updated (event-driven path)
  async onDocumentChanged(documentId: string) {
    // Implementation detail depends on the service API:
    // call the service method that performs a DB fetch + Azure Search upsert.
    await this.indexing.indexDocumentById(documentId);
  }

  // Example: cron/batch fallback entrypoint (hourly)
  async hourlyReindex() {
    await this.indexing.syncMissedDocuments();
  }
}
```

## AI Coding Instructions

- Always treat PostgreSQL as the source of truth: fetch the latest document from DB before indexing; never rely on stale event payloads for final index content.
- Ensure every Azure AI Search document includes `projectId` and keep it filterable; missing `projectId` breaks multi-tenant isolation.
- Preserve idempotency: indexing operations should be safe to retry (upsert, not insert-only) because events/cron can overlap.
- Keep event-driven and cron paths consistent by reusing the same internal indexing routine (normalization, field mapping, serialization).
- When changing document schema/fields, update both DB-to-index mapping and any Azure Search index configuration (fields, analyzers) in lockstep to avoid runtime indexing errors.

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `azuresearchservice`
- DEPENDS_ON → `keywordextractorservice`

<!-- source: interface-donutdatum.md -->

# DonutDatum

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/DonutChart.tsx` (line 7)

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `count` | `number` |

<!-- source: function-extractcomponentnamefrompath-2.md -->

# extractComponentNameFromPath

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 648)

Extract the component name from a file path

## Signature

```ts
function extractComponentNameFromPath(filePath: string): string
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string` |

**Returns:** `string`

<!-- source: class-fastapidetector.md -->

# FastAPIDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/fastapi-detector.ts` (line 70)

FastAPI Detector

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectRoutes` | `detectRoutes(entities: Entity[])` | `DetectedFastAPIRoute[]` |
| `detectModels` | `detectModels(entities: Entity[])` | `DetectedPydanticModel[]` |
| `getRouteSummary` | `getRouteSummary(route: DetectedFastAPIRoute)` | `string` |

<!-- source: function-getaudiencelabel.md -->

# getAudienceLabel

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/uiStrings.ts` (line 588)

## Signature

```ts
function getAudienceLabel(slug: string, lang: string | null): string
```

## Parameters

| Name | Type |
|---|---|
| `slug` | `string` |
| `lang` | `string | null` |

**Returns:** `string`

<!-- source: function-getavailablelayouts.md -->

# getAvailableLayouts

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/layouts/registry.ts` (line 50)

List available layout keys for a section type.

## Signature

```ts
function getAvailableLayouts(sectionType: string): string[]
```

## Parameters

| Name | Type |
|---|---|
| `sectionType` | `string` |

**Returns:** `string[]`

<!-- source: type-jobstage-2.md -->

# JobStage

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 12)

## Definition

```ts
| 'parse'
  | 'chunk'
  | 'extract-features'
  | 'analyze'
  | 'synthesize'
  | 'structure'
  | 'divide-phases'
  | 'plan-sessions'
  | 'plan-documents'
  | 'generate'
  | 'verify'
  | 'meta-docs'
  | 'screenshots'
  | 'upload'
```

<!-- source: constant-notion-max-children.md -->

# NOTION_MAX_CHILDREN

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/technical-docs/md-to-notion-blocks.ts` (line 11)

Dependency-free markdown → Notion block objects (the `children` payload for the Notion API).
Parallels `mdToStorageHtml` (Confluence): covers exactly what our generated pages emit —
headings, paragraphs with inline formatting, fenced code, bulleted lists; tables degrade to
paragraphs. No `@notionhq/client` (ESM-only → would break the CJS server build, like `marked`).

Two hard Notion limits are baked in here so the export never 400s:
 - a single rich-text run's `content` must be ≤ 2000 chars → long runs are split.
 - a request may carry ≤ 100 child blocks → chunking is done by the caller (see NOTION_MAX_CHILDREN).

<!-- source: controller-publicissuescontroller.md -->

# PublicIssuesController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/issues/public-issues.controller.ts` (line 8)

## Relationships

- MODULE_DECLARES → `create`
- MODULE_DECLARES → `getTicket`
- MODULE_DECLARES → `reply`
- MODULE_DECLARES → `csat`
- DEPENDS_ON → `issuesservice`

<!-- source: function-querymatchespage.md -->

# queryMatchesPage

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/manuals-insights/manuals-insights.service.ts` (line 45)

Does a support query "resemble" a manual page? True when any meaningful query term
appears in the page's title or slug (fuzzy, term-overlap). Used both ways:
 - weakPages: a miss that DOES resolve to a page → that page is under-serving.
 - topicGaps: a miss that resolves to NO page → the topic is undocumented.

## Signature

```ts
function queryMatchesPage(query: string, page: { title: string; slug: string }): boolean
```

## Parameters

| Name | Type |
|---|---|
| `query` | `string` |
| `page` | `{ title: string; slug: string }` |

**Returns:** `boolean`

<!-- source: interface-queuemetrics.md -->

# QueueMetrics

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/config.interface.ts` (line 348)

Queue metrics

## Properties

| Property | Type |
|---|---|
| `waiting` | `number` |
| `active` | `number` |
| `completed` | `number` |
| `failed` | `number` |
| `delayed` | `number` |
| `paused` | `number` |
| `total` | `number` |

<!-- source: class-sessioneventbridge.md -->

# SessionEventBridge

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/protocol/session-event-bridge.ts` (line 49)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `addTransport` | `addTransport(transport: AgentTransport)` | `void` |
| `on` | `on(type: T, handler: AgentProtocolEventHandler<T>)` | `void` |
| `dispose` | `dispose()` | `void` |

<!-- source: interface-socialprooftrustbadgesprops.md -->

# SocialProofTrustBadgesProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/social-proof/social-proof-trust-badges.tsx` (line 26)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `badges` | `TrustBadge[]` |

<!-- source: module-throttlingmodule.md -->

# ThrottlingModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/common/throttling.module.ts` (line 25)

<!-- source: interface-basenode.md -->

# BaseNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 9)

Types for Multi-Audience Directive Parsing and Rendering
Based on DIRECTIVE_SYNTAX_SPECIFICATION.md v1.0

## Properties

| Property | Type |
|---|---|
| `type` | `string` |
| `startLine` | `number` |
| `endLine` | `number` |
| `startOffset` | `number` |
| `endOffset` | `number` |

<!-- source: component-catchall-2.md -->

# CatchAll

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/directives.tsx` (line 121)

## Diagram

```mermaid
graph TD
    component_CatchAll_74b1beaf["CatchAll"]
    class component_CatchAll_74b1beaf rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: constant-codeblockplugin.md -->

# codeBlockPlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/index.ts` (line 107)

A plugin that adds support for code blocks and custom code block editors.

<!-- source: api-endpoint-compare.md -->

# compare

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 183)

## Endpoint

`GET /documents/:id/compare`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `dto` | query | `CompareDocumentDto` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: interface-competitorresearchresult.md -->

# CompetitorResearchResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/competitor-research.service.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `competitors` | `CompetitorInfo[]` |
| `crawledPages` | `CrawledPage[]` |
| `summary` | `string` |
| `totalContentLength` | `number` |
| `researchedAt` | `Date` |

<!-- source: component-conflictfilecard.md -->

# ConflictFileCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/changes/[crId]/page.tsx` (line 67)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `file` | `ChangeRequestConflictFile` | ✓ | - |
| `busy` | `boolean` | ✓ | - |
| `onResolve` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ConflictFileCard_27895112["ConflictFileCard"]
    class component_ConflictFileCard_27895112 rootComponent
```

## Relationships

- RENDERS → `Spinner`
- USES_HOOK → `useState`

## Referenced By

- `ChangeRequestDetailPage` (RENDERS)

<!-- source: function-createreadfiletool.md -->

# createReadFileTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/read-file.tool.ts` (line 36)

## Signature

```ts
function createReadFileTool(options: ReadFileOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `ReadFileOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: class-createsuggestiondto.md -->

# CreateSuggestionDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/suggestion/dto/create-suggestion.dto.ts` (line 3)

## Properties

| Property | Type |
|---|---|
| `originalText` | `string` |
| `suggestedText` | `string` |
| `positionStart` | `number` |
| `positionEnd` | `number` |

<!-- source: function-createv2pipeline.md -->

# createV2Pipeline

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/orchestrator.ts` (line 4656)

Create a V2 pipeline orchestrator with default configuration

## Signature

```ts
function createV2Pipeline(config: V2PipelineConfig): V2PipelineOrchestrator
```

## Parameters

| Name | Type |
|---|---|
| `config` | `V2PipelineConfig` |

**Returns:** `V2PipelineOrchestrator`

<!-- source: interface-crontoolsoptions.md -->

# CronToolsOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/cron.tool.ts` (line 119)

## Properties

| Property | Type |
|---|---|
| `scheduler` | `CronScheduler` |

<!-- source: interface-discoveredworkflow.md -->

# DiscoveredWorkflow

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 137)

Discovered Workflow - Output from LLM analysis

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `domain` | `string` |
| `confidence` | `number` |
| `stages` | `WorkflowStage[]` |
| `transitions` | `WorkflowTransition[]` |

<!-- source: service-documentpersistenceservice.md -->

# DocumentPersistenceService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/collaboration/document-persistence.service.ts` (line 13)

Service for managing periodic document saves
Handles auto-save functionality for collaborative documents

`DocumentPersistenceService` manages periodic persistence for collaborative documents in the NestJS API. It coordinates auto-save scheduling and write operations so active document changes are stored reliably without requiring clients to explicitly save every update. It sits between the collaboration layer that receives edits and the underlying document storage mechanism.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleDestroy` | `onModuleDestroy()` | `void` |
| `startPeriodicSave` | `startPeriodicSave(documentId: string, ydoc: Y.Doc, intervalMs: number)` | `() => void` |
| `stopPeriodicSave` | `stopPeriodicSave(documentId: string)` | `void` |
| `stopAllPeriodicSaves` | `stopAllPeriodicSaves()` | `void` |
| `saveDocument` | `saveDocument(documentId: string)` | `Promise<boolean>` |
| `saveAllDocuments` | `saveAllDocuments()` | `Promise<Map<string, boolean>>` |
| `hasPeriodicSave` | `hasPeriodicSave(documentId: string)` | `boolean` |
| `getActiveDocumentCount` | `getActiveDocumentCount()` | `number` |
| `getActiveDocumentIds` | `getActiveDocumentIds()` | `string[]` |
| `updateDocument` | `updateDocument(documentId: string, ydoc: Y.Doc)` | `void` |
| `flushAll` | `flushAll()` | `Promise<void>` |
| `getDocumentContent` | `getDocumentContent(documentId: string)` | `string | null` |
| `hasPendingChanges` | `hasPendingChanges(documentId: string)` | `Promise<boolean>` |

## Diagram

```mermaid
sequenceDiagram
    participant Client as Collaboration Client
    participant Collaboration as Collaboration Service
    participant Persistence as DocumentPersistenceService
    participant Storage as Document Repository/Database

    Client->>Collaboration: Send document update
    Collaboration->>Persistence: Queue document for auto-save
    Persistence->>Persistence: Reset or schedule save timer

    Note over Persistence: Auto-save interval expires

    Persistence->>Storage: Persist latest document state
    Storage-->>Persistence: Save result
    Persistence-->>Collaboration: Document persistence completed
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { DocumentPersistenceService } from './document-persistence.service';

@Injectable()
export class CollaborationService {
  constructor(
    private readonly documentPersistenceService: DocumentPersistenceService,
  ) {}

  async handleDocumentUpdate(documentId: string, content: unknown) {
    // Apply the update to the in-memory collaboration document first.
    // Then queue persistence rather than writing on every client update.
    this.documentPersistenceService.scheduleSave(documentId, content);
  }

  async closeDocument(documentId: string, content: unknown) {
    // Flush pending changes when a collaboration session ends.
    await this.documentPersistenceService.saveNow(documentId, content);
  }
}
```

## AI Coding Instructions

- Queue or debounce saves through `DocumentPersistenceService`; avoid writing to the database for every collaboration update.
- Always flush pending document changes during document/session shutdown to prevent losing updates still waiting for the auto-save timer.
- Ensure persistence operations use the latest authoritative document state, not a stale update payload captured when a timer was created.
- Clean up timers and in-memory save tracking when documents are closed or deleted to prevent memory leaks.
- Propagate or log persistence failures with enough document context for retry and operational debugging.

## Relationships

- DEPENDS_ON → `collaborationservice`

<!-- source: function-extractcomponentstatemachines.md -->

# extractComponentStateMachines

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/component-state-machine-extractor.ts` (line 25)

Extract state machines from component code
Handles both enums defined in the same file and imported enums

## Signature

```ts
function extractComponentStateMachines(componentCode: string, componentFilePath: string): StateMachine[]
```

## Parameters

| Name | Type |
|---|---|
| `componentCode` | `string` |
| `componentFilePath` | `string` |

**Returns:** `StateMachine[]`

<!-- source: class-filecache.md -->

# FileCache

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/services/entity-mapper.service.ts` (line 110)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getLines` | `getLines(absolutePath: string)` | `string[] | null` |
| `clear` | `clear()` | `void` |

<!-- source: interface-fileuploadprops.md -->

# FileUploadProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Parser/FileUpload.tsx` (line 5)

## Properties

| Property | Type |
|---|---|
| `onFileSelect` | `(file: File) => void` |
| `accept` | `string` |
| `maxSize` | `number` |
| `className` | `string` |

<!-- source: function-getavailablecolors.md -->

# getAvailableColors

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/user-colors.ts` (line 144)

Get all available colors in the palette
Useful for documentation or debugging

## Signature

```ts
function getAvailableColors(): readonly string[]
```

**Returns:** `readonly string[]`

<!-- source: function-getlayout.md -->

# getLayout

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/layouts/registry.ts` (line 36)

Get a layout renderer. Falls back to the first registered
layout (the default) if the key is not found.

## Signature

```ts
function getLayout(sectionType: string, layoutKey: string): SectionRenderer | undefined
```

## Parameters

| Name | Type |
|---|---|
| `sectionType` | `string` |
| `layoutKey` | `string` |

**Returns:** `SectionRenderer | undefined`

<!-- source: type-jobstatus-4.md -->

# JobStatus

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 191)

## Definition

```ts
'pending' | 'running' | 'completed' | 'failed'
```

<!-- source: constant-onboardingchecklisttemplate.md -->

# onboardingChecklistTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/onboarding-checklist.template.ts` (line 3)

<!-- source: controller-publicprojectcontroller.md -->

# PublicProjectController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 39)

## Relationships

- MODULE_DECLARES → `getPublishedProjects`
- MODULE_DECLARES → `getBySubdomain`
- MODULE_DECLARES → `getByCustomDomain`
- MODULE_DECLARES → `getByUrl`
- MODULE_DECLARES → `getLlmsTxtByUrl`
- MODULE_DECLARES → `getLlmsFullTxtByUrl`
- MODULE_DECLARES → `getPageMarkdownByUrl`
- MODULE_DECLARES → `getSearchIndexByUrl`
- MODULE_DECLARES → `handleMcp`
- MODULE_DECLARES → `mcpGet`
- MODULE_DECLARES → `getPublishedVersions`
- MODULE_DECLARES → `getPublishedLanguagesByUrl`
- MODULE_DECLARES → `getAudiencesByUrl`
- MODULE_DECLARES → `getAudienceDocuments`
- MODULE_DECLARES → `getDocument`
- MODULE_DECLARES → `getRelatedDocuments`
- MODULE_DECLARES → `getCapabilities`
- MODULE_DECLARES → `getPublicTechnicalSnapshot`
- MODULE_DECLARES → `getPublicEntity`
- MODULE_DECLARES → `getPublicApiSpec`
- MODULE_DECLARES → `getPublicSupportAgents`
- MODULE_DECLARES → `getPublicChatConfig`
- MODULE_DECLARES → `escalatePublicChat`
- MODULE_DECLARES → `recordPublicChatFeedback`
- MODULE_DECLARES → `recordPublicChatResolution`
- MODULE_DECLARES → `publicSearch`
- MODULE_DECLARES → `getScreenshotPlaceholders`
- DEPENDS_ON → `projectservice`
- DEPENDS_ON → `urlservice`
- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `supportagentservice`
- DEPENDS_ON → `aiservice`
- DEPENDS_ON → `brandingservice`
- DEPENDS_ON → `techdocsragservice`
- DEPENDS_ON → `technicaldocsmaterializerservice`
- DEPENDS_ON → `issuesservice`
- DEPENDS_ON → `eventsservice`
- DEPENDS_ON → `technicaldocsservice`
- DEPENDS_ON → `projectdomainsservice`

<!-- source: interface-rabbitmqconfig.md -->

# RabbitMQConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/config.interface.ts` (line 117)

RabbitMQ configuration

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `parseQueue` | `string` |
| `deadLetterQueue` | `string` |
| `prefetchCount` | `number` |

<!-- source: function-redactstepvalue.md -->

# redactStepValue

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/capture/capture.redact.ts` (line 43)

Redact a single step's `value` in place-safe (returns a new value string or
undefined). Applies to input/submit actions only.

## Signature

```ts
function redactStepValue(step: {
  action?: string;
  value?: string;
  selector?: string;
  elementRole?: string;
  elementText?: string;
}): string | undefined
```

## Parameters

| Name | Type |
|---|---|
| `step` | `{
  action?: string;
  value?: string;
  selector?: string;
  elementRole?: string;
  elementText?: string;
}` |

**Returns:** `string | undefined`

<!-- source: class-sessionjournal.md -->

# SessionJournal

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/session-journal.ts` (line 53)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `add` | `add(turn: number, type: JournalEntryType, content: string)` | `JournalEntry` |
| `read` | `read()` | `string` |
| `format` | `format()` | `string` |
| `cleanup` | `cleanup()` | `void` |
| `getGoal` | `getGoal()` | `string` |
| `count` | `count()` | `number` |
| `getAll` | `getAll()` | `readonly JournalEntry[]` |
| `getFilePath` | `getFilePath()` | `string` |

<!-- source: interface-statcardprops.md -->

# StatCardProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/stat-card.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `valueKey` | `string` |
| `labelKey` | `string` |
| `className` | `string` |

<!-- source: module-trialmodule.md -->

# TrialModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/trial/trial.module.ts` (line 9)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `authmodule`
- MODULE_IMPORTS → `technicaldocsmodule`
- MODULE_IMPORTS → `projectmodule`
- MODULE_DECLARES → `trialcontroller`
- MODULE_PROVIDES → `trialservice`

<!-- source: interface-batchauthconfig.md -->

# BatchAuthConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 110)

Authentication configuration for batch

## Properties

| Property | Type |
|---|---|
| `loginUrl` | `string` |
| `username` | `string` |
| `password` | `string` |
| `usernameSelector` | `string` |
| `passwordSelector` | `string` |
| `submitSelector` | `string` |
| `successSelector` | `string` |
| `useSmartDetection` | `boolean` |
| `healthCheck` | `SessionHealthCheck` |

<!-- source: component-catchallplugin.md -->

# CatchAllPlugin

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/error-handling.tsx` (line 96)

## Diagram

```mermaid
graph TD
    component_CatchAllPlugin_4a4b9148["CatchAllPlugin"]
    class component_CatchAllPlugin_4a4b9148 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `ConditionalContents`
- RENDERS → `ChangeCodeMirrorLanguage`
- RENDERS → `ShowSandpackInfo`
- RENDERS → `UndoRedo`
- RENDERS → `BoldItalicUnderlineToggles`

<!-- source: constant-codeblockvisitor.md -->

# CodeBlockVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/CodeBlockVisitor.ts` (line 5)

## Definition

```ts
LexicalExportVisitor<CodeBlockNode, Mdast.Code>
```

<!-- source: api-endpoint-compareversions.md -->

# compareVersions

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 75)

## Endpoint

`GET /doc-versions/:projectId/compare`

| Parameter | In | Type | Required |
|---|---|---|---|
| `from` | query | `string` | ✓ |
| `to` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: interface-competitorsearchresult.md -->

# CompetitorSearchResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/web-search/interfaces/search.interfaces.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `query` | `string` |
| `results` | `SearchResult[]` |
| `totalResults` | `number` |
| `searchTime` | `number` |
| `source` | `'cache' | 'index' | 'api'` |

<!-- source: component-contrastwarning.md -->

# ContrastWarning

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/branding/page.tsx` (line 1132)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `color` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ContrastWarning_6596dce6["ContrastWarning"]
    class component_ContrastWarning_6596dce6 rootComponent
```

## Relationships

- RENDERS → `ExclamationTriangleIcon`

## Referenced By

- `BrandingSettingsPage` (RENDERS)

<!-- source: function-createrehydrationhook.md -->

# createRehydrationHook

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/context/rehydration.ts` (line 30)

Create a PostCompactionHook that reads files from disk.
This is the "hard rehydration" implementation — actually reads files
rather than nudging the agent to re-read them.

## Signature

```ts
function createRehydrationHook(config: RehydrationConfig): PostCompactionHook
```

## Parameters

| Name | Type |
|---|---|
| `config` | `RehydrationConfig` |

**Returns:** `PostCompactionHook`

<!-- source: class-createsuggestionwithdocumentdto.md -->

# CreateSuggestionWithDocumentDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/suggestion/dto/create-suggestion.dto.ts` (line 23)

Body for the flat POST /suggestions alias route, which carries the target
document in the payload instead of the URL.

**Extends:** `CreateSuggestionDto`

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |

<!-- source: function-createvalidresult.md -->

# createValidResult

**Kind:** Function

**Source:** `atloria-monorepo/packages/core/src/validators/validation-result.ts` (line 12)

Create a successful validation result

## Signature

```ts
function createValidResult(): ValidationResult
```

**Returns:** `ValidationResult`

<!-- source: interface-definition.md -->

# Definition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/repo-map.ts` (line 35)

## Properties

| Property | Type |
|---|---|
| `file` | `string` |
| `line` | `number` |
| `kind` | `string` |
| `name` | `string` |
| `exported` | `boolean` |

<!-- source: interface-docscorpus.md -->

# DocsCorpus

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/mcp-toolset.ts` (line 13)

## Properties

| Property | Type |
|---|---|
| `projectName` | `string` |
| `pages` | `LlmsPage[]` |
| `entities` | `Entity[]` |
| `relationships` | `Relationship[]` |

<!-- source: service-documentrevisionservice.md -->

# DocumentRevisionService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/document/services/document-revision.service.ts` (line 19)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createRevision` | `createRevision(documentId: string, snapshot: RevisionSnapshot, userId: string, changeType: ChangeType)` | `Promise<DocumentRevision>` |
| `getRevisions` | `getRevisions(documentId: string, limit: number, offset: number)` | `Promise<DocumentRevision[]>` |
| `getRevision` | `getRevision(revisionId: string)` | `Promise<DocumentRevision>` |
| `restoreFromRevision` | `restoreFromRevision(documentId: string, revisionId: string, userId: string)` | `Promise<any>` |
| `getRevisionCount` | `getRevisionCount(documentId: string)` | `Promise<number>` |
| `cleanupOldRevisions` | `cleanupOldRevisions(documentId: string, keepLast: number)` | `Promise<number>` |
| `deleteAllRevisions` | `deleteAllRevisions(documentId: string)` | `Promise<number>` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: function-extractdefaultvalue-2.md -->

# extractDefaultValue

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 403)

Extract default value as a string representation

## Signature

```ts
function extractDefaultValue(node: t.Node): string
```

## Parameters

| Name | Type |
|---|---|
| `node` | `t.Node` |

**Returns:** `string`

<!-- source: class-frameworkdetector.md -->

# FrameworkDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/framework-detector.ts` (line 31)

Framework Detector - Identifies project tech stack

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detect` | `detect(repoPath: string)` | `Promise<FrameworkDetectionResult>` |

<!-- source: function-getcrdiff.md -->

# getCrDiff

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/cr-shared.ts` (line 45)

## Signature

```ts
function getCrDiff(cr: ChangeRequest): CrDiff | null
```

## Parameters

| Name | Type |
|---|---|
| `cr` | `ChangeRequest` |

**Returns:** `CrDiff | null`

<!-- source: function-getvariantstyles.md -->

# getVariantStyles

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/agents/variant.agent.ts` (line 63)

Get the variant styles metadata.

## Signature

```ts
function getVariantStyles(): VariantStyle[]
```

**Returns:** `VariantStyle[]`

<!-- source: interface-horizontalbarchartprops.md -->

# HorizontalBarChartProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/HorizontalBarChart.tsx` (line 16)

## Properties

| Property | Type |
|---|---|
| `items` | `HorizontalBarItem[]` |
| `maxItems` | `number` |
| `loading` | `boolean` |
| `emptyMessage` | `string` |

<!-- source: type-jobstatus-5.md -->

# JobStatus

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 28)

## Definition

```ts
| 'pending'
  | 'running'
  | 'paused'
  | 'awaiting_approval'
  | 'completed'
  | 'failed'
```

<!-- source: constant-oneononetemplate.md -->

# oneOnOneTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/one-on-one.template.ts` (line 3)

<!-- source: interface-ratelimitinfo.md -->

# RateLimitInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 584)

Rate limit configuration

## Properties

| Property | Type |
|---|---|
| `requests` | `number` |
| `period` | `string` |
| `scope` | `'user' | 'ip' | 'global'` |

<!-- source: function-renderbrandedemail.md -->

# renderBrandedEmail

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/email/email-template.ts` (line 31)

## Signature

```ts
function renderBrandedEmail(opts: BrandedEmailOptions): string
```

## Parameters

| Name | Type |
|---|---|
| `opts` | `BrandedEmailOptions` |

**Returns:** `string`

<!-- source: controller-samlcontroller.md -->

# SamlController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/auth/saml/saml.controller.ts` (line 9)

## Relationships

- MODULE_DECLARES → `login`
- MODULE_DECLARES → `callback`
- MODULE_DECLARES → `configureSaml`
- MODULE_DECLARES → `getConfig`
- MODULE_DECLARES → `toggleSaml`
- MODULE_DECLARES → `getMetadata`
- DEPENDS_ON → `samlservice`

<!-- source: class-sessionmanager.md -->

# SessionManager

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/session/session-manager.ts` (line 45)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createId` | `createId()` | `string` |
| `save` | `save(id: string, ctx: SessionSaveContext)` | `string` |
| `resume` | `resume(id: string)` | `ResumedSession | undefined` |
| `list` | `list()` | `SessionMeta[]` |
| `delete` | `delete(id: string)` | `boolean` |
| `latest` | `latest()` | `SessionMeta | undefined` |
| `getMeta` | `getMeta(id: string)` | `SessionMeta | undefined` |
| `loadSnapshot` | `loadSnapshot(id: string)` | `SessionSnapshot | undefined` |

<!-- source: interface-stepindicatorprops.md -->

# StepIndicatorProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/step-indicator.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `step` | `number` |
| `icon` | `LucideIcon` |
| `titleKey` | `string` |
| `descriptionKey` | `string` |

<!-- source: module-webhookmodule.md -->

# WebhookModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/webhooks/webhook.module.ts` (line 9)

## Relationships

- MODULE_IMPORTS → `databasemodule`
- MODULE_IMPORTS → `forwardref`
- MODULE_IMPORTS → `forwardref`
- MODULE_IMPORTS → `forwardref`
- MODULE_DECLARES → `webhookcontroller`
- MODULE_PROVIDES → `webhookservice`
- MODULE_EXPORTS → `webhookservice`

<!-- source: interface-batchconfig.md -->

# BatchConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/batched-screenshot-processor.ts` (line 30)

## Properties

| Property | Type |
|---|---|
| `batchSize` | `number` |
| `prisma` | `any` |
| `projectId` | `string` |
| `isCancelled` | `() => boolean` |
| `onBatchComplete` | `(result: BatchResult) => void | Promise<void>` |
| `maxBatchRetries` | `number` |
| `retryDelayMs` | `number` |

<!-- source: component-changeadmonitiontype.md -->

# ChangeAdmonitionType

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/ChangeAdmonitionType.tsx` (line 23)

## Diagram

```mermaid
graph TD
    component_ChangeAdmonitionType_2d8b33b1["ChangeAdmonitionType"]
    class component_ChangeAdmonitionType_2d8b33b1 rootComponent
```

## Relationships

- RENDERS → `Select`
- USES_HOOK → `useCellValues`
- USES_HOOK → `useTranslation`

<!-- source: constant-comment.md -->

# comment

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/mdastUtilHtmlComment.ts` (line 192)

## Definition

```ts
Extension
```

<!-- source: api-endpoint-configuresaml.md -->

# configureSaml

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/saml/saml.controller.ts` (line 64)

Configure SAML for organization
Requires admin access

## Endpoint

`POST /auth/saml/:orgId/configure`

| Parameter | In | Type | Required |
|---|---|---|---|
| `orgId` | query | `string` | ✓ |

## Referenced By

- `SamlController` (MODULE_DECLARES)

<!-- source: interface-confluenceexportdto.md -->

# ConfluenceExportDto

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/techdocs-export.service.ts` (line 60)

## Properties

| Property | Type |
|---|---|
| `baseUrl` | `string` |
| `email` | `string` |
| `apiToken` | `string` |
| `spaceKey` | `string` |
| `scope` | `'technical' | 'user'` |

<!-- source: component-copilottabbody.md -->

# CopilotTabBody

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/DeskCopilot.tsx` (line 106)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `thread` | `DeskThreadDetail` | ✓ | - |
| `cache` | `CopilotCache` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CopilotTabBody_423c9aa8["CopilotTabBody"]
    class component_CopilotTabBody_423c9aa8 rootComponent
```

## Relationships

- RENDERS → `ArrowLeftIcon`
- RENDERS → `AnswerSkeleton`
- RENDERS → `ReactMarkdown`
- RENDERS → `ArrowUturnLeftIcon`
- RENDERS → `PaperAirplaneIcon`
- USES_HOOK → `useSession`
- USES_HOOK → `useReducer`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

## Referenced By

- `DeskCopilot` (RENDERS)

<!-- source: function-createrepomaptool.md -->

# createRepoMapTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/repo-map.tool.ts` (line 28)

## Signature

```ts
function createRepoMapTool(options: RepoMapToolOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `RepoMapToolOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: class-createtemplatedto.md -->

# CreateTemplateDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/template/dto/create-template.dto.ts` (line 19)

DTO for creating a new document template.
Used by administrators and maintainers to add templates to the system.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `category` | `TemplateCategory` |
| `content` | `string` |
| `thumbnail` | `string` |
| `metadata` | `Record<string, unknown>` |
| `defaultType` | `DocumentType` |
| `defaultAudiences` | `string[]` |
| `isPublic` | `boolean` |
| `organizationId` | `string` |

<!-- source: function-curry1to0.md -->

# curry1to0

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/fp.ts` (line 29)

Takes a 1 argument function and returns a function which when called, executes it with the provided argument.

## Signature

```ts
function curry1to0(proc: (arg: T) => R, arg: T): () => R
```

## Parameters

| Name | Type |
|---|---|
| `proc` | `(arg: T) => R` |
| `arg` | `T` |

**Returns:** `() => R`

<!-- source: interface-diffhunk-2.md -->

# DiffHunk

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/edit-file.tool.ts` (line 555)

## Properties

| Property | Type |
|---|---|
| `oldStart` | `number` |
| `oldCount` | `number` |
| `oldLines` | `string[]` |
| `newLines` | `string[]` |

<!-- source: interface-docsearchhit.md -->

# DocSearchHit

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/mcp-toolset.ts` (line 20)

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `path` | `string` |
| `snippet` | `string` |
| `score` | `number` |

<!-- source: service-documentservice.md -->

# DocumentService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/document/document.service.ts` (line 39)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `create` | `create(dto: CreateDocumentDto, user: JwtPayload)` | `Promise<Document>` |
| `get` | `get(id: string, _user: JwtPayload)` | `Promise<Document>` |
| `list` | `list(filters: DocumentFiltersDto, user: JwtPayload)` | `Promise<{ documents: Document[]; totalCount: number; limit: number; offset: number }>` |
| `update` | `update(id: string, dto: UpdateDocumentDto, user: JwtPayload, options: { isMachineUpdate?: boolean; expectedUpdatedAt?: Date })` | `Promise<Document>` |
| `delete` | `delete(id: string, user: JwtPayload)` | `Promise<void>` |
| `getVersions` | `getVersions(id: string, user: JwtPayload)` | `Promise<Document[]>` |
| `getVersion` | `getVersion(id: string, version: number, user: JwtPayload)` | `Promise<Document>` |
| `revert` | `revert(id: string, version: number, user: JwtPayload)` | `Promise<Document>` |
| `publish` | `publish(id: string, dto: PublishDocumentDto, user: JwtPayload)` | `Promise<Document>` |
| `unpublish` | `unpublish(id: string, dto: UnpublishDocumentDto, user: JwtPayload)` | `Promise<Document>` |
| `render` | `render(id: string, user: JwtPayload, audienceQuery: string)` | `Promise<{
    documentId: string;
    title: string;
    renderedContent: string;
    viewerAudiences: string[];
  }>` |
| `renderPublic` | `renderPublic(id: string, user: JwtPayload)` | `Promise<{
    documentId: string;
    title: string;
    renderedContent: string;
    toc: TocEntry[];
    viewerAudiences: string[];
    createdAt: Date;
    createdBy: {
      name: string | null;
    };
  }>` |
| `renderPublicByUrl` | `renderPublicByUrl(urlId: string, audienceFromUrl: string, user: JwtPayload)` | `Promise<{
    documentId: string;
    title: string;
    slug: string;
    renderedContent: string;
    toc: TocEntry[];
    viewerAudiences: string[];
    createdAt: Date;
    createdBy: {
      name: string | null;
    };
  }>` |
| `getDocumentTree` | `getDocumentTree(projectId: string, user: JwtPayload)` | `Promise<DocumentTreeNode[]>` |
| `getPublicDocumentTree` | `getPublicDocumentTree(organizationId: string, projectId: string)` | `Promise<DocumentTreeNode[]>` |
| `bulkDelete` | `bulkDelete(documentIds: string[], user: JwtPayload)` | `Promise<BulkOperationResult>` |
| `bulkMove` | `bulkMove(documentIds: string[], categoryId: string | null, user: JwtPayload)` | `Promise<BulkOperationResult>` |
| `bulkUpdateVisibility` | `bulkUpdateVisibility(documentIds: string[], isPublic: boolean, user: JwtPayload)` | `Promise<BulkOperationResult>` |
| `bulkPublish` | `bulkPublish(dto: BulkPublishDto, user: JwtPayload)` | `Promise<{ published: number; skipped: number; total: number }>` |
| `duplicate` | `duplicate(id: string, user: JwtPayload)` | `Promise<Document>` |
| `compareDocuments` | `compareDocuments(documentId: string, fromId: string, toId: string, type: 'version' | 'revision', user: JwtPayload)` | `unknown` |
| `getDocumentStats` | `getDocumentStats(documentId: string, user: JwtPayload)` | `unknown` |
| `searchDocuments` | `searchDocuments(filters: any, user: JwtPayload)` | `unknown` |
| `reorderDocuments` | `reorderDocuments(categoryId: string, documentIds: string[], user: JwtPayload)` | `Promise<void>` |
| `reorderUncategorizedDocuments` | `reorderUncategorizedDocuments(documentIds: string[], user: JwtPayload)` | `Promise<void>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `urlservice`
- DEPENDS_ON → `tocbuilderservice`
- DEPENDS_ON → `documentrevisionservice`
- DEPENDS_ON → `documentversionservice`
- DEPENDS_ON → `documentindexingservice`
- DEPENDS_ON → `outboxservice`

<!-- source: function-extractexportednamesfromdeclaration-2.md -->

# extractExportedNamesFromDeclaration

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 540)

Extract exported names from export declarations

## Signature

```ts
function extractExportedNamesFromDeclaration(path: NodePath<t.ExportNamedDeclaration | t.ExportDefaultDeclaration>): Set<string>
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath<t.ExportNamedDeclaration | t.ExportDefaultDeclaration>` |

**Returns:** `Set<string>`

<!-- source: function-getpagetypelabel.md -->

# getPageTypeLabel

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/PublishingSidebar/pageTypeLabels.ts` (line 43)

Localized display label for a document pageType.
Falls back to the raw pageType value for unknown languages/types.

## Signature

```ts
function getPageTypeLabel(pageType: string, lang: string | null): string
```

## Parameters

| Name | Type |
|---|---|
| `pageType` | `string` |
| `lang` | `string | null` |

**Returns:** `string`

<!-- source: class-gettingstartedgenerator.md -->

# GettingStartedGenerator

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-14-meta/generators/getting-started.generator.ts` (line 30)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generate` | `generate(input: MetaDocumentationInput, templates: FixedDocTemplate[], reference: MetaCategoryReference)` | `Promise<{
    documents: GeneratedDocument[];
    promptTokens: number;
    completionTokens: number;
  }>` |

<!-- source: interface-horizontalbaritem.md -->

# HorizontalBarItem

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/HorizontalBarChart.tsx` (line 5)

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `value` | `number` |
| `meta` | `string` |
| `onClick` | `() => void` |

<!-- source: type-jsxproperties.md -->

# JsxProperties

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/index.ts` (line 127)

## Definition

```ts
Record<string, string | ExpressionValue>
```

<!-- source: constant-pages-manifest-path.md -->

# PAGES_MANIFEST_PATH

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/docs-repo/sidecar.ts` (line 80)

<!-- source: interface-redisconfig.md -->

# RedisConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/config.interface.ts` (line 85)

Redis configuration

## Properties

| Property | Type |
|---|---|
| `host` | `string` |
| `port` | `number` |
| `password` | `string` |
| `db` | `number` |
| `keyPrefix` | `string` |

<!-- source: function-registerlayout.md -->

# registerLayout

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/layouts/registry.ts` (line 21)

Register a layout renderer for a section type.

## Signature

```ts
function registerLayout(sectionType: string, layoutKey: string, renderer: SectionRenderer): void
```

## Parameters

| Name | Type |
|---|---|
| `sectionType` | `string` |
| `layoutKey` | `string` |
| `renderer` | `SectionRenderer` |

**Returns:** `void`

<!-- source: function-requireresourceownership.md -->

# RequireResourceOwnership

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/auth/guards/resource-org.guard.ts` (line 77)

Declare which request param(s) must be owned by the caller's organization.

## Signature

```ts
function RequireResourceOwnership(specs: ResourceOwnershipSpec[])
```

## Parameters

| Name | Type |
|---|---|
| `specs` | `ResourceOwnershipSpec[]` |

<!-- source: controller-screenshotcontroller-2.md -->

# ScreenshotController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/screenshot/screenshot.controller.ts` (line 19)

## Relationships

- MODULE_DECLARES → `captureScreenshot`
- MODULE_DECLARES → `bulkCaptureScreenshots`
- MODULE_DECLARES → `listScreenshots`
- MODULE_DECLARES → `listJobs`
- MODULE_DECLARES → `getJob`
- MODULE_DECLARES → `getScreenshot`
- MODULE_DECLARES → `deleteScreenshot`
- DEPENDS_ON → `screenshotservice`

<!-- source: class-sessionstore.md -->

# SessionStore

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/session/session-store.ts` (line 69)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `save` | `save(snapshot: SessionSnapshot)` | `void` |
| `load` | `load(id: string)` | `SessionSnapshot | undefined` |
| `list` | `list()` | `SessionMeta[]` |
| `delete` | `delete(id: string)` | `boolean` |
| `latest` | `latest()` | `SessionMeta | undefined` |
| `getMeta` | `getMeta(id: string)` | `SessionMeta | undefined` |

<!-- source: interface-testimonialcardprops.md -->

# TestimonialCardProps

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/_shared/testimonial-card.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `quoteKey` | `string` |
| `authorNameKey` | `string` |
| `authorRoleKey` | `string` |
| `avatarSrc` | `string` |
| `rating` | `number` |

<!-- source: module-workflowmodule.md -->

# WorkflowModule

**Kind:** Module

**Source:** `atloria-monorepo/apps/api/src/workflow/workflow.module.ts` (line 14)

## Relationships

- MODULE_IMPORTS → `configmodule`
- MODULE_IMPORTS → `graphmodule`
- MODULE_IMPORTS → `aimodule`
- MODULE_PROVIDES → `workflowdiscoveryservice`
- MODULE_PROVIDES → `workflowstorageservice`
- MODULE_EXPORTS → `workflowdiscoveryservice`
- MODULE_EXPORTS → `workflowstorageservice`

<!-- source: interface-batchconfig-2.md -->

# BatchConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 125)

Batch-level configuration

## Properties

| Property | Type |
|---|---|
| `maxConcurrency` | `number` |
| `browser` | `'chromium' | 'firefox' | 'webkit'` |
| `maxRetries` | `number` |
| `retryDelayMs` | `number` |
| `screenshotTimeout` | `number` |
| `defaultViewport` | `Viewport` |
| `format` | `'png' | 'jpeg' | 'webp'` |
| `quality` | `number` |
| `checkDuplicates` | `boolean` |

<!-- source: component-changecodemirrorlanguage.md -->

# ChangeCodeMirrorLanguage

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/ChangeCodeMirrorLanguage.tsx` (line 16)

## Diagram

```mermaid
graph TD
    component_ChangeCodeMirrorLanguage_3b50f35d["ChangeCodeMirrorLanguage"]
    class component_ChangeCodeMirrorLanguage_3b50f35d rootComponent
```

## Relationships

- RENDERS → `Select`
- USES_HOOK → `useCellValues`
- USES_HOOK → `useTranslation`

<!-- source: constant-common-state-config-extensions.md -->

# COMMON_STATE_CONFIG_EXTENSIONS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/codemirror/CodeMirrorEditor.tsx` (line 19)

## Definition

```ts
Extension[]
```

<!-- source: interface-contributorstats.md -->

# ContributorStats

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/dto/document-stats.dto.ts` (line 4)

Contributor statistics

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `email` | `string` |
| `editCount` | `number` |
| `lastEditAt` | `Date` |

<!-- source: component-copybutton-2.md -->

# CopyButton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/[ticketId]/page.tsx` (line 238)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `text` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CopyButton_2b361512["CopyButton"]
    class component_CopyButton_2b361512 rootComponent
```

## Relationships

- RENDERS → `AnimatePresence`
- RENDERS → `motion-div`
- RENDERS → `ClipboardDocumentCheckIcon`
- RENDERS → `ClipboardDocumentIcon`
- USES_HOOK → `useState`

## Referenced By

- `IssueDetailPageInner` (RENDERS)

<!-- source: api-endpoint-counts.md -->

# counts

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/desk.controller.ts` (line 52)

## Endpoint

`GET /desk/:projectId/counts`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DeskController` (MODULE_DECLARES)

<!-- source: function-createrollbacktool.md -->

# createRollbackTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/rollback.tool.ts` (line 16)

## Signature

```ts
function createRollbackTool(options: RollbackToolOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `RollbackToolOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: class-createversiondto.md -->

# CreateVersionDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/create-version.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `comment` | `string` |

<!-- source: function-curry2to1.md -->

# curry2to1

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/fp.ts` (line 21)

Takes a 2 argument function and partially applies the first argument.

## Signature

```ts
function curry2to1(proc: (arg1: T, arg2: K) => R, arg1: T): (arg2: K) => R
```

## Parameters

| Name | Type |
|---|---|
| `proc` | `(arg1: T, arg2: K) => R` |
| `arg1` | `T` |

**Returns:** `(arg2: K) => R`

<!-- source: interface-discoveredinstruction.md -->

# DiscoveredInstruction

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/instruction-loader.ts` (line 61)

Discovered instruction file with its directory depth

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `relativePath` | `string` |
| `depth` | `number` |
| `content` | `string` |

<!-- source: interface-documentmetadata.md -->

# DocumentMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/storage.interface.ts` (line 108)

Document metadata for storage

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `title` | `string` |
| `slug` | `string` |
| `type` | `'user-docs' | 'tutorial' | 'feature' | 'api' | 'state-management' | 'database' | 'component' | 'security'` |
| `categoryPath` | `string[]` |
| `content` | `string` |
| `source` | `'AI' | 'manual' | 'template'` |
| `aiModel` | `string` |
| `versionLabel` | `string` |
| `metadata` | `Record<string, unknown>` |

<!-- source: service-documentversionservice.md -->

# DocumentVersionService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/document/services/document-version.service.ts` (line 16)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createVersion` | `createVersion(documentId: string, dto: CreateVersionDto, userId: string)` | `Promise<DocumentVersion>` |
| `getVersions` | `getVersions(documentId: string)` | `Promise<DocumentVersion[]>` |
| `getVersion` | `getVersion(documentId: string, versionNumber: number)` | `Promise<DocumentVersion>` |
| `updateVersionMetadata` | `updateVersionMetadata(versionId: string, dto: UpdateVersionMetadataDto)` | `Promise<DocumentVersion>` |
| `deleteVersion` | `deleteVersion(versionId: string)` | `Promise<void>` |
| `restoreFromVersion` | `restoreFromVersion(documentId: string, versionNumber: number, userId: string)` | `Promise<any>` |
| `getVersionCount` | `getVersionCount(documentId: string)` | `Promise<number>` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: function-extractforms.md -->

# extractForms

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/form-validation-extractor.ts` (line 98)

Combined entry point — merges code + template, enriching template fields with code-level rules.

## Signature

```ts
function extractForms(code: string, templateContent: string | undefined, filePath: string, componentName: string, framework: Framework): FormDefinition[]
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string` |
| `templateContent` | `string | undefined` |
| `filePath` | `string` |
| `componentName` | `string` |
| `framework` | `Framework` |

**Returns:** `FormDefinition[]`

<!-- source: function-getpositionfromindex.md -->

# getPositionFromIndex

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Editor/UserCursors.tsx` (line 148)

Convert a character index in the editor's content to screen coordinates
for drawing a remote user's cursor.

## Signature

```ts
function getPositionFromIndex(index: number, contentEditable: HTMLElement | null, overlayReference: HTMLElement | null): { x: number; y: number; height: number } | null
```

## Parameters

| Name | Type |
|---|---|
| `index` | `number` |
| `contentEditable` | `HTMLElement | null` |
| `overlayReference` | `HTMLElement | null` |

**Returns:** `{ x: number; y: number; height: number } | null`

<!-- source: class-interactionmapbuilder.md -->

# InteractionMapBuilder

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/services/interaction-map-builder.ts` (line 39)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `buildFromRepo` | `buildFromRepo(routeMappings: RouteMappingResult, repoPath: string, framework: FrameworkType)` | `InteractionMap` |
| `build` | `build(routeMappings: RouteMappingResult, files: Map<string, string>, framework: FrameworkType)` | `InteractionMap` |

<!-- source: interface-jobhistoryprops.md -->

# JobHistoryProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/DocAutomation/JobHistory.tsx` (line 27)

## Properties

| Property | Type |
|---|---|
| `jobs` | `DocumentationJobEntry[]` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `liveProgress` | `Record<string, LiveJobProgress>` |
| `projectId` | `string` |
| `onRegenerate` | `(projectId: string) => Promise<void>` |
| `onCancelJob` | `(jobId: string) => Promise<void>` |
| `onDeleteJobDocuments` | `(jobId: string) => void` |
| `onRefresh` | `() => void` |

<!-- source: type-language.md -->

# Language

**Kind:** Type

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/CodeSample.ts` (line 8)

## Definition

```ts
'curl' | 'javascript' | 'python' | 'go' | 'java'
```

<!-- source: constant-plan-enum.md -->

# PLAN_ENUM

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/billing/billing.constants.ts` (line 40)

Maps the public checkout plan key to the OrganizationPlan enum value.

## Definition

```ts
Record<BillingPlanKey, 'PRO' | 'BUSINESS'>
```

<!-- source: interface-relationdefinition.md -->

# RelationDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 697)

Relation definition between models

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `'one-to-one' | 'one-to-many' | 'many-to-one' | 'many-to-many'` |
| `targetModel` | `string` |
| `foreignKey` | `string` |
| `onDelete` | `'CASCADE' | 'SET NULL' | 'RESTRICT' | 'NO ACTION'` |
| `onUpdate` | `'CASCADE' | 'SET NULL' | 'RESTRICT' | 'NO ACTION'` |
| `relationTable` | `string` |

<!-- source: function-rendermockup.md -->

# renderMockup

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/mockups.ts` (line 149)

Render a mockup by type. Returns full HTML string with browser chrome.

## Signature

```ts
function renderMockup(type: MockupType): string
```

## Parameters

| Name | Type |
|---|---|
| `type` | `MockupType` |

**Returns:** `string`

<!-- source: function-resolvelanguage.md -->

# resolveLanguage

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/project/language.util.ts` (line 76)

Resolve a language code to its display + direction metadata. Unknown codes
degrade gracefully: name = the code itself, dir from the base's RTL set.

## Signature

```ts
function resolveLanguage(code: string | null): ResolvedLanguage
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string | null` |

**Returns:** `ResolvedLanguage`

<!-- source: controller-searchcontroller.md -->

# SearchController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/documentation/search.controller.ts` (line 19)

Search Controller

Provides search endpoints for documentation using Azure AI Search.
Includes:
- Full-text search with filtering
- Autocomplete suggestions
- Faceted search results
- Organization + project isolation

**Graceful Degradation**: When AZURE_SEARCH_ENABLED=false, returns disabled status.

`SearchController` exposes HTTP endpoints for searching the documentation corpus via Azure AI Search. It handles full-text queries with filters, autocomplete suggestions, and faceted results, while enforcing organization/project isolation boundaries. When `AZURE_SEARCH_ENABLED=false`, it gracefully degrades by returning a disabled status instead of attempting search operations.

## Diagram

```mermaid
graph LR
  Client[API Client] -->|HTTP| SC[SearchController]
  SC -->|checks| Flag[AZURE_SEARCH_ENABLED]
  Flag -->|false| Disabled[Return: search disabled status]
  Flag -->|true| Azure[Azure AI Search]
  SC -->|Full-text search + filters| Azure
  SC -->|Autocomplete suggestions| Azure
  SC -->|Facets| Azure
  SC -->|enforce isolation| Scope[Org + Project Scope]
  Scope --> SC
  Azure --> Results[Search / Suggest / Facet Results]
  Results --> Client
```

## Usage

```ts
// Example client-side usage calling the SearchController endpoints.
// (Endpoint paths may vary based on your NestJS routing configuration.)

type SearchResponse = {
  enabled: boolean;
  results?: Array<{ id: string; title: string; snippet?: string; url?: string }>;
  facets?: Record<string, Array<{ value: string; count: number }>>;
  message?: string;
};

type SuggestResponse = {
  enabled: boolean;
  suggestions?: string[];
  message?: string;
};

const API_BASE = process.env.API_BASE ?? "http://localhost:3000";

async function searchDocs(params: {
  orgId: string;
  projectId: string;
  q: string;
  filters?: Record<string, string | string[]>;
  facets?: string[];
  top?: number;
}): Promise<SearchResponse> {
  const url = new URL(`${API_BASE}/documentation/search`);
  url.searchParams.set("orgId", params.orgId);
  url.searchParams.set("projectId", params.projectId);
  url.searchParams.set("q", params.q);
  if (params.top) url.searchParams.set("top", String(params.top));
  if (params.facets?.length) url.searchParams.set("facets", params.facets.join(","));
  if (params.filters) url.searchParams.set("filters", JSON.stringify(params.filters));

  const res = await fetch(url.toString(), { method: "GET" });
  return res.json();
}

async function suggestDocs(params: {
  orgId: string;
  projectId: string;
  prefix: string;
  top?: number;
}): Promise<SuggestResponse> {
  const url = new URL(`${API_BASE}/documentation/search/suggest`);
  url.searchParams.set("orgId", params.orgId);
  url.searchParams.set("projectId", params.projectId);
  url.searchParams.set("prefix", params.prefix);
  if (params.top) url.searchParams.set("top", String(params.top));

  const res = await fetch(url.toString(), { method: "GET" });
  return res.json();
}

(async () => {
  const search = await searchDocs({
    orgId: "org_123",
    projectId: "proj_abc",
    q: "authentication",
    filters: { type: ["guide", "api"], visibility: "public" },
    facets: ["type", "tags"],
    top: 10,
  });

  if (!search.enabled) {
    console.warn("Search is disabled:", search.message);
    return;
  }

  console.log("Results:", search.results);
  console.log("Facets:", search.facets);

  const suggest = await suggestDocs({
    orgId: "org_123",
    projectId: "proj_abc",
    prefix: "auth",
    top: 5,
  });

  console.log("Suggestions:", suggest.suggestions);
})();
```

## AI Coding Instructions

- Preserve **graceful degradation**: always gate Azure calls behind `AZURE_SEARCH_ENABLED`, and return a consistent “disabled” payload when off.
- Enforce **organization + project isolation** on every endpoint (never allow cross-scope querying, even if the client passes broader filters).
- Keep request parameters **validated and normalized** (e.g., parsing JSON `filters`, limiting `top`, sanitizing facet fields) to prevent malformed queries and expensive searches.
- Maintain a stable **response shape** across search/suggest/facet endpoints so clients can handle “enabled vs disabled” without special-casing.
- When adding new filters/facets, update both the controller contract and the Azure index/query mapping together to avoid silent mismatches.

## Relationships

- MODULE_DECLARES → `search`
- MODULE_DECLARES → `getSuggestions`
- MODULE_DECLARES → `getHealth`
- DEPENDS_ON → `azuresearchservice`
- DEPENDS_ON → `configservice`

<!-- source: class-setupcache.md -->

# SetupCache

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/setup-agent.ts` (line 273)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `get` | `get(repoKey: string)` | `SetupResult | null` |
| `set` | `set(repoKey: string, result: SetupResult)` | `void` |
| `buildKey` | `buildKey(repo: string, commit: string)` | `string` |
| `clear` | `clear()` | `void` |

<!-- source: interface-trustbadge.md -->

# TrustBadge

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/component-library/sections/social-proof/social-proof-trust-badges.tsx` (line 20)

## Properties

| Property | Type |
|---|---|
| `icon` | `LucideIcon` |
| `logoSrc` | `string` |
| `nameKey` | `string` |

<!-- source: interface-batchjobresponse.md -->

# BatchJobResponse

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 196)

Response after creating a batch job

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `status` | `JobStatus` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `name` | `string` |
| `totalUrls` | `number` |
| `capturedUrls` | `number` |
| `failedUrls` | `number` |
| `progress` | `number` |
| `createdAt` | `string` |
| `updatedAt` | `string` |
| `completedAt` | `string` |
| `error` | `string` |

<!-- source: component-changediffmarkdown.md -->

# ChangeDiffMarkdown

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/diff-source.tsx` (line 37)

## Diagram

```mermaid
graph TD
    component_ChangeDiffMarkdown_4c9652d8["ChangeDiffMarkdown"]
    class component_ChangeDiffMarkdown_4c9652d8 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `UndoRedo`
- USES_HOOK → `useRef`
- USES_HOOK → `useState`

<!-- source: constant-common-state-config-extensions-2.md -->

# COMMON_STATE_CONFIG_EXTENSIONS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/diff-source/SourceEditor.tsx` (line 11)

## Definition

```ts
Extension[]
```

<!-- source: component-copyicon.md -->

# CopyIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/CodeViewer.tsx` (line 119)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_CopyIcon_15a2a7b1["CopyIcon"]
    class component_CopyIcon_15a2a7b1 rootComponent
```

## Referenced By

- `CodeViewer` (RENDERS)

<!-- source: interface-crawleddocument.md -->

# CrawledDocument

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/web-search/interfaces/search.interfaces.ts` (line 32)

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `title` | `string` |
| `content` | `string` |
| `html` | `string` |
| `markdown` | `string` |
| `metadata` | `{
    source: string;
    category: string[];
    crawledAt: Date;
    lastModified?: Date;
    author?: string;
    tags?: string[];
  }` |

<!-- source: api-endpoint-create-4.md -->

# create

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/audience/audience.controller.ts` (line 58)

## Endpoint

`POST /audiences`

## Referenced By

- `AudienceController` (MODULE_DECLARES)

<!-- source: function-createruntime.md -->

# createRuntime

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/runtime-factory.ts` (line 34)

Create an IAgentLoop from config.
This is the recommended way to create a runtime — replaces manual
`new AzureModelProvider() + new AgentRuntime()` construction.

## Signature

```ts
function createRuntime(config: RuntimeConfig): IAgentLoop
```

## Parameters

| Name | Type |
|---|---|
| `config` | `RuntimeConfig` |

**Returns:** `IAgentLoop`

<!-- source: class-crworker.md -->

# CrWorker

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/change-request/cr.worker.ts` (line 94)

CrWorker — the single, gated consumer of the 'docs-cr' queue (S2.1 branch lifecycle +
S2.3 merge writeback).

Only spins up where DOCS_REPO_WORKER==='true' (the deployment that mounts the docs-repos
PVC); api pods enqueue-only. Jobs:
 - 'cr-open'    stages the CR's proposed content on a cr/<id> branch cut from main.
 - 'cr-merge'   THE writeback: conflict-gates each file against CURRENT POSTGRES (the serving
                source of truth — NOT lagging git main), then writes the effective content
                back to Postgres through DocumentService under a per-document CAS (revisions
                created; the outbox → reconciler then projects main — that projection commit
                is the merge commit, authored by the MERGER, GitHub-style). The CR branch is
                never git-merged and is KEPT for audit.
 - 'cr-refresh' recomputes diffCache/conflictState against current main; status untouched.
 - 'cr-restage' commits a pendingResolution onto the CR branch as the RESOLVER's author.

Git-branch work runs under the same FAIL-CLOSED per-project commit lock the committer uses;
merge writeback is DB-only and deliberately does NOT hold the lock (DocumentService calls
must never sit inside a git-lock window).

INVARIANT: the repo is checked back out to `main` in a finally, even when staging throws
mid-way — the reconciler commits to whatever branch is checked out, so a repo left on a CR
branch would silently route the next DB-wins rebuild onto the proposal branch.

**Implements:** `OnModuleInit`, `OnModuleDestroy`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `void` |
| `dispatch` | `dispatch(data: DocsCrJob)` | `Promise<void>` |
| `handle` | `handle(crId: string)` | `Promise<void>` |
| `handleMerge` | `handleMerge(crId: string)` | `Promise<void>` |
| `handleRestage` | `handleRestage(crId: string)` | `Promise<void>` |
| `openChangeRequest` | `openChangeRequest(crId: string)` | `Promise<void>` |
| `mergeChangeRequest` | `mergeChangeRequest(crId: string)` | `Promise<void>` |
| `refreshChangeRequest` | `refreshChangeRequest(crId: string)` | `Promise<void>` |
| `restageResolution` | `restageResolution(crId: string)` | `Promise<void>` |
| `onModuleDestroy` | `onModuleDestroy()` | `Promise<void>` |

<!-- source: function-describechunkrelationships.md -->

# describeChunkRelationships

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-02-chunking/chunk-relationship-graph.ts` (line 378)

Get a description of how chunks relate for documentation

## Signature

```ts
function describeChunkRelationships(graph: ChunkRelationshipGraph, chunkId: string): string
```

## Parameters

| Name | Type |
|---|---|
| `graph` | `ChunkRelationshipGraph` |
| `chunkId` | `string` |

**Returns:** `string`

<!-- source: interface-discoveryoptions.md -->

# DiscoveryOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/instruction-loader.ts` (line 51)

## Properties

| Property | Type |
|---|---|
| `filename` | `string` |
| `maxDepth` | `number` |
| `excludeDirs` | `string[]` |

<!-- source: interface-documentsaveresult.md -->

# DocumentSaveResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/storage.interface.ts` (line 164)

Document save result

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `url` | `string` |
| `filePath` | `string` |
| `categoryId` | `string` |
| `version` | `number` |

<!-- source: service-docversionexportservice.md -->

# DocVersionExportService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/doc-version/export.service.ts` (line 13)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `exportMarkdown` | `exportMarkdown(versionId: string)` | `unknown` |
| `exportStaticSite` | `exportStaticSite(versionId: string)` | `unknown` |
| `exportPDFContent` | `exportPDFContent(versionId: string)` | `unknown` |
| `exportPDFBuffer` | `exportPDFBuffer(versionId: string)` | `Promise<{ buffer: Buffer; filename: string }>` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: function-extractformsfromcode.md -->

# extractFormsFromCode

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/form-validation-extractor.ts` (line 66)

Extract forms from TypeScript/JavaScript code (FormGroup, Yup, RHF, Vuelidate).

## Signature

```ts
function extractFormsFromCode(code: string, filePath: string, componentName: string): FormDefinition[]
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string` |
| `filePath` | `string` |
| `componentName` | `string` |

**Returns:** `FormDefinition[]`

<!-- source: function-getreportersessionid.md -->

# getReporterSessionId

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/reporterSession.ts` (line 24)

## Signature

```ts
function getReporterSessionId(): string
```

**Returns:** `string`

<!-- source: class-interceptormanager.md -->

# InterceptorManager

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/utils/interceptors.ts` (line 12)

Manager for request/response interceptors

## Methods

| Method | Signature | Returns |
|---|---|---|
| `addRequestInterceptor` | `addRequestInterceptor(interceptor: RequestInterceptor)` | `() => void` |
| `addResponseInterceptor` | `addResponseInterceptor(interceptor: ResponseInterceptor)` | `() => void` |
| `addErrorInterceptor` | `addErrorInterceptor(interceptor: ErrorInterceptor)` | `() => void` |
| `executeRequestInterceptors` | `executeRequestInterceptors(config: RequestConfig)` | `Promise<RequestConfig>` |
| `executeResponseInterceptors` | `executeResponseInterceptors(response: APIResponse<T>)` | `Promise<APIResponse<T>>` |
| `executeErrorInterceptors` | `executeErrorInterceptors(error: Error)` | `Promise<Error>` |
| `clear` | `clear()` | `void` |

<!-- source: interface-jobresult.md -->

# JobResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationGenerator.ts` (line 34)

Job completion result

## Properties

| Property | Type |
|---|---|
| `documentsCreated` | `number` |
| `documentsUpdated` | `number` |
| `screenshotsCaptured` | `number` |
| `categoriesCreated` | `number` |
| `durationMs` | `number` |
| `publishedUrl` | `string` |
| `versionId` | `string` |
| `flaggedCount` | `number` |
| `carriedCount` | `number` |

<!-- source: type-lexicalvisitor.md -->

# LexicalVisitor

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/exportMarkdownFromLexical.ts` (line 96)

A generic visitor that can be used to process any lexical node.

## Definition

```ts
LexicalExportVisitor<LexicalNode, Mdast.RootContent>
```

<!-- source: constant-plan-monthly-credits.md -->

# PLAN_MONTHLY_CREDITS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/billing/billing.constants.ts` (line 25)

## Definition

```ts
Record<'FREE' | 'PRO' | 'BUSINESS', number>
```

<!-- source: interface-relationship.md -->

# Relationship

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/relationship.interface.ts` (line 187)

Relationship between two entities

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `type` | `RelationshipType` |
| `sourceId` | `string` |
| `targetId` | `string` |
| `metadata` | `RelationshipMetadata` |

<!-- source: function-renderscreenshotframe.md -->

# renderScreenshotFrame

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/mockups.ts` (line 171)

Render a browser chrome frame wrapping a screenshot <img>.

## Signature

```ts
function renderScreenshotFrame(url: string, alt: string): string
```

## Parameters

| Name | Type |
|---|---|
| `url` | `string` |
| `alt` | `string` |

**Returns:** `string`

<!-- source: function-roles.md -->

# Roles

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/auth/decorators/roles.decorator.ts` (line 6)

## Signature

```ts
function Roles(roles: UserRole[])
```

## Parameters

| Name | Type |
|---|---|
| `roles` | `UserRole[]` |

<!-- source: class-sourcetruncationprocessor.md -->

# SourceTruncationProcessor

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/context/history-processors.ts` (line 95)

Hard character limit per tool output observation.
Prevents any single tool from injecting massive payloads into context.

Applied first in the pipeline so downstream processors work with
bounded-size items.

**Implements:** `HistoryProcessor`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `process` | `process(items: AgentInputItem[])` | `AgentInputItem[]` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |

<!-- source: controller-suggestionaliascontroller.md -->

# SuggestionAliasController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.controller.ts` (line 90)

Flat alias routes (/suggestions/...) for clients keyed by suggestionId
alone — the web app's api-client adapter (apps/web/src/lib/api-client.ts)
and the

## Relationships

- MODULE_DECLARES → `list`
- MODULE_DECLARES → `create`
- MODULE_DECLARES → `accept`
- MODULE_DECLARES → `reject`
- MODULE_DECLARES → `delete`
- MODULE_DECLARES → `getById`
- DEPENDS_ON → `suggestionservice`

<!-- source: interface-validationresult.md -->

# ValidationResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/site-gen-core/src/assembler/validate.ts` (line 17)

## Properties

| Property | Type |
|---|---|
| `valid` | `boolean` |
| `errors` | `AssemblyError[]` |
| `warnings` | `string[]` |
| `manifest` | `Manifest` |
| `resolvedSections` | `ManifestSection[]` |

<!-- source: interface-batchresult.md -->

# BatchResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/batched-screenshot-processor.ts` (line 47)

## Properties

| Property | Type |
|---|---|
| `batchIndex` | `number` |
| `totalBatches` | `number` |
| `captured` | `number` |
| `failed` | `number` |
| `replaced` | `number` |
| `documentsUpdated` | `string[]` |

<!-- source: component-code-3.md -->

# Code

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 53)

## Diagram

```mermaid
graph TD
    component_Code_ff037["Code"]
    class component_Code_ff037 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useRef`

<!-- source: constant-composerchildren.md -->

# composerChildren$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 731)

<!-- source: component-counter.md -->

# Counter

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/page.tsx` (line 71)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `to` | `number` | ✓ | - |
| `suffix` | `string` | ✓ | - |
| `display` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_Counter_81da20e["Counter"]
    class component_Counter_81da20e rootComponent
```

## Relationships

- USES_HOOK → `useRef`
- USES_HOOK → `useInView`
- USES_HOOK → `useEffect`

## Referenced By

- `HomePage` (RENDERS)

<!-- source: interface-crawledpage.md -->

# CrawledPage

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/web-crawler.service.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `title` | `string` |
| `content` | `string` |
| `html` | `string` |
| `textLength` | `number` |
| `crawledAt` | `Date` |

<!-- source: api-endpoint-create-5.md -->

# create

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 38)

## Endpoint

`POST /projects/:projectId/boards`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: function-createsemanticsearchtool.md -->

# createSemanticSearchTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/semantic-search.tool.ts` (line 42)

## Signature

```ts
function createSemanticSearchTool(options: SemanticSearchToolOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `SemanticSearchToolOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: class-deskduplicatedto.md -->

# DeskDuplicateDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/issues/dto/desk.dto.ts` (line 66)

## Properties

| Property | Type |
|---|---|
| `intoTicketNumber` | `number` |

<!-- source: interface-diskbackendconfig.md -->

# DiskBackendConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/checkpoint-backend.ts` (line 173)

## Properties

| Property | Type |
|---|---|
| `sessionId` | `string` |
| `storageDir` | `string` |
| `retention` | `Partial<RetentionPolicy>` |
| `pruneOnInit` | `boolean` |

<!-- source: function-dispatchevent.md -->

# dispatchEvent

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-core/src/test-helpers.ts` (line 32)

Helper to dispatch a custom event on an element

## Signature

```ts
function dispatchEvent(element: HTMLElement, eventName: string, detail: unknown): boolean
```

## Parameters

| Name | Type |
|---|---|
| `element` | `HTMLElement` |
| `eventName` | `string` |
| `detail` | `unknown` |

**Returns:** `boolean`

<!-- source: service-docversionretentionservice.md -->

# DocVersionRetentionService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/doc-version/retention.service.ts` (line 11)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `unknown` |
| `onModuleDestroy` | `onModuleDestroy()` | `unknown` |
| `enforceAll` | `enforceAll()` | `unknown` |
| `enforcePolicy` | `enforcePolicy(projectId: string, policy: RetentionPolicy)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `auditservice`

<!-- source: interface-endpointinput.md -->

# EndpointInput

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/schema-resolver.ts` (line 172)

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `controller` | `string` |
| `methodName` | `string` |
| `httpMethod` | `string` |
| `path` | `string` |

<!-- source: function-extractformsfromtemplate.md -->

# extractFormsFromTemplate

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/form-validation-extractor.ts` (line 76)

Extract forms from template HTML (inputs, DevExtreme widgets, validation attributes).

## Signature

```ts
function extractFormsFromTemplate(templateContent: string, filePath: string, componentName: string, framework: Framework): FormDefinition[]
```

## Parameters

| Name | Type |
|---|---|
| `templateContent` | `string` |
| `filePath` | `string` |
| `componentName` | `string` |
| `framework` | `Framework` |

**Returns:** `FormDefinition[]`

<!-- source: function-getselectionrects.md -->

# getSelectionRects

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Editor/UserCursors.tsx` (line 231)

Utility function to get selection rectangles for highlighting

## Signature

```ts
function getSelectionRects(anchor: number, head: number, container: HTMLElement | null): DOMRect[]
```

## Parameters

| Name | Type |
|---|---|
| `anchor` | `number` |
| `head` | `number` |
| `container` | `HTMLElement | null` |

**Returns:** `DOMRect[]`

<!-- source: class-iterativedeeploader.md -->

# IterativeDeepLoader

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-04-analysis/iterative-deep-loader.ts` (line 39)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `executeWithDeepLoading` | `executeWithDeepLoading(initialPrompt: string, chunk: Chunk, options: {
      maxTokens?: number;
      temperature?: number;
      systemPrompt?: string;
    })` | `Promise<DeepLoaderResult>` |

<!-- source: interface-kgentity.md -->

# KGEntity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useKnowledgeGraph.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `type` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `startLine` | `number` |
| `endLine` | `number` |
| `framework` | `string` |
| `metadata` | `Record<string, unknown>` |

<!-- source: type-loglevel.md -->

# LogLevel

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/logger.ts` (line 8)

Pipeline Logger

Structured logging for the documentation automation pipeline.
Supports different log levels and can output to console or external services.

## Definition

```ts
'debug' | 'info' | 'warn' | 'error'
```

<!-- source: constant-plan-price-env.md -->

# PLAN_PRICE_ENV

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/billing/billing.constants.ts` (line 34)

Maps the public checkout plan key to env var holding the Stripe price id.

## Definition

```ts
Record<BillingPlanKey, string>
```

<!-- source: interface-relationshipmetadata.md -->

# RelationshipMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/relationship.interface.ts` (line 218)

Metadata for relationships

## Properties

| Property | Type |
|---|---|
| `props` | `string[]` |
| `httpMethod` | `string` |
| `importType` | `'named' | 'default' | 'namespace' | 'side-effect'` |
| `foreignKey` | `string` |
| `line` | `number` |
| `optional` | `boolean` |
| `lazy` | `boolean` |
| `cascade` | `string[]` |

<!-- source: function-resolvetheme.md -->

# resolveTheme

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/theme.ts` (line 106)

Merge user config with preset. If primaryColor is provided, override accent vars.

## Signature

```ts
function resolveTheme(config: ThemeConfig): ResolvedTheme
```

## Parameters

| Name | Type |
|---|---|
| `config` | `ThemeConfig` |

**Returns:** `ResolvedTheme`

<!-- source: function-sanitizeforjsonb.md -->

# sanitizeForJsonb

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/sanitize-jsonb.ts` (line 10)

Deep-sanitize a value before persisting it into a Postgres `jsonb` column.

Postgres `jsonb` cannot store the NUL character (U+0000) and chokes on other C0 control
characters. These leak in from parsed source (minified bundles, generated/binary-ish files)
and, at monorepo scale, a single bad byte deep in a multi-megabyte snapshot fails the whole
upsert with `unexpected end of hex escape`. Strip them (and lone UTF-16 surrogates, which are
not valid text) so the snapshot always persists. Tab / newline / carriage-return are kept.

## Signature

```ts
function sanitizeForJsonb(value: T): T
```

## Parameters

| Name | Type |
|---|---|
| `value` | `T` |

**Returns:** `T`

<!-- source: controller-suggestioncontroller.md -->

# SuggestionController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.controller.ts` (line 19)

SECURITY (cross-tenant): guarding :documentId alone is insufficient — a caller could pair their
OWN :documentId with a FOREIGN suggestion :id (the service acts on the suggestion by id, and
`accept` APPLIES the suggested text to the document). Suggestion-keyed routes declare BOTH.

## Relationships

- MODULE_DECLARES → `create`
- MODULE_DECLARES → `list`
- MODULE_DECLARES → `accept`
- MODULE_DECLARES → `reject`
- MODULE_DECLARES → `delete`
- MODULE_DECLARES → `getById`
- DEPENDS_ON → `suggestionservice`

<!-- source: class-swebenchadapter.md -->

# SWEBenchAdapter

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/swebench-adapter.ts` (line 61)

**Implements:** `BenchmarkAdapter`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `loadTasks` | `loadTasks(config: BenchmarkRunConfig)` | `Promise<BenchmarkTask[]>` |
| `setupTask` | `setupTask(task: BenchmarkTask, workDir: string)` | `Promise<void>` |
| `buildPrompt` | `buildPrompt(task: BenchmarkTask)` | `string` |
| `evaluate` | `evaluate(task: BenchmarkTask, workDir: string)` | `Promise<{ passed: boolean; details: string }>` |
| `cleanup` | `cleanup(_task: BenchmarkTask, workDir: string)` | `Promise<void>` |

<!-- source: interface-batchstatusresponse.md -->

# BatchStatusResponse

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 251)

Full batch status response

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `status` | `JobStatus` |
| `progress` | `number` |
| `totalUrls` | `number` |
| `capturedUrls` | `number` |
| `failedUrls` | `number` |
| `currentItem` | `string` |
| `currentStage` | `string` |
| `stageProgress` | `number` |
| `screenshots` | `ScreenshotResult[]` |
| `failures` | `ScreenshotFailure[]` |
| `error` | `string` |
| `timestamps` | `{
    createdAt: string;
    updatedAt: string;
    startedAt?: string;
    completedAt?: string;
  }` |
| `estimatedCompletion` | `string` |
| `stats` | `{
    averageCaptureTimeMs: number;
    successRate: number;
    retryCount: number;
  }` |

<!-- source: component-codeblock.md -->

# CodeBlock

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 304)

## Diagram

```mermaid
graph TD
    component_CodeBlock_61ea916a["CodeBlock"]
    class component_CodeBlock_61ea916a rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: constant-confidence-levels.md -->

# CONFIDENCE_LEVELS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 32)

Confidence levels

<!-- source: component-countup.md -->

# CountUp

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/scenes/SceneGeneration.tsx` (line 73)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `target` | `number` | ✓ | - |
| `duration` | `number` | - | 1000 |

## Diagram

```mermaid
graph TD
    component_CountUp_3f93da91["CountUp"]
    class component_CountUp_3f93da91 rootComponent
```

## Relationships

- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

## Referenced By

- `SceneGeneration` (RENDERS)

<!-- source: interface-crcommittedfile.md -->

# CrCommittedFile

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.service.ts` (line 15)

files once the branch is committed: content lives in git; the row keeps the path mapping.

## Properties

| Property | Type |
|---|---|
| `path` | `string` |
| `documentId` | `string` |

<!-- source: api-endpoint-create-6.md -->

# create

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/capture/capture.controller.ts` (line 36)

## Endpoint

`POST /capture/:projectId/flows`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `CaptureController` (MODULE_DECLARES)

<!-- source: function-createsendmessagetool.md -->

# createSendMessageTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/send-message.tool.ts` (line 63)

## Signature

```ts
function createSendMessageTool(options: SendMessageOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `SendMessageOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: class-deskreplydto.md -->

# DeskReplyDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/issues/dto/desk.dto.ts` (line 49)

## Properties

| Property | Type |
|---|---|
| `body` | `string` |
| `internal` | `boolean` |
| `andDone` | `boolean` |

<!-- source: service-docversionservice.md -->

# DocVersionService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.service.ts` (line 49)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getNextVersionNumber` | `getNextVersionNumber(projectId: string)` | `Promise<number>` |
| `create` | `create(projectId: string, organizationId: string, createdById: string, opts: {
      label?: string;
      description?: string;
      commitHash?: string;
      branch?: string;
      gitTag?: string;
      previousVersionId?: string;
      jobId?: string;
      /** Doc set this version belongs to: 'user' (default) or 'technical'. */
      audienceScope?: string;
    })` | `unknown` |
| `listByProject` | `listByProject(projectId: string, opts: {
      status?: DocVersionStatus[];
      limit?: number;
      offset?: number;
    })` | `unknown` |
| `getById` | `getById(id: string)` | `unknown` |
| `getActiveVersion` | `getActiveVersion(projectId: string, audienceScope: unknown)` | `unknown` |
| `getPublishedVersions` | `getPublishedVersions(projectId: string)` | `unknown` |
| `activate` | `activate(id: string)` | `unknown` |
| `publish` | `publish(id: string)` | `unknown` |
| `archive` | `archive(id: string)` | `unknown` |
| `deprecate` | `deprecate(id: string)` | `unknown` |
| `update` | `update(id: string, dto: { label?: string; description?: string })` | `unknown` |
| `delete` | `delete(id: string)` | `unknown` |
| `setGenerationSummary` | `setGenerationSummary(id: string, summary: Record<string, any>)` | `unknown` |
| `getReviewData` | `getReviewData(versionId: string)` | `unknown` |
| `recordFlagResolution` | `recordFlagResolution(versionId: string, previousDocId: string)` | `Promise<void>` |
| `getScreenshotInventory` | `getScreenshotInventory(versionId: string)` | `unknown` |
| `removeScreenshotPlaceholders` | `removeScreenshotPlaceholders(versionId: string, routePaths: string[])` | `unknown` |
| `previewScreenshot` | `previewScreenshot(url: string)` | `unknown` |
| `captureScreenshot` | `captureScreenshot(projectId: string, versionId: string, routePath: string, documentId: string, userTargetUrl: string)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `auditservice`
- DEPENDS_ON → `moduleref`
- DEPENDS_ON → `versionindexevictor`

<!-- source: interface-editedfile.md -->

# EditedFile

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/self-review.ts` (line 26)

## Properties

| Property | Type |
|---|---|
| `path` | `string` |
| `before` | `string` |
| `after` | `string` |

<!-- source: interface-enhanceddocumentation.md -->

# EnhancedDocumentation

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/competitor.interface.ts` (line 31)

## Properties

| Property | Type |
|---|---|
| `original` | `string` |
| `enhanced` | `string` |
| `competitorSources` | `CompetitorInfo[]` |
| `enhancementNotes` | `string[]` |

<!-- source: function-ensureuniqueslug.md -->

# ensureUniqueSlug

**Kind:** Function

**Source:** `atloria-monorepo/packages/core/src/utils/slug.ts` (line 27)

Ensure a slug is unique by appending a number if needed

## Signature

```ts
function ensureUniqueSlug(slug: string, existingSlugs: string[]): string
```

## Parameters

| Name | Type |
|---|---|
| `slug` | `string` |
| `existingSlugs` | `string[]` |

**Returns:** `string`

<!-- source: function-extracthooksfrompath-2.md -->

# extractHooksFromPath

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 419)

Extract hooks used within a function path

## Signature

```ts
function extractHooksFromPath(path: NodePath): HookInfo[]
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath` |

**Returns:** `HookInfo[]`

<!-- source: function-gettotalpendingcount.md -->

# getTotalPendingCount

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useOfflineSync.ts` (line 366)

Get total count of pending updates across all documents

## Signature

```ts
function getTotalPendingCount(): number
```

**Returns:** `number`

<!-- source: interface-kgrelationship.md -->

# KGRelationship

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useKnowledgeGraph.ts` (line 17)

## Properties

| Property | Type |
|---|---|
| `sourceId` | `string` |
| `targetId` | `string` |
| `type` | `string` |
| `metadata` | `Record<string, unknown>` |

<!-- source: class-knowledgeclassifier.md -->

# KnowledgeClassifier

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/knowledge-classifier.ts` (line 98)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `classify` | `classify(doc: GeneratedDocument, meta: DocClassificationMeta)` | `KnowledgeEntry[]` |

<!-- source: type-mappingsource.md -->

# MappingSource

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/screenshot-spec.types.ts` (line 16)

Where this mapping came from

## Definition

```ts
'interaction-map' | 'site-map' | 'ai-fallback'
```

<!-- source: constant-productrequirementstemplate.md -->

# productRequirementsTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/product-requirements.template.ts` (line 3)

<!-- source: interface-relationshipwithentities.md -->

# RelationshipWithEntities

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/relationship.interface.ts` (line 268)

Relationship with full entity information (for graph queries)

## Properties

| Property | Type |
|---|---|
| `relationship` | `Relationship` |
| `source` | `TSource` |
| `target` | `TTarget` |

<!-- source: function-searchdocs.md -->

# searchDocs

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/web-search/data/competitor-docs-index.ts` (line 386)

Search docs by keywords

## Signature

```ts
function searchDocs(keywords: string[]): CompetitorDoc[]
```

## Parameters

| Name | Type |
|---|---|
| `keywords` | `string[]` |

**Returns:** `CompetitorDoc[]`

<!-- source: controller-supportagentcontroller.md -->

# SupportAgentController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.controller.ts` (line 30)

## Relationships

- MODULE_DECLARES → `getConfig`
- MODULE_DECLARES → `upsertConfig`
- MODULE_DECLARES → `search`
- MODULE_DECLARES → `listAgents`
- MODULE_DECLARES → `createAgent`
- MODULE_DECLARES → `getAgent`
- MODULE_DECLARES → `updateAgent`
- MODULE_DECLARES → `deleteAgent`
- MODULE_DECLARES → `chat`
- MODULE_DECLARES → `getChatHistory`
- MODULE_DECLARES → `clearChatHistory`
- MODULE_DECLARES → `chatStream`
- DEPENDS_ON → `supportagentservice`

<!-- source: class-testwatcher.md -->

# TestWatcher

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/test-watcher.ts` (line 44)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onFileEdited` | `onFileEdited(toolName: string)` | `void` |
| `dispose` | `dispose()` | `void` |
| `getLastResult` | `getLastResult()` | `TestRunResult | null` |
| `isRunning` | `isRunning()` | `boolean` |

<!-- source: function-validatecontentsafety.md -->

# validateContentSafety

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/guardrails/content-safety.guardrail.ts` (line 54)

## Signature

```ts
function validateContentSafety(content: string, config: ContentSafetyConfig): GuardrailResult
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |
| `config` | `ContentSafetyConfig` |

**Returns:** `GuardrailResult`

<!-- source: interface-blockdefinitionnode.md -->

# BlockDefinitionNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 62)

Block definition node
Represents reusable content blocks

## Properties

| Property | Type |
|---|---|
| `type` | `'block_definition'` |
| `blockId` | `string` |
| `content` | `ASTNode[]` |

<!-- source: component-codeblock-2.md -->

# CodeBlock

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/mermaid.tsx` (line 60)

## Diagram

```mermaid
graph TD
    component_CodeBlock_599aa7ba["CodeBlock"]
    class component_CodeBlock_599aa7ba rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: constant-consistency-rules.md -->

# CONSISTENCY_RULES

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-11.types.ts` (line 125)

Consistency Check Rules

<!-- source: interface-crconflictfile.md -->

# CrConflictFile

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.service.ts` (line 37)

One file's conflict report inside conflictState: the 'conflict' sections verbatim plus
counts of how the OTHER sections classified (so the UI can say "2 of 7 sections conflict").

## Properties

| Property | Type |
|---|---|
| `path` | `string` |
| `documentId` | `string` |
| `sections` | `ThreeWaySection[]` |
| `counts` | `{ unchanged: number; 'take-theirs': number; 'keep-mine': number; conflict: number }` |

<!-- source: api-endpoint-create-7.md -->

# create

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/comment/comment.controller.ts` (line 51)

Create a new comment on a document

## Endpoint

`POST /documents/:documentId/comments`

| Parameter | In | Type | Required |
|---|---|---|---|
| `documentId` | query | `string` | ✓ |

## Referenced By

- `CommentController` (MODULE_DECLARES)

<!-- source: function-createspawnagenttool.md -->

# createSpawnAgentTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/spawn-agent.tool.ts` (line 116)

## Signature

```ts
function createSpawnAgentTool(options: SpawnAgentOptions<TContext>): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `SpawnAgentOptions<TContext>` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: component-csatcard.md -->

# CsatCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/issues/[ticketNumber]/page.tsx` (line 1086)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `slugId` | `string` | ✓ | - |
| `ticketNumber` | `number` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CsatCard_2c4de42["CsatCard"]
    class component_CsatCard_2c4de42 rootComponent
```

## Relationships

- USES_HOOK → `useState`

## Referenced By

- `PublicTicketPage` (RENDERS)

<!-- source: class-desktransitiondto.md -->

# DeskTransitionDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/issues/dto/desk.dto.ts` (line 39)

## Properties

| Property | Type |
|---|---|
| `action` | `DeskTransition` |
| `snoozedUntil` | `string` |

<!-- source: service-domaindnsservice.md -->

# DomainDnsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/project/domain-dns.service.ts` (line 68)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `recordSpecs` | `recordSpecs(domain: string, token: string, cnameTarget: string)` | `DnsRecordSpec[]` |
| `check` | `check(domain: string, token: string, cnameTarget: string, clusterIp: string)` | `Promise<DomainDnsResult>` |

<!-- source: interface-editfileoptions.md -->

# EditFileOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/edit-file.tool.ts` (line 17)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `maxFileSize` | `number` |
| `editFormat` | `'search_replace' | 'unified_diff'` |
| `checkpointManager` | `CheckpointManager` |
| `lintCommand` | `string` |

<!-- source: interface-enhancedscreenshotmetadata.md -->

# EnhancedScreenshotMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/screenshot.interface.ts` (line 17)

Enhanced screenshot metadata with state machine context

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `title` | `string` |
| `component` | `string` |
| `componentPath` | `string` |
| `stateMachines` | `string[]` |
| `stateMachineDetails` | `StateMachine[]` |
| `currentState` | `string` |
| `availableTransitions` | `string[]` |
| `modalTriggers` | `string[]` |
| `interactions` | `UIInteraction[]` |
| `approvalStates` | `string[]` |
| `terminalStates` | `string[]` |
| `metadata` | `{
    /**
     * Timestamp when screenshot was captured
     */
    capturedAt?: Date;

    /**
     * Viewport size used
     */
    viewport?: {
      width: number;
      height: number;
    };

    /**
     * Whether this is a modal screenshot
     */
    isModal?: boolean;

    /**
     * Parent page URL if this is a modal
     */
    parentUrl?: string;
  }` |

<!-- source: function-exportlexicaltreetomdast.md -->

# exportLexicalTreeToMdast

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/exportMarkdownFromLexical.ts` (line 113)

## Signature

```ts
function exportLexicalTreeToMdast({
  root,
  visitors,
  jsxComponentDescriptors,
  jsxIsAvailable,
  addImportStatements = true
}: ExportLexicalTreeOptions): Mdast.Root
```

## Parameters

| Name | Type |
|---|---|
| `{
  root,
  visitors,
  jsxComponentDescriptors,
  jsxIsAvailable,
  addImportStatements = true
}` | `ExportLexicalTreeOptions` |

**Returns:** `Mdast.Root`

<!-- source: function-extractimportsfromdeclaration-2.md -->

# extractImportsFromDeclaration

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 111)

Extract imports from an ImportDeclaration node

## Signature

```ts
function extractImportsFromDeclaration(path: NodePath<t.ImportDeclaration>): ImportInfo[]
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath<t.ImportDeclaration>` |

**Returns:** `ImportInfo[]`

<!-- source: function-getusercolor.md -->

# getUserColor

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/user-colors.ts` (line 83)

Get a consistent color for a user with memoization
This is more efficient when the same userId is requested multiple times

## Signature

```ts
function getUserColor(userId: string): string
```

## Parameters

| Name | Type |
|---|---|
| `userId` | `string` |

**Returns:** `string`

<!-- source: class-knowledgecollector.md -->

# KnowledgeCollector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/knowledge-collector.ts` (line 50)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `collect` | `collect(doc: GeneratedDocument, meta: DocClassificationMeta)` | `void` |
| `getReference` | `getReference(category: MetaKnowledgeCategory)` | `MetaCategoryReference` |
| `getAllReferences` | `getAllReferences()` | `KnowledgeReferenceStore` |
| `finalize` | `finalize()` | `KnowledgeReferenceStore` |
| `getStats` | `getStats()` | `{
    totalDocsProcessed: number;
    totalDocsClassified: number;
    classificationFailures: number;
  }` |

<!-- source: interface-knowledgegraphdata.md -->

# KnowledgeGraphData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useKnowledgeGraph.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `entities` | `KGEntity[]` |
| `relationships` | `KGRelationship[]` |

<!-- source: type-mdastextension.md -->

# MdastExtension

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/importMarkdownToLexical.ts` (line 150)

An extension for the `fromMarkdown` utility tree construction.

## Definition

```ts
NonNullable<MdastExtensions>[number]
```

<!-- source: constant-projectreadmetemplate.md -->

# projectReadmeTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/project-readme.template.ts` (line 3)

<!-- source: interface-responsedefinition.md -->

# ResponseDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 553)

Response definition

## Properties

| Property | Type |
|---|---|
| `statusCode` | `number` |
| `description` | `string` |
| `schema` | `SchemaDefinition` |
| `examples` | `Record<string, unknown>` |

<!-- source: function-seedtemplates.md -->

# seedTemplates

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/template/seeds/seed-templates.ts` (line 93)

Seeds all document templates into the database.

This function creates or updates all predefined templates.
Templates are marked as public and system-created.

## Signature

```ts
async function seedTemplates(prisma: PrismaClient, systemUserId: string): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `prisma` | `PrismaClient` |
| `systemUserId` | `string` |

**Returns:** `Promise<void>`

<!-- source: controller-synccontroller.md -->

# SyncController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/project/sync.controller.ts` (line 27)

## Relationships

- MODULE_DECLARES → `syncDocuments`
- MODULE_DECLARES → `reindexDocuments`
- MODULE_DECLARES → `startFullSync`
- MODULE_DECLARES → `getJobStatus`
- MODULE_DECLARES → `getOrganizationJobs`
- MODULE_DECLARES → `cancelJob`
- MODULE_DECLARES → `syncEntities`
- MODULE_DECLARES → `syncRelationships`
- DEPENDS_ON → `syncservice`
- DEPENDS_ON → `documentindexingservice`
- DEPENDS_ON → `syncjobservice`
- DEPENDS_ON → `kgsyncservice`
- DEPENDS_ON → `workflowdiscoveryservice`
- DEPENDS_ON → `workflowstorageservice`
- DEPENDS_ON → `businesscontextparserservice`
- DEPENDS_ON → `prismaservice`

<!-- source: class-todomanager.md -->

# TodoManager

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/context/todo-manager.ts` (line 19)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `add` | `add(description: string)` | `TodoItem` |
| `addBatch` | `addBatch(descriptions: string[])` | `TodoItem[]` |
| `start` | `start(id: string)` | `void` |
| `complete` | `complete(id: string, result: string)` | `void` |
| `skip` | `skip(id: string, reason: string)` | `void` |
| `getAll` | `getAll()` | `ReadonlyArray<TodoItem>` |
| `getPending` | `getPending()` | `TodoItem[]` |
| `getCurrent` | `getCurrent()` | `TodoItem | undefined` |
| `getStats` | `getStats()` | `{ total: number; completed: number; pending: number; inProgress: number; skipped: number }` |
| `toContextString` | `toContextString()` | `string` |
| `serialize` | `serialize()` | `string` |
| `deserialize` | `deserialize(json: string)` | `TodoManager` |

<!-- source: function-validatehtml.md -->

# validateHtml

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/tools/validate-html.tool.ts` (line 43)

## Signature

```ts
function validateHtml(html: string): HtmlValidationResult
```

## Parameters

| Name | Type |
|---|---|
| `html` | `string` |

**Returns:** `HtmlValidationResult`

<!-- source: interface-blockregistry.md -->

# BlockRegistry

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 179)

Block registry for storing reusable blocks

## Properties

| Property | Type |
|---|---|
| `blocks` | `Map<string, BlockDefinitionNode>` |

<!-- source: component-codeblockeditorcontainer.md -->

# CodeBlockEditorContainer

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/CodeBlockNode.tsx` (line 236)

## Diagram

```mermaid
graph TD
    component_CodeBlockEditorContainer_1a92dbc9["CodeBlockEditorContainer"]
    class component_CodeBlockEditorContainer_1a92dbc9 rootComponent
```

## Relationships

- RENDERS → `CodeBlockEditorContextProvider`
- RENDERS → `Editor`
- USES_HOOK → `useCellValue`

<!-- source: constant-contenteditableclassname.md -->

# contentEditableClassName$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 135)

Holds the CSS class name of the content editable element.

<!-- source: interface-crconflictstate.md -->

# CrConflictState

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.service.ts` (line 44)

## Properties

| Property | Type |
|---|---|
| `files` | `CrConflictFile[]` |
| `detectedAt` | `string` |

<!-- source: api-endpoint-create-8.md -->

# create

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 146)

## Endpoint

`POST /doc-versions/:projectId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: function-createtestgate.md -->

# createTestGate

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/test-watcher.ts` (line 227)

Creates a QualityGate array that checks whether tests pass.
If a TestWatcher is provided, uses its last result to avoid re-running.
If a LintTestLoop is provided, uses its state to check verification recency.

## Signature

```ts
function createTestGate(config: TestGateConfig, lintTestLoop: LintTestLoop, testWatcher: TestWatcher): QualityGate[]
```

## Parameters

| Name | Type |
|---|---|
| `config` | `TestGateConfig` |
| `lintTestLoop` | `LintTestLoop` |
| `testWatcher` | `TestWatcher` |

**Returns:** `QualityGate[]`

<!-- source: component-curatebuttons.md -->

# CurateButtons

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/EntityTree.tsx` (line 64)

Hover pin/hide controls on a tree row — stops the row's navigation.

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `entityId` | `string` | ✓ | - |
| `pinned` | `boolean` | ✓ | - |
| `onCurate` | `NonNullable` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CurateButtons_7d67d75d["CurateButtons"]
    class component_CurateButtons_7d67d75d rootComponent
```

## Referenced By

- `AppSection` (RENDERS)

<!-- source: class-docsprtrigger.md -->

# DocsPrTrigger

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr-trigger.ts` (line 11)

A dependency-free hop that lets the webhook request a docs-PR check WITHOUT importing
DocsPrModule — which would create a module cycle (WebhookModule -> DocsPrModule ->
GithubAppModule -> forwardRef(WebhookModule)).

DocsPrService registers the real handler on init. If the feature module isn't loaded,
`requestCheck` is a silent no-op — so wiring this into the webhook can never break it.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `register` | `register(fn: (projectId: string) => Promise<unknown>)` | `void` |
| `registerPrClosed` | `registerPrClosed(fn: (repoUrl: string, prNumber: number, merged: boolean) => Promise<unknown>)` | `void` |
| `requestCheck` | `requestCheck(projectId: string)` | `void` |
| `requestPrClosed` | `requestPrClosed(repoUrl: string, prNumber: number, merged: boolean)` | `void` |

<!-- source: service-draftdocumentservice.md -->

# DraftDocumentService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/document/services/draft-document.service.ts` (line 69)

Single reusable draft→publish backbone entry point: create a `state:'DRAFT'`, `version:1`
Document with a unique urlId + slug. Every draft producer (the recorder's flow→manual path,
grounded AI page assist, and the Wave-3 ticket→content loop) funnels through here so they all
land in the SAME review/publish flow (`POST documents/:id/publish`) — no forked publish paths.

`DraftDocumentService` is the shared backend entry point for creating new draft documents with `state: 'DRAFT'`, `version: 1`, and unique `urlId` and slug values. Recorder flows, grounded AI assistance, and ticket-to-content generation all use this service so every document follows the same review and `POST /documents/:id/publish` publishing path.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createDraftDocument` | `createDraftDocument(params: CreateDraftDocumentParams)` | `Promise<DraftDocumentResult>` |

## Diagram

```mermaid
sequenceDiagram
  participant Producer as Draft Producer
  participant Service as DraftDocumentService
  participant DB as Document Repository
  participant Review as Review/Publish Flow

  Producer->>Service: createDraft(input)
  Service->>Service: Generate unique urlId and slug
  Service->>DB: Create Document<br/>state: DRAFT, version: 1
  DB-->>Service: Draft document
  Service-->>Producer: Draft document ID and metadata

  Producer->>Review: POST /documents/:id/publish
  Review->>DB: Validate and publish draft
  DB-->>Review: Published document
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { DraftDocumentService } from './services/draft-document.service';

@Injectable()
export class TicketContentService {
  constructor(
    private readonly draftDocumentService: DraftDocumentService,
  ) {}

  async createDraftFromTicket(ticket: {
    title: string;
    content: string;
    workspaceId: string;
    authorId: string;
  }) {
    const draft = await this.draftDocumentService.createDraft({
      title: ticket.title,
      content: ticket.content,
      workspaceId: ticket.workspaceId,
      authorId: ticket.authorId,
    });

    // Return the draft for the standard review/publish workflow.
    return {
      documentId: draft.id,
      state: draft.state,
      publishEndpoint: `/documents/${draft.id}/publish`,
    };
  }
}
```

## AI Coding Instructions

- Route every new draft-producing workflow through `DraftDocumentService`; do not create documents directly from recorder, AI, or ticket feature code.
- Preserve the initial document invariants: `state: 'DRAFT'` and `version: 1`.
- Let the service own unique `urlId` and slug generation rather than accepting caller-generated values unless the service contract explicitly supports them.
- Do not add alternate publishing paths for generated content; published transitions must continue through `POST /documents/:id/publish`.
- When adding producer-specific metadata, keep it additive and avoid changing the shared draft/review lifecycle.

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: interface-embedderconfig.md -->

# EmbedderConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/embedder.ts` (line 17)

Azure OpenAI Embedding Adapter

Uses direct `fetch` calls to the Azure OpenAI embeddings endpoint.
Zero external dependencies — only Node.js global fetch (Node 18+).

Follows the same Azure API patterns as runtime/model-adapter.ts:
- `api-key` header authentication
- Deployment-based URL routing
- Rate limit (429) handling with Retry-After support
- Structured error propagation

## Properties

| Property | Type |
|---|---|
| `endpoint` | `string` |
| `apiKey` | `string` |
| `model` | `string` |
| `apiVersion` | `string` |
| `batchSize` | `number` |

<!-- source: interface-entity-2.md -->

# Entity

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 240)

Base entity interface - all specific entities extend this

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `type` | `EntityType` |
| `name` | `string` |
| `filePath` | `string` |
| `startLine` | `number` |
| `endLine` | `number` |
| `description` | `string` |
| `framework` | `string` |
| `tags` | `string[]` |
| `metadata` | `Record<string, unknown>` |
| `discoveredAt` | `Date` |
| `contentHash` | `string` |

<!-- source: function-exportmarkdownfromlexical.md -->

# exportMarkdownFromLexical

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/exportMarkdownFromLexical.ts` (line 428)

## Signature

```ts
function exportMarkdownFromLexical({
  root,
  toMarkdownOptions,
  toMarkdownExtensions,
  visitors,
  jsxComponentDescriptors,
  jsxIsAvailable
}: ExportMarkdownFromLexicalOptions): string
```

## Parameters

| Name | Type |
|---|---|
| `{
  root,
  toMarkdownOptions,
  toMarkdownExtensions,
  visitors,
  jsxComponentDescriptors,
  jsxIsAvailable
}` | `ExportMarkdownFromLexicalOptions` |

**Returns:** `string`

<!-- source: function-extractjsdocdescription-2.md -->

# extractJSDocDescription

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 658)

Extract JSDoc description from leading comments

## Signature

```ts
function extractJSDocDescription(path: NodePath): string | undefined
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath` |

**Returns:** `string | undefined`

<!-- source: function-getusercolorrgb.md -->

# getUserColorRGB

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/user-colors.ts` (line 105)

Get an RGB representation of a user color
Useful for creating variations (e.g., with different opacity)

## Signature

```ts
function getUserColorRGB(userId: string): { r: number; g: number; b: number }
```

## Parameters

| Name | Type |
|---|---|
| `userId` | `string` |

**Returns:** `{ r: number; g: number; b: number }`

<!-- source: class-knowledgeformatter.md -->

# KnowledgeFormatter

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-14-meta/knowledge-formatter.ts` (line 20)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `format` | `format(reference: MetaCategoryReference | undefined, options: {
      maxChars: number;
      maxEntries: number;
      snippetTypes?: SnippetType[];
      groupByCategory?: boolean;
    })` | `string` |
| `formatDocList` | `formatDocList(reference: MetaCategoryReference | undefined, options: { maxEntries: number })` | `string` |
| `formatSnippets` | `formatSnippets(entries: KnowledgeEntry[], snippetType: SnippetType, maxChars: number)` | `string` |

<!-- source: interface-lightboxprops.md -->

# LightboxProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/Lightbox.tsx` (line 24)

## Properties

| Property | Type |
|---|---|
| `onClose` | `() => void` |
| `label` | `string` |
| `closeLabel` | `string` |
| `caption` | `string | null` |
| `dir` | `'ltr' | 'rtl'` |
| `returnFocusRef` | `React.RefObject<HTMLElement | null>` |
| `children` | `React.ReactNode` |

<!-- source: type-mdastextensions.md -->

# MdastExtensions

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/importMarkdownToLexical.ts` (line 35)

## Definition

```ts
Options['mdastExtensions']
```

<!-- source: constant-prompt-templates.md -->

# PROMPT_TEMPLATES

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/ai/prompts/prompt-templates.ts` (line 1)

<!-- source: interface-schemadefinition.md -->

# SchemaDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 516)

Schema definition for request/response bodies

## Properties

| Property | Type |
|---|---|
| `type` | `string` |
| `properties` | `Record<string, PropertyDefinition>` |
| `required` | `string[]` |
| `$ref` | `string` |

<!-- source: function-servedocsmcp.md -->

# serveDocsMcp

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/mcp/serve-mcp.ts` (line 12)

The single MCP-over-Streamable-HTTP serving path, shared by the projectId-keyed technical MCP
endpoint and the public slug-fronted MCP endpoint. Stateless: each POST is a self-contained
JSON-RPC exchange (no server-held session), which fits a read-only docs server and scales trivially.

## Signature

```ts
async function serveDocsMcp(corpus: DocsCorpus, askFn: AskFn | undefined, req: Request, res: Response, onError: (msg: string) => void, execFn: ApiExecFn): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `corpus` | `DocsCorpus` |
| `askFn` | `AskFn | undefined` |
| `req` | `Request` |
| `res` | `Response` |
| `onError` | `(msg: string) => void` |
| `execFn` | `ApiExecFn` |

**Returns:** `Promise<void>`

<!-- source: controller-technicaldocschatcontroller.md -->

# TechnicalDocsChatController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-chat.controller.ts` (line 19)

Conversational grounded chat (Foundation F3): sessions with memory, SSE streaming,
and 👍/👎 feedback. Access mirrors /ask (public project open, else member token);
the owning org pays the flat ask price per streamed question, and token usage is
attributed via trackUsage(skipCreditDeduction).

## Relationships

- MODULE_DECLARES → `createSession`
- MODULE_DECLARES → `stream`
- MODULE_DECLARES → `escalate`
- MODULE_DECLARES → `feedback`
- DEPENDS_ON → `techdocschatservice`
- DEPENDS_ON → `technicaldocsservice`
- DEPENDS_ON → `aiusageservice`
- DEPENDS_ON → `prismaservice`

<!-- source: class-toolregistry.md -->

# ToolRegistry

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/tools/tool-registry.ts` (line 39)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `search` | `search(query: string, maxResults: number)` | `ToolSearchResult[]` |
| `buildDeferredToolsReminder` | `buildDeferredToolsReminder()` | `string` |
| `createToolSearchTool` | `createToolSearchTool()` | `ToolDefinition<any> | null` |
| `get` | `get(name: string)` | `ToolDefinition<any> | undefined` |
| `estimateTokenSavings` | `estimateTokenSavings()` | `{ beforeTokens: number; afterTokens: number; savedTokens: number; savingsPercent: number }` |

## Properties

| Property | Type |
|---|---|
| `alwaysLoaded` | `ToolDefinition<any>[]` |
| `deferred` | `ToolDefinition<any>[]` |

<!-- source: function-validatehtmlquality.md -->

# validateHtmlQuality

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/guardrails/html-quality.guardrail.ts` (line 25)

## Signature

```ts
function validateHtmlQuality(html: string, config: HtmlQualityConfig): GuardrailResult
```

## Parameters

| Name | Type |
|---|---|
| `html` | `string` |
| `config` | `HtmlQualityConfig` |

**Returns:** `GuardrailResult`

<!-- source: interface-bolditalicunderlinetogglesprops.md -->

# BoldItalicUnderlineTogglesProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/BoldItalicUnderlineToggles.tsx` (line 36)

## Properties

| Property | Type |
|---|---|
| `options` | `('Bold' | 'Italic' | 'Underline')[]` |

<!-- source: component-codeinlists.md -->

# CodeInLists

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/nested-lists.tsx` (line 56)

## Diagram

```mermaid
graph TD
    component_CodeInLists_8b7e7c1["CodeInLists"]
    class component_CodeInLists_8b7e7c1 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `UndoRedo`

<!-- source: constant-contenteditableref.md -->

# contentEditableRef$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 336)

A reference to the content editable element.

<!-- source: interface-crdiff-2.md -->

# CrDiff

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/change-request/diff.types.ts` (line 5)

## Properties

| Property | Type |
|---|---|
| `files` | `FileDiff[]` |
| `totalAdditions` | `number` |
| `totalDeletions` | `number` |
| `computedAt` | `string` |

<!-- source: api-endpoint-create-9.md -->

# create

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/category.controller.ts` (line 33)

Create a new category

## Endpoint

`POST /categories`

## Referenced By

- `CategoryController` (MODULE_DECLARES)

<!-- source: function-createtodowritetool.md -->

# createTodoWriteTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/todo-write.tool.ts` (line 17)

## Signature

```ts
function createTodoWriteTool(todoManager: TodoManager): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `todoManager` | `TodoManager` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: component-cursor.md -->

# Cursor

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/UserCursors.tsx` (line 45)

Individual user cursor component

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `user` | `UserWithPosition` | ✓ | - |
| `showLabel` | `boolean` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Cursor_1d65ea8["Cursor"]
    class component_Cursor_1d65ea8 rootComponent
```

## Referenced By

- `UserCursors` (RENDERS)

<!-- source: class-docsprtriggermodule.md -->

# DocsPrTriggerModule

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr-trigger.ts` (line 43)

Global so both WebhookService and DocsPrService can inject the signal with no import edge.

<!-- source: service-emailservice.md -->

# EmailService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/email/email.service.ts` (line 30)

EmailService — one send API, three transports, picked at startup:

 1. gateway — the Sherkety email gateway (EMAIL_GATEWAY_URL + EMAIL_GATEWAY_KEY).
    Managed sending from noreply@atloria.app; the platform default in prod.
 2. smtp    — nodemailer via SMTP_* env vars (self-host escape hatch).
 3. console — logs the email instead of sending; local-dev fallback.

The gateway is SendGrid-v3-compatible and carries attachments (base64,
max 10 per message) — SMTP remains only as the self-host escape hatch.

`EmailService` is the backend email-sending façade that exposes a single `send` API while selecting one of three transports at startup: Sherkety gateway (default in prod), SMTP via nodemailer, or a console logger for local development. It centralizes email delivery concerns (auth/config, transport selection, fallbacks) so the rest of the system can send emails without knowing the underlying provider. When attachments are present, it bypasses the gateway (no attachment support) and falls back to SMTP if configured, otherwise logs a warning and prints the email.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `sendMail` | `sendMail(opts: SendEmailOptions)` | `Promise<boolean>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant App as NestJS App Code
  participant Email as EmailService
  participant GW as Sherkety Gateway Transport
  participant SMTP as SMTP (nodemailer)
  participant Console as Console Transport

  App->>Email: send(message)
  Note over Email: Transport chosen at startup\n(gateway | smtp | console)

  alt message has attachments
    Note over Email: Gateway contract has no attachments
    alt SMTP configured
      Email->>SMTP: sendWithAttachments(message)
      SMTP-->>Email: result
    else SMTP not configured
      Email->>Console: warn + log(message)
      Console-->>Email: ok (logged)
    end
  else no attachments
    alt Transport = gateway
      Email->>GW: send(message)
      GW-->>Email: result
    else Transport = smtp
      Email->>SMTP: send(message)
      SMTP-->>Email: result
    else Transport = console
      Email->>Console: log(message)
      Console-->>Email: ok (logged)
    end
  end

  Email-->>App: delivery result / completion
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { EmailService } from './email.service';

@Injectable()
export class InviteService {
  constructor(private readonly email: EmailService) {}

  async sendInvite(to: string, inviteUrl: string) {
    await this.email.send({
      to,
      subject: 'You’ve been invited to Atloria',
      // shape may vary; keep to your app’s email DTO/contract
      html: `<p>Join here: <a href="${inviteUrl}">${inviteUrl}</a></p>`,
      text: `Join here: ${inviteUrl}`,
    });
  }

  async sendReport(to: string, pdfBuffer: Buffer) {
    await this.email.send({
      to,
      subject: 'Your monthly report',
      text: 'Attached is your monthly report.',
      attachments: [
        {
          filename: 'report.pdf',
          content: pdfBuffer,
          contentType: 'application/pdf',
        },
      ],
    });
  }
}
```

## AI Coding Instructions

- Treat `EmailService` as the only email entrypoint; do not instantiate transports directly in feature modules—inject the service and call `send`.
- Remember: gateway does **not** support attachments; if you add attachments to a message, ensure SMTP is configured in environments where delivery matters, or expect console fallback + warning.
- Keep transport selection/config at startup via environment variables (`EMAIL_GATEWAY_URL/KEY`, `SMTP_*`); avoid per-request switching or ad-hoc overrides.
- When modifying the send contract/DTO, update all transports consistently (gateway, SMTP, console) and preserve the fallback behavior for attachments.

<!-- source: interface-entitychange.md -->

# EntityChange

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/version-diff.ts` (line 31)

Entity change

## Properties

| Property | Type |
|---|---|
| `type` | `ChangeType` |
| `id` | `string` |
| `name` | `string` |
| `entityType` | `string` |
| `oldEntity` | `Entity` |
| `newEntity` | `Entity` |
| `severity` | `ChangeSeverity` |
| `description` | `string` |
| `affectedProperties` | `string[]` |

<!-- source: interface-envsnapshot.md -->

# EnvSnapshot

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/env-tracker.ts` (line 20)

A point-in-time snapshot of shell environment state.

## Properties

| Property | Type |
|---|---|
| `cwd` | `string` |
| `env` | `Record<string, string>` |
| `venvActive` | `string` |
| `condaEnv` | `string` |
| `timestamp` | `number` |

<!-- source: function-extractentitymentions.md -->

# extractEntityMentions

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/grounding-checker.ts` (line 57)

Extract potential entity references from generated markdown.

Looks for:
- Capitalized phrases (2+ words starting with uppercase): "Sales Order", "Journal Entry"
- Quoted terms: "something" or 'something'
- Bold terms: **something**
- Menu paths: "X > Y > Z" or "X → Y → Z"

Returns a deduplicated, normalized (lowercase, trimmed) array.

## Signature

```ts
function extractEntityMentions(markdown: string): string[]
```

## Parameters

| Name | Type |
|---|---|
| `markdown` | `string` |

**Returns:** `string[]`

<!-- source: function-extractmodals.md -->

# extractModals

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/modal-extractor.ts` (line 478)

Extract all modal definitions from both code and template, deduplicating results.

This is the main entry point for modal extraction. It calls both
extractModalsFromCode and extractModalsFromTemplate, then merges
results by name (code-derived modals take priority for metadata).

## Signature

```ts
function extractModals(code: string, templateContent: string | undefined, filePath: string, componentName: string, framework: 'angular' | 'vue' | 'react'): ModalDefinition[]
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string` |
| `templateContent` | `string | undefined` |
| `filePath` | `string` |
| `componentName` | `string` |
| `framework` | `'angular' | 'vue' | 'react'` |

**Returns:** `ModalDefinition[]`

<!-- source: function-getusercolorwithopacity.md -->

# getUserColorWithOpacity

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/user-colors.ts` (line 127)

Get a CSS color string with opacity for a user

## Signature

```ts
function getUserColorWithOpacity(userId: string, opacity: number): string
```

## Parameters

| Name | Type |
|---|---|
| `userId` | `string` |
| `opacity` | `number` |

**Returns:** `string`

<!-- source: class-largefileindexer.md -->

# LargeFileIndexer

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/large-file-indexer.ts` (line 44)

Large File Indexer - Creates indexes for files >500KB

## Methods

| Method | Signature | Returns |
|---|---|---|
| `isLargeFile` | `isLargeFile(filePath: string)` | `Promise<boolean>` |
| `createIndex` | `createIndex(filePath: string)` | `Promise<LargeFileIndex>` |

<!-- source: interface-livejobprogress.md -->

# LiveJobProgress

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationJobs.ts` (line 22)

Live progress state for a running job

## Properties

| Property | Type |
|---|---|
| `jobId` | `string` |
| `progress` | `number` |
| `currentStage` | `string | null` |
| `stageProgress` | `number` |
| `currentItem` | `string | null` |
| `elapsedMs` | `number` |
| `estimatedRemainingMs` | `number` |
| `screenshotProgress` | `{
    batchIndex: number;
    totalBatches: number;
    captured: number;
    totalMappings: number;
  }` |

<!-- source: type-mdasthtmlnode.md -->

# MdastHTMLNode

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/MdastHTMLNode.ts` (line 30)

A HTML MDAST node.

## Definition

```ts
MdastBlockHTMLNode | MdastInlineHTMLNode
```

<!-- source: constant-public-sse-throttle.md -->

# PUBLIC_SSE_THROTTLE

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/common/throttling.module.ts` (line 23)

<!-- source: interface-serviceentity.md -->

# ServiceEntity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 734)

Service entity (NestJS, Express, etc.)

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.SERVICE` |
| `dependencies` | `DependencyInfo[]` |
| `methods` | `MethodDefinition[]` |
| `isSingleton` | `boolean` |

<!-- source: function-signaturehashof.md -->

# signatureHashOf

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-materializer.service.ts` (line 165)

entitySignatureHash over a SNAPSHOT entity (s0-4). Signature data lives in two shapes:
symbol-swept entities carry methods/fields in `metadata`, framework entities at the top
level (see renderEntityPage's same dual read), and method params appear as `parameters` or
legacy `params`. Normalize both before hashing so a param/return-type change re-hashes
regardless of which parser wrote the entity. FUNCTION entities fold their own
params/returnType in as a synthetic method (the hash has no function branch). Description/
comment edits never change the hash — that is the whole point.

## Signature

```ts
function signatureHashOf(entity: { name?: string; type?: string } & Record<string, unknown>): string
```

## Parameters

| Name | Type |
|---|---|
| `entity` | `{ name?: string; type?: string } & Record<string, unknown>` |

**Returns:** `string`

<!-- source: controller-technicaldocscontroller.md -->

# TechnicalDocsController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 21)

## Relationships

- MODULE_DECLARES → `startJob`
- MODULE_DECLARES → `generate`
- MODULE_DECLARES → `getSnapshot`
- MODULE_DECLARES → `getApiDocSet`
- MODULE_DECLARES → `getEntity`
- MODULE_DECLARES → `setCuration`
- MODULE_DECLARES → `importUrlSource`
- MODULE_DECLARES → `importPdfSource`
- MODULE_DECLARES → `importZendesk`
- MODULE_DECLARES → `importIntercom`
- MODULE_DECLARES → `listSources`
- MODULE_DECLARES → `removeSource`
- MODULE_DECLARES → `listConnectors`
- MODULE_DECLARES → `createConnector`
- MODULE_DECLARES → `syncConnector`
- MODULE_DECLARES → `setConnectorEnabled`
- MODULE_DECLARES → `removeConnector`
- MODULE_DECLARES → `exportConfluence`
- MODULE_DECLARES → `exportNotion`
- MODULE_DECLARES → `setEscalation`
- MODULE_DECLARES → `getEscalation`
- MODULE_DECLARES → `setPlaygroundTestKey`
- MODULE_DECLARES → `getApiTarget`
- MODULE_DECLARES → `setApiTarget`
- MODULE_DECLARES → `getApiSpec`
- MODULE_DECLARES → `getStatus`
- DEPENDS_ON → `technicaldocsservice`
- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `technicaldocsqueue`
- DEPENDS_ON → `aiusageservice`
- DEPENDS_ON → `techdocssourcesservice`
- DEPENDS_ON → `techdocsconnectorsservice`
- DEPENDS_ON → `techdocsexportservice`
- DEPENDS_ON → `techdocsnotionexportservice`

<!-- source: class-toolresultmanager.md -->

# ToolResultManager

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/context/tool-result-manager.ts` (line 30)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `store` | `store(toolName: string, result: string, turn: number)` | `ToolResult` |
| `getAll` | `getAll()` | `ReadonlyArray<ToolResult>` |
| `getByTool` | `getByTool(toolName: string)` | `ToolResult[]` |
| `getLatest` | `getLatest(toolName: string)` | `ToolResult | undefined` |
| `getTotalTokens` | `getTotalTokens()` | `number` |
| `cleanup` | `cleanup(currentTurn: number)` | `void` |
| `toContextString` | `toContextString()` | `string` |
| `clear` | `clear()` | `void` |
| `serialize` | `serialize()` | `string` |
| `deserialize` | `deserialize(json: string, config: ToolResultManagerConfig)` | `ToolResultManager` |

<!-- source: function-validateimagequality.md -->

# validateImageQuality

**Kind:** Function

**Source:** `atloria-monorepo/libs/pme-core/src/guardrails/image-quality.guardrail.ts` (line 41)

Validate image metadata against quality criteria.
Exported for direct use in tests and pipelines.

## Signature

```ts
function validateImageQuality(metadata: ImageMetadata, config: ImageQualityConfig): GuardrailResult
```

## Parameters

| Name | Type |
|---|---|
| `metadata` | `ImageMetadata` |
| `config` | `ImageQualityConfig` |

**Returns:** `GuardrailResult`

<!-- source: interface-borderradius.md -->

# BorderRadius

**Kind:** Interface

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 90)

## Properties

| Property | Type |
|---|---|
| `none` | `string` |
| `sm` | `string` |
| `md` | `string` |
| `lg` | `string` |
| `xl` | `string` |
| `full` | `string` |

<!-- source: component-codemirror.md -->

# Codemirror

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/cm-merge.tsx` (line 82)

## Diagram

```mermaid
graph TD
    component_Codemirror_4289ef46["Codemirror"]
    class component_Codemirror_4289ef46 rootComponent
```

## Relationships

- USES_HOOK → `useCallback`

<!-- source: constant-contenteditablewrapperelement.md -->

# contentEditableWrapperElement$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 461)

<!-- source: api-endpoint-create-10.md -->

# create

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 56)

## Endpoint

`POST /documents`

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: interface-createdraftdocumentparams.md -->

# CreateDraftDocumentParams

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/services/draft-document.service.ts` (line 36)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `organizationId` | `string` |
| `userId` | `string` |
| `title` | `string` |
| `markdown` | `string` |
| `source` | `DocumentSource` |
| `type` | `DocumentType` |
| `metadata` | `Record<string, unknown>` |
| `audienceSlug` | `string` |
| `slugFallback` | `string` |

<!-- source: function-createtoolsearchtool.md -->

# createToolSearchTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/tool-search.tool.ts` (line 36)

## Signature

```ts
function createToolSearchTool(options: ToolSearchToolOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `ToolSearchToolOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: component-customdomaincard.md -->

# CustomDomainCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Domains/DomainTab.tsx` (line 330)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `onToast` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomDomainCard_589d45d6["CustomDomainCard"]
    class component_CustomDomainCard_589d45d6 rootComponent
```

## Relationships

- RENDERS → `DomainStatusChip`
- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `XMarkIcon`
- RENDERS → `GlobeAltIcon`
- RENDERS → `CopyButton`
- RENDERS → `ArrowPathIcon`
- RENDERS → `CheckCircleIcon`
- RENDERS → `ArrowTopRightOnSquareIcon`
- RENDERS → `CheckIcon`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

## Referenced By

- `DomainTab` (RENDERS)

<!-- source: class-documentfiltersdto.md -->

# DocumentFiltersDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/document-filters.dto.ts` (line 7)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `categoryId` | `string` |
| `docVersionId` | `string` |
| `state` | `DocumentState` |
| `audience` | `string` |
| `type` | `DocumentType` |
| `search` | `string` |
| `limit` | `number` |
| `offset` | `number` |
| `sortBy` | `string` |
| `sortOrder` | `'asc' | 'desc'` |

<!-- source: service-embeddingsservice.md -->

# EmbeddingsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/rag/embeddings.service.ts` (line 10)

Azure OpenAI text embeddings for the technical-docs RAG. Uses the `text-embedding-3-large`
deployment (3072-dim, regional → data stays in-region). Batches inputs per request and retries
transient failures so indexing tens of thousands of entities is resilient.

`EmbeddingsService` generates Azure OpenAI text embeddings for the technical-docs RAG pipeline, using the `text-embedding-3-large` deployment (3072 dimensions) to keep data in-region. It batches inputs to reduce request overhead and implements retries for transient failures, making large-scale indexing (tens of thousands of entities) resilient. This service is typically used during ingestion/indexing and any workflow that needs deterministic vector representations for search and retrieval.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `embedOne` | `embedOne(text: string, usage: { tokens: number })` | `Promise<number[]>` |
| `embed` | `embed(texts: string[], batchSize: unknown, usage: { tokens: number })` | `Promise<number[][]>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant Indexer as RAG Indexer/Ingester
  participant Embeddings as EmbeddingsService
  participant Azure as Azure OpenAI (text-embedding-3-large)
  participant Store as Vector Store/Index

  Indexer->>Embeddings: embedTexts(texts[])
  note over Embeddings: Split into batches\n(avoid max input limits)
  loop For each batch
    Embeddings->>Azure: createEmbeddings(batch)
    alt transient failure (429/5xx/network)
      Embeddings->>Azure: retry with backoff
    end
    Azure-->>Embeddings: embeddings[]
  end
  Embeddings-->>Indexer: embeddings aligned to inputs
  Indexer->>Store: upsert(vectors + metadata)
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { EmbeddingsService } from './embeddings.service';

@Injectable()
export class DocsIndexer {
  constructor(private readonly embeddings: EmbeddingsService) {}

  async indexEntities(entities: Array<{ id: string; title: string; body: string }>) {
    const texts = entities.map(e => `${e.title}\n\n${e.body}`);

    // Produces 3072-dim vectors (text-embedding-3-large)
    const vectors = await this.embeddings.embedTexts(texts);

    // Example: align embeddings back to entities for vector-store upsert
    const records = entities.map((e, i) => ({
      id: e.id,
      vector: vectors[i],
      metadata: { title: e.title },
    }));

    // upsertRecords(records) // your vector store integration
    return records;
  }
}
```

## AI Coding Instructions

- Keep embeddings aligned with input order: batch splitting must preserve stable indexing so `vectors[i]` maps to `texts[i]`.
- Follow the existing batching strategy (size and token/length constraints) to avoid Azure OpenAI input limits and reduce request overhead.
- Retain and extend the retry policy only for transient errors (e.g., 429, 5xx, network timeouts); avoid retrying deterministic validation errors.
- Integration point: this service should be called from ingestion/indexing paths; store the resulting vectors with the same entity IDs/metadata used by the retriever.
- Treat all content as region-bound: do not add logging or telemetry that leaks raw text outside the intended region or persistence boundaries.

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: interface-entitydiff.md -->

# EntityDiff

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/staleness.ts` (line 53)

## Properties

| Property | Type |
|---|---|
| `changed` | `string[]` |
| `added` | `string[]` |
| `removed` | `string[]` |

<!-- source: interface-evalcommandoptions.md -->

# EvalCommandOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/swebench-evaluator.ts` (line 40)

Options for building the eval command

## Properties

| Property | Type |
|---|---|
| `predictionsPath` | `string` |
| `runId` | `string` |
| `maxWorkers` | `number` |
| `dataset` | `string` |
| `timeout` | `number` |
| `split` | `string` |

<!-- source: function-extractmodalsfromcode.md -->

# extractModalsFromCode

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/modal-extractor.ts` (line 79)

Extract modal definitions from TypeScript/JavaScript source code.

Scans for programmatic modal triggers: openPopup(), dialog.open(),
modalService.show(), useState patterns, jQuery .modal() calls, etc.

## Signature

```ts
function extractModalsFromCode(code: string, filePath: string, componentName: string): ModalDefinition[]
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string` |
| `filePath` | `string` |
| `componentName` | `string` |

**Returns:** `ModalDefinition[]`

<!-- source: function-extractsignature.md -->

# extractSignature

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/services/entity-mapper.service.ts` (line 374)

Extract the first declaration line as a signature.

## Signature

```ts
function extractSignature(fileCache: FileCache, absolutePath: string, startLine: number): string | undefined
```

## Parameters

| Name | Type |
|---|---|
| `fileCache` | `FileCache` |
| `absolutePath` | `string` |
| `startLine` | `number` |

**Returns:** `string | undefined`

<!-- source: function-getwebsocketclient.md -->

# getWebSocketClient

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/websocket-client.ts` (line 297)

Get or create WebSocket client instance

## Signature

```ts
function getWebSocketClient(apiUrl: string): AtloriaWebSocketClient
```

## Parameters

| Name | Type |
|---|---|
| `apiUrl` | `string` |

**Returns:** `AtloriaWebSocketClient`

<!-- source: class-learningpathgenerator.md -->

# LearningPathGenerator

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-14-meta/generators/learning-path.generator.ts` (line 25)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generate` | `generate(input: LearningPathDocInput, reference: MetaCategoryReference)` | `Promise<{
    document: GeneratedDocument;
    promptTokens: number;
    completionTokens: number;
  }>` |

<!-- source: interface-managedconnector.md -->

# ManagedConnector

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/lib/api-client.ts` (line 27)

F3 managed connector — client-safe view (never carries the stored config/credentials).

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `type` | `'ZENDESK' | 'INTERCOM' | 'URL'` |
| `enabled` | `boolean` |
| `syncIntervalMinutes` | `number` |
| `status` | `'idle' | 'syncing' | 'ok' | 'error'` |
| `lastError` | `string | null` |
| `lastSyncedAt` | `string | null` |
| `lastItemCount` | `number | null` |
| `cursor` | `string | null` |
| `hasConfig` | `boolean` |
| `createdAt` | `string` |

<!-- source: type-mdastjsx.md -->

# MdastJsx

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/index.ts` (line 32)

An MDX JSX MDAST node.

## Definition

```ts
MdxJsxTextElement | MdxJsxFlowElement
```

<!-- source: constant-rag-index-credit-cost.md -->

# RAG_INDEX_CREDIT_COST

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/billing/billing.constants.ts` (line 20)

<!-- source: function-slimnavmap.md -->

# slimNavMap

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/curation.ts` (line 40)

Apply curation to a navMap: hidden entities are removed (type groups emptied by hiding are
dropped), pinned entities float to the top of their type group (relative order otherwise
preserved). Pure + non-mutating; a no-op curation returns the input untouched.

## Signature

```ts
function slimNavMap(navMap: T): T
```

## Parameters

| Name | Type |
|---|---|
| `navMap` | `T` |

**Returns:** `T`

<!-- source: interface-slotdefinition.md -->

# SlotDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 394)

Slot definition (Vue)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `props` | `PropDefinition[]` |

<!-- source: controller-technicaldocsmcpcontroller.md -->

# TechnicalDocsMcpController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-mcp.controller.ts` (line 46)

Hosts each project's technical docs as a live MCP server over Streamable HTTP, so coding agents
(Claude, Cursor, …) can add `…/technical-docs/:projectId/mcp` and query the docs + entity graph.

Stateless: each POST is a self-contained JSON-RPC exchange (no server-held session), which fits a
read-only docs server and scales trivially. Access mirrors the public docs — a publicly-published
project is open; otherwise a bearer token whose user can access the project is required. (Private
projects with the full MCP OAuth 2.1 flow are a follow-up.)

`TechnicalDocsMcpController` exposes each project’s technical documentation as a live MCP server over Streamable HTTP, enabling coding agents (Claude, Cursor, etc.) to query docs and the entity graph via a JSON-RPC interface. Each request is stateless (a self-contained JSON-RPC exchange), making it scalable and suitable for a read-only docs surface. Access mirrors the public docs: published projects are open; otherwise a bearer token must grant the caller access to the project.

## Diagram

```mermaid
graph LR
  A[Agent / Client<br/>Claude, Cursor, CLI] -->|POST JSON-RPC<br/>/technical-docs/:projectId/mcp| B[TechnicalDocsMcpController]
  B --> C{Authorization}
  C -->|Project is published| D[Allow]
  C -->|Not published| E[Verify Bearer Token<br/>User has project access]
  E -->|OK| D[Allow]
  E -->|Denied| F[401/403]
  D --> G[Docs + Entity Graph Provider]
  G --> H[JSON-RPC Response<br/>(Streamable HTTP)]
  H --> A
```

## Usage

```ts
// Example: calling the MCP endpoint from Node.js using JSON-RPC over HTTP.
// This is the typical way a coding agent or tool would interact with the controller.

const projectId = "proj_123";
const baseUrl = "https://api.example.com";
const url = `${baseUrl}/technical-docs/${projectId}/mcp`;

// Include Authorization only for non-public (unpublished) projects.
const token = process.env.API_TOKEN; // optional
const headers: Record<string, string> = {
  "content-type": "application/json",
  ...(token ? { authorization: `Bearer ${token}` } : {}),
};

const jsonRpcRequest = {
  jsonrpc: "2.0",
  id: "req-1",
  method: "docs.search", // method names depend on your MCP toolset exposed by the server
  params: {
    query: "How is billing handled in the API?",
    limit: 5,
  },
};

const res = await fetch(url, {
  method: "POST",
  headers,
  body: JSON.stringify(jsonRpcRequest),
});

if (!res.ok) {
  const text = await res.text();
  throw new Error(`MCP request failed: ${res.status} ${res.statusText}\n${text}`);
}

const json = await res.json();
console.log("JSON-RPC response:", json);
```

## AI Coding Instructions

- Preserve the stateless contract: every `POST` must be a complete JSON-RPC exchange (no server-held sessions, no per-connection state).
- Keep auth rules aligned with public docs behavior: allow published projects anonymously; require `Authorization: Bearer ...` and validate project access for unpublished projects.
- Treat this as read-only infrastructure: avoid adding mutations or side effects (writes, background jobs) to MCP handlers exposed through this controller.
- Maintain Streamable HTTP compatibility (chunked/streaming response semantics where applicable) and avoid middleware that buffers the entire response body.
- When extending methods or integrating new docs/entity sources, keep response shapes stable for agents and ensure errors are proper JSON-RPC errors (not ad-hoc HTTP payloads).

## Relationships

- MODULE_DECLARES → `ragIndex`
- MODULE_DECLARES → `enrich`
- MODULE_DECLARES → `handle`
- MODULE_DECLARES → `mcpGet`
- MODULE_DECLARES → `getLlmsTxt`
- MODULE_DECLARES → `getLlmsFullTxt`
- MODULE_DECLARES → `getPageMarkdown`
- MODULE_DECLARES → `downloadSdk`
- MODULE_DECLARES → `ask`
- MODULE_DECLARES → `assist`
- MODULE_DECLARES → `assistApply`
- MODULE_DECLARES → `playgroundProxy`
- DEPENDS_ON → `technicaldocsmaterializerservice`
- DEPENDS_ON → `technicaldocsservice`
- DEPENDS_ON → `techdocsragservice`
- DEPENDS_ON → `technicaldocsqueue`
- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `aiusageservice`
- DEPENDS_ON → `draftdocumentservice`

<!-- source: class-trajectorylogger.md -->

# TrajectoryLogger

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/tracing/trajectory-logger.ts` (line 46)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `attach` | `attach(session: AttachableSession)` | `void` |
| `record` | `record(event: string, data: Record<string, unknown>)` | `void` |
| `getEntries` | `getEntries()` | `TrajectoryEntry[]` |
| `toJSONL` | `toJSONL()` | `string` |
| `flush` | `flush()` | `void` |
| `clear` | `clear()` | `void` |

<!-- source: interface-browsersession.md -->

# BrowserSession

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 172)

Browser session for capturing screenshots

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `baseUrl` | `string` |
| `isAuthenticated` | `boolean` |
| `screenshots` | `string[]` |
| `status` | `'pending' | 'running' | 'completed' | 'failed'` |
| `startedAt` | `Date` |
| `completedAt` | `Date` |
| `error` | `string` |

<!-- source: component-codemirroreditor.md -->

# CodeMirrorEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/codemirror/CodeMirrorEditor.tsx` (line 22)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `language` | `any` | ✓ | - |
| `nodeKey` | `any` | ✓ | - |
| `code` | `any` | ✓ | - |
| `focusEmitter` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CodeMirrorEditor_1b095ce5["CodeMirrorEditor"]
    class component_CodeMirrorEditor_1b095ce5 rootComponent
```

## Relationships

- RENDERS → `Select`
- USES_HOOK → `useTranslation`
- USES_HOOK → `useCodeBlockEditorContext`
- USES_HOOK → `useCellValues`
- USES_HOOK → `useCodeMirrorRef`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: constant-convertselectiontonode.md -->

# convertSelectionToNode$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 797)

Converts the current selection to a node created by the published factory.

<!-- source: api-endpoint-create-11.md -->

# create

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/public-issues.controller.ts` (line 13)

## Endpoint

`POST /public/issues`

## Referenced By

- `PublicIssuesController` (MODULE_DECLARES)

<!-- source: interface-createinvitationdto.md -->

# CreateInvitationDto

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/invitation/invitation.service.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `email` | `string` |
| `role` | `UserRole` |

<!-- source: function-createunifieddiffedittool.md -->

# createUnifiedDiffEditTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/edit-file.tool.ts` (line 468)

Create an edit tool that accepts unified diff format instead of
search/replace. Better for complex, multi-site edits.

The agent provides a standard unified diff (with

## Signature

```ts
function createUnifiedDiffEditTool(options: EditFileOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `EditFileOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: component-customdomainpublishingrow.md -->

# CustomDomainPublishingRow

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/page.tsx` (line 1736)

Publishing-card row for the custom domain: shows the shared status chip when a domain exists (fetched once, non-blocking) plus a deep link into Settings → Branding → Domain.

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomDomainPublishingRow_16a8d4e7["CustomDomainPublishingRow"]
    class component_CustomDomainPublishingRow_16a8d4e7 rootComponent
```

## Relationships

- RENDERS → `DomainStatusChip`
- RENDERS → `Link`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

## Referenced By

- `ProjectPage` (RENDERS)

<!-- source: class-documentskeletondto.md -->

# DocumentSkeletonDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/documentation/dto/doc-automation.dto.ts` (line 13)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `features` | `string[]` |
| `description` | `string` |

<!-- source: interface-entityenrichment.md -->

# EntityEnrichment

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/entity-page.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `description` | `string` |
| `diagram` | `string` |
| `example` | `string` |
| `instructions` | `string` |

<!-- source: service-entityextractorservice.md -->

# EntityExtractorService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/graph/services/entity-extractor.service.ts` (line 12)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `extractFromDocument` | `extractFromDocument(documentId: string)` | `Promise<KGEntity[]>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `aiservice`

<!-- source: interface-evalresult.md -->

# EvalResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/swebench-evaluator.ts` (line 33)

Result from the Docker evaluation harness

## Properties

| Property | Type |
|---|---|
| `instanceId` | `string` |
| `resolved` | `boolean` |
| `details` | `Record<string, unknown>` |

<!-- source: function-extractmodalsfromtemplate.md -->

# extractModalsFromTemplate

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/modal-extractor.ts` (line 251)

Extract modal definitions from HTML template content.

Scans for modal-related elements: app-shared-popup, dx-popup,
Bootstrap modal attributes, ngIf popup conditionals, React/Vue modal components.

## Signature

```ts
function extractModalsFromTemplate(templateContent: string, filePath: string, componentName: string, framework: 'angular' | 'vue' | 'react'): ModalDefinition[]
```

## Parameters

| Name | Type |
|---|---|
| `templateContent` | `string` |
| `filePath` | `string` |
| `componentName` | `string` |
| `framework` | `'angular' | 'vue' | 'react'` |

**Returns:** `ModalDefinition[]`

<!-- source: function-extractsourcecode.md -->

# extractSourceCode

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/services/entity-mapper.service.ts` (line 356)

Extract source code lines from a file (1-indexed, inclusive).

## Signature

```ts
function extractSourceCode(fileCache: FileCache, absolutePath: string, startLine: number, endLine: number): string | undefined
```

## Parameters

| Name | Type |
|---|---|
| `fileCache` | `FileCache` |
| `absolutePath` | `string` |
| `startLine` | `number` |
| `endLine` | `number` |

**Returns:** `string | undefined`

<!-- source: function-hashcolor.md -->

# hashColor

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Boards/helpers.ts` (line 61)

## Signature

```ts
function hashColor(str: string): string
```

## Parameters

| Name | Type |
|---|---|
| `str` | `string` |

**Returns:** `string`

<!-- source: class-lexicaljsxnode.md -->

# LexicalJsxNode

**Kind:** Class

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/LexicalJsxNode.tsx` (line 28)

**Extends:** `DecoratorNode`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getType` | `getType()` | `string` |
| `clone` | `clone(node: LexicalJsxNode)` | `LexicalJsxNode` |
| `importJSON` | `importJSON(serializedNode: SerializedLexicalJsxNode)` | `LexicalJsxNode` |
| `getMdastNode` | `getMdastNode()` | `MdastJsx` |
| `getImportStatement` | `getImportStatement()` | `ImportStatement | undefined` |
| `exportJSON` | `exportJSON()` | `SerializedLexicalJsxNode` |
| `createDOM` | `createDOM()` | `HTMLElement` |
| `updateDOM` | `updateDOM()` | `false` |
| `setMdastNode` | `setMdastNode(mdastNode: MdastJsx)` | `void` |
| `decorate` | `decorate(parentEditor: LexicalEditor, config: EditorConfig)` | `JSX.Element` |
| `isInline` | `isInline()` | `boolean` |
| `isKeyboardSelectable` | `isKeyboardSelectable()` | `boolean` |

## Properties

| Property | Type |
|---|---|
| `__mdastNode` | `MdastJsx` |
| `__focusEmitter` | `any` |
| `__importStatement` | `ImportStatement` |
| `select` | `any` |

<!-- source: interface-mcpinstallblockprops.md -->

# McpInstallBlockProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/McpInstallBlock.tsx` (line 23)

## Properties

| Property | Type |
|---|---|
| `mcpUrl` | `string` |
| `serverName` | `string` |
| `authToken` | `string` |
| `variant` | `'inline' | 'menu' | 'modal'` |

<!-- source: type-mdxnodetype.md -->

# MdxNodeType

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/MdastHTMLNode.ts` (line 38)

The MDAST jsx distinction value used to differentiate inline and block level elements.

## Definition

```ts
MdastHTMLNode['type']
```

<!-- source: constant-redacted.md -->

# REDACTED

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/capture/capture.redact.ts` (line 13)

Server-side value redaction for captured steps (defense in depth).

The recorder client already redacts sensitive inputs at capture time
(type=password, token/email/card patterns) — but we NEVER trust the client.
Every stored step value is re-scanned here so a secret can never land in the
database even if a tampered/old recorder sends one through.

Moat rule: the recipe (selectors + actions) is the asset — secret VALUES are
not, and are actively harmful to keep. When in doubt, redact.

<!-- source: function-slugify.md -->

# slugify

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/document/services/draft-document.service.ts` (line 24)

Slugify a title into a URL-safe slug (shared with the recorder draft path).

## Signature

```ts
function slugify(text: string, fallback): string
```

## Parameters

| Name | Type |
|---|---|
| `text` | `string` |
| `fallback` | `any` |

**Returns:** `string`

<!-- source: interface-statemanagementinfo.md -->

# StateManagementInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 405)

State management information

## Properties

| Property | Type |
|---|---|
| `type` | `'useState' | 'useReducer' | 'context' | 'redux' | 'zustand' | 'pinia' | 'other'` |
| `stores` | `string[]` |
| `actions` | `string[]` |
| `selectors` | `string[]` |

<!-- source: controller-templatecontroller.md -->

# TemplateController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/template/template.controller.ts` (line 32)

Controller for document template operations.
Provides endpoints for browsing, using, and creating templates.

`TemplateController` is a NestJS controller responsible for document template operations in the API. It exposes HTTP endpoints to browse available templates, create/manage templates, and apply a template to generate documents. It sits at the edge of the backend, validating request inputs and delegating business logic to the underlying template service layer.

## Diagram

```mermaid
graph LR
  Client[API Client] -->|HTTP request| TC[TemplateController]
  TC -->|validate/parse DTOs| Pipes[Nest Pipes/Guards]
  TC -->|delegate| TS[TemplateService]
  TS -->|read/write| DB[(Database)]
  TS -->|load/store| FS[(Template Storage)]
  TS -->|generate document| DOC[Document Builder/Renderer]
  TS -->|response DTO| TC
  TC -->|HTTP response| Client
```

## Usage

```ts
// Example: calling TemplateController endpoints from a client (Node.js / browser).
// Adjust baseUrl and routes to match your actual API paths.

async function listTemplates(baseUrl: string, token: string) {
  const res = await fetch(`${baseUrl}/templates`, {
    method: "GET",
    headers: { Authorization: `Bearer ${token}` },
  });

  if (!res.ok) throw new Error(`Failed to list templates: ${res.status}`);
  return res.json(); // e.g., [{ id, name, category, ... }]
}

async function createTemplate(baseUrl: string, token: string) {
  const res = await fetch(`${baseUrl}/templates`, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      Authorization: `Bearer ${token}`,
    },
    body: JSON.stringify({
      name: "NDA v1",
      description: "Standard NDA template",
      // ...other fields expected by your CreateTemplateDto
    }),
  });

  if (!res.ok) throw new Error(`Failed to create template: ${res.status}`);
  return res.json(); // e.g., { id, ... }
}

async function applyTemplate(baseUrl: string, token: string, templateId: string) {
  const res = await fetch(`${baseUrl}/templates/${templateId}/use`, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      Authorization: `Bearer ${token}`,
    },
    body: JSON.stringify({
      variables: { companyName: "Atloria, Inc." },
      // ...other fields expected by your "use template" DTO
    }),
  });

  if (!res.ok) throw new Error(`Failed to use template: ${res.status}`);

  // Could be JSON metadata or a file stream depending on implementation.
  const contentType = res.headers.get("content-type") ?? "";
  return contentType.includes("application/json") ? res.json() : res.blob();
}

// Example runner
(async () => {
  const baseUrl = "https://api.example.com";
  const token = process.env.API_TOKEN!;

  const templates = await listTemplates(baseUrl, token);
  const created = await createTemplate(baseUrl, token);
  const output = await applyTemplate(baseUrl, token, created.id);

  console.log({ templatesCount: templates.length, createdId: created.id, outputType: typeof output });
})();
```

## AI Coding Instructions

- Keep controller methods thin: validate/transform request DTOs and delegate all business logic to the template service; avoid embedding persistence or rendering logic in the controller.
- Use NestJS DTOs + `ValidationPipe` consistently for all inputs (query/params/body) to prevent template injection and malformed payloads from reaching the service.
- Maintain stable route patterns for template listing/creation vs. “use/apply” actions (e.g., `POST /templates/:id/use`) and document the response type (JSON vs file/stream) to avoid client breakages.
- Ensure authentication/authorization guards are applied uniformly, especially for template creation and any endpoint that can access private templates or generate documents.
- When adding new endpoints, align return shapes with existing response DTOs and handle errors with Nest exceptions (`BadRequestException`, `NotFoundException`) rather than raw errors.

## Relationships

- MODULE_DECLARES → `list`
- MODULE_DECLARES → `getById`
- MODULE_DECLARES → `create`
- MODULE_DECLARES → `useTemplate`
- MODULE_DECLARES → `saveAsTemplate`
- MODULE_DECLARES → `update`
- MODULE_DECLARES → `delete`
- DEPENDS_ON → `templateservice`

<!-- source: class-vectorstore.md -->

# VectorStore

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/vector-store.ts` (line 62)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `load` | `load()` | `void` |
| `save` | `save()` | `void` |
| `upsert` | `upsert(chunks: CodeChunk[])` | `void` |
| `remove` | `remove(chunkIds: string[])` | `void` |
| `removeByFile` | `removeByFile(files: string[])` | `void` |
| `getAll` | `getAll()` | `CodeChunk[]` |
| `getByFile` | `getByFile(file: string)` | `CodeChunk[]` |
| `vectorSearch` | `vectorSearch(queryEmbedding: number[], topK: number)` | `Array<{ chunk: CodeChunk; score: number }>` |
| `getMerkle` | `getMerkle()` | `Map<string, string>` |
| `setMerkle` | `setMerkle(merkle: Map<string, string>)` | `void` |

<!-- source: interface-businesscontext-2.md -->

# BusinessContext

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/orchestrator.ts` (line 58)

Structured business context extracted from client-provided sources
(PDF brochure, marketing website, competitor docs, markdown files).

Extracted by the agent pre-pipeline and injected into AI prompts
across Stages 4-10 to ensure generated docs use correct business
terminology, personas, and workflow descriptions.

## Properties

| Property | Type |
|---|---|
| `productName` | `string` |
| `productTagline` | `string` |
| `productDescription` | `string` |
| `domain` | `string` |
| `personas` | `{ name: string; description: string }[]` |
| `features` | `{ name: string; description: string; category?: string }[]` |
| `glossary` | `{ term: string; definition: string }[]` |
| `workflows` | `{ name: string; steps: string[]; description?: string }[]` |
| `tone` | `string` |
| `rawContext` | `string` |
| `sources` | `{ type: 'pdf' | 'url' | 'file' | 'text'; path: string }[]` |

<!-- source: component-codetoggle.md -->

# CodeToggle

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/CodeToggle.tsx` (line 12)

## Diagram

```mermaid
graph TD
    component_CodeToggle_537b2e77["CodeToggle"]
    class component_CodeToggle_537b2e77 rootComponent
```

## Relationships

- RENDERS → `MultipleChoiceToggleGroup`
- USES_HOOK → `useCellValues`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useTranslation`

<!-- source: constant-coreplugin.md -->

# corePlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 932)

<!-- source: api-endpoint-create-12.md -->

# create

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 45)

## Endpoint

`POST /projects`

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: interface-createnotificationdto.md -->

# CreateNotificationDto

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/notification/notification.service.ts` (line 5)

## Properties

| Property | Type |
|---|---|
| `userId` | `string` |
| `type` | `'MENTION' | 'COMMENT' | 'SUGGESTION' | 'DOCUMENT_SHARED' | 'REVIEW_REQUEST' | 'SYSTEM'` |
| `title` | `string` |
| `message` | `string` |
| `entityType` | `string` |
| `entityId` | `string` |
| `metadata` | `Record<string, any>` |

<!-- source: function-createwebfetchtool.md -->

# createWebFetchTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/web-fetch.tool.ts` (line 25)

## Signature

```ts
function createWebFetchTool(options: WebFetchOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `WebFetchOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: component-customertabbody.md -->

# CustomerTabBody

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/DeskCopilot.tsx` (line 473)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `thread` | `DeskThreadDetail` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomerTabBody_1379617c["CustomerTabBody"]
    class component_CustomerTabBody_1379617c rootComponent
```

## Relationships

- RENDERS → `SectionLabel`
- RENDERS → `ArrowTopRightOnSquareIcon`

## Referenced By

- `DeskCopilot` (RENDERS)

<!-- source: class-enhancedocumentdto.md -->

# EnhanceDocumentDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/ai/dto/enhance-document.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `provider` | `string` |

<!-- source: interface-entitypagecontext.md -->

# EntityPageContext

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/entity-page.ts` (line 31)

## Properties

| Property | Type |
|---|---|
| `relationships` | `Relationship[]` |
| `allEntities` | `Entity[]` |
| `enrichment` | `EntityEnrichment` |
| `sourceLinkBase` | `string` |
| `nameResolver` | `(id: string) => string` |
| `outgoingBySource` | `Map<string, Relationship[]>` |
| `incomingByTarget` | `Map<string, Relationship[]>` |

<!-- source: service-eventsservice.md -->

# EventsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/events/events.service.ts` (line 24)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `record` | `record(input: {
    type: string;
    projectId?: string | null;
    organizationId?: string | null;
    sessionId?: string | null;
    userId?: string | null;
    payload?: Record<string, unknown> | null;
  })` | `Promise<{ id: string }>` |
| `recordSafe` | `recordSafe(input: Parameters<EventsService['record']>[0])` | `void` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: function-extractpermissions.md -->

# extractPermissions

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/permission-extractor.ts` (line 378)

Extract all permission checks from code and template.

## Signature

```ts
function extractPermissions(code: string, templateContent: string | undefined, filePath: string, componentName: string, framework: 'angular' | 'vue' | 'react'): PermissionCheck[]
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string` |
| `templateContent` | `string | undefined` |
| `filePath` | `string` |
| `componentName` | `string` |
| `framework` | `'angular' | 'vue' | 'react'` |

**Returns:** `PermissionCheck[]`

<!-- source: interface-failureanalysis.md -->

# FailureAnalysis

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/benchmark-monitor.ts` (line 65)

## Properties

| Property | Type |
|---|---|
| `totalTasks` | `number` |
| `passed` | `number` |
| `failed` | `number` |
| `timedOut` | `number` |
| `passRate` | `number` |
| `byCategory` | `Record<string, number>` |
| `correctAreaButFailed` | `TaskResult[]` |
| `noChanges` | `TaskResult[]` |
| `timedOutWithChanges` | `TaskResult[]` |
| `patterns` | `FailurePattern[]` |
| `toolComparison` | `{
    passing: Record<string, number>;
    failing: Record<string, number>;
  }` |
| `avgTurns` | `{ passing: number; failing: number }` |
| `summary` | `string` |

<!-- source: function-fromwithineditorread.md -->

# fromWithinEditorRead

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/lexicalHelpers.ts` (line 17)

Fetches a value from the Lexical editor read cycle.

## Signature

```ts
function fromWithinEditorRead(editor: LexicalEditor, fn: () => T): T
```

## Parameters

| Name | Type |
|---|---|
| `editor` | `LexicalEditor` |
| `fn` | `() => T` |

**Returns:** `T`

<!-- source: function-htmltomarkdown.md -->

# htmlToMarkdown

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/markdown-converter.ts` (line 28)

Convert HTML to Markdown

## Signature

```ts
function htmlToMarkdown(html: string): string
```

## Parameters

| Name | Type |
|---|---|
| `html` | `string` |

**Returns:** `string`

<!-- source: class-logger.md -->

# Logger

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/logger.ts` (line 43)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `setStage` | `setStage(stage: string)` | `void` |
| `clearStage` | `clearStage()` | `void` |
| `debug` | `debug(message: string, data: Record<string, unknown>)` | `void` |
| `info` | `info(message: string, data: Record<string, unknown>)` | `void` |
| `warn` | `warn(message: string, data: Record<string, unknown>)` | `void` |
| `error` | `error(message: string, error: Error, data: Record<string, unknown>)` | `void` |
| `stageStart` | `stageStart(stage: string, details: Record<string, unknown>)` | `void` |
| `stageComplete` | `stageComplete(stage: string, duration: number, details: Record<string, unknown>)` | `void` |
| `stageFailed` | `stageFailed(stage: string, error: Error, details: Record<string, unknown>)` | `void` |
| `tokenUsage` | `tokenUsage(stage: string, inputTokens: number, outputTokens: number, model: string)` | `void` |
| `child` | `child(prefix: string)` | `Logger` |

<!-- source: interface-memberuser.md -->

# MemberUser

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useProjectMembers.ts` (line 10)

Member type for

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `email` | `string` |
| `avatar` | `string | null` |
| `role` | `string` |

<!-- source: type-metaknowledgecategory.md -->

# MetaKnowledgeCategory

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/knowledge-reference.types.ts` (line 13)

Knowledge Reference Types

Types for the knowledge-driven meta-docs feature (Phase 1).
Used by KnowledgeClassifier and KnowledgeCollector during Stage 10
to build a reference store that Stage 14 uses for meta-doc generation.

## Definition

```ts
| 'welcome'
  | 'getting-started'
  | 'learning-paths'
  | 'help-troubleshooting'
  | 'admin-guide'
```

<!-- source: constant-releasenotestemplate.md -->

# releaseNotesTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/release-notes.template.ts` (line 3)

<!-- source: function-stabilizeparseoutput.md -->

# stabilizeParseOutput

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/stabilize-parse-output.ts` (line 24)

## Signature

```ts
function stabilizeParseOutput(entities: Entity[], relationships: Relationship[], rootDir: string): { entities: Entity[]; relationships: Relationship[] }
```

## Parameters

| Name | Type |
|---|---|
| `entities` | `Entity[]` |
| `relationships` | `Relationship[]` |
| `rootDir` | `string` |

**Returns:** `{ entities: Entity[]; relationships: Relationship[] }`

<!-- source: interface-syncresult.md -->

# SyncResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/knowledge-graph/sync/kg-sync.service.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `entitiesCreated` | `number` |
| `entitiesUpdated` | `number` |
| `relationshipsCreated` | `number` |
| `errors` | `string[]` |
| `duration` | `number` |

<!-- source: controller-testconnectioncontroller.md -->

# TestConnectionController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/parsing/test-connection.controller.ts` (line 25)

## Relationships

- MODULE_DECLARES → `testConnection`
- MODULE_DECLARES → `listBranches`
- DEPENDS_ON → `gitcloneservice`

<!-- source: class-verboselogger.md -->

# VerboseLogger

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/session/verbose-logger.ts` (line 47)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `setVerbose` | `setVerbose(enabled: boolean)` | `void` |
| `isVerbose` | `isVerbose()` | `boolean` |
| `resetCounters` | `resetCounters()` | `void` |

<!-- source: interface-buttonprofile.md -->

# ButtonProfile

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/site-map.types.ts` (line 28)

## Properties

| Property | Type |
|---|---|
| `text` | `string` |
| `selector` | `string` |
| `isEnabled` | `boolean` |

<!-- source: component-comparisonfeaturetable-2.md -->

# ComparisonFeatureTable

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/comparison/comparison-feature-table.tsx` (line 21)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `columns` | `unknown[]` | ✓ | - |
| `features` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ComparisonFeatureTable_1c03ffe1["ComparisonFeatureTable"]
    class component_ComparisonFeatureTable_1c03ffe1 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `ComparisonRow`
- USES_HOOK → `useTranslation`

<!-- source: constant-countup.md -->

# countUp

**Kind:** Constant

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/animations.ts` (line 82)

Animated number counter — for stats sections

## Definition

```ts
Variants
```

<!-- source: api-endpoint-create-13.md -->

# create

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/template/template.controller.ts` (line 86)

Create a new template.
Only admins and maintainers can create templates.

## Endpoint

`POST /templates`

## Referenced By

- `TemplateController` (MODULE_DECLARES)

<!-- source: interface-createscheduledreportdto.md -->

# CreateScheduledReportDto

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/analytics/export/scheduled-reports.service.ts` (line 11)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `cron` | `string` |
| `timezone` | `string` |
| `format` | `ReportFormat` |
| `period` | `number` |
| `sections` | `ExportSection[]` |
| `recipientEmails` | `string[]` |

<!-- source: function-createwebsearchtool.md -->

# createWebSearchTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/web-search.tool.ts` (line 75)

## Signature

```ts
function createWebSearchTool(options: WebSearchOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `WebSearchOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: component-customimage.md -->

# CustomImage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 755)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `src` | `any` | ✓ | - |
| `alt` | `any` | ✓ | - |
| `documentTitle` | `any` | ✓ | - |
| `lang` | `any` | ✓ | - |
| `node` | `any` | ✓ | - |
| `...props` | `object` | - | - |

## Diagram

```mermaid
graph TD
    component_CustomImage_4c354b47["CustomImage"]
    class component_CustomImage_4c354b47 rootComponent
```

## Relationships

- RENDERS → `ScreenshotFigure`
- RENDERS → `VideoEmbed`
- RENDERS → `VideoPlayer`

## Referenced By

- `MarkdownRenderer` (RENDERS)

<!-- source: interface-entitypath-2.md -->

# EntityPath

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/relationship.interface.ts` (line 306)

Graph path between entities

## Properties

| Property | Type |
|---|---|
| `startId` | `string` |
| `endId` | `string` |
| `relationships` | `Relationship[]` |
| `entityIds` | `string[]` |
| `length` | `number` |

<!-- source: class-externalfailuredto.md -->

# ExternalFailureDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/documentation/dto/doc-automation.dto.ts` (line 607)

Terminal failure reported by an external generator (atlorix-runner) once it has exhausted its
retries. Without this the runner could only report PROGRESS, so a job whose subprocess died
stayed RUNNING in the DB until the 2-hour stuck-job sweeper expired it — the UI spun, and the
real reason (which the runner had in hand) was never persisted anywhere.

## Properties

| Property | Type |
|---|---|
| `error` | `string` |
| `errorStage` | `string` |
| `errorStack` | `string` |

<!-- source: function-extractpermissionsfromcode.md -->

# extractPermissionsFromCode

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/permission-extractor.ts` (line 75)

Extract permission checks from TypeScript/JavaScript source code.

Detects:
- Route guard references (canActivate, canLoad, etc.)
- Permission checking method calls (hasPermission, can, isAuthorized)
- Role-based checks (hasRole, isAdmin, role === 'admin')
- Decorator-based permissions (@Roles,

## Signature

```ts
function extractPermissionsFromCode(code: string, filePath: string, componentName: string): PermissionCheck[]
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string` |
| `filePath` | `string` |
| `componentName` | `string` |

**Returns:** `PermissionCheck[]`

<!-- source: interface-failurepattern.md -->

# FailurePattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/benchmark-monitor.ts` (line 54)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `count` | `number` |
| `taskIds` | `string[]` |
| `suggestion` | `string` |

<!-- source: service-featuredetectorservice.md -->

# FeatureDetectorService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/feature-detector.service.ts` (line 60)

Feature Detector Service

Automatically identifies "features" from parsed codebase

Detection strategies:
1. State Machine-based: Each state machine represents a feature workflow
2. Module-based: Group by application modules (Angular modules, React feature folders)
3. Route-based: Group by route prefix (e.g., /sales/*, /inventory/*)
4. Business Context-based: Extract from marketing/process docs

`FeatureDetectorService` automatically identifies higher-level “features” from a parsed codebase so the system can organize, document, and reason about workflows and domains. It applies multiple detection strategies—state machine workflows, module/folder boundaries, route prefixes, and business-context documentation—to produce a consolidated set of feature definitions for downstream tooling (e.g., docs, navigation, analysis).

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectFeatures` | `detectFeatures(options: {
    entities: any[]; // Parsed entities from parser-core
    appMap?: any; // Application structure map
    businessContext?: {
      marketing: string[];
      workflows: string[];
      features: string[];
    };
  })` | `Promise<DetectedFeature[]>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  actor Caller
  participant FDS as FeatureDetectorService
  participant Code as Parsed Codebase/AST
  participant SM as StateMachine Strategy
  participant Mod as Module Strategy
  participant Rt as Route Strategy
  participant Biz as Business Context Strategy
  participant Out as Feature Set

  Caller->>FDS: detectFeatures(codebase, options)
  FDS->>Code: read parsed structures (AST, routes, modules)
  FDS->>SM: detectFromStateMachines(codebase)
  SM-->>FDS: features (workflow-based)
  FDS->>Mod: detectFromModules(codebase)
  Mod-->>FDS: features (module/folder-based)
  FDS->>Rt: detectFromRoutes(codebase)
  Rt-->>FDS: features (route-prefix-based)
  FDS->>Biz: detectFromBusinessDocs(contextDocs)
  Biz-->>FDS: features (domain/context-based)
  FDS->>FDS: merge/dedupe/score + resolve conflicts
  FDS-->>Out: consolidated features
  Out-->>Caller: Feature[] (with sources/metadata)
```

## Usage

```ts
import { FeatureDetectorService } from './documentation/services/feature-detector.service';

// In NestJS you would usually inject this service; this is a simplified example.
async function runFeatureDetection() {
  const featureDetector = new FeatureDetectorService();

  // Example shape: depends on your parser output; keep it consistent with what the service expects.
  const parsedCodebase = {
    stateMachines: [
      /* ... */
    ],
    modules: [
      /* Angular modules / React feature folders ... */
    ],
    routes: [
      { method: 'GET', path: '/sales/orders' },
      { method: 'POST', path: '/inventory/items' },
    ],
    docs: {
      marketing: 'Sales workflow covers quote -> order -> invoice ...',
      process: 'Inventory receiving and stock adjustments ...',
    },
  };

  const features = await featureDetector.detectFeatures(parsedCodebase, {
    strategies: ['stateMachine', 'module', 'route', 'businessContext'],
    routePrefixDepth: 1, // e.g., "/sales/*" groups under "sales"
  });

  // Use the detected features to generate docs, navigation, or analysis outputs
  for (const f of features) {
    console.log(`[feature] ${f.name}`, {
      key: f.key,
      sources: f.sources,
      confidence: f.confidence,
    });
  }
}

runFeatureDetection().catch(console.error);
```

## AI Coding Instructions

- Preserve the “multi-strategy” pattern: each detector should be independent (pure-ish) and return features with source metadata so merging/deduping can be explained and debugged.
- When adding a new strategy, ensure it produces stable feature keys (deterministic naming) to avoid churn in generated docs and to make deduplication reliable.
- Be careful merging results: handle collisions (same name from different strategies) via scoring/priority rules and keep provenance (`sources`) for traceability.
- Integrate with parsers/ingestors at clear boundaries: this service should consume normalized parsed structures (AST/module/route/doc summaries), not raw filesystem or framework-specific internals.

<!-- source: function-generateslug-2.md -->

# generateSlug

**Kind:** Function

**Source:** `atloria-monorepo/packages/core/src/utils/slug.ts` (line 8)

Utility functions for generating and validating slugs

## Signature

```ts
function generateSlug(text: string): string
```

## Parameters

| Name | Type |
|---|---|
| `text` | `string` |

**Returns:** `string`

<!-- source: function-iscrpolling.md -->

# isCrPolling

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/cr-shared.ts` (line 92)

True while the worker owns the row and the UI should poll the CR.

## Signature

```ts
function isCrPolling(status: ChangeRequest['status']): boolean
```

## Parameters

| Name | Type |
|---|---|
| `status` | `ChangeRequest['status']` |

**Returns:** `boolean`

<!-- source: class-markdownparseerror.md -->

# MarkdownParseError

**Kind:** Class

**Source:** `atloria-monorepo/packages/editor/src/importMarkdownToLexical.ts` (line 162)

An error that gets thrown when the Markdown parsing fails due to a syntax error.

**Extends:** `Error`

<!-- source: interface-menuconfig.md -->

# MenuConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/BrandingContext.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `bgColor` | `string` |
| `textColor` | `string` |
| `height` | `number` |
| `borderColor` | `string` |
| `borderStyle` | `'solid' | 'none' | 'shadow'` |

<!-- source: type-modalclosemethod-2.md -->

# ModalCloseMethod

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 18)

How a modal should be closed

## Definition

```ts
'button-text' | 'data-dismiss' | 'escape' | 'backdrop' | 'auto'
```

<!-- source: constant-resource-ownership-key.md -->

# RESOURCE_OWNERSHIP_KEY

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/auth/guards/resource-org.guard.ts` (line 74)

<!-- source: function-stablestringify.md -->

# stableStringify

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/docs-repo/sidecar.ts` (line 88)

Deterministic JSON: object keys sorted recursively, 2-space indent, trailing newline. Arrays
keep their order (the caller has already ordered them meaningfully). This is what guarantees
byte-stability across reconciles for an unchanged logical input.

## Signature

```ts
function stableStringify(value: unknown): string
```

## Parameters

| Name | Type |
|---|---|
| `value` | `unknown` |

**Returns:** `string`

<!-- source: controller-trialcontroller.md -->

# TrialController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/trial/trial.controller.ts` (line 14)

Anonymous one-click trial for PUBLIC GitHub repos (Phase 1.1). Rate-limited per IP by
the AI cost guard + a global daily cap inside the service.

## Relationships

- MODULE_DECLARES → `generate`
- MODULE_DECLARES → `status`
- MODULE_DECLARES → `claim`
- DEPENDS_ON → `trialservice`

<!-- source: interface-uniqueconstraint.md -->

# UniqueConstraint

**Kind:** Interface

**Source:** `atloria-monorepo/apps/parser-orchestrator/src/interfaces/entity.interface.ts` (line 723)

Unique constraint definition

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `fields` | `string[]` |

<!-- source: class-vercelaimodelprovider.md -->

# VercelAIModelProvider

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/vercel-ai-adapter.ts` (line 33)

**Implements:** `IModelProvider`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getResponse` | `getResponse(request: ModelProviderRequest)` | `Promise<ModelProviderResponse>` |
| `getStreamedResponse` | `getStreamedResponse(request: ModelProviderRequest)` | `AsyncIterable<unknown>` |
| `getProfile` | `getProfile()` | `ModelCapabilityProfile` |

<!-- source: interface-captureconfig.md -->

# CaptureConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 202)

Configuration for the capture service

## Properties

| Property | Type |
|---|---|
| `outputDir` | `string` |
| `maxConcurrentSessions` | `number` |
| `maxRetries` | `number` |
| `retryDelayMs` | `number` |
| `screenshotTimeout` | `number` |
| `sessionTimeout` | `number` |
| `auth` | `AuthConfig` |

<!-- source: component-comparisonrow-2.md -->

# ComparisonRow

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/comparison-row.tsx` (line 16)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `featureKey` | `string` | ✓ | - |
| `values` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ComparisonRow_23b8f7bc["ComparisonRow"]
    class component_ComparisonRow_23b8f7bc rootComponent
```

## Relationships

- RENDERS → `Check`
- RENDERS → `X`
- USES_HOOK → `useTranslation`

<!-- source: constant-createactiveeditorsubscription.md -->

# createActiveEditorSubscription$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 666)

<!-- source: api-endpoint-createagent.md -->

# createAgent

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.controller.ts` (line 115)

## Endpoint

`POST /support-agent/:projectId/agents`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `SupportAgentController` (MODULE_DECLARES)

<!-- source: interface-createversiondto.md -->

# CreateVersionDto

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/services/document-version.service.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `comment` | `string` |

<!-- source: function-createworktreecontroltools.md -->

# createWorktreeControlTools

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/worktree-control.tool.ts` (line 29)

## Signature

```ts
function createWorktreeControlTools(options: WorktreeControlOptions): WorktreeControlTools<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `WorktreeControlOptions` |

**Returns:** `WorktreeControlTools<TContext>`

<!-- source: component-customtooltip.md -->

# CustomTooltip

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/DonutChart.tsx` (line 34)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `active` | `any` | ✓ | - |
| `payload` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomTooltip_6863ed1["CustomTooltip"]
    class component_CustomTooltip_6863ed1 rootComponent
```

## Referenced By

- `DonutChart` (RENDERS)

<!-- source: interface-entityrelationship.md -->

# EntityRelationship

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 92)

## Properties

| Property | Type |
|---|---|
| `sourceEntity` | `string` |
| `targetEntity` | `string` |
| `relationshipType` | `'one-to-many' | 'many-to-one' | 'one-to-one' | 'many-to-many'` |
| `propertyName` | `string` |
| `filePath` | `string` |
| `lineNumber` | `number` |

<!-- source: class-externalprogressdto.md -->

# ExternalProgressDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/documentation/dto/doc-automation.dto.ts` (line 571)

ExternalProgressDto — payload from atlorix-runner (or any external
generator) reporting a phase boundary or item progress on a job that
the api created.

## Properties

| Property | Type |
|---|---|
| `stage` | `string` |
| `progress` | `number` |
| `stageProgress` | `number` |
| `currentItem` | `string` |
| `eventType` | `string` |

<!-- source: function-extractpermissionsfromtemplate.md -->

# extractPermissionsFromTemplate

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/permission-extractor.ts` (line 187)

Extract permission checks from HTML templates.

Detects:
- Angular: *ngIf="hasPermission('x')", *ngIf="can('x')", *ngIf="isAdmin"
- Vue: v-if="hasPermission('x')", v-show="can('x')"
- React: {hasPermission('x') && <Component />}

## Signature

```ts
function extractPermissionsFromTemplate(templateContent: string, filePath: string, componentName: string, framework: 'angular' | 'vue' | 'react'): PermissionCheck[]
```

## Parameters

| Name | Type |
|---|---|
| `templateContent` | `string` |
| `filePath` | `string` |
| `componentName` | `string` |
| `framework` | `'angular' | 'vue' | 'react'` |

**Returns:** `PermissionCheck[]`

<!-- source: service-featuredocsgeneratorservice.md -->

# FeatureDocsGeneratorService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/feature-docs-generator.service.ts` (line 35)

Feature Documentation Generator Service

Generates comprehensive feature documentation using AI
Leverages Phase 2.1 & 3 context (state machines, UI interactions)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generateFeatureDocumentation` | `generateFeatureDocumentation(feature: DetectedFeature, options: {
      generatorProvider?: 'azure-claude' | 'azure-openai';
      reviewerProvider?: 'azure-claude' | 'azure-openai';
      enableReviewer?: boolean;
      businessContext?: any;
    })` | `Promise<FeatureDocumentation>` |

## Relationships

- DEPENDS_ON → `azureclaudeprovider`
- DEPENDS_ON → `azureopenaiprovider`

<!-- source: interface-filelocalization.md -->

# FileLocalization

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/types.ts` (line 61)

File localization metrics for a single task result.

## Properties

| Property | Type |
|---|---|
| `filesEdited` | `string[]` |
| `expectedFiles` | `string[]` |
| `overlap` | `string[]` |
| `recall` | `number` |
| `precision` | `number` |

<!-- source: function-generateusers.md -->

# generateUsers

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/examples/assets/dataCode.ts` (line 32)

## Signature

```ts
function generateUsers(length: number, startIndex)
```

## Parameters

| Name | Type |
|---|---|
| `length` | `number` |
| `startIndex` | `any` |

<!-- source: function-isemptyfilters.md -->

# isEmptyFilters

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 38)

## Signature

```ts
function isEmptyFilters(f: BoardFiltersState): boolean
```

## Parameters

| Name | Type |
|---|---|
| `f` | `BoardFiltersState` |

**Returns:** `boolean`

<!-- source: class-megafileindexer.md -->

# MegaFileIndexer

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/mega-file-indexer.ts` (line 47)

Mega File Indexer - Handles extremely large files with phased extraction

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectMegaFile` | `detectMegaFile(filePath: string)` | `Promise<MegaFileDetectionResult>` |
| `createIndex` | `createIndex(filePath: string)` | `Promise<MegaFileIndex>` |
| `extractAllPhases` | `extractAllPhases(filePath: string)` | `Promise<MegaFilePhaseExtractionResult>` |
| `loadSection` | `loadSection(filePath: string, startLine: number, endLine: number)` | `Promise<string>` |
| `loadEntity` | `loadEntity(index: MegaFileIndex, entityName: string)` | `Promise<string | null>` |

<!-- source: interface-metriccardprops.md -->

# MetricCardProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/MetricCard.tsx` (line 8)

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `value` | `number | null | undefined` |
| `previousValue` | `number | null` |
| `format` | `'number' | 'percent' | 'duration'` |
| `trend` | `number[]` |
| `icon` | `React.ReactNode` |
| `accent` | `string` |
| `onClick` | `() => void` |
| `loading` | `boolean` |

<!-- source: type-modaltriggertype-2.md -->

# ModalTriggerType

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 15)

InteractionMap Types

Defines the structure for source-code-derived interaction maps
that catalog all modals, tabs, forms, permissions, and workflow states
per route/component. Used by the hybrid screenshot mapper to generate
deterministic capture specs instead of AI guessing.

## Definition

```ts
'direct' | 'programmatic' | 'navigation'
```

<!-- source: constant-retrospectivetemplate.md -->

# retrospectiveTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/retrospective.template.ts` (line 3)

<!-- source: function-stripmarkdown.md -->

# stripMarkdown

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/search-index.ts` (line 94)

Strip markdown/HTML to readable plain text (cheap, no deps).

## Signature

```ts
function stripMarkdown(md: string): string
```

## Parameters

| Name | Type |
|---|---|
| `md` | `string` |

**Returns:** `string`

<!-- source: class-watchmode.md -->

# WatchMode

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/tools/watch-mode.ts` (line 28)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `start` | `start()` | `MarkerResult[]` |
| `stop` | `stop()` | `void` |
| `scanFile` | `scanFile(filePath: string)` | `MarkerResult[]` |
| `scanDirectory` | `scanDirectory(dirPath: string)` | `MarkerResult[]` |

<!-- source: controller-webhookcontroller.md -->

# WebhookController

**Kind:** Controller

**Source:** `atloria-monorepo/apps/api/src/webhooks/webhook.controller.ts` (line 12)

## Relationships

- MODULE_DECLARES → `handleGitHub`
- MODULE_DECLARES → `handleGitLab`
- MODULE_DECLARES → `handleAzureDevOps`
- DEPENDS_ON → `webhookservice`

<!-- source: interface-capturedscreenshot.md -->

# CapturedScreenshot

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 241)

Captured screenshot with hashes for deduplication

## Properties

| Property | Type |
|---|---|
| `placeholderId` | `string` |
| `description` | `string` |
| `localPath` | `string` |
| `blobUrl` | `string` |
| `contentHash` | `string` |
| `perceptualHash` | `string` |
| `dimensions` | `{ width: number; height: number }` |
| `fileSize` | `number` |
| `format` | `'png' | 'jpeg' | 'webp'` |
| `capturedAt` | `Date` |
| `uploadedAt` | `Date` |
| `isNew` | `boolean` |
| `reusedFromId` | `string` |
| `reusedFromUrl` | `string` |
| `parentPlaceholderId` | `string` |
| `sequenceOrder` | `number` |

<!-- source: component-comparisonsidebyside-2.md -->

# ComparisonSideBySide

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/comparison/comparison-side-by-side.tsx` (line 24)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `before` | `ComparisonColumn` | ✓ | - |
| `after` | `ComparisonColumn` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ComparisonSideBySide_1034af54["ComparisonSideBySide"]
    class component_ComparisonSideBySide_1034af54 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `X`
- RENDERS → `Check`
- USES_HOOK → `useTranslation`

<!-- source: api-endpoint-createconfig.md -->

# createConfig

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 49)

## Endpoint

`POST /doc-automation/config`

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: constant-createrooteditorsubscription.md -->

# createRootEditorSubscription$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 540)

<!-- source: function-createwritefiletool.md -->

# createWriteFileTool

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/write-file.tool.ts` (line 25)

## Signature

```ts
function createWriteFileTool(options: WriteFileOptions): ToolDefinition<TContext>
```

## Parameters

| Name | Type |
|---|---|
| `options` | `WriteFileOptions` |

**Returns:** `ToolDefinition<TContext>`

<!-- source: interface-crpendingresolution.md -->

# CrPendingResolution

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.service.ts` (line 51)

A section resolution awaiting its cr-restage commit (persisted on the row; the job carries
only the crId, mirroring how open's proposal travels).

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `resolvedContent` | `string` |
| `resolvedById` | `string | null` |

<!-- source: component-customtooltip-2.md -->

# CustomTooltip

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/TimeSeriesChart.tsx` (line 32)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `active` | `any` | ✓ | - |
| `payload` | `any` | ✓ | - |
| `label` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomTooltip_64b1f87["CustomTooltip"]
    class component_CustomTooltip_64b1f87 rootComponent
```

## Referenced By

- `TimeSeriesChart` (RENDERS)

<!-- source: interface-enumvalue.md -->

# EnumValue

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 86)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `value` | `number | string` |
| `description` | `string` |

<!-- source: function-extractpropsfromparameter-2.md -->

# extractPropsFromParameter

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 187)

Extract props from a function component's first parameter

## Signature

```ts
function extractPropsFromParameter(param: t.Node | null | undefined, typeDefinitions: TypeDefinitionMap): PropInfo[]
```

## Parameters

| Name | Type |
|---|---|
| `param` | `t.Node | null | undefined` |
| `typeDefinitions` | `TypeDefinitionMap` |

**Returns:** `PropInfo[]`

<!-- source: service-feedbackservice.md -->

# FeedbackService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/analytics/feedback.service.ts` (line 20)

Per-doc helpfulness feedback. One row per (sessionId, documentSlug) —
if a reader changes their mind and clicks the other thumb, the row
upserts in place.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `submit` | `submit(dto: SubmitFeedbackDto)` | `unknown` |
| `getSummary` | `getSummary(projectId: string, days: unknown)` | `unknown` |
| `getWorstRated` | `getWorstRated(projectId: string, days: unknown, limit: unknown, minRatings: unknown)` | `unknown` |
| `getRecentNegativeComments` | `getRecentNegativeComments(projectId: string, days: unknown, limit: unknown)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: class-finalizepmepagedto.md -->

# FinalizePmePageDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/pme/dto/pme.dto.ts` (line 45)

## Properties

| Property | Type |
|---|---|
| `pageId` | `string` |
| `sectionChoices` | `Record<string, 'A' | 'B' | 'C'>` |

<!-- source: function-getglobalratelimiter.md -->

# getGlobalRateLimiter

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/rate-limiter.ts` (line 173)

Get or create a global rate limiter instance

## Signature

```ts
function getGlobalRateLimiter(config: Partial<RateLimiterConfig>): RateLimiter
```

## Parameters

| Name | Type |
|---|---|
| `config` | `Partial<RateLimiterConfig>` |

**Returns:** `RateLimiter`

<!-- source: interface-gitbackendconfig.md -->

# GitBackendConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/git-backend.ts` (line 27)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `sessionId` | `string` |
| `staleAgeDays` | `number` |

<!-- source: function-ispaymentrequired.md -->

# isPaymentRequired

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/api-client.ts` (line 103)

True when the error is the fail-closed billing gate (HTTP 402).

## Signature

```ts
function isPaymentRequired(err: unknown): boolean
```

## Parameters

| Name | Type |
|---|---|
| `err` | `unknown` |

**Returns:** `boolean`

<!-- source: class-metricscollector.md -->

# MetricsCollector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/pipeline-metrics.ts` (line 134)

Mutable collector that stages push data into during the run.
Call `toJSON()` at the end to get the final snapshot.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `stageStart` | `stageStart(name: string)` | `void` |
| `stageEnd` | `stageEnd(name: string, status: 'success' | 'failed' | 'skipped')` | `void` |
| `addTokenUsage` | `addTokenUsage(stage: string, input: number, output: number)` | `void` |
| `addScreenshotFailure` | `addScreenshotFailure(url: string, reason: string)` | `void` |
| `addQualityScore` | `addQualityScore(docId: string, title: string, score: number, passed: boolean)` | `void` |
| `addVerificationScore` | `addVerificationScore(docId: string, title: string, accuracy: number, claims: number, flagged: number)` | `void` |
| `toJSON` | `toJSON()` | `PipelineMetrics` |

## Properties

| Property | Type |
|---|---|
| `tokens` | `PipelineMetrics['tokens']` |
| `screenshots` | `PipelineMetrics['screenshots']` |
| `quality` | `PipelineMetrics['quality']` |
| `extraction` | `PipelineMetrics['extraction']` |
| `documents` | `PipelineMetrics['documents']` |

<!-- source: interface-navdoc.md -->

# NavDoc

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/PrevNextNav.tsx` (line 8)

## Properties

| Property | Type |
|---|---|
| `slug` | `string` |
| `title` | `string` |

<!-- source: type-pagetype-2.md -->

# PageType

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/site-map.types.ts` (line 63)

## Definition

```ts
'list' | 'detail' | 'form' | 'dashboard' | 'settings' | 'report' | 'unknown'
```

<!-- source: constant-roles-key.md -->

# ROLES_KEY

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/auth/decorators/roles.decorator.ts` (line 5)

<!-- source: function-terms.md -->

# terms

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/manuals-insights/manuals-insights.service.ts` (line 29)

Lowercase → alphanumeric words of length >= 3, minus stopwords.

## Signature

```ts
function terms(s: string | null | undefined): string[]
```

## Parameters

| Name | Type |
|---|---|
| `s` | `string | null | undefined` |

**Returns:** `string[]`

<!-- source: class-websockettransport.md -->

# WebSocketTransport

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/protocol/websocket-transport.ts` (line 45)

**Implements:** `AgentTransport`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `handleEvent` | `handleEvent(event: AgentProtocolEvent)` | `void` |

<!-- source: interface-captureprogress.md -->

# CaptureProgress

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-capturer.service.ts` (line 27)

Progress callback for capture operations

## Properties

| Property | Type |
|---|---|
| `completed` | `number` |
| `total` | `number` |
| `currentItem` | `string` |
| `currentGroup` | `string` |

<!-- source: component-conditionalcontents.md -->

# ConditionalContents

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/toolbar.tsx` (line 296)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `options` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ConditionalContents_51c33312["ConditionalContents"]
    class component_ConditionalContents_51c33312 rootComponent
```

## Relationships

- USES_HOOK → `useCellValue`
- USES_HOOK → `useMemo`

<!-- source: api-endpoint-createconnector.md -->

# createConnector

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 268)

## Endpoint

`POST /technical-docs/:projectId/connectors`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: interface-crproposedfile.md -->

# CrProposedFile

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.service.ts` (line 9)

files as stored on a draft row: the proposal travels in the row (the job carries only crId).

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `proposedContent` | `string` |

<!-- source: constant-currentblocktype.md -->

# currentBlockType$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 785)

Holds the current block type of the selection (i.e. Heading, Paragraph, etc).

<!-- source: component-dailybarchart.md -->

# DailyBarChart

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/page.tsx` (line 225)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `data` | `TrendPoint[]` | ✓ | - |
| `height` | `number` | - | 240 |

## Diagram

```mermaid
graph TD
    component_DailyBarChart_24135fa3["DailyBarChart"]
    class component_DailyBarChart_24135fa3 rootComponent
```

## Relationships

- RENDERS → `ResponsiveContainer`
- RENDERS → `BarChart`
- RENDERS → `CartesianGrid`
- RENDERS → `XAxis`
- RENDERS → `YAxis`
- RENDERS → `RTooltip`
- RENDERS → `Bar`

## Referenced By

- `IssuesListPage` (RENDERS)

<!-- source: function-deduplicateissues.md -->

# deduplicateIssues

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/confidence-filter.ts` (line 155)

Deduplicate issues from multiple agents.

Two issues are considered duplicates when they share the same file, line, and category.
When duplicates are found, the issue with the highest confidence is kept.

## Signature

```ts
function deduplicateIssues(issues: ScoredIssue[]): ScoredIssue[]
```

## Parameters

| Name | Type |
|---|---|
| `issues` | `ScoredIssue[]` |

**Returns:** `ScoredIssue[]`

<!-- source: interface-envvariableentity-2.md -->

# EnvVariableEntity

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 1003)

Environment variable entity

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.ENV_VARIABLE` |
| `variableName` | `string` |
| `exampleValue` | `string` |
| `isSensitive` | `boolean` |
| `isRequired` | `boolean` |
| `category` | `string` |

<!-- source: function-extractpropsfromtypeannotation-2.md -->

# extractPropsFromTypeAnnotation

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 267)

Extract props from TypeScript type annotation

## Signature

```ts
function extractPropsFromTypeAnnotation(typeNode: t.TSType, typeDefinitions: TypeDefinitionMap): PropInfo[]
```

## Parameters

| Name | Type |
|---|---|
| `typeNode` | `t.TSType` |
| `typeDefinitions` | `TypeDefinitionMap` |

**Returns:** `PropInfo[]`

<!-- source: service-filecontextservice.md -->

# FileContextService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/ai/services/file-context.service.ts` (line 49)

Optimized file context service inspired by Claude Code & Cursor

Key optimizations:
1. Lazy loading - Only read files when needed
2. Chunking - Read files in segments (line ranges)
3. Token counting - Estimate tokens before sending
4. Caching - Cache file contents with invalidation
5. Smart filtering - Skip irrelevant files (node_modules, binaries, etc.)
6. Relevance ranking - Prioritize most relevant files

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getFileMetadata` | `getFileMetadata(filePath: string)` | `Promise<FileMetadata>` |
| `readFile` | `readFile(filePath: string)` | `Promise<string>` |
| `readFileChunk` | `readFileChunk(filePath: string, startLine: number, endLine: number)` | `Promise<FileChunk>` |
| `findRelevantFiles` | `findRelevantFiles(baseDir: string, patterns: string[], options: {
      maxFiles?: number;
      maxTokens?: number;
      exclude?: string[];
    })` | `Promise<FileMetadata[]>` |
| `buildContext` | `buildContext(files: string[], budget: number, keywords: string[])` | `Promise<{
    chunks: FileChunk[];
    budget: ContextBudget;
    skippedFiles: string[];
  }>` |
| `estimateTokens` | `estimateTokens(content: string)` | `number` |
| `clearCache` | `clearCache(filePath: string)` | `void` |
| `getCacheStats` | `getCacheStats()` | `unknown` |
| `formatChunksForAI` | `formatChunksForAI(chunks: FileChunk[], baseDir: string)` | `string` |

<!-- source: class-forgotpassworddto.md -->

# ForgotPasswordDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/auth/dto/password.dto.ts` (line 11)

## Properties

| Property | Type |
|---|---|
| `email` | `string` |

<!-- source: function-getinitialtheme.md -->

# getInitialTheme

**Kind:** Function

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/theme.ts` (line 126)

## Signature

```ts
function getInitialTheme(defaultMode: ThemeMode): ThemeMode
```

## Parameters

| Name | Type |
|---|---|
| `defaultMode` | `ThemeMode` |

**Returns:** `ThemeMode`

<!-- source: interface-globsearchoptions.md -->

# GlobSearchOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/glob-search.tool.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `maxResults` | `number` |
| `excludePatterns` | `string[]` |

<!-- source: function-isvalidurlid.md -->

# isValidUrlId

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/url-utils.ts` (line 93)

Validate a URL ID format
Must be exactly 10 alphanumeric characters

## Signature

```ts
function isValidUrlId(urlId: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `urlId` | `string` |

**Returns:** `boolean`

<!-- source: class-nestjsdetector.md -->

# NestJSDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/nestjs-detector.ts` (line 98)

NestJS Detector

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectControllers` | `detectControllers(entities: Entity[])` | `DetectedNestJSController[]` |
| `detectServices` | `detectServices(entities: Entity[])` | `DetectedNestJSService[]` |
| `getControllerSummary` | `getControllerSummary(controller: DetectedNestJSController)` | `string` |

<!-- source: interface-parseddocumenturl.md -->

# ParsedDocumentUrl

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/lib/url-utils.ts` (line 6)

URL utilities for document navigation
Client-side URL parsing and building functions

## Properties

| Property | Type |
|---|---|
| `slug` | `string` |
| `urlId` | `string` |
| `audience` | `string` |

<!-- source: type-personaclassification.md -->

# PersonaClassification

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 126)

## Definition

```ts
'admin' | 'user'
```

<!-- source: constant-securityincidenttemplate.md -->

# securityIncidentTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/security-incident.template.ts` (line 3)

<!-- source: function-tokenize.md -->

# tokenize

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/search-index.ts` (line 125)

Lowercased, deduped, stopword-filtered significant tokens (capped).

## Signature

```ts
function tokenize(text: string): string[]
```

## Parameters

| Name | Type |
|---|---|
| `text` | `string` |

**Returns:** `string[]`

<!-- source: class-worktreemanager.md -->

# WorktreeManager

**Kind:** Class

**Source:** `atloria-monorepo/libs/agent-core/src/tools/worktree-manager.ts` (line 49)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `isGitRepo` | `isGitRepo()` | `boolean` |
| `create` | `create(name: string)` | `WorktreeInfo` |
| `remove` | `remove(name: string)` | `void` |
| `list` | `list()` | `WorktreeInfo[]` |
| `diff` | `diff(name: string)` | `string` |
| `hasChanges` | `hasChanges(name: string)` | `boolean` |
| `activeCount` | `activeCount()` | `number` |
| `pruneStale` | `pruneStale()` | `number` |

<!-- source: interface-captureresult.md -->

# CaptureResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 186)

Result of capturing a single screenshot

## Properties

| Property | Type |
|---|---|
| `placeholderId` | `string` |
| `success` | `boolean` |
| `localPath` | `string` |
| `screenshotId` | `string` |
| `blobUrl` | `string` |
| `error` | `string` |
| `capturedAt` | `Date` |
| `dimensions` | `{ width: number; height: number }` |
| `fileSize` | `number` |
| `retryCount` | `number` |

<!-- source: component-conditionalrendering.md -->

# ConditionalRendering

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 372)

## Diagram

```mermaid
graph TD
    component_ConditionalRendering_142f3310["ConditionalRendering"]
    class component_ConditionalRendering_142f3310 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `UndoRedo`
- USES_HOOK → `useState`

<!-- source: api-endpoint-createcustomdomain.md -->

# createCustomDomain

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 369)

## Endpoint

`POST /projects/:id/custom-domain`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: constant-currentformat.md -->

# currentFormat$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 171)

Holds the current format of the selection.

<!-- source: interface-cursorposition-2.md -->

# CursorPosition

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/collaboration/interfaces/collaboration.interfaces.ts` (line 30)

Cursor position in the document

## Properties

| Property | Type |
|---|---|
| `index` | `number` |
| `length` | `number` |

<!-- source: component-demoterminal.md -->

# DemoTerminal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/page.tsx` (line 102)

## Diagram

```mermaid
graph TD
    component_DemoTerminal_27cbe349["DemoTerminal"]
    class component_DemoTerminal_27cbe349 rootComponent
```

## Relationships

- RENDERS → `motion-span`
- RENDERS → `motion-div`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

## Referenced By

- `HomePage` (RENDERS)

<!-- source: function-detectzeroprogress.md -->

# detectZeroProgress

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/agent-hardening.ts` (line 118)

Detect consecutive turns with zero tokens (likely API failures).

If the last N turns all produced 0 tokens, the agent is stuck —
probably hitting rate limits or auth errors silently.

## Signature

```ts
function detectZeroProgress(turnHistory: Array<{ tokens: number }>, threshold: number): boolean
```

## Parameters

| Name | Type |
|---|---|
| `turnHistory` | `Array<{ tokens: number }>` |
| `threshold` | `number` |

**Returns:** `boolean`

<!-- source: interface-errorhandlingpattern.md -->

# ErrorHandlingPattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-management.interface.ts` (line 401)

Error handling pattern

## Properties

| Property | Type |
|---|---|
| `errorField` | `string` |
| `errorActions` | `string[]` |
| `errorMessages` | `string[]` |
| `recoveryActions` | `Array<{
    name: string;
    description: string;
  }>` |
| `hasRetry` | `boolean` |
| `errorBoundaries` | `string[]` |

<!-- source: function-extractrenderedcomponents-2.md -->

# extractRenderedComponents

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 506)

Extract rendered child components (JSX elements that start with uppercase)

## Signature

```ts
function extractRenderedComponents(path: NodePath): string[]
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath` |

**Returns:** `string[]`

<!-- source: service-flowdetectorservice.md -->

# FlowDetectorService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/graph/services/flow-detector.service.ts` (line 9)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectFlow` | `detectFlow(projectId: string, entityId: string, flowName: string)` | `Promise<Flow>` |
| `detectImpact` | `detectImpact(projectId: string, entityId: string)` | `Promise<KGEntity[]>` |

## Relationships

- DEPENDS_ON → `knowledgegraphservice`

<!-- source: class-generatefromneo4jdto.md -->

# GenerateFromNeo4jDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/documentation/dto/generate-from-neo4j.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `types` | `('overview' | 'guides' | 'tutorials' | 'features')[]` |
| `saveToDatabase` | `boolean` |
| `createCategories` | `boolean` |

<!-- source: function-getselectednode.md -->

# getSelectedNode

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/lexicalHelpers.ts` (line 29)

Gets the selected node from the Lexical editor.

## Signature

```ts
function getSelectedNode(selection: RangeSelection): TextNode | ElementNode | null
```

## Parameters

| Name | Type |
|---|---|
| `selection` | `RangeSelection` |

**Returns:** `TextNode | ElementNode | null`

<!-- source: interface-grepsearchoptions.md -->

# GrepSearchOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/grep-search.tool.ts` (line 17)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `maxResults` | `number` |
| `maxFileSize` | `number` |
| `excludePatterns` | `string[]` |

<!-- source: function-loadfilters.md -->

# loadFilters

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 138)

## Signature

```ts
function loadFilters(boardId: string): BoardFiltersState
```

## Parameters

| Name | Type |
|---|---|
| `boardId` | `string` |

**Returns:** `BoardFiltersState`

<!-- source: class-networkerror.md -->

# NetworkError

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/types/errors.ts` (line 19)

Network error (connection issues, timeouts, etc.)

**Extends:** `APIError`

<!-- source: interface-parsingresultsprops.md -->

# ParsingResultsProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Parser/ParsingResults.tsx` (line 11)

## Properties

| Property | Type |
|---|---|
| `result` | `ParseResult` |
| `code` | `string` |
| `className` | `string` |

<!-- source: type-providerfamily.md -->

# ProviderFamily

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/prompt-adapter.ts` (line 15)

## Definition

```ts
'claude' | 'gpt'
```

<!-- source: constant-slug-registry-path.md -->

# SLUG_REGISTRY_PATH

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/docs-repo/sidecar.ts` (line 81)

<!-- source: function-torichtext.md -->

# toRichText

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/md-to-notion-blocks.ts` (line 34)

Tokenize one line of markdown into Notion rich-text runs (code / bold / italic / link).

## Signature

```ts
function toRichText(s: string): NotionRichText[]
```

## Parameters

| Name | Type |
|---|---|
| `s` | `string` |

**Returns:** `NotionRichText[]`

<!-- source: interface-categoryfiltersdto.md -->

# CategoryFiltersDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/category.dto.ts` (line 35)

DTO for category query filters

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `parentId` | `string` |

<!-- source: component-conditionaltoolbar.md -->

# ConditionalToolbar

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/toolbar.tsx` (line 102)

## Diagram

```mermaid
graph TD
    component_ConditionalToolbar_70eef2a1["ConditionalToolbar"]
    class component_ConditionalToolbar_70eef2a1 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `UndoRedo`
- RENDERS → `BoldItalicUnderlineToggles`
- RENDERS → `ListsToggle`
- RENDERS → `Separator`
- RENDERS → `BlockTypeSelect`
- RENDERS → `CreateLink`
- RENDERS → `InsertImage`
- USES_HOOK → `useState`

<!-- source: api-endpoint-createentity.md -->

# createEntity

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/graph.controller.ts` (line 39)

## Endpoint

`POST /knowledge-graph/entities`

## Referenced By

- `GraphController` (MODULE_DECLARES)

<!-- source: constant-currentlisttype.md -->

# currentListType$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/lists/index.ts` (line 53)

The current list type in the editor.

<!-- source: interface-customdomainview-2.md -->

# CustomDomainView

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/project/project-domains.service.ts` (line 27)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `domain` | `string` |
| `status` | `string` |
| `records` | `DnsRecordSpec[]` |
| `lastError` | `string | null` |
| `lastCheckedAt` | `Date | null` |
| `verifiedAt` | `Date | null` |
| `createdAt` | `Date` |

<!-- source: component-dependencycard.md -->

# DependencyCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/DependencyGraph.tsx` (line 60)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `dependency` | `Dependency` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DependencyCard_765e4510["DependencyCard"]
    class component_DependencyCard_765e4510 rootComponent
```

## Relationships

- RENDERS → `ExternalIcon`
- RENDERS → `InternalIcon`

## Referenced By

- `DependencyGraph` (RENDERS)

<!-- source: function-estimatetokens.md -->

# estimateTokens

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/context/context-manager.ts` (line 50)

Estimate tokens from string length (rough: ~4 chars per token).

## Signature

```ts
function estimateTokens(text: string): number
```

## Parameters

| Name | Type |
|---|---|
| `text` | `string` |

**Returns:** `number`

<!-- source: interface-eventdefinition-2.md -->

# EventDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 456)

Event definition (Vue, Angular)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `payload` | `string` |
| `description` | `string` |

<!-- source: function-extractstatetransitions.md -->

# extractStateTransitions

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/state-machine-analyzer.ts` (line 123)

Extract state transitions from code by analyzing methods and state assignments

## Signature

```ts
function extractStateTransitions(code: string, enumName: string): StateTransition[]
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string` |
| `enumName` | `string` |

**Returns:** `StateTransition[]`

<!-- source: service-flowdraftstitcherservice.md -->

# FlowDraftStitcherService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/capture/flow-draft-stitcher.service.ts` (line 43)

FlowDraftStitcherService (WS-A, api side).

Background poll loop: watches a flow-replay job on the screenshot-worker and,
as each step's screenshot becomes available, replaces that step's
`[SCREENSHOT: flow-step-N]` placeholder in the draft Document's markdown with a
real annotated image `![Step N](<blobUrl>#atloria-annotations=…)`. When the job
finishes it clears `metadata.screenshotsPending` and strips any placeholders for
steps that never produced a screenshot (they degrade to text via the reader's
remarkStripScreenshots). Runs HTTP-only — no browser on the api pod.

`FlowDraftStitcherService` runs on the API side to poll screenshot-worker flow-replay jobs and stitch completed step screenshots into a draft document. As screenshots become available, it replaces `[SCREENSHOT: flow-step-N]` markdown placeholders with annotated image URLs; when the replay completes, it clears `metadata.screenshotsPending` and removes unresolved placeholders.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `start` | `start(params: StartStitchParams)` | `void` |

## Diagram

```mermaid
sequenceDiagram
  participant API as FlowDraftStitcherService
  participant Worker as screenshot-worker
  participant Draft as Draft Document Store

  loop While flow-replay job is pending
    API->>Worker: Poll flow-replay job status
    Worker-->>API: Completed steps and screenshot blob URLs

    loop For each newly completed step
      API->>Draft: Load draft markdown
      API->>API: Replace [SCREENSHOT: flow-step-N]
      API->>Draft: Save annotated image markdown
    end
  end

  Worker-->>API: Job finished
  API->>Draft: Clear metadata.screenshotsPending
  API->>Draft: Remove unresolved screenshot placeholders
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { FlowDraftStitcherService } from './flow-draft-stitcher.service';

@Injectable()
export class FlowReplayCoordinator {
  constructor(
    private readonly flowDraftStitcher: FlowDraftStitcherService,
  ) {}

  async startStitching(params: {
    draftId: string;
    replayJobId: string;
  }): Promise<void> {
    await this.flowDraftStitcher.stitchFlowDraft({
      draftId: params.draftId,
      replayJobId: params.replayJobId,
    });
  }
}
```

## AI Coding Instructions

- Keep this service HTTP-only: communicate with screenshot-worker through its API and do not introduce browser, Playwright, or local screenshot dependencies.
- Preserve the exact placeholder format, `[SCREENSHOT: flow-step-N]`, so replacements remain deterministic and idempotent.
- Only replace placeholders for newly available screenshots; avoid rewriting already stitched image markdown on subsequent poll iterations.
- When a replay job reaches a terminal state, clear `metadata.screenshotsPending` and remove unresolved placeholders so the document reader can degrade remaining content safely.
- Ensure annotated image URLs use the expected `#atloria-annotations=…` fragment format consumed by the document renderer.

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: class-generateoutlinedto.md -->

# GenerateOutlineDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/ai/dto/generate-outline.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `topic` | `string` |
| `audience` | `string` |
| `provider` | `string` |

<!-- source: function-getselectionasmarkdown.md -->

# getSelectionAsMarkdown

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/lexicalHelpers.ts` (line 120)

Gets the markdown representation of the current selection in the Lexical editor.
Returns an empty string if there is no selection or if the selection is collapsed.
Converts selected nodes to markdown by recursively processing them and preserving formatting.
Note: Selects entire nodes, not partial selections within nodes.

## Signature

```ts
function getSelectionAsMarkdown(editor: LexicalEditor, _exportParams: Omit<ExportMarkdownFromLexicalOptions, 'root'>): string
```

## Parameters

| Name | Type |
|---|---|
| `editor` | `LexicalEditor` |
| `_exportParams` | `Omit<ExportMarkdownFromLexicalOptions, 'root'>` |

**Returns:** `string`

<!-- source: interface-guardraildefinition.md -->

# GuardrailDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 158)

Guardrail definitions.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `execute` | `(input: string) => Promise<GuardrailResult>` |

<!-- source: function-markdowntohtml.md -->

# markdownToHtml

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/markdown-converter.ts` (line 44)

Convert Markdown to HTML

## Signature

```ts
async function markdownToHtml(markdown: string): Promise<string>
```

## Parameters

| Name | Type |
|---|---|
| `markdown` | `string` |

**Returns:** `Promise<string>`

<!-- source: class-nextjsdetector.md -->

# NextJSDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/nextjs-detector.ts` (line 64)

Next.js Detector

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectPages` | `detectPages(entities: Entity[])` | `DetectedNextJSPage[]` |
| `detectAPIRoutes` | `detectAPIRoutes(entities: Entity[])` | `DetectedNextJSAPIRoute[]` |
| `getPageSummary` | `getPageSummary(page: DetectedNextJSPage)` | `string` |

<!-- source: interface-pmejob.md -->

# PmeJob

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/stores/pmeStore.ts` (line 12)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `projectId` | `string` |
| `status` | `PmeJobStatus` |
| `progress` | `number` |
| `stage` | `string` |
| `message` | `string` |
| `error` | `string` |
| `pages` | `PmePage[]` |
| `createdAt` | `string` |
| `completedAt` | `string` |

<!-- source: type-readonlyclicklinkcallback.md -->

# ReadOnlyClickLinkCallback

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 347)

## Definition

```ts
(event: MouseEvent, node: LinkNode, url: string) => void
```

<!-- source: constant-soptemplate.md -->

# sopTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/sop.template.ts` (line 3)

<!-- source: function-transformsnapshottodocset.md -->

# transformSnapshotToDocSet

**Kind:** Function

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-materializer.service.ts` (line 231)

Pure transform: navMap + entities + relationships → category tree + entity
reference pages. Deterministic (stable ordering, stable slug dedupe) so
re-runs produce identical output for identical snapshots.

## Signature

```ts
function transformSnapshotToDocSet(navMap: TechnicalNavMap, entities: SnapshotEntity[], relationships: SnapshotRelationship[], options: MaterializeOptions): TechnicalDocSet
```

## Parameters

| Name | Type |
|---|---|
| `navMap` | `TechnicalNavMap` |
| `entities` | `SnapshotEntity[]` |
| `relationships` | `SnapshotRelationship[]` |
| `options` | `MaterializeOptions` |

**Returns:** `TechnicalDocSet`

<!-- source: interface-categorynode.md -->

# CategoryNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 134)

Hierarchical category node

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `icon` | `string` |
| `order` | `number` |
| `level` | `number` |
| `path` | `string` |
| `documents` | `DocumentNode[]` |
| `subcategories` | `CategoryNode[]` |

<!-- source: component-contactform.md -->

# ContactForm

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/layout/contact-form.tsx` (line 38)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `fields` | `FormField[]` | ✓ | - |
| `submitLabelKey` | `string` | ✓ | - |
| `successMessageKey` | `string` | ✓ | - |
| `errorMessageKey` | `string` | ✓ | - |
| `siteId` | `string` | ✓ | - |
| `apiUrl` | `string` | - | "https://api.atloria.app/v1/forms" |
| `headlineKey` | `string` | - | - |
| `descriptionKey` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_ContactForm_36c615a1["ContactForm"]
    class component_ContactForm_36c615a1 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `CheckCircle`
- RENDERS → `AlertCircle`
- RENDERS → `Send`
- USES_HOOK → `useTranslation`
- USES_HOOK → `useState`

<!-- source: api-endpoint-createjob.md -->

# createJob

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/pme/pme.controller.ts` (line 34)

## Endpoint

`POST /pme/generate`

## Referenced By

- `PmeController` (MODULE_DECLARES)

<!-- source: constant-currentselection.md -->

# currentSelection$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 204)

Holds the current selection.

<!-- source: interface-dependency.md -->

# Dependency

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/parser/interfaces/code-parser.interface.ts` (line 44)

## Properties

| Property | Type |
|---|---|
| `source` | `string` |
| `symbols` | `string[]` |
| `type` | `'import' | 'require' | 'include'` |
| `isExternal` | `boolean` |

<!-- source: component-diffchunkblock.md -->

# DiffChunkBlock

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/documents/[id]/compare/page.tsx` (line 605)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `chunk` | `DiffChunk` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DiffChunkBlock_6e9df7bc["DiffChunkBlock"]
    class component_DiffChunkBlock_6e9df7bc rootComponent
```

## Relationships

- RENDERS → `MarkdownRenderer`

## Referenced By

- `SideBySideDiff` (RENDERS)

<!-- source: interface-exportinfo-2.md -->

# ExportInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 505)

Export information

## Properties

| Property | Type |
|---|---|
| `isDefault` | `boolean` |
| `namedExports` | `string[]` |

<!-- source: function-extracttabs.md -->

# extractTabs

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/tab-extractor.ts` (line 405)

## Signature

```ts
function extractTabs(templateContent: string | undefined, filePath: string, componentName: string, framework: 'angular' | 'vue' | 'react'): TabDefinition[]
```

## Parameters

| Name | Type |
|---|---|
| `templateContent` | `string | undefined` |
| `filePath` | `string` |
| `componentName` | `string` |
| `framework` | `'angular' | 'vue' | 'react'` |

**Returns:** `TabDefinition[]`

<!-- source: function-filterbyconfidence.md -->

# filterByConfidence

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/confidence-filter.ts` (line 142)

Filter to high-confidence issues only.

## Signature

```ts
function filterByConfidence(issues: ScoredIssue[], threshold): ScoredIssue[]
```

## Parameters

| Name | Type |
|---|---|
| `issues` | `ScoredIssue[]` |
| `threshold` | `any` |

**Returns:** `ScoredIssue[]`

<!-- source: service-freshnessservice.md -->

# FreshnessService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/freshness.service.ts` (line 65)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `stale` | `stale(projectId: string, organizationId: string)` | `Promise<StaleResult>` |
| `reshoot` | `reshoot(projectId: string, user: JwtPayload)` | `Promise<ReshootResult>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `docautomationservice`

<!-- source: class-generateuserdocsdto.md -->

# GenerateUserDocsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/documentation/dto/generate-user-docs.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `appMap` | `any` |
| `screenshots` | `Record<string, any[]>` |
| `businessContext` | `{
    marketing: string[];
    workflows: string[];
    brand: string[];
    processes: string[];
  }` |
| `workflows` | `string[]` |
| `enableReviewer` | `boolean` |
| `generatorProvider` | `'azure-claude' | 'azure-openai'` |
| `reviewerProvider` | `'azure-claude' | 'azure-openai'` |
| `projectId` | `string` |
| `enableCompetitorResearch` | `boolean` |
| `projectType` | `string` |
| `projectDescription` | `string` |
| `saveIncremental` | `boolean` |

<!-- source: function-getselectionrectangle.md -->

# getSelectionRectangle

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/lexicalHelpers.ts` (line 54)

Gets the coordinates of the selection in the Lexical editor.

## Signature

```ts
function getSelectionRectangle(editor: LexicalEditor)
```

## Parameters

| Name | Type |
|---|---|
| `editor` | `LexicalEditor` |

<!-- source: interface-guardrailresult.md -->

# GuardrailResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 168)

## Properties

| Property | Type |
|---|---|
| `passed` | `boolean` |
| `message` | `string` |
| `metadata` | `Record<string, unknown>` |

<!-- source: function-matchesfilters.md -->

# matchesFilters

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 59)

Apply filters client-side to a card

## Signature

```ts
function matchesFilters(card: BoardCardData, f: BoardFiltersState, knownAssigneeIds: Set<string>): boolean
```

## Parameters

| Name | Type |
|---|---|
| `card` | `BoardCardData` |
| `f` | `BoardFiltersState` |
| `knownAssigneeIds` | `Set<string>` |

**Returns:** `boolean`

<!-- source: class-notfounderror.md -->

# NotFoundError

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/types/errors.ts` (line 66)

Not found error (404 Not Found)

**Extends:** `APIError`

<!-- source: interface-pmepage.md -->

# PmePage

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/stores/pmeStore.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `pageType` | `string` |
| `htmlUrl` | `string` |
| `htmlContent` | `string` |
| `variants` | `PmeVariant[]` |

<!-- source: type-rectdata.md -->

# RectData

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 26)

Describes the boundaries of the current selection so that the link dialog can position itself accordingly.

## Definition

```ts
Pick<DOMRect, 'height' | 'width' | 'top' | 'left'>
```

<!-- source: constant-sprintplanningtemplate.md -->

# sprintPlanningTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/sprint-planning.template.ts` (line 3)

<!-- source: interface-categoryupsertresult.md -->

# CategoryUpsertResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 269)

Category upsert result

## Properties

| Property | Type |
|---|---|
| `operation` | `UpsertOperation` |
| `category` | `{
    id: string; // Database ID
    slug: string;
    name: string;
  }` |

<!-- source: component-cookiebanner.md -->

# CookieBanner

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/layout/cookie-banner.tsx` (line 35)

## Diagram

```mermaid
graph TD
    component_CookieBanner_4a8c72a9["CookieBanner"]
    class component_CookieBanner_4a8c72a9 rootComponent
```

## Relationships

- RENDERS → `AnimatePresence`
- RENDERS → `motion-div`
- USES_HOOK → `useTranslation`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: api-endpoint-createrelation.md -->

# createRelation

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/graph.controller.ts` (line 48)

## Endpoint

`POST /knowledge-graph/relations`

## Referenced By

- `GraphController` (MODULE_DECLARES)

<!-- source: constant-deep-load-triggers.md -->

# DEEP_LOAD_TRIGGERS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-10.types.ts` (line 139)

Deep Load Trigger - Conditions that trigger deep loading

<!-- source: interface-detectedfeature.md -->

# DetectedFeature

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/feature-detector.service.ts` (line 18)

Detected feature from codebase analysis

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `category` | `string` |
| `components` | `any[]` |
| `services` | `any[]` |
| `routes` | `string[]` |
| `stateMachines` | `any[]` |
| `uiInteractions` | `any[]` |
| `codeExamples` | `CodeExample[]` |
| `configOptions` | `{
    envVars: string[];
    settings: Record<string, any>;
  }` |
| `complexity` | `'simple' | 'moderate' | 'complex'` |
| `userRoles` | `string[]` |
| `prerequisites` | `string[]` |
| `relatedFeatures` | `string[]` |

<!-- source: component-difflinerow.md -->

# DiffLineRow

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/documents/[id]/compare/page.tsx` (line 479)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `line` | `DiffLine` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DiffLineRow_34bae6d6["DiffLineRow"]
    class component_DiffLineRow_34bae6d6 rootComponent
```

## Referenced By

- `UnifiedDiff` (RENDERS)

<!-- source: interface-extensioncategories.md -->

# ExtensionCategories

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/file-scanner.ts` (line 60)

Supported file extension categories

## Properties

| Property | Type |
|---|---|
| `typescript` | `string[]` |
| `javascript` | `string[]` |
| `styles` | `string[]` |
| `config` | `string[]` |
| `documentation` | `string[]` |
| `templates` | `string[]` |

<!-- source: function-extracttabsfromtemplate.md -->

# extractTabsFromTemplate

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/tab-extractor.ts` (line 358)

Extract tab definitions from an HTML/template string.

Uses htmlparser2 to parse the template and walks the DOM tree looking for
known tab-group patterns across Angular, React, and Vue frameworks.

## Signature

```ts
function extractTabsFromTemplate(templateContent: string, filePath: string, componentName: string, framework: 'angular' | 'vue' | 'react'): TabDefinition[]
```

## Parameters

| Name | Type |
|---|---|
| `templateContent` | `string` |
| `filePath` | `string` |
| `componentName` | `string` |
| `framework` | `'angular' | 'vue' | 'react'` |

**Returns:** `TabDefinition[]`

<!-- source: function-filtertoolsbymode.md -->

# filterToolsByMode

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/tool-profiles.ts` (line 129)

Filter a list of tool definitions down to those allowed by the given mode.
Tools not in the profile are omitted. When mode is 'full', returns all tools.

## Signature

```ts
function filterToolsByMode(tools: T[], mode: TaskMode): T[]
```

## Parameters

| Name | Type |
|---|---|
| `tools` | `T[]` |
| `mode` | `TaskMode` |

**Returns:** `T[]`

<!-- source: function-getstateasmarkdown.md -->

# getStateAsMarkdown

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/lexicalHelpers.ts` (line 102)

## Signature

```ts
function getStateAsMarkdown(editor: LexicalEditor, exportParams: Omit<ExportMarkdownFromLexicalOptions, 'root'>)
```

## Parameters

| Name | Type |
|---|---|
| `editor` | `LexicalEditor` |
| `exportParams` | `Omit<ExportMarkdownFromLexicalOptions, 'root'>` |

<!-- source: service-gitcloneservice.md -->

# GitCloneService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/parsing/git-clone.service.ts` (line 32)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `clone` | `clone(options: CloneOptions)` | `Promise<CloneResult>` |
| `testAccess` | `testAccess(options: {
    repositoryUrl: string;
    provider: RepositoryProvider;
    credentials?: RepositoryCredentialsDto;
  })` | `Promise<{ success: boolean; error?: string }>` |
| `listBranchesViaGit` | `listBranchesViaGit(options: {
    repositoryUrl: string;
    provider: RepositoryProvider;
    credentials?: RepositoryCredentialsDto;
  })` | `Promise<{ success: boolean; branches: { name: string }[]; error?: string }>` |
| `buildCloneUrl` | `buildCloneUrl(options: {
    repositoryUrl: string;
    provider: RepositoryProvider;
    credentials?: RepositoryCredentialsDto;
  })` | `string` |
| `parseRepositoryUrl` | `parseRepositoryUrl(repositoryUrl: string)` | `ParsedRepoUrl` |
| `getHeadSha` | `getHeadSha(localPath: string)` | `Promise<string | null>` |
| `cleanup` | `cleanup(localPath: string)` | `Promise<void>` |
| `cleanupOldClones` | `cleanupOldClones(olderThanHours: number)` | `Promise<void>` |

<!-- source: class-githubwriteadapter.md -->

# GitHubWriteAdapter

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/docs-pr/git-write/github-write.adapter.ts` (line 22)

Opens (or updates) a docs-fix PR on GitHub via the existing GitHub App installation
token. Hand-rolled REST over axios to match the house style (no octokit in the repo).

Strategy: the head branch always carries exactly ONE commit off the base tip, so the
PR diff is clean and a follow-up push simply force-updates that single commit —
GitHub then updates the same PR (dedupe by head branch). Nothing merges automatically.

**Extends:** `GitWriteAdapter`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `openOrUpdatePr` | `openOrUpdatePr(input: OpenOrUpdatePrInput)` | `Promise<OpenOrUpdatePrResult>` |

<!-- source: interface-historyprocessor.md -->

# HistoryProcessor

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/history-processors.ts` (line 25)

A history processor transforms input items before they reach the model.
Must return a new array — never mutate the input.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |

<!-- source: class-openaiprovider.md -->

# OpenAIProvider

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/openai.provider.ts` (line 55)

**Implements:** `AIProvider`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generate` | `generate(prompt: string, options: OpenAIGenerateOptions, stage: JobStage)` | `Promise<OpenAIResponse>` |
| `generateWithStreaming` | `generateWithStreaming(prompt: string, options: OpenAIGenerateOptions, stage: JobStage)` | `Promise<OpenAIResponse>` |
| `generateText` | `generateText(prompt: string, options: Omit<OpenAIGenerateOptions, 'messages'>, stage: JobStage)` | `Promise<string>` |
| `generateJSON` | `generateJSON(prompt: string, options: OpenAIGenerateOptions, stage: JobStage)` | `Promise<{ data: T; response: OpenAIResponse }>` |
| `verifyClaim` | `verifyClaim(claim: string, sourceCode: string, context: string)` | `Promise<{
    verified: boolean;
    confidence: number;
    reasoning: string;
    issues?: string[];
  }>` |
| `generateWithStructuredOutput` | `generateWithStructuredOutput(options: {
    prompt: string;
    schema: object;
    model?: string;
  })` | `Promise<{ content: T; usage: { inputTokens: number; outputTokens: number } }>` |
| `isAvailable` | `isAvailable()` | `Promise<boolean>` |
| `getThrottlingStatus` | `getThrottlingStatus()` | `{ consecutiveFailures: number; adaptiveDelayMs: number; lastFailureTime: number }` |

## Properties

| Property | Type |
|---|---|
| `name` | `any` |

<!-- source: function-originof.md -->

# originOf

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 201)

## Signature

```ts
function originOf(t: Pick<DeskThread, 'chatSessionId' | 'pageUrl'>): Origin
```

## Parameters

| Name | Type |
|---|---|
| `t` | `Pick<DeskThread, 'chatSessionId' | 'pageUrl'>` |

**Returns:** `Origin`

<!-- source: interface-pmestrategy.md -->

# PmeStrategy

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/stores/pmeStore.ts` (line 44)

## Properties

| Property | Type |
|---|---|
| `audience` | `{ primary: string; painPoints: string[]; goals: string[] }` |
| `valueProposition` | `string` |
| `tone` | `{ voice: string; adjectives: string[]; avoidTerms: string[] }` |
| `differentiators` | `string[]` |
| `confirmed` | `boolean` |

<!-- source: type-replacementformat.md -->

# ReplacementFormat

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 297)

How to format the replacement in documents

## Definition

```ts
'markdown' | 'mdx' | 'html'
```

<!-- source: constant-stripe-client.md -->

# STRIPE_CLIENT

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/billing/billing.service.ts` (line 19)

Injection token for the Stripe SDK client (mockable in tests).

<!-- source: interface-cellprops.md -->

# CellProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/table/TableEditor.tsx` (line 307)

## Properties

| Property | Type |
|---|---|
| `parentEditor` | `LexicalEditor` |
| `lexicalTable` | `TableNode` |
| `contents` | `Mdast.PhrasingContent[]` |
| `colIndex` | `number` |
| `rowIndex` | `number` |
| `align` | `Mdast.AlignType` |
| `activeCell` | `[number, number] | null` |
| `setActiveCell` | `(cell: [number, number] | null) => void` |
| `focus` | `boolean` |

<!-- source: component-createlink.md -->

# CreateLink

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/CreateLink.tsx` (line 12)

## Diagram

```mermaid
graph TD
    component_CreateLink_42ea935f["CreateLink"]
    class component_CreateLink_42ea935f rootComponent
```

## Relationships

- RENDERS → `ButtonWithTooltip`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useCellValue`
- USES_HOOK → `useTranslation`

<!-- source: api-endpoint-createreport.md -->

# createReport

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/export/analytics-export.controller.ts` (line 97)

## Endpoint

`POST /analytics/:projectId/reports`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `AnalyticsExportController` (MODULE_DECLARES)

<!-- source: constant-default-capture-config.md -->

# DEFAULT_CAPTURE_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 464)

## Definition

```ts
CaptureConfig
```

<!-- source: interface-detectedtutorial.md -->

# DetectedTutorial

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/tutorial-detector.service.ts` (line 25)

Detected tutorial from state machine analysis

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `difficulty` | `'beginner' | 'intermediate' | 'advanced'` |
| `estimatedTime` | `string` |
| `stateTransition` | `{
    from: string;
    to: string;
    method: string;
    stateMachine: string;
    requiresModal?: boolean;
    requiresApproval?: boolean;
  }` |
| `component` | `any` |
| `feature` | `string` |
| `route` | `string` |
| `uiInteractions` | `any[]` |
| `prerequisites` | `string[]` |
| `requiredRole` | `string` |
| `category` | `string` |
| `tags` | `string[]` |
| `nextSteps` | `string[]` |
| `previousSteps` | `string[]` |
| `formFields` | `any[]` |
| `screenshots` | `any[]` |
| `stateFlow` | `StateFlow` |
| `loadingState` | `LoadingStateMetadata` |
| `errorHandling` | `ErrorHandlingMetadata` |

<!-- source: component-documentationautomationsection.md -->

# DocumentationAutomationSection

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/page.tsx` (line 645)

Documentation Automation Section Component Manages automatic documentation generation configuration and execution

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DocumentationAutomationSection_27caeac1["DocumentationAutomationSection"]
    class component_DocumentationAutomationSection_27caeac1 rootComponent
```

## Relationships

- RENDERS → `ChevronUp`
- RENDERS → `ChevronDown`
- RENDERS → `CompletionSummary`
- RENDERS → `ProgressPanel`
- RENDERS → `ConfigEditor`
- RENDERS → `JobHistory`
- USES_HOOK → `useSession`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useDocumentationConfig`
- USES_HOOK → `useDocumentationGenerator`
- USES_HOOK → `useDocumentationJobs`

## Referenced By

- `ProjectPage` (RENDERS)

<!-- source: function-extracttypedefinitionsfrompath.md -->

# extractTypeDefinitionsFromPath

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 163)

Extract type definitions (interfaces and type aliases) from file
Returns a map of type name to type declaration node

## Signature

```ts
function extractTypeDefinitionsFromPath(path: NodePath<t.Program>): TypeDefinitionMap
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath<t.Program>` |

**Returns:** `TypeDefinitionMap`

<!-- source: interface-fielddefinition-2.md -->

# FieldDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 731)

Field definition for a database model

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `nullable` | `boolean` |
| `unique` | `boolean` |
| `primaryKey` | `boolean` |
| `autoIncrement` | `boolean` |
| `defaultValue` | `unknown` |
| `description` | `string` |
| `columnName` | `string` |

<!-- source: function-formatcompactionsummary.md -->

# formatCompactionSummary

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/context/model-compactor.ts` (line 453)

Format a CompactionSummary into a human-readable string
suitable for injection into the agent's instruction context.

## Signature

```ts
function formatCompactionSummary(summary: CompactionSummary): string
```

## Parameters

| Name | Type |
|---|---|
| `summary` | `CompactionSummary` |

**Returns:** `string`

<!-- source: function-getstoredtheme.md -->

# getStoredTheme

**Kind:** Function

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/theme.ts` (line 86)

## Signature

```ts
function getStoredTheme(): ThemeMode | null
```

**Returns:** `ThemeMode | null`

<!-- source: service-githubappservice.md -->

# GithubAppService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/github-app/github-app.service.ts` (line 15)

Foundation F1: the Atloria GitHub App. One app, installed per customer org/personal
account with per-install repo grants — GitHub enforces tenant isolation, tokens are
org-owned (survive employee churn), and webhooks arrive tagged with the installation.
Unlocks: one-click public-repo trial, self-serve onboarding, freshness at scale.

Env: GITHUB_APP_ID, GITHUB_APP_PRIVATE_KEY (PEM, \n-escaped), GITHUB_APP_WEBHOOK_SECRET.

`GithubAppService` encapsulates Atloria’s GitHub App (“Foundation F1”) integration: creating and using installation-scoped credentials, validating webhook authenticity, and interacting with GitHub on behalf of a specific customer org/user installation. It relies on GitHub’s installation model to enforce tenant isolation (per-install repo grants) and to ensure tokens are org-owned (survive employee churn), enabling self-serve onboarding, public-repo trials, and scalable data freshness.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `installationToken` | `installationToken(installationId: number | bigint)` | `Promise<string>` |
| `cloneCredentialsFor` | `cloneCredentialsFor(repoUrl: string)` | `Promise<{ username: string; password: string } | null>` |
| `verifySignature` | `verifySignature(signature: string | undefined, rawBody: string | Buffer | undefined)` | `void` |
| `handleInstallationEvent` | `handleInstallationEvent(action: string, payload: any)` | `Promise<void>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant GH as GitHub
  participant API as Atloria API (Webhook Controller)
  participant GAS as GithubAppService
  participant GHA as GitHub API

  GH->>API: Webhook event (X-Hub-Signature-256, installation.id, payload)
  API->>GAS: verifyWebhookSignature(rawBody, headers)
  GAS-->>API: ok / throw (invalid signature)

  API->>GAS: getInstallationClient(installationId)
  GAS->>GH: Create JWT (app id + private key)
  GAS->>GHA: POST /app/installations/{id}/access_tokens (JWT)
  GHA-->>GAS: installation access token (scoped to granted repos)
  GAS-->>API: Octokit client (auth = installation token)

  API->>GHA: GitHub API calls via client (repos, pulls, commits, etc.)
  GHA-->>API: responses (tenant-isolated by installation grants)
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import type { Request } from 'express';
import { GithubAppService } from './github-app.service';

@Injectable()
export class GithubWebhookHandler {
  constructor(private readonly githubApp: GithubAppService) {}

  async handle(req: Request) {
    // IMPORTANT: signature verification typically needs the raw request body
    // Ensure your Nest/Express setup preserves rawBody for webhook routes.
    await this.githubApp.verifyWebhookSignature(
      // @ts-expect-error depends on your raw body middleware
      req.rawBody ?? Buffer.from(JSON.stringify(req.body)),
      req.headers,
    );

    const installationId = req.body?.installation?.id;
    if (!installationId) throw new Error('Missing installation.id in webhook payload');

    const octokit = await this.githubApp.getInstallationClient(installationId);

    // Example: list repos accessible to this installation (tenant-scoped)
    const { data } = await octokit.apps.listReposAccessibleToInstallation();
    return data.repositories.map(r => ({ id: r.id, full_name: r.full_name }));
  }
}
```

## AI Coding Instructions

- Always operate “per installation”: require `installation.id` (from webhook payload or stored mapping) and use installation-scoped tokens/clients; never use a user PAT for backend GitHub operations.
- Webhook verification must use the exact raw bytes of the request body (before JSON parsing/mutation) with `GITHUB_APP_WEBHOOK_SECRET`; failing to preserve `rawBody` is a common pitfall.
- `GITHUB_APP_PRIVATE_KEY` is PEM with `\n`-escaped newlines—normalize it (replace `\\n` with `\n`) before signing JWTs, or token creation will fail.
- Treat installation access tokens as short-lived; do not persist them long-term—recreate via the app JWT flow when needed and handle 401/403 by refreshing.
- Keep tenant isolation intact: never broaden repo access in code; rely on GitHub’s per-installation grants and ensure all queries are made through the installation-authenticated Octokit instance.

## Relationships

- DEPENDS_ON → `configservice`
- DEPENDS_ON → `prismaservice`

<!-- source: class-gitwriteadapter.md -->

# GitWriteAdapter

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/docs-pr/git-write/git-write.adapter.ts` (line 49)

Provider-agnostic write surface. Phase 0 ships only the GitHub implementation;
GitLab/Bitbucket slot in behind this same interface later.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `openOrUpdatePr` | `openOrUpdatePr(input: OpenOrUpdatePrInput)` | `Promise<OpenOrUpdatePrResult>` |

<!-- source: interface-hookdefinition.md -->

# HookDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/hook-registry.ts` (line 48)

A single hook definition

## Properties

| Property | Type |
|---|---|
| `command` | `string` |
| `timeout` | `number` |
| `matcher` | `string` |

<!-- source: function-overlapcount.md -->

# overlapCount

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/copilotUtils.ts` (line 99)

## Signature

```ts
function overlapCount(a: string, b: string): number
```

## Parameters

| Name | Type |
|---|---|
| `a` | `string` |
| `b` | `string` |

**Returns:** `number`

<!-- source: class-parseerror.md -->

# ParseError

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/errors.ts` (line 58)

Error thrown when parsing fails

**Extends:** `PipelineError`

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `line` | `number` |

<!-- source: interface-pmevariant.md -->

# PmeVariant

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/stores/pmeStore.ts` (line 34)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `variantKey` | `string` |
| `variantName` | `string` |
| `sectionType` | `string` |
| `selected` | `boolean` |
| `content` | `Record<string, unknown>` |
| `htmlContent` | `string` |

<!-- source: type-replacementprogresscallback.md -->

# ReplacementProgressCallback

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-replacer.service.ts` (line 40)

## Definition

```ts
(progress: ReplacementProgress) => void
```

<!-- source: constant-system-prompt-layers.md -->

# SYSTEM_PROMPT_LAYERS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/support-agent/prompts/system-prompt-layers.ts` (line 19)

<!-- source: interface-changerequest.md -->

# ChangeRequest

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/change-requests.ts` (line 64)

Change request model for API responses

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `projectId` | `string` |
| `kind` | `ChangeRequestKind` |
| `status` | `ChangeRequestStatus` |
| `title` | `string` |
| `branchRef` | `string` |
| `authorType` | `string` |
| `authorId` | `string | null` |
| `baseCommit` | `string | null` |
| `headCommit` | `string | null` |
| `mergeCommit` | `string | null` |
| `files` | `ChangeRequestProposedFile[] | ChangeRequestCommittedFile[]` |
| `diffCache` | `unknown` |
| `conflictState` | `ChangeRequestConflictState | null` |
| `error` | `string | null` |
| `mergedAt` | `string | null` |
| `mergedById` | `string | null` |
| `createdAt` | `string` |
| `updatedAt` | `string` |

<!-- source: api-endpoint-createsession.md -->

# createSession

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-chat.controller.ts` (line 48)

## Endpoint

`POST /technical-docs/:projectId/chat/sessions`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsChatController` (MODULE_DECLARES)

<!-- source: component-ctabanner-2.md -->

# CtaBanner

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/cta/cta-banner.tsx` (line 19)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `icon` | `LucideIcon` | - | - |

## Diagram

```mermaid
graph TD
    component_CtaBanner_1d8cd003["CtaBanner"]
    class component_CtaBanner_1d8cd003 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `Icon`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- USES_HOOK → `useTranslation`

<!-- source: constant-default-document-upload-config.md -->

# DEFAULT_DOCUMENT_UPLOAD_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-13.types.ts` (line 66)

Default upload configuration for document batches

## Definition

```ts
UploadBatchConfig
```

<!-- source: interface-detectedworkflow.md -->

# DetectedWorkflow

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/workflow-detector.service.ts` (line 6)

Represents a detected business workflow

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `category` | `string` |
| `steps` | `WorkflowStep[]` |
| `relatedPages` | `string[]` |
| `estimatedDuration` | `string` |
| `userRoles` | `string[]` |
| `prerequisites` | `string[]` |

<!-- source: component-documentitem.md -->

# DocumentItem

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/DocAutomation/SkeletonBuilder.tsx` (line 437)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `document` | `SkeletonDocument` | ✓ | - |
| `isEditing` | `boolean` | ✓ | - |
| `onStartEdit` | `Function` | ✓ | - |
| `onEndEdit` | `Function` | ✓ | - |
| `onUpdate` | `Function` | ✓ | - |
| `onRemove` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DocumentItem_6fb2a1b0["DocumentItem"]
    class component_DocumentItem_6fb2a1b0 rootComponent
```

## Relationships

- RENDERS → `Reorder-Item`
- RENDERS → `GripVertical`
- RENDERS → `Trash2`
- USES_HOOK → `useState`

## Referenced By

- `CategoryItem` (RENDERS)

<!-- source: function-extracttypestring-2.md -->

# extractTypeString

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 365)

Convert TypeScript type to string representation

## Signature

```ts
function extractTypeString(typeNode: t.TSType | null | undefined): string
```

## Parameters

| Name | Type |
|---|---|
| `typeNode` | `t.TSType | null | undefined` |

**Returns:** `string`

<!-- source: interface-filescannerconfig.md -->

# FileScannerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/config.interface.ts` (line 67)

File scanner configuration

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `includePatterns` | `string[]` |
| `excludePatterns` | `string[]` |
| `respectGitignore` | `boolean` |
| `maxFileSize` | `number` |
| `followSymlinks` | `boolean` |
| `maxDepth` | `number` |

<!-- source: function-formatissues.md -->

# formatIssues

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/confidence-filter.ts` (line 198)

Format issues for display.

Groups by severity (critical first), then sorts by confidence within each group.
Output format:
```
### Critical Issues
[!!!] (95) file.ts:42 [bug] — Description
      Suggestion: How to fix
      Found by: agent-name
```

## Signature

```ts
function formatIssues(issues: ScoredIssue[]): string
```

## Parameters

| Name | Type |
|---|---|
| `issues` | `ScoredIssue[]` |

**Returns:** `string`

<!-- source: function-getuser.md -->

# getUser

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/examples/assets/dataCode.ts` (line 24)

## Signature

```ts
function getUser(index: number)
```

## Parameters

| Name | Type |
|---|---|
| `index` | `number` |

<!-- source: service-githubservice.md -->

# GitHubService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/github/github.service.ts` (line 5)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getAuthUrl` | `getAuthUrl(userId: string)` | `string` |
| `handleCallback` | `handleCallback(code: string, userId: string)` | `Promise<void>` |
| `getConnectionStatus` | `getConnectionStatus(userId: string)` | `Promise<{ connected: boolean; username: string | null }>` |
| `listRepos` | `listRepos(userId: string)` | `Promise<any[]>` |
| `listBranches` | `listBranches(userId: string, owner: string, repo: string)` | `Promise<any[]>` |
| `disconnect` | `disconnect(userId: string)` | `Promise<void>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `configservice`

<!-- source: interface-hookrunresult.md -->

# HookRunResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/hook-registry.ts` (line 67)

Result of running hooks for a given event

## Properties

| Property | Type |
|---|---|
| `blocked` | `boolean` |
| `blockReason` | `string` |

<!-- source: class-improvetextdto.md -->

# ImproveTextDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/ai/dto/improve-text.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `text` | `string` |
| `provider` | `string` |

<!-- source: function-parseaudiencefromurl.md -->

# parseAudienceFromUrl

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Boards/helpers.ts` (line 69)

Extract the audience slug from a published doc URL like /p/{slug}/{audience}/{doc}

## Signature

```ts
function parseAudienceFromUrl(pageUrl: string | null | undefined): string
```

## Parameters

| Name | Type |
|---|---|
| `pageUrl` | `string | null | undefined` |

**Returns:** `string`

<!-- source: class-pipelineerror.md -->

# PipelineError

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/errors.ts` (line 13)

Base class for all pipeline errors

**Extends:** `Error`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `toJSON` | `toJSON()` | `PipelineErrorInfo` |

## Properties

| Property | Type |
|---|---|
| `code` | `ErrorCode` |
| `stage` | `JobStage` |
| `recoverable` | `boolean` |
| `details` | `unknown` |
| `cause` | `Error` |

<!-- source: interface-progresspanelprops.md -->

# ProgressPanelProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/DocAutomation/ProgressPanel.tsx` (line 145)

## Properties

| Property | Type |
|---|---|
| `progress` | `number` |
| `currentStage` | `string | null` |
| `stageProgress` | `number` |
| `currentItem` | `string | null` |
| `elapsedMs` | `number` |
| `estimatedRemainingMs` | `number` |
| `isRunning` | `boolean` |
| `isFailed` | `boolean` |
| `isCancelled` | `boolean` |
| `error` | `Error | null` |
| `onCancel` | `() => void` |
| `screenshotProgress` | `{
    batchIndex: number;
    totalBatches: number;
    captured: number;
    totalMappings: number;
  } | null` |
| `onCancelScreenshots` | `() => void` |

<!-- source: type-requestinterceptor.md -->

# RequestInterceptor

**Kind:** Type

**Source:** `atloria-monorepo/packages/api-client/src/types/config.ts` (line 112)

Interceptor function types

## Definition

```ts
(
  config: RequestConfig
) => RequestConfig | Promise<RequestConfig>
```

<!-- source: constant-systemarchitecturetemplate.md -->

# systemArchitectureTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/system-architecture.template.ts` (line 3)

<!-- source: interface-changerequestcommittedfile.md -->

# ChangeRequestCommittedFile

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/change-requests.ts` (line 24)

A file once the branch is committed (content lives in git; only the path mapping remains)

## Properties

| Property | Type |
|---|---|
| `path` | `string` |
| `documentId` | `string` |

<!-- source: api-endpoint-createversion.md -->

# createVersion

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 603)

## Endpoint

`POST /documents/:id/versions`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: component-ctacard-2.md -->

# CtaCard

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/cta/cta-card.tsx` (line 24)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `icon` | `LucideIcon` | - | - |

## Diagram

```mermaid
graph TD
    component_CtaCard_5fb78ac3["CtaCard"]
    class component_CtaCard_5fb78ac3 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `Icon`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- USES_HOOK → `useTranslation`

<!-- source: constant-default-format.md -->

# DEFAULT_FORMAT

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/FormatConstants.ts` (line 2)

<!-- source: interface-diffchange.md -->

# DiffChange

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/dto/compare-document.dto.ts` (line 55)

Single diff change

## Properties

| Property | Type |
|---|---|
| `type` | `DiffChangeType` |
| `value` | `string` |
| `lineNumber` | `number` |

<!-- source: component-documentlayoutinner.md -->

# DocumentLayoutInner

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/doc/[...segments]/layout.tsx` (line 14)

Inner layout component that uses the DocContext

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DocumentLayoutInner_8e0c690["DocumentLayoutInner"]
    class component_DocumentLayoutInner_8e0c690 rootComponent
```

## Relationships

- RENDERS → `X`
- RENDERS → `Menu`
- RENDERS → `ChevronLeft`
- RENDERS → `ChevronRight`
- RENDERS → `ListX`
- RENDERS → `List`
- USES_HOOK → `useDocContext`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

## Referenced By

- `DocumentLayout` (RENDERS)

<!-- source: function-extractuiinteractionsfromfile.md -->

# extractUIInteractionsFromFile

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ui-interaction-detector.ts` (line 357)

Extract UI interactions from Angular component template file

Reads the .html template file associated with an Angular component
and extracts all interactive elements.

## Signature

```ts
function extractUIInteractionsFromFile(templatePath: string, stateMachines: StateMachine[], componentName: string): UIInteraction[]
```

## Parameters

| Name | Type |
|---|---|
| `templatePath` | `string` |
| `stateMachines` | `StateMachine[]` |
| `componentName` | `string` |

**Returns:** `UIInteraction[]`

<!-- source: interface-filescannerdefaults.md -->

# FileScannerDefaults

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/file-scanner.ts` (line 50)

Scanner default configuration

## Properties

| Property | Type |
|---|---|
| `defaultExcludePatterns` | `string[]` |
| `defaultMaxFileSize` | `number` |

<!-- source: function-formatpreflightresults.md -->

# formatPreflightResults

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/test-watcher.ts` (line 383)

Format preflight results as a string for the system prompt.

## Signature

```ts
function formatPreflightResults(results: PreflightResult[]): string
```

## Parameters

| Name | Type |
|---|---|
| `results` | `PreflightResult[]` |

**Returns:** `string`

<!-- source: function-getworkerconfig.md -->

# getWorkerConfig

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.config.ts` (line 53)

Get screenshot worker client configuration from environment variables

Environment variables:
- SCREENSHOT_WORKER_URL: Base URL of the worker service (default: http://localhost:3000)
- SCREENSHOT_WORKER_TIMEOUT: Job completion timeout in ms (default: 300000)
- SCREENSHOT_WORKER_POLL_INTERVAL: Poll interval in ms (default: 2000)

## Signature

```ts
function getWorkerConfig(): ScreenshotWorkerClientConfig
```

**Returns:** `ScreenshotWorkerClientConfig`

<!-- source: service-gitlabservice.md -->

# GitLabService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/gitlab/gitlab.service.ts` (line 5)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getAuthUrl` | `getAuthUrl(userId: string)` | `string` |
| `handleCallback` | `handleCallback(code: string, userId: string)` | `Promise<void>` |
| `getConnectionStatus` | `getConnectionStatus(userId: string)` | `Promise<{ connected: boolean; username: string | null }>` |
| `listRepos` | `listRepos(userId: string)` | `Promise<any[]>` |
| `listBranches` | `listBranches(userId: string, owner: string, repo: string)` | `Promise<any[]>` |
| `disconnect` | `disconnect(userId: string)` | `Promise<void>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `configservice`

<!-- source: interface-iagentloop.md -->

# IAgentLoop

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/loop-interface.ts` (line 20)

<!-- source: class-invitememberdto.md -->

# InviteMemberDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/organization/dto/invite-member.dto.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `email` | `string` |
| `role` | `UserRole` |

<!-- source: function-parsecollectionurl.md -->

# parseCollectionUrl

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/url-utils.ts` (line 76)

Parse a collection URL to extract slug and urlId

## Signature

```ts
function parseCollectionUrl(pathname: string): { slug: string; urlId: string } | null
```

## Parameters

| Name | Type |
|---|---|
| `pathname` | `string` |

**Returns:** `{ slug: string; urlId: string } | null`

<!-- source: class-progresstracker.md -->

# ProgressTracker

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/progress-tracker.ts` (line 26)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `startBatch` | `startBatch(batchIndex: number, itemsInBatch: number, additionalInfo: Record<string, unknown>)` | `number` |
| `completeBatch` | `completeBatch(batchStartTime: number, itemsCompleted: number, additionalInfo: Record<string, unknown>)` | `ProgressStats` |
| `completeItem` | `completeItem(itemStartTime: number, itemName: string, additionalInfo: Record<string, unknown>)` | `ProgressStats` |
| `getStats` | `getStats()` | `ProgressStats` |
| `complete` | `complete(additionalInfo: Record<string, unknown>)` | `void` |

<!-- source: interface-prompttemplate.md -->

# PromptTemplate

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/types/ai.ts` (line 53)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `category` | `'enhancement' | 'generation' | 'analysis' | 'custom'` |
| `template` | `string` |
| `variables` | `string[]` |
| `createdAt` | `Date` |
| `updatedAt` | `Date` |

<!-- source: type-responseinterceptor.md -->

# ResponseInterceptor

**Kind:** Type

**Source:** `atloria-monorepo/packages/api-client/src/types/config.ts` (line 116)

## Definition

```ts
<T>(
  response: APIResponse<T>
) => APIResponse<T> | Promise<APIResponse<T>>
```

<!-- source: constant-techdocs-generate-credit-cost.md -->

# TECHDOCS_GENERATE_CREDIT_COST

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/billing/billing.constants.ts` (line 19)

Technical-docs / RAG operation costs (Tier 1 metering). Scaled against the
1,000-credit full generation: a technical regen is parse+materialize (no
screenshots/AI authoring); indexing/enrichment are bounded worker jobs; ask/assist
are single LLM round-trips. The PROJECT'S OWNING ORG pays — including for anonymous
chat on public projects (your public docs' AI burns your credits).

<!-- source: interface-changerequestconflictfile.md -->

# ChangeRequestConflictFile

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/change-requests.ts` (line 45)

One file's conflict report: the conflicting sections verbatim plus counts of how the
remaining sections classified

## Properties

| Property | Type |
|---|---|
| `path` | `string` |
| `documentId` | `string` |
| `sections` | `ChangeRequestConflictSection[]` |
| `counts` | `{ unchanged: number; 'take-theirs': number; 'keep-mine': number; conflict: number }` |

<!-- source: api-endpoint-csat.md -->

# csat

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/public-issues.controller.ts` (line 45)

## Endpoint

`POST /public/issues/:projectSlugId/:ticketNumber/csat`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectSlugId` | query | `string` | ✓ |
| `ticketNumber` | query | `number` | ✓ |

## Referenced By

- `PublicIssuesController` (MODULE_DECLARES)

<!-- source: component-ctasplitform-2.md -->

# CtaSplitForm

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/cta/cta-split-form.tsx` (line 24)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `contactItems` | `ContactItem[]` | - | - |
| `formId` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_CtaSplitForm_1793832["CtaSplitForm"]
    class component_CtaSplitForm_1793832 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- RENDERS → `motion-ul`
- RENDERS → `ItemIcon`
- USES_HOOK → `useTranslation`

<!-- source: constant-default-large-file-config.md -->

# DEFAULT_LARGE_FILE_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/large-file-indexer.ts` (line 35)

Default configuration

## Definition

```ts
LargeFileIndexerConfig
```

<!-- source: interface-diffhunk.md -->

# DiffHunk

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/change-request/diff.types.ts` (line 2)

## Properties

| Property | Type |
|---|---|
| `header` | `string` |
| `lines` | `DiffLine[]` |

<!-- source: component-draftlink.md -->

# DraftLink

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/ops/ManualInsightsPanel.tsx` (line 22)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `href` | `string` | ✓ | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DraftLink_75510c68["DraftLink"]
    class component_DraftLink_75510c68 rootComponent
```

## Referenced By

- `ManualInsightsPanel` (RENDERS)

<!-- source: function-extractworkflowsignals.md -->

# extractWorkflowSignals

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/workflow-signal-extractor.ts` (line 27)

Extract workflow signals - now just packages all data for AI

## Signature

```ts
function extractWorkflowSignals(entities: Entity[], relationships: Relationship[], rootDir: string): WorkflowSignals
```

## Parameters

| Name | Type |
|---|---|
| `entities` | `Entity[]` |
| `relationships` | `Relationship[]` |
| `rootDir` | `string` |

**Returns:** `WorkflowSignals`

<!-- source: interface-filestats.md -->

# FileStats

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/file-scanner.ts` (line 39)

File statistics

## Properties

| Property | Type |
|---|---|
| `size` | `number` |
| `isFile` | `boolean` |
| `isDirectory` | `boolean` |
| `modifiedAt` | `Date` |
| `createdAt` | `Date` |

<!-- source: function-formatrehydrationitems.md -->

# formatRehydrationItems

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/context/rehydration.ts` (line 84)

Format rehydration items as synthetic tool output for injection into
the conversation. Each file becomes a synthetic read_file result.

## Signature

```ts
function formatRehydrationItems(items: RehydrationItem[]): string
```

## Parameters

| Name | Type |
|---|---|
| `items` | `RehydrationItem[]` |

**Returns:** `string`

<!-- source: function-hasselectors.md -->

# hasSelectors

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 182)

Check if a route mapping has any selectors

## Signature

```ts
function hasSelectors(mapping: RouteMapping): boolean
```

## Parameters

| Name | Type |
|---|---|
| `mapping` | `RouteMapping` |

**Returns:** `boolean`

<!-- source: interface-imodelprovider.md -->

# IModelProvider

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-provider-interface.ts` (line 99)

The pluggable model provider interface.
Loops call this to talk to any LLM.

<!-- source: service-invitationservice.md -->

# InvitationService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/invitation/invitation.service.ts` (line 38)

Invitation-token flow — the ONLY path into an existing organization.
(Open registration always creates a fresh org; see AuthService.register.)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `create` | `create(organizationId: string, dto: CreateInvitationDto, user: JwtPayload)` | `unknown` |
| `getByToken` | `getByToken(token: string)` | `unknown` |
| `accept` | `accept(token: string, dto: AcceptInvitationDto)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `emailservice`
- DEPENDS_ON → `configservice`

<!-- source: class-javascriptparser.md -->

# JavaScriptParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/parser/parsers/javascript.parser.ts` (line 17)

**Implements:** `CodeParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `parse` | `parse(code: string, _filename: undefined)` | `Promise<ParseResult>` |
| `extractSymbols` | `extractSymbols(code: string)` | `Promise<ParserSymbol[]>` |
| `extractDependencies` | `extractDependencies(code: string)` | `Promise<Dependency[]>` |

## Properties

| Property | Type |
|---|---|
| `language` | `any` |
| `supportedExtensions` | `any` |

<!-- source: function-parsedocumenturl.md -->

# parseDocumentUrl

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/url-utils.ts` (line 21)

Parse a document URL to extract slug and urlId
Supports formats:
- /doc/{slug}-{urlId}
- /doc/{audience}/{slug}-{urlId}

## Signature

```ts
function parseDocumentUrl(pathname: string): ParsedDocumentUrl | null
```

## Parameters

| Name | Type |
|---|---|
| `pathname` | `string` |

**Returns:** `ParsedDocumentUrl | null`

<!-- source: class-projectendpoints.md -->

# ProjectEndpoints

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/projects.ts` (line 37)

Project endpoints

## Methods

| Method | Signature | Returns |
|---|---|---|
| `list` | `list(params: ProjectListParams)` | `Promise<Project[]>` |
| `get` | `get(id: string)` | `Promise<Project>` |
| `getBySlug` | `getBySlug(organizationId: string, slug: string)` | `Promise<Project>` |
| `create` | `create(dto: CreateProjectDto)` | `Promise<Project>` |
| `update` | `update(id: string, dto: UpdateProjectDto)` | `Promise<Project>` |
| `delete` | `delete(id: string)` | `Promise<void>` |

<!-- source: interface-publicbranding.md -->

# PublicBranding

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/BrandingContext.tsx` (line 21)

## Properties

| Property | Type |
|---|---|
| `siteName` | `string | null` |
| `tagline` | `string | null` |
| `logoLightUrl` | `string | null` |
| `faviconUrl` | `string | null` |
| `primaryColor` | `string | null` |
| `accentColor` | `string | null` |
| `supportEmail` | `string | null` |
| `menuStyle` | `MenuStyle | null` |
| `menuConfig` | `MenuConfig | null` |
| `theme` | `string | null` |

<!-- source: type-rolesourcetype-2.md -->

# RoleSourceType

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 171)

How permissions are managed

## Definition

```ts
'hardcoded' | 'database' | 'external' | 'unknown'
```

<!-- source: constant-technicaldesigntemplate.md -->

# technicalDesignTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/technical-design.template.ts` (line 3)

<!-- source: interface-changerequestconflictsection.md -->

# ChangeRequestConflictSection

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/change-requests.ts` (line 32)

One aligned three-way section inside a conflict report (mirrors the API's ThreeWaySection)

## Properties

| Property | Type |
|---|---|
| `heading` | `string` |
| `level` | `number` |
| `base` | `string` |
| `mine` | `string` |
| `theirs` | `string` |
| `state` | `'unchanged' | 'take-theirs' | 'keep-mine' | 'conflict'` |

<!-- source: component-customcodeblockeditor.md -->

# CustomCodeBlockEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 321)

## Diagram

```mermaid
graph TD
    component_CustomCodeBlockEditor_6a757f72["CustomCodeBlockEditor"]
    class component_CustomCodeBlockEditor_6a757f72 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`

<!-- source: constant-default-mega-file-config.md -->

# DEFAULT_MEGA_FILE_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/mega-file-indexer.ts` (line 38)

Default configuration

## Definition

```ts
MegaFileIndexerConfig
```

<!-- source: api-endpoint-deflection.md -->

# deflection

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/manuals-insights/manuals-insights.controller.ts` (line 25)

## Endpoint

`GET /manuals-insights/:projectId/deflection`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `ManualsInsightsController` (MODULE_DECLARES)

<!-- source: interface-diffline.md -->

# DiffLine

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/change-request/diff.types.ts` (line 1)

## Properties

| Property | Type |
|---|---|
| `type` | `'add'|'del'|'ctx'` |
| `text` | `string` |
| `oldLine` | `number` |
| `newLine` | `number` |

<!-- source: component-editabledescription.md -->

# EditableDescription

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/[ticketId]/page.tsx` (line 304)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `text` | `string` | ✓ | - |
| `sectionHeading` | `string` | - | - |
| `onSave` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_EditableDescription_be7c90f["EditableDescription"]
    class component_EditableDescription_be7c90f rootComponent
```

## Relationships

- RENDERS → `LinkIcon`
- RENDERS → `motion-div`
- RENDERS → `ChevronDownIcon`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

## Referenced By

- `IssueDetailPageInner` (RENDERS)

<!-- source: function-fileimportsfrom.md -->

# fileImportsFrom

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/framework-detect.ts` (line 35)

True when the file has an `import … from '<pkgPrefix>…'` (or `require('<pkgPrefix>…')`).

## Signature

```ts
function fileImportsFrom(filePath: string, pkgPrefix: string, content: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string` |
| `pkgPrefix` | `string` |
| `content` | `string` |

**Returns:** `boolean`

<!-- source: interface-filesystemstorageconfig.md -->

# FileSystemStorageConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/storage.interface.ts` (line 265)

File system storage configuration

## Properties

| Property | Type |
|---|---|
| `baseDir` | `string` |
| `screenshotsDir` | `string` |
| `documentsDir` | `string` |
| `createDirs` | `boolean` |

<!-- source: function-getdefaultprofile.md -->

# getDefaultProfile

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-profiles.ts` (line 195)

Returns the default capability profile for a known model ID.
Used as the name-based fallback when no explicit profile is declared.

For Azure deployments with arbitrary names (e.g., "my-prod-agent"),
this will return STANDARD_PROFILE — callers should use explicit
modelProfile on AzureModelProviderConfig instead.

## Signature

```ts
function getDefaultProfile(modelId: string | undefined): ModelCapabilityProfile
```

## Parameters

| Name | Type |
|---|---|
| `modelId` | `string | undefined` |

**Returns:** `ModelCapabilityProfile`

<!-- source: function-importmarkdowntolexical.md -->

# importMarkdownToLexical

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/importMarkdownToLexical.ts` (line 210)

## Signature

```ts
function importMarkdownToLexical({
  root,
  markdown,
  visitors,
  syntaxExtensions,
  mdastExtensions,
  ...descriptors
}: MarkdownParseOptions): void
```

## Parameters

| Name | Type |
|---|---|
| `{
  root,
  markdown,
  visitors,
  syntaxExtensions,
  mdastExtensions,
  ...descriptors
}` | `MarkdownParseOptions` |

**Returns:** `void`

<!-- source: interface-indexstats.md -->

# IndexStats

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/types.ts` (line 63)

Returned from index().

## Properties

| Property | Type |
|---|---|
| `totalFiles` | `number` |
| `totalChunks` | `number` |
| `newChunks` | `number` |
| `updatedChunks` | `number` |
| `removedChunks` | `number` |
| `embeddedChunks` | `number` |
| `durationMs` | `number` |

<!-- source: service-issuesservice.md -->

# IssuesService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/issues/issues.service.ts` (line 32)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createPublic` | `createPublic(dto: CreateIssueDto)` | `unknown` |
| `createFromChatEscalation` | `createFromChatEscalation(input: {
    projectId: string;
    chatSessionId: string;
    question: string;
    transcript: Array<{ role: string; content: string }>;
    reporterEmail?: string;
    pageUrl?: string;
  })` | `unknown` |
| `getPublicTicket` | `getPublicTicket(projectSlugId: string, ticketNumber: number, reporterSessionId: string)` | `unknown` |
| `addCustomerReply` | `addCustomerReply(projectSlugId: string, ticketNumber: number, input: { body: string; reporterSessionId: string })` | `unknown` |
| `recordTicketCsat` | `recordTicketCsat(projectSlugId: string, ticketNumber: number, score: number)` | `unknown` |
| `notifyReporterResolved` | `notifyReporterResolved(projectId: string, issue: {
      ticketNumber: number;
      reporterEmail: string | null;
      pageTitle: string | null;
      category: string;
      priority: string;
      description: string;
      closedReason?: string | null;
    })` | `unknown` |
| `list` | `list(projectId: string, user: JwtPayload, params: {
      status?: string;
      category?: string;
      ticketType?: string;
      priority?: string;
      assigneeId?: string;
      search?: string;
      sortBy?: string;
      sortOrder?: string;
      page?: number;
      limit?: number;
    })` | `unknown` |
| `getStats` | `getStats(projectId: string, user: JwtPayload)` | `unknown` |
| `getOne` | `getOne(projectId: string, issueId: string, user: JwtPayload)` | `unknown` |
| `update` | `update(projectId: string, issueId: string, dto: UpdateIssueDto, user: JwtPayload)` | `unknown` |
| `bulkUpdate` | `bulkUpdate(projectId: string, dto: BulkUpdateIssuesDto, user: JwtPayload)` | `unknown` |
| `addComment` | `addComment(projectId: string, issueId: string, dto: CreateIssueCommentDto, user: JwtPayload, opts: { suppressAutoTransition?: boolean })` | `unknown` |
| `getDuplicates` | `getDuplicates(projectId: string, issueId: string, user: JwtPayload)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `emailservice`
- DEPENDS_ON → `eventsservice`

<!-- source: class-jobfiltersdto.md -->

# JobFiltersDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/documentation/dto/doc-automation.dto.ts` (line 624)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `status` | `string` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: function-parseprojecturl.md -->

# parseProjectUrl

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/url-utils.ts` (line 136)

Parse a project URL to extract slug and urlId

## Signature

```ts
function parseProjectUrl(pathname: string): { slug: string; urlId: string } | null
```

## Parameters

| Name | Type |
|---|---|
| `pathname` | `string` |

**Returns:** `{ slug: string; urlId: string } | null`

<!-- source: class-projectmanager.md -->

# ProjectManager

**Kind:** Class

**Source:** `atloria-monorepo/packages/core/src/managers/project-manager.ts` (line 13)

ProjectManager handles project business logic
This class is framework-agnostic and can be used in any environment

## Methods

| Method | Signature | Returns |
|---|---|---|
| `validate` | `validate(project: Partial<Project>)` | `ValidationResult` |
| `canAccess` | `canAccess(user: User, project: Project)` | `boolean` |
| `getUserRole` | `getUserRole(user: User, project: Project)` | `UserRole | null` |
| `canEdit` | `canEdit(user: User, project: Project)` | `boolean` |
| `canDelete` | `canDelete(user: User, project: Project)` | `boolean` |
| `canCreateDocuments` | `canCreateDocuments(user: User, project: Project)` | `boolean` |
| `canManageSettings` | `canManageSettings(user: User, project: Project)` | `boolean` |
| `canView` | `canView(user: User, project: Project)` | `boolean` |
| `getPermissions` | `getPermissions(user: User, project: Project)` | `void` |

<!-- source: interface-publishedlanguage.md -->

# PublishedLanguage

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/LanguageContext.tsx` (line 19)

Public-viewer i18n. Each published DocVersion is written in a single
language; the API exposes the distinct languages (`/public/p/:slug/languages`)
and the viewer applies `dir` (RTL/LTR) + renders a locale switcher when more
than one language exists. Doc slugs are English/ASCII and shared across
languages, so switching keeps the reader on the same document.

## Properties

| Property | Type |
|---|---|
| `code` | `string` |
| `name` | `string` |
| `dir` | `'ltr' | 'rtl'` |
| `versionNumber` | `number` |
| `documentCount` | `number` |
| `isDefault` | `boolean` |

<!-- source: type-screenshotprogresscallback.md -->

# ScreenshotProgressCallback

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 489)

Progress callback for stage 12

## Definition

```ts
(progress: ScreenshotProgress) => void
```

<!-- source: constant-theme-presets-2.md -->

# THEME_PRESETS

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/branding/branding.service.ts` (line 26)

Theme presets (4.2) — whole-page token packs the public viewer expands client-side.

<!-- source: interface-changerequestconflictstate.md -->

# ChangeRequestConflictState

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/change-requests.ts` (line 56)

Persisted when a merge attempt (or a diff refresh) found sections conflicting with newer
changes on main — the CR flips back to 'open' and merges are blocked until resolved

## Properties

| Property | Type |
|---|---|
| `files` | `ChangeRequestConflictFile[]` |
| `detectedAt` | `string` |

<!-- source: component-customtheming.md -->

# CustomTheming

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/toolbar.tsx` (line 61)

## Diagram

```mermaid
graph TD
    component_CustomTheming_4fd2e789["CustomTheming"]
    class component_CustomTheming_4fd2e789 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `KitchenSinkToolbar`

<!-- source: constant-default-poll-interval-ms.md -->

# DEFAULT_POLL_INTERVAL_MS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.config.ts` (line 23)

Default poll interval when waiting for job completion (2 seconds)

<!-- source: api-endpoint-delete-3.md -->

# delete

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/audience/audience.controller.ts` (line 100)

## Endpoint

`DELETE /audiences/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `AudienceController` (MODULE_DECLARES)

<!-- source: interface-diffstats.md -->

# DiffStats

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/doc-version/version-diff.service.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `linesA` | `number` |
| `linesB` | `number` |
| `linesAdded` | `number` |
| `linesRemoved` | `number` |
| `changePercent` | `number` |

<!-- source: component-editorerror.md -->

# EditorError

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/CollaborativeDocumentEditor.tsx` (line 226)

Error state component

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `error` | `Error | null` | ✓ | - |
| `onRetry` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_EditorError_fbce422["EditorError"]
    class component_EditorError_fbce422 rootComponent
```

## Referenced By

- `CollaborativeDocumentEditor` (RENDERS)

<!-- source: interface-filteredentities.md -->

# FilteredEntities

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/visibility-filter.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `visible` | `Entity[]` |
| `hidden` | `Entity[]` |
| `stats` | `FilterStatistics` |

<!-- source: function-findapiendpointsforsequence.md -->

# findAPIEndpointsForSequence

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/sequence-diagram.generator.ts` (line 528)

Find all API endpoints suitable for sequence diagrams

## Signature

```ts
function findAPIEndpointsForSequence(entities: Entity[]): APIEndpointEntity[]
```

## Parameters

| Name | Type |
|---|---|
| `entities` | `Entity[]` |

**Returns:** `APIEndpointEntity[]`

<!-- source: function-implementorfull.md -->

# implementOrFull

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/prompt-sections.ts` (line 89)

Only for modes that involve writing code

## Signature

```ts
function implementOrFull(ctx: SectionContext): boolean
```

## Parameters

| Name | Type |
|---|---|
| `ctx` | `SectionContext` |

**Returns:** `boolean`

<!-- source: function-importmdasttreetolexical.md -->

# importMdastTreeToLexical

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/importMarkdownToLexical.ts` (line 244)

## Signature

```ts
function importMdastTreeToLexical({ root, mdastRoot, visitors, ...descriptors }: MdastTreeImportOptions): void
```

## Parameters

| Name | Type |
|---|---|
| `{ root, mdastRoot, visitors, ...descriptors }` | `MdastTreeImportOptions` |

**Returns:** `void`

<!-- source: interface-instructionlayer.md -->

# InstructionLayer

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/instruction-loader.ts` (line 33)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `content` | `string` |
| `priority` | `number` |

<!-- source: service-jwtauthguard.md -->

# JwtAuthGuard

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/auth/guards/jwt-auth.guard.ts` (line 7)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `canActivate` | `canActivate(context: ExecutionContext)` | `unknown` |

## Relationships

- DEPENDS_ON → `reflector`

<!-- source: class-jwtstrategy.md -->

# JwtStrategy

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/auth/strategies/jwt.strategy.ts` (line 10)

**Extends:** `PassportStrategy(Strategy)`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `validate` | `validate(payload: JwtPayload)` | `Promise<JwtPayload>` |

<!-- source: function-pickgapproposal.md -->

# pickGapProposal

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/copilotUtils.ts` (line 105)

Best proposal with token overlap ≥ 2 against the thread title/question, or null.

## Signature

```ts
function pickGapProposal(proposals: TicketTopicProposal[], threadText: string): TicketTopicProposal | null
```

## Parameters

| Name | Type |
|---|---|
| `proposals` | `TicketTopicProposal[]` |
| `threadText` | `string` |

**Returns:** `TicketTopicProposal | null`

<!-- source: class-promptadapter.md -->

# PromptAdapter

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/prompt-adapter.ts` (line 17)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `setCrossModuleRelationships` | `setCrossModuleRelationships(relationships: { sourceArea: string; targetArea: string; sharedEntities: string[]; strength: number }[])` | `void` |
| `adaptSystemPrompt` | `adaptSystemPrompt(baseSystemPrompt: string, stage: string)` | `string` |
| `adaptAnalysisPrompt` | `adaptAnalysisPrompt(basePrompt: string)` | `string` |
| `adaptSynthesisPrompt` | `adaptSynthesisPrompt(basePrompt: string)` | `string` |
| `adaptStructurePrompt` | `adaptStructurePrompt(basePrompt: string)` | `string` |
| `adaptPlanningPrompt` | `adaptPlanningPrompt(basePrompt: string)` | `string` |
| `adaptMetaDocPrompt` | `adaptMetaDocPrompt(basePrompt: string, appName: string)` | `string` |
| `adaptGenerationPrompt` | `adaptGenerationPrompt(basePrompt: string, appName: string)` | `string` |

## Properties

| Property | Type |
|---|---|
| `family` | `ProviderFamily` |

<!-- source: interface-publishedprojectresponse.md -->

# PublishedProjectResponse

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useProjectPublish.ts` (line 11)

Published project response from the API

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `slug` | `string` |
| `urlId` | `string` |
| `publishedSlug` | `string` |
| `publicUrl` | `string` |
| `publishedAt` | `string` |
| `isPublic` | `boolean` |

<!-- source: type-screenshotstatus.md -->

# ScreenshotStatus

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 46)

## Definition

```ts
| 'pending' // Not yet processed
  | 'mapped' // URL mapping complete
  | 'captured' // Screenshot taken
  | 'uploaded' // Uploaded to Azure
  | 'replaced' // Placeholder replaced in docs
  | 'failed' // Failed at some stage
  | 'skipped'
```

<!-- source: constant-troubleshootingtemplate.md -->

# troubleshootingTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/troubleshooting.template.ts` (line 3)

<!-- source: interface-changerequestlistparams.md -->

# ChangeRequestListParams

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/change-requests.ts` (line 101)

Change request list query parameters

## Properties

| Property | Type |
|---|---|
| `status` | `ChangeRequestStatus` |

<!-- source: constant-default-rate-limiter-config.md -->

# DEFAULT_RATE_LIMITER_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/rate-limiter.ts` (line 17)

## Definition

```ts
RateLimiterConfig
```

<!-- source: api-endpoint-delete-4.md -->

# delete

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/comment/comment.controller.ts` (line 189)

Delete a comment

## Endpoint

`DELETE /documents/:documentId/comments/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `CommentController` (MODULE_DECLARES)

<!-- source: component-dialogform.md -->

# DialogForm

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/DialogButton.tsx` (line 85)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `autocompleteSuggestions` | `any` | ✓ | - |
| `onSubmitCallback` | `any` | ✓ | - |
| `dialogInputPlaceholder` | `any` | ✓ | - |
| `submitButtonTitle` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DialogForm_4436395b["DialogForm"]
    class component_DialogForm_4436395b rootComponent
```

## Relationships

- RENDERS → `Dialog-Close`
- USES_HOOK → `useState`
- USES_HOOK → `useCellValue`
- USES_HOOK → `useCombobox`
- USES_HOOK → `useCallback`

<!-- source: interface-dnsrecordspec-2.md -->

# DnsRecordSpec

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/project/domain-dns.service.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `type` | `'CNAME' | 'TXT'` |
| `name` | `string` |
| `expected` | `string` |

<!-- source: component-editorskeleton.md -->

# EditorSkeleton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/CollaborativeDocumentEditor.tsx` (line 196)

Loading skeleton component

## Diagram

```mermaid
graph TD
    component_EditorSkeleton_48d0a949["EditorSkeleton"]
    class component_EditorSkeleton_48d0a949 rootComponent
```

## Referenced By

- `CollaborativeDocumentEditor` (RENDERS)

<!-- source: interface-filterstatistics.md -->

# FilterStatistics

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/visibility-filter.ts` (line 27)

## Properties

| Property | Type |
|---|---|
| `total` | `number` |
| `visible` | `number` |
| `hidden` | `number` |
| `byAccess` | `Record<string, number>` |
| `byStability` | `Record<string, number>` |

<!-- source: function-findapiendpointswithcallers.md -->

# findAPIEndpointsWithCallers

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/api-flow-diagram.generator.ts` (line 512)

Find all API endpoints that are called by components

## Signature

```ts
function findAPIEndpointsWithCallers(allEntities: Entity[], relationships: Relationship[]): APIEndpointEntity[]
```

## Parameters

| Name | Type |
|---|---|
| `allEntities` | `Entity[]` |
| `relationships` | `Relationship[]` |

**Returns:** `APIEndpointEntity[]`

<!-- source: function-inferexports.md -->

# inferExports

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/services/entity-mapper.service.ts` (line 393)

Infer whether an entity is exported.
Checks extended entity properties (ComponentEntity.exports, etc.)
and metadata. Defaults to true if we can't determine.

## Signature

```ts
function inferExports(entity: ParserCoreEntity): boolean
```

## Parameters

| Name | Type |
|---|---|
| `entity` | `ParserCoreEntity` |

**Returns:** `boolean`

<!-- source: function-ishardblocked.md -->

# isHardBlocked

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/session/permission-gate.ts` (line 200)

Quick check: is this command in the T3 hard-block list?
Convenience wrapper around classifyBashCommand for callers that only need
to know whether to block.

## Signature

```ts
function isHardBlocked(command: string): { blocked: boolean; reason?: string }
```

## Parameters

| Name | Type |
|---|---|
| `command` | `string` |

**Returns:** `{ blocked: boolean; reason?: string }`

<!-- source: interface-journalentry.md -->

# JournalEntry

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/session-journal.ts` (line 33)

## Properties

| Property | Type |
|---|---|
| `turn` | `number` |
| `type` | `JournalEntryType` |
| `content` | `string` |
| `timestamp` | `number` |

<!-- source: service-k8singressservice.md -->

# K8sIngressService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/project/k8s-ingress.service.ts` (line 29)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `ensureIngress` | `ensureIngress(domain: string)` | `Promise<{ ok: boolean; secretName: string; error?: string }>` |
| `certReady` | `certReady(domain: string)` | `Promise<boolean>` |
| `removeIngress` | `removeIngress(domain: string)` | `Promise<void>` |
| `listManagedHosts` | `listManagedHosts()` | `Promise<string[] | null>` |

<!-- source: class-listchangerequestsdto.md -->

# ListChangeRequestsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/change-request/dto/change-request.dto.ts` (line 73)

## Properties

| Property | Type |
|---|---|
| `status` | `CrStatus` |

<!-- source: function-post.md -->

# POST

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/api/early-access/route.ts` (line 19)

## Signature

```ts
async function POST(req: NextRequest)
```

## Parameters

| Name | Type |
|---|---|
| `req` | `NextRequest` |

<!-- source: interface-publishedversion.md -->

# PublishedVersion

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/lib/public-api.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `versionNumber` | `number` |
| `label` | `string | null` |
| `status` | `'ACTIVE' | 'PUBLISHED' | 'DEPRECATED'` |
| `publishedAt` | `string | null` |
| `isActive` | `boolean` |
| `documentCount` | `number` |

<!-- source: class-qualitygate.md -->

# QualityGate

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/quality-gate.ts` (line 56)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `evaluate` | `evaluate(documents: GeneratedDocument[], plans: DocumentPlan[], entities: Entity[], sharedContext: string, retrievedContexts: Map<string, RetrievedContext>, moduleAreas: string[])` | `Promise<QualityGateResult>` |

<!-- source: type-sectiontype-2.md -->

# SectionType

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-09.types.ts` (line 71)

## Definition

```ts
| 'introduction'
  | 'prerequisites'
  | 'overview'
  | 'step-by-step'
  | 'explanation'
  | 'reference'
  | 'tips'
  | 'troubleshooting'
  | 'related'
  | 'summary'
```

<!-- source: constant-useronboardingtemplate.md -->

# userOnboardingTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/user-onboarding.template.ts` (line 3)

<!-- source: interface-changerequestproposedfile.md -->

# ChangeRequestProposedFile

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/change-requests.ts` (line 16)

A proposed file as submitted on open (content travels inline until the branch is staged)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `proposedContent` | `string` |

<!-- source: constant-default-replacement-config.md -->

# DEFAULT_REPLACEMENT_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-replacer.service.ts` (line 24)

Default replacement configuration

## Definition

```ts
ReplacementConfig
```

<!-- source: api-endpoint-delete-5.md -->

# delete

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 233)

## Endpoint

`DELETE /doc-versions/:projectId/:versionId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-diffsourceplugin.md -->

# DiffSourcePlugin

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 337)

## Diagram

```mermaid
graph TD
    component_DiffSourcePlugin_41dca71d["DiffSourcePlugin"]
    class component_DiffSourcePlugin_41dca71d rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `UndoRedo`

<!-- source: interface-docdiffentry.md -->

# DocDiffEntry

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/doc-version/version-diff.service.ts` (line 12)

## Properties

| Property | Type |
|---|---|
| `slug` | `string` |
| `title` | `string` |
| `type` | `string` |
| `source` | `string` |
| `docId` | `string` |
| `docIdA` | `string` |
| `docIdB` | `string` |
| `titleChanged` | `boolean` |
| `previousTitle` | `string` |
| `contentDiffStats` | `DiffStats` |

<!-- source: component-emptystate.md -->

# EmptyState

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/MessageList.tsx` (line 71)

Empty state shown when there are no messages

## Diagram

```mermaid
graph TD
    component_EmptyState_35824664["EmptyState"]
    class component_EmptyState_35824664 rootComponent
```

## Referenced By

- `MessageList` (RENDERS)

<!-- source: function-findentrypoints.md -->

# findEntryPoints

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/deployment-diagram.generator.ts` (line 592)

Find services that act as entry points (API gateways, load balancers)

## Signature

```ts
function findEntryPoints(entities: Entity[], relationships: Relationship[]): Entity[]
```

## Parameters

| Name | Type |
|---|---|
| `entities` | `Entity[]` |
| `relationships` | `Relationship[]` |

**Returns:** `Entity[]`

<!-- source: interface-formdefinition.md -->

# FormDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/form-validation-extractor.ts` (line 31)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `submitMethod` | `string` |
| `fields` | `FormFieldDefinition[]` |
| `route` | `string` |
| `hostComponent` | `string` |
| `sourceFile` | `string` |

<!-- source: function-initanalytics.md -->

# initAnalytics

**Kind:** Function

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/analytics.ts` (line 41)

Initialize analytics provider. Defers until cookie consent is given.

## Signature

```ts
function initAnalytics(config: AnalyticsConfig)
```

## Parameters

| Name | Type |
|---|---|
| `config` | `AnalyticsConfig` |

<!-- source: function-ismacos.md -->

# isMacOS

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/bash-sandbox.ts` (line 98)

Returns true if this process is running on macOS

## Signature

```ts
function isMacOS(): boolean
```

**Returns:** `boolean`

<!-- source: interface-journaltooloptions.md -->

# JournalToolOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/journal.tool.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `journal` | `SessionJournal` |

<!-- source: service-keywordextractorservice.md -->

# KeywordExtractorService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/keyword-extractor.service.ts` (line 26)

Keyword Extraction Service

Extracts searchable keywords from documentation content.
Leverages Phase 2.1 & 3 context for rich keyword extraction:
- State machines → states, transitions, action verbs
- UI interactions → button labels, form fields
- Code → method names, class names
- Content → natural language terms

Used by DocumentIndexingService to create search indexes.

`KeywordExtractorService` extracts searchable keywords from documentation content to support fast, relevant search. It analyzes multiple signal sources—state machines, UI interactions, code identifiers, and natural language terms—to produce a rich keyword set. The resulting keywords are consumed by `DocumentIndexingService` when building and updating search indexes.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `extractFromWorkflow` | `extractFromWorkflow(workflow: any)` | `ExtractedKeywords` |
| `extractFromFeature` | `extractFromFeature(feature: any)` | `ExtractedKeywords` |
| `extractFromTutorial` | `extractFromTutorial(tutorial: any)` | `ExtractedKeywords` |
| `getAllKeywords` | `getAllKeywords(keywords: ExtractedKeywords)` | `string[]` |
| `getWeightedKeywords` | `getWeightedKeywords(keywords: ExtractedKeywords)` | `Array<{ keyword: string; weight: number }>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant DI as DocumentIndexingService
  participant KE as KeywordExtractorService
  participant IDX as Search Index

  DI->>KE: extractKeywords(docContent, context)
  Note over KE: Parse and normalize tokens<br/>from Phase 2.1 & 3 context
  KE->>KE: State machines → states/transitions/action verbs
  KE->>KE: UI interactions → button labels/fields
  KE->>KE: Code → class/method names
  KE->>KE: Content → natural language terms
  KE-->>DI: keywords[]
  DI->>IDX: upsertDocument({ id, keywords, ... })
```

## Usage

```ts
// Example (NestJS): using KeywordExtractorService within an indexing workflow

import { Injectable } from '@nestjs/common';
import { KeywordExtractorService } from './keyword-extractor.service';

type DocContext = {
  stateMachines?: Array<{ states: string[]; transitions: string[] }>;
  ui?: { buttons?: string[]; fields?: string[] };
  code?: { classes?: string[]; methods?: string[] };
};

@Injectable()
export class ExampleIndexingWorkflow {
  constructor(private readonly keywordExtractor: KeywordExtractorService) {}

  async buildIndexPayload(docId: string, markdown: string, context: DocContext) {
    const keywords = await this.keywordExtractor.extractKeywords(markdown, context);

    return {
      id: docId,
      keywords, // store on the document index record
      content: markdown,
    };
  }
}

// Example (non-Nest): direct instantiation (if it has no DI-only dependencies)
async function extractForSearch(content: string, context: DocContext) {
  const svc = new KeywordExtractorService();
  return svc.extractKeywords(content, context);
}
```

## AI Coding Instructions

- Preserve deterministic output: normalize case/whitespace, deduplicate, and keep keyword ordering stable (or explicitly sort) to avoid index churn.
- When adding new keyword sources, route them through a single normalization/tokenization pipeline so scoring and filtering remain consistent.
- Be careful with noise: avoid indexing stop-words, very short tokens, and overly-generic UI terms unless they improve search recall.
- Integration point: `DocumentIndexingService` depends on this output—keep the return type and semantics stable; any changes should update indexing and tests together.
- Prefer additive changes (new extractors/weights) over breaking changes; validate with real docs to ensure keywords remain relevant and not overly broad.

<!-- source: class-listdocversionsdto.md -->

# ListDocVersionsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/doc-version/dto/doc-version.dto.ts` (line 53)

## Properties

| Property | Type |
|---|---|
| `status` | `string[]` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: function-post-2.md -->

# POST

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/mcp/route.ts` (line 11)

Slug-fronted, same-origin MCP endpoint: POST /p/<slug>/mcp — proxies the API's public,
urlId-keyed MCP server (docs + entity graph over technical + user manuals). Coding agents
(Claude, Cursor, …) add this URL directly. Stateless: each POST is a self-contained JSON-RPC
exchange, so no session state crosses the proxy.

## Signature

```ts
async function POST(req: Request, ctx: { params: Promise<{ slugId: string }> })
```

## Parameters

| Name | Type |
|---|---|
| `req` | `Request` |
| `ctx` | `{ params: Promise<{ slugId: string }> }` |

<!-- source: class-qualityscorer.md -->

# QualityScorer

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/quality-scorer.ts` (line 63)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `scoreAll` | `scoreAll(documents: GeneratedDocument[], plans: DocumentPlan[], entities: Entity[], moduleAreas: string[])` | `QualityScore[]` |
| `scoreDocument` | `scoreDocument(doc: GeneratedDocument, plan: DocumentPlan, entities: Entity[], moduleAreas: string[])` | `QualityScore` |

<!-- source: interface-screenshotannotationprops.md -->

# ScreenshotAnnotationProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/ScreenshotAnnotation.tsx` (line 41)

## Properties

| Property | Type |
|---|---|
| `src` | `string` |
| `alt` | `string` |
| `annotations` | `Annotation[]` |

<!-- source: type-selectortype.md -->

# SelectorType

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 38)

## Definition

```ts
(typeof SELECTOR_TYPES)[number]
```

<!-- source: constant-userstorytemplate.md -->

# userStoryTemplate

**Kind:** Constant

**Source:** `atloria-monorepo/apps/api/src/template/seeds/user-story.template.ts` (line 3)

<!-- source: interface-checkpointdata.md -->

# CheckpointData

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/pipeline/checkpoint.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `jobState` | `JobState` |
| `stageData` | `Record<string, unknown>` |
| `timestamp` | `Date` |
| `version` | `string` |

<!-- source: constant-default-retry-config-2.md -->

# DEFAULT_RETRY_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/retry.ts` (line 21)

## Definition

```ts
RetryConfig
```

<!-- source: api-endpoint-delete-6.md -->

# delete

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/category.controller.ts` (line 96)

Delete a category

## Endpoint

`DELETE /categories/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `CategoryController` (MODULE_DECLARES)

<!-- source: component-diffsourcetogglewrapper.md -->

# DiffSourceToggleWrapper

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/DiffSourceToggleWrapper.tsx` (line 23)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |
| `SourceToolbar` | `any` | ✓ | - |
| `options` | `any` | - | [] |

## Diagram

```mermaid
graph TD
    component_DiffSourceToggleWrapper_24233a1["DiffSourceToggleWrapper"]
    class component_DiffSourceToggleWrapper_24233a1 rootComponent
```

## Relationships

- RENDERS → `SingleChoiceToggleGroup`
- USES_HOOK → `useCellValues`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useTranslation`

<!-- source: interface-docfilechange.md -->

# DocFileChange

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-pr/git-write/git-write.adapter.ts` (line 1)

## Properties

| Property | Type |
|---|---|
| `path` | `string` |
| `content` | `string` |

<!-- source: component-errorcontent.md -->

# ErrorContent

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/common/ErrorState.tsx` (line 96)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `config` | `unknown` | ✓ | - |
| `errorType` | `ErrorType` | ✓ | - |
| `error` | `string` | ✓ | - |
| `showAction` | `boolean` | - | - |

## Diagram

```mermaid
graph TD
    component_ErrorContent_a9d81d2["ErrorContent"]
    class component_ErrorContent_a9d81d2 rootComponent
```

## Relationships

- RENDERS → `ActionButton`

## Referenced By

- `ErrorState` (RENDERS)

<!-- source: function-findmodelclusters.md -->

# findModelClusters

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/database-schema-diagram.generator.ts` (line 423)

Group models by their relations to find isolated clusters

## Signature

```ts
function findModelClusters(models: DatabaseModelEntity[]): DatabaseModelEntity[][]
```

## Parameters

| Name | Type |
|---|---|
| `models` | `DatabaseModelEntity[]` |

**Returns:** `DatabaseModelEntity[][]`

<!-- source: interface-formelement.md -->

# FormElement

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/template-analysis.interface.ts` (line 63)

Form element detected in template

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `onSubmit` | `string` |
| `fields` | `FormField[]` |
| `line` | `number` |
| `conditionalOn` | `string` |

<!-- source: function-iserrorcode.md -->

# isErrorCode

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/errors.ts` (line 289)

Check if an error is a specific type

## Signature

```ts
function isErrorCode(error: unknown, code: ErrorCode): boolean
```

## Parameters

| Name | Type |
|---|---|
| `error` | `unknown` |
| `code` | `ErrorCode` |

**Returns:** `boolean`

<!-- source: interface-jsonschemaoutput.md -->

# JsonSchemaOutput

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 28)

## Properties

| Property | Type |
|---|---|
| `type` | `'json_schema'` |
| `schema` | `Record<string, unknown>` |
| `name` | `string` |
| `strict` | `boolean` |

<!-- source: service-kgsyncservice-2.md -->

# KgSyncService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/graph/services/kg-sync.service.ts` (line 23)

Knowledge Graph Sync Service (Neo4j Implementation)

Handles bulk sync operations from CLI dynamic mode.
Provides efficient batch upsert for entities and relationships in Neo4j.

Neo4j is the ideal storage for knowledge graph data because:
- Optimized for relationship traversals
- Native graph queries with Cypher
- Better performance for complex dependency analysis
- Built-in graph algorithms

`KgSyncService` is a NestJS service that performs high-throughput, bulk synchronization of knowledge-graph data into Neo4j, optimized for CLI “dynamic mode” runs. It batches upserts for both entities (nodes) and relationships (edges) to efficiently keep the graph consistent and queryable for dependency analysis and traversal-heavy workloads.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `syncEntities` | `syncEntities(projectId: string, entities: SyncEntityDto[])` | `Promise<SyncEntitiesResponseDto>` |
| `syncRelationships` | `syncRelationships(projectId: string, relationships: SyncRelationshipDto[])` | `Promise<SyncRelationshipsResponseDto>` |
| `getEntities` | `getEntities(projectId: string, type: string)` | `unknown` |
| `getEntityById` | `getEntityById(projectId: string, entityId: string)` | `unknown` |
| `getRelationships` | `getRelationships(projectId: string)` | `unknown` |
| `getRelationshipsForEntity` | `getRelationshipsForEntity(projectId: string, entityId: string)` | `unknown` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant CLI as CLI Dynamic Mode
  participant API as NestJS API
  participant KG as KgSyncService
  participant N4J as Neo4j

  CLI->>API: Trigger bulk sync (entities + relationships)
  API->>KG: sync(payload)
  KG->>KG: Validate/normalize input\n(chunk into batches)
  loop For each batch
    KG->>N4J: Upsert nodes (MERGE)\n+ set properties
    KG->>N4J: Upsert relationships (MERGE)\n+ set properties
  end
  KG-->>API: Summary (counts/errors)
  API-->>CLI: Sync result
```

## Usage

```ts
// Example NestJS command handler / controller usage
import { Injectable } from '@nestjs/common';
import { KgSyncService } from './graph/services/kg-sync.service';

type KgEntityUpsert = {
  id: string;
  type: string; // e.g. "Package" | "File" | "Symbol"
  props?: Record<string, unknown>;
};

type KgRelationshipUpsert = {
  fromId: string;
  toId: string;
  type: string; // e.g. "DEPENDS_ON" | "IMPORTS" | "REFERENCES"
  props?: Record<string, unknown>;
};

@Injectable()
export class KgSyncRunner {
  constructor(private readonly kgSync: KgSyncService) {}

  async run() {
    const entities: KgEntityUpsert[] = [
      { id: 'pkg:api', type: 'Package', props: { name: 'api' } },
      { id: 'file:src/main.ts', type: 'File', props: { path: 'src/main.ts' } },
    ];

    const relationships: KgRelationshipUpsert[] = [
      {
        fromId: 'file:src/main.ts',
        toId: 'pkg:api',
        type: 'BELONGS_TO',
        props: { inferred: true },
      },
    ];

    // The service typically performs batched upserts into Neo4j.
    // Adjust method name/shape to match the implementation in your repo.
    const result = await this.kgSync.sync({
      entities,
      relationships,
      mode: 'dynamic',
      batchSize: 1000,
    });

    return result; // e.g. { upsertedNodes, upsertedRels, errors }
  }
}
```

## AI Coding Instructions

- Preserve the “batch upsert” pattern (chunk inputs, run Cypher `MERGE` with parameters); avoid per-entity queries, which will destroy performance in dynamic CLI runs.
- Keep node/relationship identity stable (consistent `id`/keys and relationship endpoints); changing identity fields can cause duplicates instead of updates.
- Ensure writes are parameterized Cypher (no string concatenation) and prefer `UNWIND`-based queries to insert/update many rows per transaction.
- Integrate cleanly with the Neo4j driver/session lifecycle (transactions, session close) and surface a compact sync summary (counts + failures) for CLI reporting.
- When adding new entity/relationship types, update the mapping/labeling logic and add minimal indexes/constraints in Neo4j to support the new keys.

## Relationships

- DEPENDS_ON → `neo4jservice`
- DEPENDS_ON → `prismaservice`

<!-- source: function-loadhooksconfig.md -->

# loadHooksConfig

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/session/hook-registry.ts` (line 209)

Load a hooks config from a JSON file.
Returns null if the file doesn't exist or can't be parsed.

## Signature

```ts
function loadHooksConfig(filePath: string): HooksConfig | null
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string` |

**Returns:** `HooksConfig | null`

<!-- source: class-lockhelderror.md -->

# LockHeldError

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/docs-repo/commit-lock.ts` (line 15)

The lock is held by another committer — retry later.

**Extends:** `Error`

<!-- source: function-preprocessmarkdown.md -->

# preprocessMarkdown

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/preprocessMarkdown.ts` (line 6)

Preprocess markdown content to handle custom JSX components
Converts JSX-style components to HTML that ReactMarkdown can handle

## Signature

```ts
function preprocessMarkdown(content: string): string
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |

**Returns:** `string`

<!-- source: class-ratelimiter.md -->

# RateLimiter

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/rate-limiter.ts` (line 41)

Rate limiter for controlling concurrent API requests

## Methods

| Method | Signature | Returns |
|---|---|---|
| `acquire` | `acquire()` | `Promise<void>` |
| `release` | `release()` | `void` |
| `withLimit` | `withLimit(operation: () => Promise<T>)` | `Promise<T>` |
| `getStatus` | `getStatus()` | `{ active: number; queued: number; available: number }` |
| `hasAvailableSlot` | `hasAvailableSlot()` | `boolean` |
| `clearQueue` | `clearQueue()` | `number` |

## Properties

| Property | Type |
|---|---|
| `maxConcurrent` | `number` |

<!-- source: interface-screenshotfigureprops.md -->

# ScreenshotFigureProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/ScreenshotFigure.tsx` (line 25)

## Properties

| Property | Type |
|---|---|
| `src` | `string` |
| `alt` | `string` |
| `annotations` | `Annotation[]` |
| `caption` | `string | null` |
| `lang` | `string` |
| `dir` | `'ltr' | 'rtl'` |

<!-- source: type-serializedcodeblocknode.md -->

# SerializedCodeBlockNode

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/CodeBlockNode.tsx` (line 41)

## Definition

```ts
Spread<CreateCodeBlockNodeOptions & { type: 'codeblock'; version: 1 }, SerializedLexicalNode>
```

<!-- source: interface-checkpointserviceconfig.md -->

# CheckpointServiceConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/pipeline/checkpoint.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `checkpointDir` | `string` |
| `autoSaveInterval` | `number` |
| `maxCheckpoints` | `number` |

<!-- source: constant-default-screenshot-stage-config.md -->

# DEFAULT_SCREENSHOT_STAGE_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 452)

## Definition

```ts
Partial<ScreenshotStageConfig>
```

<!-- source: api-endpoint-delete-7.md -->

# delete

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 257)

## Endpoint

`DELETE /documents/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: component-diffsourcewrapper.md -->

# DiffSourceWrapper

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/diff-source/DiffSourceWrapper.tsx` (line 8)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DiffSourceWrapper_2f3e541c["DiffSourceWrapper"]
    class component_DiffSourceWrapper_2f3e541c rootComponent
```

## Relationships

- RENDERS → `DiffViewer`
- RENDERS → `SourceEditor`
- USES_HOOK → `useCellValues`

<!-- source: interface-docsconfig.md -->

# DocsConfig

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/change-request/docs-config.service.ts` (line 6)

The client-facing docs-config shape (the only ProjectDocsRepo field exposed over REST).

## Properties

| Property | Type |
|---|---|
| `requireReview` | `boolean` |

<!-- source: component-erroricon.md -->

# ErrorIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/ParsingResults.tsx` (line 120)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_ErrorIcon_52464809["ErrorIcon"]
    class component_ErrorIcon_52464809 rootComponent
```

## Referenced By

- `ParsingResults` (RENDERS)

<!-- source: function-findrootcomponents.md -->

# findRootComponents

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/component-hierarchy-diagram.generator.ts` (line 435)

Find all root components (components that are not rendered by others)

## Signature

```ts
function findRootComponents(components: ComponentEntity[], relationships: Relationship[]): string[]
```

## Parameters

| Name | Type |
|---|---|
| `components` | `ComponentEntity[]` |
| `relationships` | `Relationship[]` |

**Returns:** `string[]`

<!-- source: interface-formfield.md -->

# FormField

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/template-analysis.interface.ts` (line 83)

Form field within a form

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `required` | `boolean` |
| `model` | `string` |

<!-- source: function-ismdastdirectivesnode.md -->

# isMdastDirectivesNode

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/directives/MdastDirectiveVisitor.ts` (line 13)

Determines if the given node is a HTML MDAST node.

## Signature

```ts
function isMdastDirectivesNode(node: Mdast.Nodes): node is Directives
```

## Parameters

| Name | Type |
|---|---|
| `node` | `Mdast.Nodes` |

**Returns:** `node is Directives`

<!-- source: interface-jsonstoreconfig.md -->

# JsonStoreConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/memory/json-store.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `storageDir` | `string` |

<!-- source: service-knowledgegraphservice-2.md -->

# KnowledgeGraphService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/graph/services/knowledge-graph.service.ts` (line 24)

KnowledgeGraphService — tenant-scoped knowledge-graph access.

SECURITY (cross-tenant): every method is scoped by `projectId`, which the controller obtains
from an org-verified route/body/query param (ResourceOrgGuard, kind: 'project'). Neo4j `:Entity`
nodes are a single shared label across all tenants, so EVERY Cypher here filters on
`{ projectId: $projectId }` — start nodes, traversed neighbours, and delete targets alike — so a
caller can never read, mutate, or delete a node outside their own project. Nodes follow the same
convention the kg-sync writer uses: a composite `id = "${projectId}-${entityId}"`, a raw
`entityId`, and a `projectId` property (see kg-sync.service.ts).

Label / relationship-type interpolation is validated against the EntityType / RelationType enums
before it reaches Cypher — these strings become labels/rel-types (which cannot be parameterised),
so a whitelist is the guard against Cypher injection.

`KnowledgeGraphService` provides tenant-scoped access to Neo4j knowledge-graph entities and relationships. Every query is constrained by the caller’s verified `projectId`, ensuring that reads, traversals, mutations, and deletes cannot cross project boundaries. It also validates dynamic entity labels and relationship types against approved enums before interpolating them into Cypher.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createEntity` | `createEntity(projectId: string, entity: Partial<KGEntity>)` | `Promise<KGEntity>` |
| `createRelation` | `createRelation(projectId: string, relation: KGRelation)` | `Promise<void>` |
| `getEntity` | `getEntity(projectId: string, entityId: string)` | `Promise<KGEntity>` |
| `findRelated` | `findRelated(projectId: string, entityId: string, depth: unknown, type: RelationType)` | `Promise<KGEntity[]>` |
| `findPath` | `findPath(projectId: string, fromId: string, toId: string)` | `Promise<Path | null>` |
| `searchEntities` | `searchEntities(projectId: string, query: string, type: EntityType)` | `Promise<KGEntity[]>` |
| `getEntityRelationships` | `getEntityRelationships(projectId: string, entityId: string)` | `Promise<any[]>` |
| `deleteEntity` | `deleteEntity(projectId: string, entityId: string)` | `Promise<void>` |
| `getStatistics` | `getStatistics(projectId: string)` | `Promise<any>` |

## Diagram

```mermaid
sequenceDiagram
  participant Client
  participant Controller
  participant Guard as ResourceOrgGuard
  participant Service as KnowledgeGraphService
  participant Neo4j

  Client->>Controller: Request with projectId and graph parameters
  Controller->>Guard: Verify project belongs to caller's org
  Guard-->>Controller: Authorized projectId
  Controller->>Service: Call method(projectId, entityId, ...)
  Service->>Service: Validate EntityType / RelationType
  Service->>Neo4j: Cypher query with projectId filter
  Note over Service,Neo4j: Match start nodes, neighbours, and targets<br/>using { projectId: $projectId }
  Neo4j-->>Service: Scoped graph records
  Service-->>Controller: Entities / relationships / result
  Controller-->>Client: Response
```

## AI Coding Instructions

- Always pass the org-verified `projectId` into every service method; never derive tenant scope from an untrusted entity ID or request field.
- Preserve `{ projectId: $projectId }` filtering for start nodes, traversed neighbours, relationship endpoints, and delete targets in every Cypher query.
- Use the composite graph node ID format `${projectId}-${entityId}` when addressing nodes, while retaining raw `entityId` and `projectId` properties.
- Validate every interpolated Neo4j label or relationship type against `EntityType` and `RelationType`; labels and relationship types cannot be safely parameterized.
- Keep graph writes aligned with the conventions used by `kg-sync.service.ts` so synced and manually managed graph data remain compatible.

## Relationships

- DEPENDS_ON → `neo4jservice`

<!-- source: class-lockunavailableerror.md -->

# LockUnavailableError

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/docs-repo/commit-lock.ts` (line 7)

Redis is unreachable — FAIL-CLOSED: the caller must NOT commit.

**Extends:** `Error`

<!-- source: function-meetsconfidence.md -->

# meetsConfidence

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/memory/types.ts` (line 147)

Check if a confidence level meets a minimum threshold.

## Signature

```ts
function meetsConfidence(actual: string, minimum: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `actual` | `string` |
| `minimum` | `string` |

**Returns:** `boolean`

<!-- source: class-reactdetector.md -->

# ReactDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/react-detector.ts` (line 39)

React Detector

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detect` | `detect(entities: Entity[])` | `DetectedReactComponent[]` |
| `getComponentSummary` | `getComponentSummary(component: DetectedReactComponent)` | `string` |

<!-- source: function-remarkscreenshot.md -->

# remarkScreenshot

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/remark-screenshot.ts` (line 9)

Remark plugin to transform <Screenshot> HTML tags into React-compatible format
This ensures ReactMarkdown can properly render the Screenshot component

<!-- source: interface-sectionresolution.md -->

# SectionResolution

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/section-merge.ts` (line 13)

Pure helpers for composing a resolved markdown document from per-section
conflict choices (change-request three-way resolution).

The authoritative full text is the CURRENT document content ("mine"); a
resolution replaces one heading-delimited section of it with the chosen
text (usually the proposed "theirs" text, or a manual inline edit).

A "section" spans from its heading line (`#{level} Heading`) up to — but not
including — the next heading of the same or shallower level (or EOF).

## Properties

| Property | Type |
|---|---|
| `heading` | `string` |
| `level` | `number` |
| `text` | `string` |

<!-- source: type-serializeddirectivenode.md -->

# SerializedDirectiveNode

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/directives/DirectiveNode.tsx` (line 14)

## Definition

```ts
Spread<
  {
    mdastNode: Directives
    type: 'directive'
    version: 1
  },
  SerializedLexicalNode
>
```

<!-- source: interface-chunk.md -->

# Chunk

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-02.types.ts` (line 33)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `entities` | `Entity[]` |
| `groupingReason` | `string` |
| `featureArea` | `string` |
| `tokens` | `{
    total: number;
    byTier: Record<EntityTier, number>;
  }` |

<!-- source: constant-default-timeout-ms.md -->

# DEFAULT_TIMEOUT_MS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.config.ts` (line 18)

Default timeout for job completion (5 minutes)

<!-- source: api-endpoint-delete-8.md -->

# delete

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 150)

## Endpoint

`DELETE /projects/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: component-diffviewer.md -->

# DiffViewer

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/diff-source/DiffViewer.tsx` (line 18)

## Diagram

```mermaid
graph TD
    component_DiffViewer_6fac23e0["DiffViewer"]
    class component_DiffViewer_6fac23e0 rootComponent
```

## Relationships

- USES_HOOK → `useRealm`
- USES_HOOK → `useCellValues`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useRef`
- USES_HOOK → `useCellValue`
- USES_HOOK → `useEffect`

<!-- source: interface-docscrjob.md -->

# DocsCrJob

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/change-request/docs-cr-queue.service.ts` (line 9)

## Properties

| Property | Type |
|---|---|
| `type` | `DocsCrJobType` |
| `crId` | `string` |

<!-- source: component-erroricon-2.md -->

# ErrorIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/common/ErrorState.tsx` (line 76)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `config` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ErrorIcon_408095c0["ErrorIcon"]
    class component_ErrorIcon_408095c0 rootComponent
```

## Referenced By

- `ErrorState` (RENDERS)

<!-- source: function-findrootmodels.md -->

# findRootModels

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/database-schema-diagram.generator.ts` (line 403)

Find models that have no incoming relations (potential root models)

## Signature

```ts
function findRootModels(models: DatabaseModelEntity[]): DatabaseModelEntity[]
```

## Parameters

| Name | Type |
|---|---|
| `models` | `DatabaseModelEntity[]` |

**Returns:** `DatabaseModelEntity[]`

<!-- source: interface-formfielddefinition.md -->

# FormFieldDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/form-validation-extractor.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `required` | `boolean` |
| `model` | `string` |
| `validationRules` | `FormValidationRule[]` |
| `selector` | `string` |
| `conditionalOn` | `string` |

<!-- source: function-ismdasthtmlnode.md -->

# isMdastHTMLNode

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/MdastHTMLNode.ts` (line 44)

Determines if the given node is a HTML MDAST node.

## Signature

```ts
function isMdastHTMLNode(node: Mdast.Nodes): node is MdastHTMLNode
```

## Parameters

| Name | Type |
|---|---|
| `node` | `Mdast.Nodes` |

**Returns:** `node is MdastHTMLNode`

<!-- source: service-languagedetectorservice.md -->

# LanguageDetectorService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/support-agent/language-detector.service.ts` (line 3)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectLanguage` | `detectLanguage(text: string)` | `{ code: string; name: string; confidence: number }` |
| `getLanguageName` | `getLanguageName(code: string)` | `string` |

<!-- source: interface-linttestconfig.md -->

# LintTestConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/lint-test-loop.ts` (line 15)

Lint-Test-Fix Loop

Nudge-based post-edit verification. After the agent edits files,
this module generates nudges telling it to run lint/test commands
and tracks retry attempts.

Design: The agent decides whether to lint/test (not forced). Some edits
(adding a comment) don't need it. The nudge makes it a strong suggestion.
If lint/test fails repeatedly, a hard stop is injected.

Integration: Used by AutonomousTurnHook or directly by domain layers.

## Properties

| Property | Type |
|---|---|
| `lintCommand` | `string` |
| `testCommand` | `string` |
| `typeCheckCommand` | `string` |
| `maxRetries` | `number` |
| `minEditsBeforeNudge` | `number` |

<!-- source: class-logindto.md -->

# LoginDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/auth/dto/login.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `email` | `string` |
| `password` | `string` |

<!-- source: function-mergeevalresults.md -->

# mergeEvalResults

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/swebench-evaluator.ts` (line 227)

Merge Docker harness evaluation results back into TaskResult objects.
Updates `passed` field based on official harness resolution status.

## Signature

```ts
function mergeEvalResults(taskResults: TaskResult[], evalResults: EvalResult[]): TaskResult[]
```

## Parameters

| Name | Type |
|---|---|
| `taskResults` | `TaskResult[]` |
| `evalResults` | `EvalResult[]` |

**Returns:** `TaskResult[]`

<!-- source: class-reactselectorextractor.md -->

# ReactSelectorExtractor

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/react-selector-extractor.ts` (line 18)

React Selector Extractor

## Methods

| Method | Signature | Returns |
|---|---|---|
| `extractFromJsx` | `extractFromJsx(jsx: string)` | `ExtractedSelectors` |

<!-- source: function-robots.md -->

# robots

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/robots.ts` (line 10)

robots.txt — allow crawlers (incl. AI crawlers) to index published docs under /p/,
keep the authenticated app (/app) and API-ish paths out, and advertise the sitemap.
Per-site llms.txt is discovered via the <link rel="alternate"> hints in each site's <head>.

## Signature

```ts
function robots(): MetadataRoute.Robots
```

**Returns:** `MetadataRoute.Robots`

<!-- source: interface-selectionrange.md -->

# SelectionRange

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useCollaboration.ts` (line 40)

Selection range in the document

## Properties

| Property | Type |
|---|---|
| `anchor` | `number` |
| `head` | `number` |

<!-- source: type-serializedlexicaljsxnode.md -->

# SerializedLexicalJsxNode

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/LexicalJsxNode.tsx` (line 15)

## Definition

```ts
Spread<
  {
    mdastNode: MdastJsx
    importStatement: ImportStatement | undefined
    type: 'jsx'
    version: 1
  },
  SerializedLexicalNode
>
```

<!-- source: interface-chunkanalysis.md -->

# ChunkAnalysis

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-04.types.ts` (line 30)

## Properties

| Property | Type |
|---|---|
| `chunkId` | `string` |
| `summary` | `string` |
| `userFunctionality` | `string[]` |
| `suggestedTopics` | `DocumentationTopic[]` |
| `complexity` | `'simple' | 'moderate' | 'complex'` |
| `targetAudience` | `string[]` |
| `prerequisites` | `string[]` |
| `warnings` | `string[]` |
| `confidence` | `number` |

<!-- source: constant-default-upload-config.md -->

# DEFAULT_UPLOAD_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 473)

## Definition

```ts
UploadConfig
```

<!-- source: api-endpoint-delete-9.md -->

# delete

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/template/template.controller.ts` (line 225)

Delete a template.
Only admins can delete templates.

## Endpoint

`DELETE /templates/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `TemplateController` (MODULE_DECLARES)

<!-- source: component-directiveeditorcontainer.md -->

# DirectiveEditorContainer

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/directives/DirectiveNode.tsx` (line 120)

## Diagram

```mermaid
graph TD
    component_DirectiveEditorContainer_258feab1["DirectiveEditorContainer"]
    class component_DirectiveEditorContainer_258feab1 rootComponent
```

## Relationships

- RENDERS → `NestedEditorsContext-Provider`
- RENDERS → `Editor`
- USES_HOOK → `useCellValues`

<!-- source: interface-docsprrunresult.md -->

# DocsPrRunResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr.service.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `status` | `DocsPrStatus` |
| `reason` | `string` |
| `prNumber` | `number` |
| `prUrl` | `string` |
| `pages` | `string[]` |

<!-- source: component-escalatepanel.md -->

# EscalatePanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/SupportChatWidget.tsx` (line 579)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `status` | `unknown | unknown | unknown | unknown` | ✓ | - |
| `email` | `string` | ✓ | - |
| `note` | `string` | ✓ | - |
| `ticketNumber` | `number | null` | ✓ | - |
| `trackingUrl` | `string | null` | ✓ | - |
| `lang` | `string | null | undefined` | ✓ | - |
| `onEmailChange` | `Function` | ✓ | - |
| `onNoteChange` | `Function` | ✓ | - |
| `onSubmit` | `Function` | ✓ | - |
| `onCancel` | `Function` | ✓ | - |
| `onRetry` | `Function` | ✓ | - |
| `onDone` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_EscalatePanel_3207206f["EscalatePanel"]
    class component_EscalatePanel_3207206f rootComponent
```

## Relationships

- RENDERS → `CheckCircle2`
- RENDERS → `ArrowLeft`

## Referenced By

- `SupportChatWidget` (RENDERS)

<!-- source: function-findungroundedexamplemethods.md -->

# findUngroundedExampleMethods

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/example-grounding.ts` (line 33)

Return the method names an example calls on an instance of `entityName` that are NOT among
`knownMethods` — i.e. hallucinated APIs. Conservative to avoid dropping good examples:
  - Binds the entity only via `new EntityName(` or a `<var>: EntityName` typed param/field.
  - Returns `[]` when there are no known methods (nothing to ground) or no bound var (unsure).
Calls on other objects (`res.status`, `this.prisma.insert`, standard lib) are never flagged.

## Signature

```ts
function findUngroundedExampleMethods(example: string, entityName: string, knownMethods: string[]): string[]
```

## Parameters

| Name | Type |
|---|---|
| `example` | `string` |
| `entityName` | `string` |
| `knownMethods` | `string[]` |

**Returns:** `string[]`

<!-- source: interface-formvalidationrule.md -->

# FormValidationRule

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/form-validation-extractor.ts` (line 15)

Form Validation Extractor

Extracts form fields and validation rules from source code across multiple
frameworks (Angular, React, Vue). Goes deeper than template-analyzer's basic
FormField extraction by capturing validation rules, DevExtreme widgets,
and programmatic validator definitions.

## Properties

| Property | Type |
|---|---|
| `type` | `string` |
| `param` | `string` |
| `message` | `string` |

<!-- source: function-ismdastjsxnode.md -->

# isMdastJsxNode

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/index.ts` (line 107)

Determines whether the given node is a JSX node.

## Signature

```ts
function isMdastJsxNode(node: Mdast.Nodes): node is MdastJsx
```

## Parameters

| Name | Type |
|---|---|
| `node` | `Mdast.Nodes` |

**Returns:** `node is MdastJsx`

<!-- source: interface-lintteststate.md -->

# LintTestState

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/lint-test-loop.ts` (line 32)

## Properties

| Property | Type |
|---|---|
| `editsSinceLastVerification` | `number` |
| `editedFiles` | `string[]` |
| `consecutiveFailures` | `number` |
| `verified` | `boolean` |
| `maxRetriesExceeded` | `boolean` |
| `lastVerificationTurn` | `number` |

<!-- source: service-manualsinsightsservice.md -->

# ManualsInsightsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/manuals-insights/manuals-insights.service.ts` (line 99)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `insights` | `insights(projectId: string, organizationId: string)` | `unknown` |
| `deflection` | `deflection(projectId: string, organizationId: string, days: unknown)` | `unknown` |
| `ticketTopics` | `ticketTopics(projectId: string, organizationId: string, days: unknown)` | `Promise<TicketTopicProposal[]>` |
| `generateDraftFromCluster` | `generateDraftFromCluster(projectId: string, organizationId: string, userId: string, topicKey: string)` | `Promise<{ documentId: string; slug: string; state: string }>` |
| `freshness` | `freshness(projectId: string, slug: string)` | `Promise<{ stale: boolean; since?: string; staleCount?: number }>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `techdocsragservice`
- DEPENDS_ON → `draftdocumentservice`

<!-- source: class-movecarddto.md -->

# MoveCardDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/boards/dto/card.dto.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `columnId` | `string` |
| `position` | `number` |

<!-- source: function-needsapplypatch.md -->

# needsApplyPatch

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/prompt-sections.ts` (line 93)

Only for models that use apply_patch format

## Signature

```ts
function needsApplyPatch(ctx: SectionContext): boolean
```

## Parameters

| Name | Type |
|---|---|
| `ctx` | `SectionContext` |

**Returns:** `boolean`

<!-- source: class-requestcancellederror.md -->

# RequestCancelledError

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/types/errors.ts` (line 99)

Request cancelled error

**Extends:** `NetworkError`

<!-- source: function-savefilters.md -->

# saveFilters

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 149)

## Signature

```ts
function saveFilters(boardId: string, f: BoardFiltersState)
```

## Parameters

| Name | Type |
|---|---|
| `boardId` | `string` |
| `f` | `BoardFiltersState` |

<!-- source: interface-skeletonbuilderprops.md -->

# SkeletonBuilderProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/DocAutomation/SkeletonBuilder.tsx` (line 21)

## Properties

| Property | Type |
|---|---|
| `skeleton` | `SkeletonStructure | null` |
| `isDirty` | `boolean` |
| `loading` | `boolean` |
| `onAddCategory` | `(category: Omit<SkeletonCategory, 'documents'>) => void` |
| `onRemoveCategory` | `(slug: string) => void` |
| `onUpdateCategory` | `(slug: string, updates: Partial<Omit<SkeletonCategory, 'documents'>>) => void` |
| `onAddDocument` | `(categorySlug: string, document: SkeletonDocument) => void` |
| `onRemoveDocument` | `(categorySlug: string, documentSlug: string) => void` |
| `onUpdateDocument` | `(categorySlug: string, documentSlug: string, updates: Partial<SkeletonDocument>) => void` |
| `onReorderCategories` | `(slugs: string[]) => void` |
| `onReorderDocuments` | `(categorySlug: string, documentSlugs: string[]) => void` |
| `onSave` | `() => Promise<void>` |
| `onReset` | `() => void` |

<!-- source: type-snippettype.md -->

# SnippetType

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/knowledge-reference.types.ts` (line 20)

## Definition

```ts
| 'overview'
  | 'getting-started'
  | 'navigation-path'
  | 'key-feature'
  | 'troubleshooting'
  | 'faq-candidate'
  | 'admin-only'
  | 'persona-relevant'
  | 'workflow-step'
  | 'quick-win'
```

<!-- source: interface-chunkcluster.md -->

# ChunkCluster

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-02-chunking/chunk-relationship-graph.ts` (line 299)

A cluster of related chunks

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `chunkIds` | `string[]` |
| `primaryFeature` | `string` |

<!-- source: constant-default-viewport.md -->

# DEFAULT_VIEWPORT

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 444)

## Definition

```ts
Viewport
```

<!-- source: api-endpoint-deleteagent.md -->

# deleteAgent

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.controller.ts` (line 140)

## Endpoint

`DELETE /support-agent/:projectId/agents/:agentId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `agentId` | query | `string` | ✓ |

## Referenced By

- `SupportAgentController` (MODULE_DECLARES)

<!-- source: interface-docsrepojob.md -->

# DocsRepoJob

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/docs-repo-queue.service.ts` (line 6)

Coalesced per-project commit job — the committer drains the outbox for this project.

## Properties

| Property | Type |
|---|---|
| `type` | `'commit'` |
| `projectId` | `string` |

<!-- source: component-documentlist-2.md -->

# DocumentList

**Kind:** Component

**Source:** `atloria-monorepo/packages/ui-react/src/components/DocumentList.tsx` (line 37)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `documents` | `Document[]` | ✓ | - |
| `onDocumentClick` | `Function` | - | - |
| `loading` | `boolean` | - | false |
| `emptyMessage` | `string` | - | "No documents found" |

## Diagram

```mermaid
graph TD
    component_DocumentList_6a3928c3["DocumentList"]
    class component_DocumentList_6a3928c3 rootComponent
```

## Relationships

- RENDERS → `DocumentTextIcon`
- RENDERS → `ClockIcon`

<!-- source: component-fieldstable.md -->

# FieldsTable

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/entity/[entityId]/page.tsx` (line 134)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `fields` | `any[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FieldsTable_3544c969["FieldsTable"]
    class component_FieldsTable_3544c969 rootComponent
```

## Relationships

- RENDERS → `Code`
- RENDERS → `CheckIcon`

## Referenced By

- `EntityDetailPage` (RENDERS)

<!-- source: function-formatapiflowasmarkdown.md -->

# formatAPIFlowAsMarkdown

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/api-flow-diagram.generator.ts` (line 479)

Format API flow diagram as markdown

## Signature

```ts
function formatAPIFlowAsMarkdown(mermaidCode: string): string
```

## Parameters

| Name | Type |
|---|---|
| `mermaidCode` | `string` |

**Returns:** `string`

<!-- source: interface-headinginfo-2.md -->

# HeadingInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 958)

Heading information in markdown

## Properties

| Property | Type |
|---|---|
| `level` | `number` |
| `text` | `string` |
| `line` | `number` |

<!-- source: function-ismdasttext.md -->

# isMdastText

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/LexicalTextVisitor.ts` (line 19)

## Signature

```ts
function isMdastText(mdastNode: Mdast.Nodes): mdastNode is Mdast.Text
```

## Parameters

| Name | Type |
|---|---|
| `mdastNode` | `Mdast.Nodes` |

**Returns:** `mdastNode is Mdast.Text`

<!-- source: interface-listdirectoryoptions.md -->

# ListDirectoryOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/list-directory.tool.ts` (line 13)

## Properties

| Property | Type |
|---|---|
| `maxDepth` | `number` |
| `excludePatterns` | `string[]` |
| `rootDir` | `string` |

<!-- source: service-neo4jdocsorchestratorservice.md -->

# Neo4jDocsOrchestratorService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/neo4j-docs-orchestrator.service.ts` (line 17)

Orchestrates complete documentation generation from Neo4j knowledge graph data

This service handles the entire documentation workflow:
1. Query Neo4j for workflows, entities, and relationships
2. Generate all documentation types (Overview, Guides, Tutorials, Features)
3. Create category hierarchy (Doc Type → Business Module → Subcategory)
4. Save documents to database with proper ordering
5. Return complete documentation structure

`Neo4jDocsOrchestratorService` orchestrates end-to-end documentation generation by pulling workflows, entities, and relationships from a Neo4j knowledge graph and transforming them into structured docs. It generates multiple doc types (Overview, Guides, Tutorials, Features), builds a hierarchical category structure (Doc Type → Business Module → Subcategory), persists the ordered results to the database, and returns the final documentation tree for consumers.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generateCompleteDocumentation` | `generateCompleteDocumentation(projectId: string, organizationId: string, userId: string, options: {
      types?: ('overview' | 'guides' | 'tutorials' | 'features')[];
      saveToDatabase?: boolean;
      createCategories?: boolean;
    })` | `Promise<GeneratedDocumentationResult>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant Caller
  participant Orchestrator as Neo4jDocsOrchestratorService
  participant Neo4j as Neo4j (Knowledge Graph)
  participant Generators as Doc Generators<br/>(Overview/Guides/Tutorials/Features)
  participant Categorizer as Category Hierarchy Builder
  participant DB as Database (Docs)

  Caller->>Orchestrator: generateDocumentation()
  Orchestrator->>Neo4j: queryWorkflowsEntitiesRelationships()
  Neo4j-->>Orchestrator: graphData (workflows/entities/relationships)
  Orchestrator->>Generators: generateAllDocTypes(graphData)
  Generators-->>Orchestrator: documents[]
  Orchestrator->>Categorizer: buildHierarchy(documents)
  Categorizer-->>Orchestrator: categorizedDocs (DocType→Module→Subcategory)
  Orchestrator->>DB: saveDocumentsWithOrdering(categorizedDocs)
  DB-->>Orchestrator: persistedStructure
  Orchestrator-->>Caller: documentationStructure
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { Neo4jDocsOrchestratorService } from './documentation/services/neo4j-docs-orchestrator.service';

@Injectable()
export class DocsJobRunner {
  constructor(
    private readonly neo4jDocsOrchestrator: Neo4jDocsOrchestratorService,
  ) {}

  async run() {
    // Triggers the full workflow:
    // 1) Query Neo4j
    // 2) Generate Overview/Guides/Tutorials/Features
    // 3) Build category hierarchy
    // 4) Persist ordered docs
    // 5) Return final structure
    const result = await this.neo4jDocsOrchestrator.generateDocumentation();

    // Example: return to an API caller, enqueue follow-up jobs, etc.
    return {
      generatedAt: new Date().toISOString(),
      categories: result.categories,
      documentsCount: result.documents?.length ?? 0,
    };
  }
}
```

## AI Coding Instructions

- Treat this service as the orchestration layer: keep Neo4j querying, doc generation, categorization, and persistence as clearly separated steps (don’t mix responsibilities inside a single method).
- Preserve deterministic ordering when saving documents; ordering impacts navigation and downstream rendering—avoid non-stable sorts or relying on database default ordering.
- When extending doc types (e.g., adding a new generator), integrate it through the “generate all documentation types” step and ensure the category hierarchy logic understands the new type.
- Be defensive about Neo4j result shapes: validate required nodes/relationships before generating docs to prevent partial graphs from producing broken category trees.

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `azureclaudeprovider`
- DEPENDS_ON → `knowledgegraphservice`
- DEPENDS_ON → `neo4jservice`

<!-- source: class-openchangerequestdto.md -->

# OpenChangeRequestDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/change-request/dto/change-request.dto.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `kind` | `CrKind` |
| `title` | `string` |
| `files` | `ChangeRequestFileDto[]` |
| `sourceFlagIds` | `string[]` |
| `docVersionId` | `string` |

<!-- source: function-parseevalresults.md -->

# parseEvalResults

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/swebench-evaluator.ts` (line 186)

Parse evaluation results from the harness output.

The harness writes results to `{run_id}/results.json` with format:
```json
{
  "instance_id": {
    "resolved": true|false,
    "tests_status": { "FAIL_TO_PASS": {...}, "PASS_TO_PASS": {...} }
  }
}
```

## Signature

```ts
function parseEvalResults(resultsDir: string): EvalResult[]
```

## Parameters

| Name | Type |
|---|---|
| `resultsDir` | `string` |

**Returns:** `EvalResult[]`

<!-- source: class-requestdeduplicator.md -->

# RequestDeduplicator

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/utils/deduplication.ts` (line 5)

Request deduplication manager
Prevents duplicate requests within a specified time window

## Methods

| Method | Signature | Returns |
|---|---|---|
| `deduplicate` | `deduplicate(method: string, url: string, body: unknown | undefined, executor: () => Promise<T>)` | `Promise<T>` |
| `clear` | `clear()` | `void` |
| `cleanup` | `cleanup()` | `void` |

<!-- source: function-scorestaticindex.md -->

# scoreStaticIndex

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/staticSearch.ts` (line 71)

Rank the static index for a query. Returns modal-ready results (highest
first), dropping docs that match no query term. Pure + deterministic.

## Signature

```ts
function scoreStaticIndex(index: StaticSearchIndex, query: string, limit): StaticSearchResult[]
```

## Parameters

| Name | Type |
|---|---|
| `index` | `StaticSearchIndex` |
| `query` | `string` |
| `limit` | `any` |

**Returns:** `StaticSearchResult[]`

<!-- source: interface-skeletoncategory.md -->

# SkeletonCategory

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationConfig.ts` (line 18)

Category in skeleton structure

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `documents` | `SkeletonDocument[]` |

<!-- source: type-statemanagement.md -->

# StateManagement

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/framework.types.ts` (line 65)

Detected state management

## Definition

```ts
| 'redux'
  | 'zustand'
  | 'jotai'
  | 'recoil'
  | 'mobx'
  | 'pinia'
  | 'vuex'
  | 'ngrx'
  | 'xstate'
  | 'none'
```

<!-- source: interface-chunkedge.md -->

# ChunkEdge

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-02.types.ts` (line 147)

## Properties

| Property | Type |
|---|---|
| `from` | `string` |
| `to` | `string` |
| `relationship` | `'imports' | 'uses' | 'extends' | 'implements'` |
| `strength` | `'strong' | 'weak'` |
| `examples` | `string[]` |

<!-- source: constant-default-worker-url.md -->

# DEFAULT_WORKER_URL

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.config.ts` (line 13)

Default URL for the screenshot-worker service

<!-- source: api-endpoint-deleteasset.md -->

# deleteAsset

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/assets/assets.controller.ts` (line 57)

## Endpoint

`DELETE /assets/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `AssetsController` (MODULE_DECLARES)

<!-- source: interface-documentroom.md -->

# DocumentRoom

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/collaboration/interfaces/collaboration.interfaces.ts` (line 110)

Room info for a document

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `users` | `Map<string, CollaborationUser>` |
| `lastActivity` | `Date` |

<!-- source: component-downshiftautocomplete.md -->

# DownshiftAutoComplete

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/ui/DownshiftAutoComplete.tsx` (line 21)

## Diagram

```mermaid
graph TD
    component_DownshiftAutoComplete_2ca298fb["DownshiftAutoComplete"]
    class component_DownshiftAutoComplete_2ca298fb rootComponent
```

## Relationships

- RENDERS → `DownshiftAutoCompleteWithSuggestions`

<!-- source: component-fieldstable-2.md -->

# FieldsTable

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/technical/entity/[entityId]/page.tsx` (line 78)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `fields` | `any[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FieldsTable_10cc1686["FieldsTable"]
    class component_FieldsTable_10cc1686 rootComponent
```

## Relationships

- RENDERS → `Code`
- RENDERS → `CheckIcon`

## Referenced By

- `PublicEntityDetailPage` (RENDERS)

<!-- source: function-formatasmarkdown.md -->

# formatAsMarkdown

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/state-machine-diagram.generator.ts` (line 403)

Format diagram as markdown code block

## Signature

```ts
function formatAsMarkdown(mermaidCode: string): string
```

## Parameters

| Name | Type |
|---|---|
| `mermaidCode` | `string` |

**Returns:** `string`

<!-- source: interface-hierarchydiagramresult.md -->

# HierarchyDiagramResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/component-hierarchy-diagram.generator.ts` (line 70)

Result of hierarchy diagram generation

## Properties

| Property | Type |
|---|---|
| `mermaidCode` | `string` |
| `stats` | `{
    /** Total components in diagram */
    totalComponents: number;
    /** Maximum depth reached */
    maxDepth: number;
    /** Number of leaf components (no children) */
    leafComponents: number;
    /** Total relationships shown */
    totalRelationships: number;
  }` |
| `cssClasses` | `string[]` |

<!-- source: function-isreasoningmodel.md -->

# isReasoningModel

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/azure-responses.provider.ts` (line 47)

GPT-5 series (gpt-5, gpt-5.1/.2/.4/.5, gpt-5.3-codex) and the o-series (o1/o3/o4)
are REASONING models. On the Responses API they reject sampling params
(`temperature`, `top_p`, penalties, `stop`, `max_tokens`) with a 400, and are
instead steered by `reasoning.effort` + `text.verbosity`. The non-reasoning chat
variant `gpt-5-chat` still takes `temperature`, so it's excluded here.

## Signature

```ts
function isReasoningModel(model: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `model` | `string` |

**Returns:** `boolean`

<!-- source: interface-livesweloopoptions.md -->

# LiveSweLoopOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/live-swe-loop.ts` (line 71)

Options for the Live-SWE loop.

## Properties

| Property | Type |
|---|---|
| `maxRequeries` | `number` |
| `historyProcessors` | `HistoryProcessor[]` |

<!-- source: service-neo4jservice.md -->

# Neo4jService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/graph/services/neo4j.service.ts` (line 8)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `unknown` |
| `onModuleDestroy` | `onModuleDestroy()` | `unknown` |
| `getSession` | `getSession()` | `Session` |
| `query` | `query(cypher: string, params: any)` | `Promise<any[]>` |
| `write` | `write(cypher: string, params: any)` | `Promise<any>` |

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: class-parsecodedto.md -->

# ParseCodeDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/parser/dto/parse-code.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `code` | `string` |
| `language` | `string` |
| `filename` | `string` |

<!-- source: function-parseissues.md -->

# parseIssues

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/confidence-filter.ts` (line 51)

Parse scored issues from agent output text.

Tries line-format first (one issue per line), then falls back to JSON array.
Returns empty array if neither format is found.

## Signature

```ts
function parseIssues(agentOutput: string, agentName: string): ScoredIssue[]
```

## Parameters

| Name | Type |
|---|---|
| `agentOutput` | `string` |
| `agentName` | `string` |

**Returns:** `ScoredIssue[]`

<!-- source: class-restclient.md -->

# RestClient

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/clients/RestClient.ts` (line 20)

REST client for making HTTP requests

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getInterceptors` | `getInterceptors()` | `InterceptorManager` |
| `setToken` | `setToken(token: string)` | `void` |
| `getToken` | `getToken()` | `string` |
| `request` | `request(config: RequestConfig)` | `Promise<T>` |
| `get` | `get(path: string, params: Record<string, string | number | boolean | undefined>, config: Partial<RequestConfig>)` | `Promise<T>` |
| `post` | `post(path: string, body: unknown, config: Partial<RequestConfig>)` | `Promise<T>` |
| `put` | `put(path: string, body: unknown, config: Partial<RequestConfig>)` | `Promise<T>` |
| `patch` | `patch(path: string, body: unknown, config: Partial<RequestConfig>)` | `Promise<T>` |
| `delete` | `delete(path: string, config: Partial<RequestConfig>)` | `Promise<T>` |

<!-- source: function-shortsha.md -->

# shortSha

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/cr-shared.ts` (line 107)

## Signature

```ts
function shortSha(sha: string | null): string
```

## Parameters

| Name | Type |
|---|---|
| `sha` | `string | null` |

**Returns:** `string`

<!-- source: interface-skeletondocument.md -->

# SkeletonDocument

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationConfig.ts` (line 8)

Document in skeleton structure

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `features` | `string[]` |
| `screenshots` | `{ path: string; name: string }[]` |

<!-- source: type-syntaxextension.md -->

# SyntaxExtension

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/importMarkdownToLexical.ts` (line 156)

An extension for the `fromMarkdown` utility markdown parse.

## Definition

```ts
MarkdownParseOptions['syntaxExtensions'][number]
```

<!-- source: interface-chunkinput.md -->

# ChunkInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-02.types.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `entities` | `Entity[]` |
| `budget` | `TokenBudget` |
| `largeFileThreshold` | `number` |

<!-- source: constant-defaultcodeblocklanguage.md -->

# defaultCodeBlockLanguage$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/index.ts` (line 76)

Contains the default language to use when creating a new code block if no language is passed.

<!-- source: api-endpoint-deletecolumn.md -->

# deleteColumn

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 127)

## Endpoint

`DELETE /projects/:projectId/boards/:boardId/columns/:columnId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `boardId` | query | `string` | ✓ |
| `columnId` | query | `string` | ✓ |
| `moveCardsTo` | query | `string` | - |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: interface-documentstateresponse.md -->

# DocumentStateResponse

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/collaboration/interfaces/collaboration.interfaces.ts` (line 82)

Document state response sent to clients

## Properties

| Property | Type |
|---|---|
| `state` | `Uint8Array` |
| `activeUsers` | `CollaborationUser[]` |
| `version` | `number` |

<!-- source: component-editimagetoolbar.md -->

# EditImageToolbar

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/EditImageToolbar.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `nodeKey` | `string` | ✓ | - |
| `imageSource` | `string` | ✓ | - |
| `initialImagePath` | `string | null` | ✓ | - |
| `title` | `string` | ✓ | - |
| `alt` | `string` | ✓ | - |
| `width` | `number | unknown` | - | - |
| `height` | `number | unknown` | - | - |

## Diagram

```mermaid
graph TD
    component_EditImageToolbar_35492e0e["EditImageToolbar"]
    class component_EditImageToolbar_35492e0e rootComponent
```

## Relationships

- USES_HOOK → `useCellValues`
- USES_HOOK → `useLexicalComposerContext`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useTranslation`

<!-- source: component-filediff.md -->

# FileDiff

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/CrDiffView.tsx` (line 21)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `file` | `CrDiffFile` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FileDiff_174a9c8a["FileDiff"]
    class component_FileDiff_174a9c8a rootComponent
```

## Referenced By

- `CrDiffView` (RENDERS)

<!-- source: function-formatcompetitorsforaicontext.md -->

# formatCompetitorsForAIContext

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/competitor-discovery.ts` (line 71)

Format competitor research for AI context

## Signature

```ts
function formatCompetitorsForAIContext(_competitors: CompetitorInfo[], crawledContent: Array<{ competitor: string; url: string; title: string; content: string }>): string
```

## Parameters

| Name | Type |
|---|---|
| `_competitors` | `CompetitorInfo[]` |
| `crawledContent` | `Array<{ competitor: string; url: string; title: string; content: string }>` |

**Returns:** `string`

<!-- source: interface-hookentity-2.md -->

# HookEntity

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 917)

Hook entity (React)

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.HOOK` |
| `returnType` | `string` |
| `parameters` | `ParameterDefinition[]` |
| `dependencies` | `string[]` |
| `isCustom` | `boolean` |

<!-- source: function-isrecoverable.md -->

# isRecoverable

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/errors.ts` (line 296)

Check if an error is recoverable

## Signature

```ts
function isRecoverable(error: unknown): boolean
```

## Parameters

| Name | Type |
|---|---|
| `error` | `unknown` |

**Returns:** `boolean`

<!-- source: interface-loadedplugin.md -->

# LoadedPlugin

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/plugins/plugin-types.ts` (line 104)

A fully loaded and validated plugin ready for registration.

## Properties

| Property | Type |
|---|---|
| `manifest` | `PluginManifest` |
| `rootDir` | `string` |
| `commands` | `CommandDefinition[]` |
| `agents` | `AgentDefinition[]` |
| `skills` | `SkillDefinition[]` |

<!-- source: service-notificationservice.md -->

# NotificationService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/notification/notification.service.ts` (line 21)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createNotification` | `createNotification(dto: CreateNotificationDto)` | `unknown` |
| `notifyMentions` | `notifyMentions(comment: { id: string; content: string; documentId: string }, mentionedUserIds: string[], authorName: string)` | `unknown` |
| `notifyNewComment` | `notifyNewComment(documentId: string, commentId: string, authorName: string, subscribedUserIds: string[])` | `unknown` |
| `notifySuggestion` | `notifySuggestion(documentId: string, suggestionId: string, authorName: string, documentOwnerId: string)` | `unknown` |
| `getUnreadNotifications` | `getUnreadNotifications(userId: string)` | `unknown` |
| `listForUser` | `listForUser(userId: string, opts: ListNotificationsOptions)` | `unknown` |
| `markAsRead` | `markAsRead(notificationId: string, userId: string)` | `unknown` |
| `markAllAsRead` | `markAllAsRead(userId: string)` | `unknown` |
| `getUserNotifications` | `getUserNotifications(userId: string, limit: unknown)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: function-parsememoryextractionresponse.md -->

# parseMemoryExtractionResponse

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/session-memory.ts` (line 148)

Parse the model's response into SessionMemory objects.
Handles common response formats (raw JSON, markdown-wrapped JSON, etc.).

## Signature

```ts
function parseMemoryExtractionResponse(response: string): SessionMemory[]
```

## Parameters

| Name | Type |
|---|---|
| `response` | `string` |

**Returns:** `SessionMemory[]`

<!-- source: class-parseprojectdto-2.md -->

# ParseProjectDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/parsing/dto/parse-project.dto.ts` (line 70)

## Properties

| Property | Type |
|---|---|
| `repositoryUrl` | `string` |
| `provider` | `RepositoryProvider` |
| `branch` | `string` |
| `credentials` | `RepositoryCredentialsDto` |
| `options` | `ParserOptionsDto` |
| `autoSync` | `boolean` |

<!-- source: class-routetemplatelinker.md -->

# RouteTemplateLinker

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/services/route-template-linker.ts` (line 31)

Route-Template Linker Service

## Methods

| Method | Signature | Returns |
|---|---|---|
| `linkRoutes` | `linkRoutes(files: Map<string, string>, framework: FrameworkType)` | `RouteMappingResult` |

<!-- source: function-sitemap.md -->

# sitemap

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/sitemap.ts` (line 13)

Dynamic sitemap — only includes pages from ACTIVE versions.
Non-active version pages are crawlable via links but excluded.

Structure generated:
  /p/{slugWithId}                              — project landing
  /p/{slugWithId}/{audienceSlug}               — audience landing
  /p/{slugWithId}/{audienceSlug}/{docSlug}     — document page

## Signature

```ts
async function sitemap(): Promise<MetadataRoute.Sitemap>
```

**Returns:** `Promise<MetadataRoute.Sitemap>`

<!-- source: interface-skeletonstructure.md -->

# SkeletonStructure

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationConfig.ts` (line 27)

Skeleton structure for documentation

## Properties

| Property | Type |
|---|---|
| `categories` | `SkeletonCategory[]` |

<!-- source: type-themeeventlistener.md -->

# ThemeEventListener

**Kind:** Type

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 155)

Theme event listener

## Definition

```ts
(event: ThemeUpdateEvent) => void
```

<!-- source: interface-chunknode.md -->

# ChunkNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-02.types.ts` (line 141)

## Properties

| Property | Type |
|---|---|
| `chunkId` | `string` |
| `featureArea` | `string` |
| `entityCount` | `number` |

<!-- source: constant-defaultdarktokens.md -->

# defaultDarkTokens

**Kind:** Constant

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/default-tokens.ts` (line 131)

Default dark theme tokens

## Definition

```ts
ThemeTokens
```

<!-- source: api-endpoint-deleteconfig.md -->

# deleteConfig

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 110)

## Endpoint

`DELETE /doc-automation/config/:projectId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: interface-documentstatsresult.md -->

# DocumentStatsResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/dto/document-stats.dto.ts` (line 24)

Document statistics response

## Properties

| Property | Type |
|---|---|
| `revisionCount` | `number` |
| `versionCount` | `number` |
| `wordCount` | `number` |
| `characterCount` | `number` |
| `contributors` | `ContributorStats[]` |
| `timeline` | `TimelineStats[]` |
| `lastModified` | `Date` |
| `createdAt` | `Date` |
| `publishedAt` | `Date` |
| `averageRevisionsPerDay` | `number` |
| `mostActiveContributor` | `ContributorStats | null` |

<!-- source: component-editorchild.md -->

# EditorChild

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/link/index.tsx` (line 36)

## Diagram

```mermaid
graph TD
    component_EditorChild_72e8cdd4["EditorChild"]
    class component_EditorChild_72e8cdd4 rootComponent
```

## Relationships

- RENDERS → `LexicalLinkPlugin`
- RENDERS → `LexicalAutoLinkPlugin`

<!-- source: component-filterbutton.md -->

# FilterButton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/SymbolList.tsx` (line 124)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |
| `active` | `boolean` | ✓ | - |
| `onClick` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FilterButton_3226009c["FilterButton"]
    class component_FilterButton_3226009c rootComponent
```

## Referenced By

- `SymbolList` (RENDERS)

<!-- source: function-formatdeploymentasmarkdown.md -->

# formatDeploymentAsMarkdown

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/deployment-diagram.generator.ts` (line 522)

Format deployment diagram as markdown

## Signature

```ts
function formatDeploymentAsMarkdown(mermaidCode: string): string
```

## Parameters

| Name | Type |
|---|---|
| `mermaidCode` | `string` |

**Returns:** `string`

<!-- source: interface-hookinfo-2.md -->

# HookInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 41)

Information about a hook usage

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `'built-in' | 'custom'` |
| `location` | `string` |
| `dependencies` | `string[]` |

<!-- source: function-isvalidslug.md -->

# isValidSlug

**Kind:** Function

**Source:** `atloria-monorepo/packages/core/src/utils/slug.ts` (line 20)

Validate a slug format

## Signature

```ts
function isValidSlug(slug: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `slug` | `string` |

**Returns:** `boolean`

<!-- source: interface-loopstate.md -->

# LoopState

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/autonomous-loop.ts` (line 389)

Tracks which "phases" the agent has entered based on tool calls.
Used to decide when to nudge. Exported so runners can inspect/display it.

## Properties

| Property | Type |
|---|---|
| `hasInvestigated` | `boolean` |
| `hasPlanned` | `boolean` |
| `hasActed` | `boolean` |
| `hasVerified` | `boolean` |
| `lastInvestigationTurn` | `number` |
| `lastActionTurn` | `number` |
| `consecutiveErrors` | `number` |
| `totalErrors` | `number` |
| `circuitBreakerBlocks` | `Record<string, number>` |

<!-- source: service-opsalertservice.md -->

# OpsAlertService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/ops-alert.service.ts` (line 10)

Minimal ops alerting for pipeline failures. Always ERROR-logs; additionally POSTs to
ALERT_WEBHOOK_URL when configured (Slack/Teams/generic — payload is `{ text }`).
Best-effort by design: alerting must never throw into the pipeline it reports on.

`OpsAlertService` provides minimal operational alerting for pipeline failures in the API backend. It always writes an `ERROR` log entry and, when `ALERT_WEBHOOK_URL` is configured, also sends a best-effort POST to that webhook using a simple `{ text }` payload compatible with Slack/Teams/generic receivers. Alerting is designed to never throw or disrupt the pipeline it is reporting on.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `jobFailed` | `jobFailed(kind: string, projectId: string, error: string, jobId: string | null)` | `Promise<void>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant Pipeline as Pipeline/Job Runner
  participant Service as OpsAlertService
  participant Logger as Nest Logger
  participant Webhook as ALERT_WEBHOOK_URL (Slack/Teams/etc.)

  Pipeline->>Service: alert(text)
  Service->>Logger: error(text)
  alt ALERT_WEBHOOK_URL configured
    Service->>Webhook: POST { text }
    Webhook-->>Service: 2xx/4xx/timeout
    Service->>Logger: (optional) debug/warn on delivery failure
  else not configured
    Service->>Logger: (optional) debug: webhook disabled
  end
  Service-->>Pipeline: resolve (never throws)
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { OpsAlertService } from './technical-docs/ops-alert.service';

@Injectable()
export class PipelineRunner {
  constructor(private readonly opsAlert: OpsAlertService) {}

  async runPipeline(pipelineId: string) {
    try {
      // ... pipeline work
      throw new Error('Step "build" failed with exit code 1');
    } catch (err: any) {
      const msg = `[pipeline:${pipelineId}] Failure: ${err?.message ?? String(err)}`;

      // Best-effort: logs ERROR; posts to ALERT_WEBHOOK_URL if configured; will not throw.
      await this.opsAlert.alert(msg);

      // Re-throw (or handle) independently of alerting.
      throw err;
    }
  }
}
```

## AI Coding Instructions

- Keep alerting **best-effort**: never let network/webhook failures throw into callers; swallow/handle errors internally.
- Always emit an **ERROR-level log** for the alert message; webhook delivery is additive and optional.
- When posting to the webhook, send a minimal payload `{ text: string }` and avoid service-specific fields unless explicitly required.
- Treat `ALERT_WEBHOOK_URL` as an integration point: if unset/empty, skip HTTP calls and return quickly.
- Avoid blocking critical paths: use timeouts/retries conservatively (or none) so alerting cannot stall the pipeline.

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: function-parseprediction.md -->

# parsePrediction

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/swebench-evaluator.ts` (line 72)

Parse a JSONL line back to a prediction object.

## Signature

```ts
function parsePrediction(line: string): SWEBenchPrediction
```

## Parameters

| Name | Type |
|---|---|
| `line` | `string` |

**Returns:** `SWEBenchPrediction`

<!-- source: class-parseroptionsdto.md -->

# ParserOptionsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/parsing/dto/parse-project.dto.ts` (line 11)

## Properties

| Property | Type |
|---|---|
| `include` | `string[]` |
| `exclude` | `string[]` |
| `frameworks` | `string[]` |
| `screenshots` | `boolean` |

<!-- source: class-screenshotworkerclient.md -->

# ScreenshotWorkerClient

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.client.ts` (line 35)

Client for interacting with the screenshot-worker API

## Methods

| Method | Signature | Returns |
|---|---|---|
| `submitBatch` | `submitBatch(request: ScreenshotBatchRequest)` | `Promise<BatchJobResponse>` |
| `getJobStatus` | `getJobStatus(jobId: string, organizationId: string)` | `Promise<BatchStatusResponse | null>` |
| `waitForCompletion` | `waitForCompletion(jobId: string, organizationId: string, timeoutMs: number)` | `Promise<BatchStatusResponse>` |

<!-- source: function-slainfo.md -->

# slaInfo

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 211)

SLA countdown chip. Live-ticks: pass a `now` timestamp refreshed on an interval.
Quiet gray 'SLA 22m' → amber warn → red 'SLA -4m' breach.

## Signature

```ts
function slaInfo(t: Pick<DeskThread, 'slaDueAt' | 'slaState' | 'status' | 'firstAgentReplyAt' | 'snoozedUntil'>, now: number): { label: string; tone: 'ok' | 'warn' | 'breach' } | null
```

## Parameters

| Name | Type |
|---|---|
| `t` | `Pick<DeskThread, 'slaDueAt' | 'slaState' | 'status' | 'firstAgentReplyAt' | 'snoozedUntil'>` |
| `now` | `number` |

**Returns:** `{ label: string; tone: 'ok' | 'warn' | 'breach' } | null`

<!-- source: interface-staticsearchdoc.md -->

# StaticSearchDoc

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/staticSearch.ts` (line 16)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `url` | `string` |
| `documentType` | `SearchDocType` |
| `headings` | `string[]` |
| `excerpt` | `string` |
| `tokens` | `string[]` |
| `boost` | `number` |

<!-- source: type-themeeventtype.md -->

# ThemeEventType

**Kind:** Type

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 150)

Theme engine event types

## Definition

```ts
'theme-change' | 'mode-change'
```

<!-- source: interface-chunkrelationshipgraph.md -->

# ChunkRelationshipGraph

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-02.types.ts` (line 136)

ChunkRelationshipGraph - Cross-chunk import/dependency analysis

Helps AI understand how different chunks relate to each other.
Critical for cross-cutting features like "complete a sale" which
spans multiple chunks (customers, products, orders).

## Properties

| Property | Type |
|---|---|
| `nodes` | `ChunkNode[]` |
| `edges` | `ChunkEdge[]` |

<!-- source: constant-defaultlighttokens.md -->

# defaultLightTokens

**Kind:** Constant

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/default-tokens.ts` (line 7)

Default Atloria theme tokens
These match the CSS variables defined in global.css

## Definition

```ts
ThemeTokens
```

<!-- source: api-endpoint-deleteentity.md -->

# deleteEntity

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/graph.controller.ts` (line 195)

## Endpoint

`DELETE /knowledge-graph/entities/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `projectId` | query | `string` | ✓ |

## Referenced By

- `GraphController` (MODULE_DECLARES)

<!-- source: interface-documenttreenode.md -->

# DocumentTreeNode

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/document.service.ts` (line 2313)

Document tree node interface for navigation

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `slug` | `string` |
| `urlId` | `string | null` |
| `url` | `string` |
| `state` | `string` |
| `collectionId` | `string | null` |
| `children` | `DocumentTreeNode[]` |

<!-- source: component-editorinaform.md -->

# EditorInAForm

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/link-dialog.tsx` (line 121)

## Diagram

```mermaid
graph TD
    component_EditorInAForm_1785f799["EditorInAForm"]
    class component_EditorInAForm_1785f799 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `CreateLink`

<!-- source: component-filterbutton-2.md -->

# FilterButton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Suggestions/SuggestionPanel.tsx` (line 158)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `active` | `boolean` | ✓ | - |
| `onClick` | `Function` | ✓ | - |
| `count` | `number` | ✓ | - |
| `variant` | `unknown | unknown | unknown` | - | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FilterButton_6084db22["FilterButton"]
    class component_FilterButton_6084db22 rootComponent
```

## Referenced By

- `SuggestionPanel` (RENDERS)

<!-- source: function-formathierarchyasmarkdown.md -->

# formatHierarchyAsMarkdown

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/component-hierarchy-diagram.generator.ts` (line 424)

Format diagram as markdown code block

## Signature

```ts
function formatHierarchyAsMarkdown(mermaidCode: string): string
```

## Parameters

| Name | Type |
|---|---|
| `mermaidCode` | `string` |

**Returns:** `string`

<!-- source: interface-hookusage-2.md -->

# HookUsage

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 439)

Hook usage in a component

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `'built-in' | 'custom'` |
| `location` | `string` |
| `dependencies` | `string[]` |

<!-- source: function-isvisible-2.md -->

# isVisible

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-core/src/test-helpers.ts` (line 66)

Helper to check if an element is visible

## Signature

```ts
function isVisible(element: HTMLElement): boolean
```

## Parameters

| Name | Type |
|---|---|
| `element` | `HTMLElement` |

**Returns:** `boolean`

<!-- source: interface-markerresult.md -->

# MarkerResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/watch-mode.ts` (line 13)

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `relativePath` | `string` |
| `line` | `number` |
| `marker` | `string` |
| `instruction` | `string` |
| `context` | `string` |

<!-- source: service-opsalertsservice.md -->

# OpsAlertsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/ops/ops-alerts.service.ts` (line 23)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `sweep` | `sweep()` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `emailservice`

<!-- source: function-parsereviewresponse.md -->

# parseReviewResponse

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/self-review.ts` (line 104)

Parse a structured review response into a ReviewResult.
Handles both JSON responses and free-text responses.

## Signature

```ts
function parseReviewResponse(response: string): ReviewResult
```

## Parameters

| Name | Type |
|---|---|
| `response` | `string` |

**Returns:** `ReviewResult`

<!-- source: class-parsestatusdto.md -->

# ParseStatusDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/parsing/dto/parse-status.dto.ts` (line 12)

## Properties

| Property | Type |
|---|---|
| `jobId` | `string` |
| `status` | `ParseJobStatus` |
| `progress` | `number` |
| `currentStep` | `string` |
| `error` | `string` |
| `result` | `{
    entitiesCount: number;
    documentsGenerated: number;
    duration: number;
    frameworks: string[];
  }` |

<!-- source: class-servererror.md -->

# ServerError

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/types/errors.ts` (line 88)

Server error (5xx)

**Extends:** `APIError`

<!-- source: function-snoozeuntil.md -->

# snoozeUntil

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/DeskDialogs.tsx` (line 36)

## Signature

```ts
function snoozeUntil(preset: SnoozePreset): string
```

## Parameters

| Name | Type |
|---|---|
| `preset` | `SnoozePreset` |

**Returns:** `string`

<!-- source: interface-staticsearchindex.md -->

# StaticSearchIndex

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/staticSearch.ts` (line 27)

## Properties

| Property | Type |
|---|---|
| `v` | `number` |
| `slugWithId` | `string` |
| `generatedAt` | `string` |
| `count` | `number` |
| `docs` | `StaticSearchDoc[]` |

<!-- source: type-thememode-2.md -->

# ThemeMode

**Kind:** Type

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 120)

Theme mode

## Definition

```ts
'light' | 'dark' | 'system'
```

<!-- source: interface-chunkrelationshipsummary.md -->

# ChunkRelationshipSummary

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-02-chunking/chunk-relationship-graph.ts` (line 285)

Summary of chunk relationships

## Properties

| Property | Type |
|---|---|
| `totalNodes` | `number` |
| `totalEdges` | `number` |
| `mostConnectedChunks` | `Array<{ chunk: ChunkNode; connections: number }>` |
| `clusters` | `ChunkCluster[]` |
| `crossCuttingChunks` | `string[]` |
| `importRelationships` | `number` |
| `extendsRelationships` | `number` |
| `implementsRelationships` | `number` |

<!-- source: constant-defaults.md -->

# DEFAULTS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 326)

<!-- source: api-endpoint-deletejobdocuments.md -->

# deleteJobDocuments

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 248)

## Endpoint

`DELETE /doc-automation/jobs/:id/documents`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: interface-documentupdatedata.md -->

# DocumentUpdateData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/collaboration/interfaces/collaboration.interfaces.ts` (line 59)

Document update payload from Yjs

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `update` | `Uint8Array` |

<!-- source: component-editorrootelement.md -->

# EditorRootElement

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/MDXEditor.tsx` (line 194)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |
| `className` | `any` | ✓ | - |
| `overlayContainer` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_EditorRootElement_2f524900["EditorRootElement"]
    class component_EditorRootElement_2f524900 rootComponent
```

## Relationships

- USES_HOOK → `useRef`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useEffect`

<!-- source: component-filterpill.md -->

# FilterPill

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Comments/CommentSidebar.tsx` (line 144)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `value` | `CommentFilter` | ✓ | - |
| `label` | `string` | ✓ | - |
| `count` | `number` | - | - |

## Diagram

```mermaid
graph TD
    component_FilterPill_46adcadd["FilterPill"]
    class component_FilterPill_46adcadd rootComponent
```

## Referenced By

- `CommentSidebar` (RENDERS)

<!-- source: function-formatschemaasmarkdown.md -->

# formatSchemaAsMarkdown

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/database-schema-diagram.generator.ts` (line 357)

Format database schema diagram as markdown

## Signature

```ts
function formatSchemaAsMarkdown(mermaidCode: string): string
```

## Parameters

| Name | Type |
|---|---|
| `mermaidCode` | `string` |

**Returns:** `string`

<!-- source: interface-httpendpoint.md -->

# HttpEndpoint

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 47)

## Properties

| Property | Type |
|---|---|
| `method` | `'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'` |
| `path` | `string` |
| `service` | `string` |
| `serviceMethod` | `string` |
| `parameters` | `string[]` |
| `returnType` | `string` |
| `filePath` | `string` |
| `lineNumber` | `number` |

<!-- source: function-jaccardsimilarity.md -->

# jaccardSimilarity

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/grounding-checker.ts` (line 110)

Calculate Jaccard similarity between two strings.
Splits both strings into word sets (lowercase) and returns |intersection| / |union|.

## Signature

```ts
function jaccardSimilarity(a: string, b: string): number
```

## Parameters

| Name | Type |
|---|---|
| `a` | `string` |
| `b` | `string` |

**Returns:** `number`

<!-- source: interface-mcpcallresult.md -->

# McpCallResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/mcp/mcp-client.ts` (line 57)

## Properties

| Property | Type |
|---|---|
| `content` | `Array<{ type: string; text?: string; data?: string; mimeType?: string }>` |
| `isError` | `boolean` |

<!-- source: service-opsservice.md -->

# OpsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/ops/ops.service.ts` (line 11)

Admin cockpit read-side (Phase 2.3): one overview call aggregating what Tier 0/1 already
record — jobs (status/duration/failures), AI spend (AIUsage), credits, queue health and
the F2 interaction stream (deflection). Org-scoped: you see your own organization.

`OpsService` powers the organization-scoped admin cockpit overview for Phase 2.3. It aggregates operational read-side data—including job health, AI usage and spend, credit balances, queue status, and F2 interaction/deflection activity—into a single dashboard-oriented response. The service is intended for observability and operational decision-making rather than mutating underlying records.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `overview` | `overview(organizationId: string)` | `unknown` |

## Diagram

```mermaid
sequenceDiagram
  participant Admin as Admin Client
  participant Controller as Ops Controller
  participant Ops as OpsService
  participant Jobs as Jobs Data
  participant AI as AIUsage Data
  participant Credits as Credits Data
  participant Queue as Queue Health
  participant F2 as F2 Interaction Stream

  Admin->>Controller: Request organization overview
  Controller->>Ops: getOverview(orgId)
  Ops->>Jobs: Fetch job status, duration, failures
  Ops->>AI: Fetch usage and spend totals
  Ops->>Credits: Fetch credit information
  Ops->>Queue: Fetch queue health metrics
  Ops->>F2: Fetch interaction and deflection metrics

  Jobs-->>Ops: Job metrics
  AI-->>Ops: AI spend metrics
  Credits-->>Ops: Credit metrics
  Queue-->>Ops: Queue metrics
  F2-->>Ops: Deflection metrics

  Ops-->>Controller: Aggregated ops overview
  Controller-->>Admin: Organization-scoped dashboard data
```

## Usage

```ts
import { Controller, Get, Req } from '@nestjs/common';
import { OpsService } from './ops.service';

@Controller('ops')
export class OpsController {
  constructor(private readonly opsService: OpsService) {}

  @Get('overview')
  async getOverview(@Req() request: { user: { organizationId: string } }) {
    // Always derive the organization scope from the authenticated user.
    return this.opsService.getOverview(request.user.organizationId);
  }
}
```

## AI Coding Instructions

- Keep all queries organization-scoped; never accept an arbitrary organization ID without authorization checks.
- Treat this as a read-side aggregation service: avoid creating or updating jobs, usage records, credits, or interaction events here.
- Preserve a stable overview response shape, since admin cockpit consumers may depend on metric names and defaults.
- Fetch independent metric groups concurrently where possible, while ensuring partial or unavailable operational data is handled safely.
- Reuse the existing job, AI usage, credit, queue, and F2 data-access services rather than duplicating their query logic.

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `configservice`

<!-- source: function-parsesetupresult.md -->

# parseSetupResult

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/setup-agent.ts` (line 194)

## Signature

```ts
function parseSetupResult(output: string): SetupResult
```

## Parameters

| Name | Type |
|---|---|
| `output` | `string` |

**Returns:** `SetupResult`

<!-- source: class-parsingqueue.md -->

# ParsingQueue

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/parsing/parsing.queue.ts` (line 30)

**Implements:** `OnModuleInit`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `void` |
| `addParseJob` | `addParseJob(data: ParseJobData)` | `Promise<{ id: string }>` |
| `getJobStatus` | `getJobStatus(jobId: string)` | `Promise<any>` |
| `cancelJob` | `cancelJob(jobId: string)` | `Promise<boolean>` |

<!-- source: function-sourcebadgeof.md -->

# sourceBadgeOf

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/copilotUtils.ts` (line 60)

## Signature

```ts
function sourceBadgeOf(source: Pick<CopilotAskSource, 'path' | 'docType'>): SourceBadge
```

## Parameters

| Name | Type |
|---|---|
| `source` | `Pick<CopilotAskSource, 'path' | 'docType'>` |

**Returns:** `SourceBadge`

<!-- source: class-springdetector.md -->

# SpringDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/spring-detector.ts` (line 130)

Spring Boot Detector

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectControllers` | `detectControllers(entities: Entity[])` | `DetectedSpringController[]` |
| `detectServices` | `detectServices(entities: Entity[])` | `DetectedSpringService[]` |
| `detectEntities` | `detectEntities(entities: Entity[])` | `DetectedJPAEntity[]` |
| `getControllerSummary` | `getControllerSummary(controller: DetectedSpringController)` | `string` |

<!-- source: interface-staticsearchresult.md -->

# StaticSearchResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/staticSearch.ts` (line 35)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `url` | `string` |
| `documentType` | `SearchDocType` |
| `snippet` | `string` |
| `score` | `number` |

<!-- source: type-thememode-3.md -->

# ThemeMode

**Kind:** Type

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/theme.ts` (line 8)

Theme Engine

CSS custom properties approach: one set of components, multiple theme presets.
Client-side toggle via JS, persisted to localStorage.

## Definition

```ts
'dark' | 'light' | 'colorful'
```

<!-- source: interface-chunkresult.md -->

# ChunkResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-02.types.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `chunks` | `Chunk[]` |
| `largeFiles` | `LargeFileSummary[]` |
| `largeFileIndexes` | `LargeFileIndex[]` |
| `autoGeneratedFiles` | `AutoGeneratedFileInfo[]` |
| `relationshipGraph` | `ChunkRelationshipGraph` |
| `stats` | `ChunkStats` |

<!-- source: api-endpoint-deletereport.md -->

# deleteReport

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/export/analytics-export.controller.ts` (line 123)

## Endpoint

`DELETE /analytics/:projectId/reports/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `AnalyticsExportController` (MODULE_DECLARES)

<!-- source: constant-detection-configs-by-name.md -->

# DETECTION_CONFIGS_BY_NAME

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/index.ts` (line 57)

Detection config by name

<!-- source: interface-domaindnsresult.md -->

# DomainDnsResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/project/domain-dns.service.ts` (line 27)

## Properties

| Property | Type |
|---|---|
| `records` | `CheckedRecord[]` |
| `issues` | `Array<{ code: string; message: string }>` |
| `registrar` | `{ name: string; url?: string } | null` |
| `routingOk` | `boolean` |
| `ownershipOk` | `boolean` |

<!-- source: component-escapeunknowntextdirectives.md -->

# EscapeUnknownTextDirectives

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/directives.tsx` (line 130)

## Diagram

```mermaid
graph TD
    component_EscapeUnknownTextDirectives_22319f91["EscapeUnknownTextDirectives"]
    class component_EscapeUnknownTextDirectives_22319f91 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useState`

<!-- source: component-filterpopover.md -->

# FilterPopover

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 295)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `anchorRect` | `DOMRect` | ✓ | - |
| `filters` | `BoardFiltersState` | ✓ | - |
| `options` | `ReturnType` | ✓ | - |
| `onChange` | `Function` | ✓ | - |
| `onClose` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FilterPopover_7619f95e["FilterPopover"]
    class component_FilterPopover_7619f95e rootComponent
```

## Relationships

- RENDERS → `FilterSection`
- RENDERS → `CheckIcon`
- RENDERS → `AssigneeRow`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

## Referenced By

- `BoardFiltersButton` (RENDERS)

<!-- source: function-formatscreenshotplanmarkdown.md -->

# formatScreenshotPlanMarkdown

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/screenshot-instruction-generator.ts` (line 568)

Format screenshot plan as markdown

## Signature

```ts
function formatScreenshotPlanMarkdown(plan: ScreenshotPlan): string
```

## Parameters

| Name | Type |
|---|---|
| `plan` | `ScreenshotPlan` |

**Returns:** `string`

<!-- source: interface-impactanalysis-2.md -->

# ImpactAnalysis

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/relationship.interface.ts` (line 454)

Impact analysis result

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `directDependencies` | `string[]` |
| `directDependents` | `string[]` |
| `allDependencies` | `string[]` |
| `allDependents` | `string[]` |
| `impactScore` | `number` |
| `recommendations` | `string[]` |

<!-- source: function-joinproc.md -->

# joinProc

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/fp.ts` (line 71)

returns a function which calls all passed functions in the passed order.
joinProc does not pass arguments or collect return values.

## Signature

```ts
function joinProc(procs: (() => unknown)[])
```

## Parameters

| Name | Type |
|---|---|
| `procs` | `(() => unknown)[]` |

<!-- source: interface-mcpconfig.md -->

# McpConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/mcp/mcp-manager.ts` (line 47)

## Properties

| Property | Type |
|---|---|
| `mcpServers` | `Record<string, McpServerConfig>` |

<!-- source: service-optionaljwtauthguard.md -->

# OptionalJwtAuthGuard

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/auth/guards/optional-jwt-auth.guard.ts` (line 14)

Optional JWT Auth Guard

This guard attempts to authenticate the user via JWT but doesn't
require authentication. If a valid JWT is present, req.user will
be populated. If not, the request continues with req.user undefined.

Use this for public endpoints that need optional authentication
(e.g., public document viewer that shows more content for authenticated users).

`OptionalJwtAuthGuard` is a NestJS guard that attempts to authenticate incoming requests using a JWT without enforcing authentication. If a valid token is present, it attaches the decoded user to `req.user`; otherwise, the request proceeds normally with `req.user` remaining `undefined`. Use it for public endpoints that can enhance responses when a user is authenticated.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `handleRequest` | `handleRequest(err: any, user: TUser)` | `TUser | undefined` |
| `canActivate` | `canActivate(context: ExecutionContext)` | `unknown` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant C as Client
  participant N as NestJS Pipeline
  participant G as OptionalJwtAuthGuard
  participant J as Jwt Strategy / Auth Service
  participant R as Controller/Route Handler

  C->>N: HTTP Request (may include Authorization: Bearer <jwt>)
  N->>G: canActivate(context)
  G->>J: Validate JWT (if present)
  alt JWT valid
    J-->>G: user payload
    G-->>N: allow; set req.user = payload
  else No JWT or invalid JWT
    J-->>G: validation fails / no token
    G-->>N: allow; req.user remains undefined
  end
  N->>R: Invoke handler
  R-->>C: Response (optionally tailored by req.user)
```

## Usage

```ts
import { Controller, Get, Req, UseGuards } from '@nestjs/common';
import { Request } from 'express';
import { OptionalJwtAuthGuard } from './auth/guards/optional-jwt-auth.guard';

@Controller('documents')
export class DocumentsController {
  @Get(':id/view')
  @UseGuards(OptionalJwtAuthGuard)
  viewDocument(@Req() req: Request) {
    // If authenticated: req.user is populated by the JWT strategy
    const user = (req as any).user;

    if (user) {
      return { mode: 'enhanced', message: `Hello ${user.email ?? 'user'}`, content: 'Full content' };
    }

    // If not authenticated: still allowed, but limited response
    return { mode: 'public', message: 'Hello guest', content: 'Preview content' };
  }
}
```

## AI Coding Instructions

- Keep the guard **non-blocking**: it should never throw/deny solely due to missing or invalid JWT—always allow the request to continue.
- Ensure downstream code treats `req.user` as **optional** (`undefined`), and branch logic accordingly (avoid assuming authenticated state).
- Integrate with the existing **JWT strategy/passport setup** (e.g., the same validation logic as the required JWT guard), but swallow auth failures instead of propagating them.
- When adding new endpoints, use this guard for **public routes with optional personalization**, not for anything that must enforce authorization checks.

<!-- source: function-parseunifieddiff.md -->

# parseUnifiedDiff

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/tools/edit-file.tool.ts` (line 569)

Parse a unified diff string into hunks.

## Signature

```ts
function parseUnifiedDiff(diff: string): DiffHunk[]
```

## Parameters

| Name | Type |
|---|---|
| `diff` | `string` |

**Returns:** `DiffHunk[]`

<!-- source: class-paymentrequiredexception.md -->

# PaymentRequiredException

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/common/payment-required.exception.ts` (line 8)

402 Payment Required — thrown when an organization has insufficient
credits for an operation. NestJS does not ship a built-in exception for
this status code.

**Extends:** `HttpException`

<!-- source: function-splicesection.md -->

# spliceSection

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/section-merge.ts` (line 69)

Replace one heading-delimited section of `content` with `replacement`.
If the section is not found in the current content, the section is appended
at the end (the proposal introduced a new section).

## Signature

```ts
function spliceSection(content: string, heading: string, level: number, replacement: string): string
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |
| `heading` | `string` |
| `level` | `number` |
| `replacement` | `string` |

**Returns:** `string`

<!-- source: class-stageresultstore.md -->

# StageResultStore

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/stage-result-store.ts` (line 31)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `setParseResult` | `setParseResult(result: ParseResult)` | `void` |
| `setChunkResult` | `setChunkResult(result: ChunkResult)` | `void` |
| `setFeatureResult` | `setFeatureResult(result: FeatureResult)` | `void` |
| `setAnalysisResult` | `setAnalysisResult(result: AnalysisResult)` | `void` |
| `setSynthesisResult` | `setSynthesisResult(result: SynthesisResult)` | `void` |
| `setStructureResult` | `setStructureResult(result: StructureResult)` | `void` |
| `setPhaseResult` | `setPhaseResult(result: PhaseResult)` | `void` |
| `setSessionResult` | `setSessionResult(result: SessionResult)` | `void` |
| `setPlanResult` | `setPlanResult(result: PlanResult)` | `void` |
| `setGenerationResult` | `setGenerationResult(result: GenerationResult)` | `void` |
| `setVerificationResult` | `setVerificationResult(result: VerificationResult)` | `void` |
| `setMetaDocResult` | `setMetaDocResult(result: MetaDocumentationResult)` | `void` |
| `setKnowledgeReferenceStore` | `setKnowledgeReferenceStore(store: KnowledgeReferenceStore)` | `void` |
| `getParseResult` | `getParseResult()` | `ParseResult | undefined` |
| `getChunkResult` | `getChunkResult()` | `ChunkResult | undefined` |
| `getFeatureResult` | `getFeatureResult()` | `FeatureResult | undefined` |
| `getAnalysisResult` | `getAnalysisResult()` | `AnalysisResult | undefined` |
| `getSynthesisResult` | `getSynthesisResult()` | `SynthesisResult | undefined` |
| `getStructureResult` | `getStructureResult()` | `StructureResult | undefined` |
| `getPhaseResult` | `getPhaseResult()` | `PhaseResult | undefined` |
| `getSessionResult` | `getSessionResult()` | `SessionResult | undefined` |
| `getPlanResult` | `getPlanResult()` | `PlanResult | undefined` |
| `getGenerationResult` | `getGenerationResult()` | `GenerationResult | undefined` |
| `getVerificationResult` | `getVerificationResult()` | `VerificationResult | undefined` |
| `getMetaDocResult` | `getMetaDocResult()` | `MetaDocumentationResult | undefined` |
| `getKnowledgeReferenceStore` | `getKnowledgeReferenceStore()` | `KnowledgeReferenceStore | undefined` |
| `getKnowledgeReference` | `getKnowledgeReference(category: MetaKnowledgeCategory)` | `MetaCategoryReference | undefined` |
| `getChunkAnalysis` | `getChunkAnalysis(chunkId: string)` | `ChunkAnalysis | undefined` |
| `getChunkAnalyses` | `getChunkAnalyses()` | `ChunkAnalysis[]` |
| `getChunksForFeature` | `getChunksForFeature(featureId: string)` | `string[]` |
| `getFeaturesForChunk` | `getFeaturesForChunk(chunkId: string)` | `string[]` |
| `getChunkById` | `getChunkById(chunkId: string)` | `Chunk | undefined` |
| `getFeatureById` | `getFeatureById(featureId: string)` | `UserFeature | undefined` |
| `getEntitiesForChunk` | `getEntitiesForChunk(chunkId: string)` | `Entity[]` |
| `clear` | `clear()` | `void` |
| `getMemoryEstimate` | `getMemoryEstimate()` | `number` |

<!-- source: interface-statuschip.md -->

# StatusChip

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/cr-shared.ts` (line 58)

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `bg` | `string` |
| `color` | `string` |
| `dot` | `string` |

<!-- source: type-tomarkdownextension.md -->

# ToMarkdownExtension

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/exportMarkdownFromLexical.ts` (line 387)

## Definition

```ts
NonNullable<ToMarkdownOptions['extensions']>[number]
```

<!-- source: interface-chunkstats.md -->

# ChunkStats

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-02.types.ts` (line 155)

## Properties

| Property | Type |
|---|---|
| `inputEntities` | `number` |
| `filteredEntities` | `number` |
| `outputChunks` | `number` |
| `totalTokens` | `number` |
| `avgTokensPerChunk` | `number` |
| `largeFileCount` | `number` |

<!-- source: api-endpoint-deletescreenshot.md -->

# deleteScreenshot

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/screenshot/screenshot.controller.ts` (line 87)

## Endpoint

`DELETE /screenshots/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ScreenshotController` (MODULE_DECLARES)

<!-- source: constant-dialogbutton.md -->

# DialogButton

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/DialogButton.tsx` (line 19)

Use this primitive to create a toolbar button that opens a dialog with a text input, autocomplete suggestions, and a submit button.

<!-- source: interface-draftdocumentresult.md -->

# DraftDocumentResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/services/draft-document.service.ts` (line 54)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `slug` | `string` |
| `urlId` | `string` |
| `state` | `string` |
| `type` | `string` |

<!-- source: component-example.md -->

# Example

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/bug-683.tsx` (line 38)

## Diagram

```mermaid
graph TD
    component_Example_d4914e1["Example"]
    class component_Example_d4914e1 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`

<!-- source: component-filtersection.md -->

# FilterSection

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 492)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `title` | `string` | ✓ | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FilterSection_16d326e2["FilterSection"]
    class component_FilterSection_16d326e2 rootComponent
```

## Referenced By

- `FilterPopover` (RENDERS)

<!-- source: function-formatsequenceasmarkdown.md -->

# formatSequenceAsMarkdown

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/sequence-diagram.generator.ts` (line 468)

Format sequence diagram as markdown

## Signature

```ts
function formatSequenceAsMarkdown(mermaidCode: string): string
```

## Parameters

| Name | Type |
|---|---|
| `mermaidCode` | `string` |

**Returns:** `string`

<!-- source: interface-importinfo-2.md -->

# ImportInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 16)

Information about an import statement

## Properties

| Property | Type |
|---|---|
| `source` | `string` |
| `importType` | `'default' | 'named' | 'namespace' | 'side-effect'` |
| `imported` | `string` |
| `local` | `string` |

<!-- source: function-loadfonts.md -->

# loadFonts

**Kind:** Function

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/fonts.ts` (line 26)

Load fonts from Google Fonts and update CSS custom properties.
Call once during app initialization.

## Signature

```ts
function loadFonts(config: FontConfig)
```

## Parameters

| Name | Type |
|---|---|
| `config` | `FontConfig` |

<!-- source: interface-mcphttpoptions.md -->

# McpHttpOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/mcp/mcp-client.ts` (line 35)

## Properties

| Property | Type |
|---|---|
| `transport` | `'http'` |
| `url` | `string` |
| `token` | `string` |

<!-- source: service-organizationguard.md -->

# OrganizationGuard

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/auth/guards/organization.guard.ts` (line 24)

OrganizationGuard — validates an EXPLICIT `organizationId` present in the request (param, query,
or body) against the caller's org. Correct for org-settings-style routes that name an org
directly.

⚠️ IT DOES NOT PROTECT resource-scoped routes. When no `organizationId` is present (the case for
every `:projectId` / `:id` / `:versionId` / `:documentId` route) it INTENTIONALLY no-ops and
allows the request — the resource-scoped access is expected to be enforced elsewhere. A 2026-07
audit found ~16 controllers wrongly treated this guard as tenant protection on such routes,
leaving them cross-tenant. For any route keyed by a child id use `ResourceOrgGuard` +
`@RequireResourceOwnership(...)`, which resolves the resource → its owning org and 403s a
mismatch. Do NOT add new `:id`-scoped routes relying on this guard alone.

`OrganizationGuard` validates an explicit `organizationId` supplied in a request parameter, query string, or body against the caller’s organization membership. It is intended for organization-settings-style routes that directly name an organization; when no `organizationId` is present, it intentionally allows the request and does **not** provide tenant protection for resource-scoped routes. For `:projectId`, `:id`, `:versionId`, or similar child-resource routes, use `ResourceOrgGuard` with `@RequireResourceOwnership(...)` instead.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `canActivate` | `canActivate(context: ExecutionContext)` | `boolean` |

## Diagram

```mermaid
sequenceDiagram
  participant Client
  participant Controller
  participant OrganizationGuard
  participant AuthContext
  participant Handler

  Client->>Controller: Request with organizationId
  Controller->>OrganizationGuard: canActivate(context)
  OrganizationGuard->>OrganizationGuard: Read organizationId from params, query, or body

  alt organizationId is present
    OrganizationGuard->>AuthContext: Read caller organization
    alt IDs match
      OrganizationGuard->>Handler: Allow request
    else IDs do not match
      OrganizationGuard-->>Client: 403 Forbidden
    end
  else no explicit organizationId
    Note over OrganizationGuard: Intentional no-op for resource-scoped routes
    OrganizationGuard->>Handler: Allow request
  end
```

## Usage

```ts
import { Controller, Get, Param, UseGuards } from '@nestjs/common';
import { OrganizationGuard } from '@/auth/guards/organization.guard';

@Controller('organizations')
@UseGuards(OrganizationGuard)
export class OrganizationSettingsController {
  // Protected because organizationId is explicitly present in the route.
  @Get(':organizationId/settings')
  getSettings(@Param('organizationId') organizationId: string) {
    return { organizationId };
  }
}
```

```ts
// Do NOT use OrganizationGuard alone for child-resource routes:
//
// @Get('projects/:projectId')
// @UseGuards(OrganizationGuard) // Unsafe: no organizationId means this guard no-ops.
//
// Use ResourceOrgGuard + @RequireResourceOwnership(...) instead.
```

## AI Coding Instructions

- Use `OrganizationGuard` only when the route explicitly receives an `organizationId` through params, query, or request body.
- Do not treat this guard as general tenant isolation: it intentionally allows requests without an explicit `organizationId`.
- For routes scoped by child-resource IDs such as `:id`, `:projectId`, `:documentId`, or `:versionId`, use `ResourceOrgGuard` and `@RequireResourceOwnership(...)`.
- When adding organization settings endpoints, ensure the supplied `organizationId` is consistently named and available in one of the guard’s supported request locations.

<!-- source: class-pdfworkerunavailableerror.md -->

# PdfWorkerUnavailableError

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/doc-version/export.service.ts` (line 6)

Raised when the PDF-rendering worker can't be reached / fails the render.

**Extends:** `Error`

<!-- source: function-planorfull.md -->

# planOrFull

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/prompt-sections.ts` (line 97)

Mode is plan or full

## Signature

```ts
function planOrFull(ctx: SectionContext): boolean
```

## Parameters

| Name | Type |
|---|---|
| `ctx` | `SectionContext` |

**Returns:** `boolean`

<!-- source: class-statemachinedetector.md -->

# StateMachineDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/state-machine-detector.ts` (line 60)

State Machine Detector

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detect` | `detect(entities: Entity[])` | `DetectedStateMachine[]` |
| `linkTransitions` | `linkTransitions(stateMachines: DetectedStateMachine[], entities: Entity[])` | `void` |

<!-- source: function-statuschip.md -->

# statusChip

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/cr-shared.ts` (line 69)

Status chip for a CR row. An 'open' CR with a populated conflictState is
"needs review" — a merge attempt hit conflicts, not a failure.

## Signature

```ts
function statusChip(cr: Pick<ChangeRequest, 'status' | 'conflictState'>): StatusChip
```

## Parameters

| Name | Type |
|---|---|
| `cr` | `Pick<ChangeRequest, 'status' | 'conflictState'>` |

**Returns:** `StatusChip`

<!-- source: interface-subdomaincheckresult.md -->

# SubdomainCheckResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/lib/api-client.ts` (line 76)

## Properties

| Property | Type |
|---|---|
| `slug` | `string` |
| `available` | `boolean` |
| `reason` | `string` |

<!-- source: type-translation.md -->

# Translation

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 919)

## Definition

```ts
(
  key: string,
  defaultValue: string,
  interpolations?: Record<string, any>,
) => string
```

<!-- source: interface-claimtoverify.md -->

# ClaimToVerify

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/openai-reviewer.service.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `claim` | `string` |

<!-- source: api-endpoint-deleteversion.md -->

# deleteVersion

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 718)

## Endpoint

`DELETE /documents/:id/versions/:versionId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: constant-directivedescriptors.md -->

# directiveDescriptors$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 313)

Contains the currently registered Markdown directive descriptors.

<!-- source: interface-driftresult.md -->

# DriftResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/reconciler.service.ts` (line 38)

## Properties

| Property | Type |
|---|---|
| `inSync` | `boolean` |
| `differences` | `number` |
| `added` | `string[]` |
| `removed` | `string[]` |
| `changed` | `string[]` |
| `needsRenormalize` | `boolean` |

<!-- source: component-example-2.md -->

# Example

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/cm-merge.tsx` (line 42)

## Diagram

```mermaid
graph TD
    component_Example_30c25bb0["Example"]
    class component_Example_30c25bb0 rootComponent
```

## Relationships

- USES_HOOK → `useRef`
- USES_HOOK → `useCallback`

<!-- source: component-filterselect.md -->

# FilterSelect

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/all/page.tsx` (line 98)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `value` | `string` | ✓ | - |
| `onChange` | `Function` | ✓ | - |
| `label` | `string` | - | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FilterSelect_54797ffd["FilterSelect"]
    class component_FilterSelect_54797ffd rootComponent
```

## Referenced By

- `IssuesAllPageInner` (RENDERS)

<!-- source: function-formatvalidationreport.md -->

# formatValidationReport

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/coverage-validator.ts` (line 484)

Format validation report as human-readable text

## Signature

```ts
function formatValidationReport(report: ValidationReport): string
```

## Parameters

| Name | Type |
|---|---|
| `report` | `ValidationReport` |

**Returns:** `string`

<!-- source: interface-indexdefinition-2.md -->

# IndexDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 763)

Index definition

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `fields` | `string[]` |
| `unique` | `boolean` |
| `type` | `'btree' | 'hash' | 'gin' | 'gist' | 'fulltext'` |

<!-- source: function-loggroundingsummary.md -->

# logGroundingSummary

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/grounding-checker.ts` (line 178)

Log a summary of grounding validation results.

Categories:
- Well-grounded (>= 0.7)
- Partially grounded (0.3-0.7)
- Unverifiable (< 0.3)

## Signature

```ts
function logGroundingSummary(results: GroundingResult[]): void
```

## Parameters

| Name | Type |
|---|---|
| `results` | `GroundingResult[]` |

**Returns:** `void`

<!-- source: interface-mcphttpserverconfig.md -->

# McpHttpServerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/mcp/mcp-manager.ts` (line 40)

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `token` | `string` |

<!-- source: service-organizationservice.md -->

# OrganizationService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/organization/organization.service.ts` (line 20)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `list` | `list(user: JwtPayload)` | `Promise<Organization[]>` |
| `get` | `get(id: string, user: JwtPayload)` | `Promise<Organization>` |
| `update` | `update(id: string, dto: UpdateOrganizationDto, user: JwtPayload)` | `Promise<Organization>` |
| `getMembers` | `getMembers(id: string, user: JwtPayload)` | `Promise<any[]>` |
| `getSettings` | `getSettings(id: string, user: JwtPayload)` | `Promise<Record<string, any>>` |
| `updateSettings` | `updateSettings(id: string, dto: UpdateOrgSettingsDto, user: JwtPayload)` | `Promise<Organization>` |
| `getUserAudiences` | `getUserAudiences(organizationId: string, userId: string, currentUser: JwtPayload)` | `Promise<{ userId: string; audienceIds: string[] }>` |
| `updateUserAudiences` | `updateUserAudiences(organizationId: string, userId: string, dto: UpdateUserAudiencesDto, currentUser: JwtPayload)` | `Promise<{ userId: string; audienceIds: string[] }>` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: class-publicticketreplydto.md -->

# PublicTicketReplyDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/issues/dto/public-ticket.dto.ts` (line 4)

Customer reply from the public tracking page — session id proves ownership

## Properties

| Property | Type |
|---|---|
| `body` | `string` |
| `reporterSessionId` | `string` |

<!-- source: function-readheavy.md -->

# readHeavy

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/prompt-sections.ts` (line 101)

Mode is explore, plan, or full

## Signature

```ts
function readHeavy(ctx: SectionContext): boolean
```

## Parameters

| Name | Type |
|---|---|
| `ctx` | `SectionContext` |

**Returns:** `boolean`

<!-- source: interface-subdomainupdateresult.md -->

# SubdomainUpdateResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/lib/api-client.ts` (line 82)

## Properties

| Property | Type |
|---|---|
| `publishedSlug` | `string` |
| `publicUrl` | `string` |
| `project` | `{ id: string; publishedSlug: string }` |

<!-- source: class-suggestionendpoints.md -->

# SuggestionEndpoints

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/suggestions.ts` (line 28)

Suggestion endpoints

All routes are nested under the owning document
(`/documents/:documentId/suggestions/...`) to match the API's
SuggestionController — the old flat `/suggestions/:id` paths never existed
server-side.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `list` | `list(documentId: string, params: Omit<SuggestionListParams, 'documentId'>)` | `Promise<SuggestionWithUser[]>` |
| `get` | `get(documentId: string, suggestionId: string)` | `Promise<SuggestionWithUser>` |
| `create` | `create(documentId: string, dto: CreateSuggestionDto)` | `Promise<SuggestionWithUser>` |
| `update` | `update(suggestionId: string, dto: UpdateSuggestionDto)` | `Promise<SuggestionWithUser>` |
| `delete` | `delete(documentId: string, suggestionId: string)` | `Promise<void>` |
| `accept` | `accept(documentId: string, suggestionId: string, reviewComment: string)` | `Promise<SuggestionWithUser>` |
| `reject` | `reject(documentId: string, suggestionId: string, reviewComment: string)` | `Promise<SuggestionWithUser>` |

<!-- source: function-threadmatchesbucket.md -->

# threadMatchesBucket

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 162)

Does this thread still belong in the given bucket after a local mutation?

## Signature

```ts
function threadMatchesBucket(bucket: BucketKey, t: DeskThread): boolean
```

## Parameters

| Name | Type |
|---|---|
| `bucket` | `BucketKey` |
| `t` | `DeskThread` |

**Returns:** `boolean`

<!-- source: type-uilibrary.md -->

# UILibrary

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/framework.types.ts` (line 48)

Detected UI component library

## Definition

```ts
| 'devextreme'
  | 'mui'
  | 'antd'
  | 'chakra'
  | 'shadcn'
  | 'radix'
  | 'primereact'
  | 'primevue'
  | 'vuetify'
  | 'bootstrap'
  | 'tailwind'
  | 'none'
```

<!-- source: interface-claimverification.md -->

# ClaimVerification

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-11.types.ts` (line 52)

## Properties

| Property | Type |
|---|---|
| `claimId` | `string` |
| `status` | `'verified' | 'flagged' | 'uncertain'` |
| `groundingScore` | `number` |
| `openaiScore` | `number` |
| `issues` | `string[]` |

<!-- source: api-endpoint-deprecate.md -->

# deprecate

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 221)

## Endpoint

`POST /doc-versions/:projectId/:versionId/deprecate`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: constant-directivesplugin.md -->

# directivesPlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/directives/index.ts` (line 101)

A plugin that adds support for markdown directives.

<!-- source: interface-emailattachment.md -->

# EmailAttachment

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/email/email.service.ts` (line 5)

## Properties

| Property | Type |
|---|---|
| `filename` | `string` |
| `content` | `Buffer | string` |
| `contentType` | `string` |

<!-- source: component-example-3.md -->

# Example

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/i18n.tsx` (line 35)

## Diagram

```mermaid
graph TD
    component_Example_7d33a559["Example"]
    class component_Example_7d33a559 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: component-flaggeddoccard.md -->

# FlaggedDocCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/versions/[versionId]/review/page.tsx` (line 40)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `doc` | `unknown` | ✓ | - |
| `onResolve` | `Function` | ✓ | - |
| `resolving` | `boolean` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FlaggedDocCard_4fb68cee["FlaggedDocCard"]
    class component_FlaggedDocCard_4fb68cee rootComponent
```

## Relationships

- USES_HOOK → `useState`

## Referenced By

- `ReviewPage` (RENDERS)

<!-- source: function-generateallapiflowdiagrams.md -->

# generateAllAPIFlowDiagrams

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/api-flow-diagram.generator.ts` (line 492)

Generate flow diagrams for all API endpoints

## Signature

```ts
function generateAllAPIFlowDiagrams(endpoints: APIEndpointEntity[], allEntities: Entity[], relationships: Relationship[], options: APIFlowDiagramOptions): Array<{ endpointPath: string; method: string; result: APIFlowDiagramResult }>
```

## Parameters

| Name | Type |
|---|---|
| `endpoints` | `APIEndpointEntity[]` |
| `allEntities` | `Entity[]` |
| `relationships` | `Relationship[]` |
| `options` | `APIFlowDiagramOptions` |

**Returns:** `Array<{ endpointPath: string; method: string; result: APIFlowDiagramResult }>`

<!-- source: interface-iparser-2.md -->

# IParser

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/parser.interface.ts` (line 59)

Base interface that ALL parsers must implement

Each parser (React, NestJS, Prisma, etc.) implements this interface
to ensure consistent behavior across the system.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `version` | `string` |
| `supportedPatterns` | `string[]` |

<!-- source: function-makehsltransparent.md -->

# makeHslTransparent

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/makeHslTransparent.ts` (line 2)

## Signature

```ts
function makeHslTransparent(hsl: string, alpha: number)
```

## Parameters

| Name | Type |
|---|---|
| `hsl` | `string` |
| `alpha` | `number` |

<!-- source: interface-mcpmanageroptions.md -->

# McpManagerOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/mcp/mcp-manager.ts` (line 51)

## Properties

| Property | Type |
|---|---|
| `configPath` | `string` |

<!-- source: service-outboxpollerservice.md -->

# OutboxPollerService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/docs-repo/outbox-poller.service.ts` (line 18)

OutboxPollerService — the PRODUCER that actually runs the commit loop.

The outbox rows are only useful if something drains them; nothing else does. Every minute
(on the worker only) this reads the pending outbox grouped by project and enqueues ONE
coalesced commit job per project with pending work. The CommitterWorker then drains + commits.

GATED on DOCS_REPO_WORKER==='true' (mirrors technical-docs' worker gate) so the many api
replicas don't all poll and double-enqueue — only the dedicated 1-replica worker deployment
produces. ScheduleModule.forRoot() is registered app-wide, so

`OutboxPollerService` is the producer side of the docs-repository outbox pipeline. On the dedicated worker deployment, it runs every minute, finds pending outbox work grouped by project, and enqueues one coalesced commit job per project for `CommitterWorker` to drain and commit.

The poller is gated by `DOCS_REPO_WORKER === 'true'` so API replicas do not independently poll the outbox and create duplicate jobs.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `poll` | `poll()` | `Promise<void>` |
| `drainAndEnqueue` | `drainAndEnqueue()` | `Promise<number>` |

## Diagram

```mermaid
sequenceDiagram
    participant Scheduler as NestJS Scheduler
    participant Poller as OutboxPollerService
    participant Outbox as Docs Repo Outbox
    participant Queue as Commit Job Queue
    participant Worker as CommitterWorker
    participant Repo as Git Repository

    Scheduler->>Poller: Run every minute
    Poller->>Poller: Check DOCS_REPO_WORKER === "true"

    alt Worker deployment enabled
        Poller->>Outbox: Find pending rows grouped by project
        Outbox-->>Poller: Projects with pending work

        loop Each project with pending rows
            Poller->>Queue: Enqueue one coalesced commit job
        end

        Queue->>Worker: Process project commit job
        Worker->>Outbox: Drain pending outbox rows
        Worker->>Repo: Create and push commit
    else Non-worker API replica
        Poller-->>Poller: Skip polling
    end
```

## AI Coding Instructions

- Keep this service producer-only: it should discover pending outbox work and enqueue jobs, while `CommitterWorker` remains responsible for draining rows and writing commits.
- Preserve the `DOCS_REPO_WORKER === 'true'` gate on every polling path; API replicas must not poll or enqueue commit jobs.
- Coalesce work by project and enqueue at most one commit job per project per polling run, rather than creating one job per outbox row.
- Treat the outbox and queue as eventually consistent: commit jobs should be safe to retry, since rows may remain pending until `CommitterWorker` successfully commits them.
- `ScheduleModule.forRoot()` is registered application-wide; do not assume scheduled methods run only on worker pods without explicitly checking the worker environment gate.

## Relationships

- DEPENDS_ON → `configservice`
- DEPENDS_ON → `outboxservice`
- DEPENDS_ON → `docsrepoqueue`

<!-- source: class-publishdocumentdto.md -->

# PublishDocumentDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/publish-document.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `isPublic` | `boolean` |

<!-- source: function-reciprocalrankfusion.md -->

# reciprocalRankFusion

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/hybrid-search.ts` (line 38)

Merge BM25 and vector search results using Reciprocal Rank Fusion.

## Signature

```ts
function reciprocalRankFusion(bm25Results: RankedItem[], vectorResults: RankedItem[], topK: number, k: number): SearchResult[]
```

## Parameters

| Name | Type |
|---|---|
| `bm25Results` | `RankedItem[]` |
| `vectorResults` | `RankedItem[]` |
| `topK` | `number` |
| `k` | `number` |

**Returns:** `SearchResult[]`

<!-- source: class-sveltedetector.md -->

# SvelteDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/svelte-detector.ts` (line 57)

Svelte Detector

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detect` | `detect(entities: Entity[])` | `DetectedSvelteComponent[]` |
| `getComponentSummary` | `getComponentSummary(component: DetectedSvelteComponent)` | `string` |

<!-- source: interface-symbollistprops.md -->

# SymbolListProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Parser/SymbolList.tsx` (line 8)

## Properties

| Property | Type |
|---|---|
| `symbols` | `Symbol[]` |
| `onSymbolClick` | `(symbol: Symbol) => void` |
| `selectedSymbol` | `Symbol` |
| `className` | `string` |

<!-- source: function-timeago.md -->

# timeAgo

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 187)

## Signature

```ts
function timeAgo(iso: string): string
```

## Parameters

| Name | Type |
|---|---|
| `iso` | `string` |

**Returns:** `string`

<!-- source: type-uploadprogresscallback.md -->

# UploadProgressCallback

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 200)

## Definition

```ts
(progress: UploadProgress) => void | Promise<void>
```

<!-- source: interface-claimverificationresult.md -->

# ClaimVerificationResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/openai-reviewer.service.ts` (line 29)

## Properties

| Property | Type |
|---|---|
| `claimId` | `string` |
| `verdict` | `'verified' | 'flagged' | 'uncertain'` |
| `confidence` | `number` |
| `issue` | `string` |
| `suggestion` | `string` |

<!-- source: api-endpoint-detectflow.md -->

# detectFlow

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/graph.controller.ts` (line 166)

## Endpoint

`GET /knowledge-graph/flow/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `projectId` | query | `string` | ✓ |

## Referenced By

- `GraphController` (MODULE_DECLARES)

<!-- source: constant-directivevisitor.md -->

# DirectiveVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/directives/DirectiveVisitor.ts` (line 5)

## Definition

```ts
LexicalExportVisitor<DirectiveNode, LeafDirective>
```

<!-- source: interface-errorhandlingmetadata.md -->

# ErrorHandlingMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/tutorial-detector.service.ts` (line 16)

Error handling metadata for tutorial generation

## Properties

| Property | Type |
|---|---|
| `errorActions` | `string[]` |
| `recoveryActions` | `string[]` |
| `errorMessages` | `string[]` |

<!-- source: component-example-4.md -->

# Example

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/jsx.tsx` (line 98)

## Diagram

```mermaid
graph TD
    component_Example_3b01900a["Example"]
    class component_Example_3b01900a rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `InsertMyLeaf`

<!-- source: component-gapcard.md -->

# GapCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/ThreadList.tsx` (line 38)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `topic` | `TicketTopicProposal` | ✓ | - |
| `draft` | `GapDraftState | undefined` | ✓ | - |
| `onDraft` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_GapCard_4219f712["GapCard"]
    class component_GapCard_4219f712 rootComponent
```

## Referenced By

- `ThreadList` (RENDERS)

<!-- source: function-generateallcomponenthierarchydiagrams.md -->

# generateAllComponentHierarchyDiagrams

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/component-hierarchy-diagram.generator.ts` (line 461)

Generate hierarchy diagrams for all root components

## Signature

```ts
function generateAllComponentHierarchyDiagrams(components: ComponentEntity[], relationships: Relationship[], options: ComponentHierarchyDiagramOptions): Array<{ componentName: string; componentId: string; result: HierarchyDiagramResult }>
```

## Parameters

| Name | Type |
|---|---|
| `components` | `ComponentEntity[]` |
| `relationships` | `Relationship[]` |
| `options` | `ComponentHierarchyDiagramOptions` |

**Returns:** `Array<{ componentName: string; componentId: string; result: HierarchyDiagramResult }>`

<!-- source: interface-istorageprovider.md -->

# IStorageProvider

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/storage.interface.ts` (line 196)

Storage provider interface

Abstracts storage operations to support both file system and cloud modes

<!-- source: function-mapplaceholderswithintelligence.md -->

# mapPlaceholdersWithIntelligence

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/agent-screenshot-mapper.ts` (line 448)

Maps screenshot placeholders to exact specs using source code intelligence.
In production, the inner mapping would be done by an AI agent with the
intelligence injected into its context. For the POC, we use heuristic matching.

## Signature

```ts
function mapPlaceholdersWithIntelligence(intelligence: SourceCodeIntelligence, docs: DocScreenshotRequest[], siteUrl: string): AgentScreenshotSpec[]
```

## Parameters

| Name | Type |
|---|---|
| `intelligence` | `SourceCodeIntelligence` |
| `docs` | `DocScreenshotRequest[]` |
| `siteUrl` | `string` |

**Returns:** `AgentScreenshotSpec[]`

<!-- source: interface-mcpserverinfo.md -->

# McpServerInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/mcp/mcp-client.ts` (line 45)

## Properties

| Property | Type |
|---|---|
| `protocolVersion` | `string` |
| `capabilities` | `Record<string, unknown>` |
| `serverInfo` | `{ name: string; version: string }` |

<!-- source: service-outboxservice.md -->

# OutboxService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/docs-repo/outbox.service.ts` (line 39)

OutboxService — the transactional outbox for the docs substrate.

`record` is called AFTER a successful content mutation (publish/reconcile/regen). It is
fire-and-forget and RESILIENT: it writes ONE row and NEVER throws into the caller — a
failed outbox insert must not fail the request that already succeeded. The committer
worker drains these rows and coalesces them into repo commits.

`OutboxService` implements the transactional outbox for the documentation substrate. After a content mutation succeeds—such as publish, reconcile, or regeneration—it records a single durable outbox row without allowing insertion failures to affect the already-successful request. A committer worker later drains and coalesces these rows into repository commits.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `record` | `record(projectId: string, eventType: string, payload: Record<string, unknown>)` | `Promise<void>` |
| `drainPending` | `drainPending(limit: unknown)` | `Promise<OutboxBatch[]>` |
| `pendingForProject` | `pendingForProject(projectId: string, limit: unknown)` | `Promise<OutboxEvent[]>` |
| `pendingDepth` | `pendingDepth()` | `Promise<number>` |
| `markProcessed` | `markProcessed(ids: string[])` | `Promise<void>` |
| `incrementAttempts` | `incrementAttempts(ids: string[])` | `Promise<void>` |

## Diagram

```mermaid
sequenceDiagram
  participant Mutation as Content Mutation Service
  participant Outbox as OutboxService
  participant DB as Database
  participant Worker as Committer Worker
  participant Repo as Docs Repository

  Mutation->>Mutation: Publish / reconcile / regenerate content
  Mutation->>Outbox: record(event)
  Outbox->>DB: Insert one outbox row

  alt Insert succeeds
    DB-->>Outbox: Row persisted
  else Insert fails
    DB-->>Outbox: Error
    Outbox->>Outbox: Log/handle failure
  end

  Outbox-->>Mutation: Never throws
  Mutation-->>Mutation: Complete successful request

  Worker->>DB: Drain pending outbox rows
  Worker->>Worker: Coalesce related changes
  Worker->>Repo: Create repository commit
  Worker->>DB: Mark rows processed
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { OutboxService } from './outbox.service';

@Injectable()
export class DocumentPublisherService {
  constructor(private readonly outboxService: OutboxService) {}

  async publishDocument(documentId: string): Promise<void> {
    // Perform and commit the primary content mutation first.
    await this.publishDocumentContent(documentId);

    // Record the follow-up repository work after the mutation succeeds.
    // This call is resilient and must not fail the publish request.
    await this.outboxService.record({
      type: 'document.published',
      documentId,
    });
  }

  private async publishDocumentContent(documentId: string): Promise<void> {
    // Persist published document content.
  }
}
```

## AI Coding Instructions

- Call `record` only after the primary content mutation has completed successfully; do not enqueue events for failed or rolled-back mutations.
- Treat `record` as fire-and-forget/resilient behavior: failures must be contained inside `OutboxService` and must never fail the caller's request.
- Write one outbox row per successful mutation; let the committer worker handle batching and coalescing into repository commits.
- Keep event payloads sufficient for the committer worker to identify the affected documentation content without requiring request-local state.
- Do not replace the outbox with direct repository commits in mutation handlers; repository synchronization belongs to the worker that drains the outbox.

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: class-pythonparser.md -->

# PythonParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/parser/parsers/python.parser.ts` (line 15)

**Implements:** `CodeParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `parse` | `parse(code: string, _filename: undefined)` | `Promise<ParseResult>` |
| `extractSymbols` | `extractSymbols(code: string)` | `Promise<ParserSymbol[]>` |
| `extractDependencies` | `extractDependencies(code: string)` | `Promise<Dependency[]>` |

## Properties

| Property | Type |
|---|---|
| `language` | `any` |
| `supportedExtensions` | `any` |

<!-- source: function-resolvemodelprofile.md -->

# resolveModelProfile

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-profiles.ts` (line 224)

Resolves the capability profile to use for a given request.

## Signature

```ts
function resolveModelProfile(modelId: string | undefined, explicit: ModelCapabilityProfile): ModelCapabilityProfile
```

## Parameters

| Name | Type |
|---|---|
| `modelId` | `string | undefined` |
| `explicit` | `ModelCapabilityProfile` |

**Returns:** `ModelCapabilityProfile`

<!-- source: interface-templategalleryprops.md -->

# TemplateGalleryProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Templates/TemplateGallery.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `onSelect` | `(template: DocumentTemplate) => void` |
| `organizationId` | `string` |
| `title` | `string` |
| `showSearch` | `boolean` |

<!-- source: class-themeengine.md -->

# ThemeEngine

**Kind:** Class

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/theme-engine.ts` (line 25)

ThemeEngine - A framework-agnostic theming system for Atloria

Features:
- CSS Variables-based theming
- Dark/Light mode support
- localStorage persistence
- System preference detection
- SSR support (no flash of unstyled content)
- Cross-tab synchronization
- White-label support via custom tokens

## Methods

| Method | Signature | Returns |
|---|---|---|
| `setMode` | `setMode(mode: ThemeMode)` | `void` |
| `getMode` | `getMode()` | `ThemeMode` |
| `getEffectiveThemeMode` | `getEffectiveThemeMode()` | `'light' | 'dark'` |
| `enableDarkMode` | `enableDarkMode()` | `void` |
| `disableDarkMode` | `disableDarkMode()` | `void` |
| `toggleDarkMode` | `toggleDarkMode()` | `void` |
| `useSystemPreference` | `useSystemPreference()` | `void` |
| `getTheme` | `getTheme()` | `ThemeTokens` |
| `updateTheme` | `updateTheme(updates: Partial<ThemeTokens>)` | `void` |
| `subscribe` | `subscribe(listener: ThemeEventListener)` | `() => void` |
| `getSSRScript` | `getSSRScript(config: ThemeConfig)` | `string` |
| `destroy` | `destroy()` | `void` |

<!-- source: function-timeago-2.md -->

# timeAgo

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Boards/helpers.ts` (line 49)

## Signature

```ts
function timeAgo(iso: string): string
```

## Parameters

| Name | Type |
|---|---|
| `iso` | `string` |

**Returns:** `string`

<!-- source: type-uploadprogresscallback-2.md -->

# UploadProgressCallback

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-uploader.service.ts` (line 32)

## Definition

```ts
(progress: UploadProgress) => void
```

<!-- source: interface-claudeconfig.md -->

# ClaudeConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/claude.provider.ts` (line 165)

## Properties

| Property | Type |
|---|---|
| `azureEndpoint` | `string` |
| `azureApiKey` | `string` |
| `azureAccessToken` | `string` |
| `anthropicApiKey` | `string` |
| `model` | `string` |
| `maxTokens` | `number` |
| `temperature` | `number` |
| `timeout` | `number` |
| `retry` | `Partial<RetryConfig>` |

<!-- source: api-endpoint-detectimpact.md -->

# detectImpact

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/graph.controller.ts` (line 176)

## Endpoint

`GET /knowledge-graph/impact/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `projectId` | query | `string` | ✓ |

## Referenced By

- `GraphController` (MODULE_DECLARES)

<!-- source: constant-disableautolink.md -->

# disableAutoLink$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link/index.tsx` (line 15)

Holds whether the auto-linking of URLs and email addresses is disabled.

<!-- source: component-example-5.md -->

# Example

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/nested-jsx-elements.tsx` (line 98)

## Diagram

```mermaid
graph TD
    component_Example_389a950e["Example"]
    class component_Example_389a950e rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `UndoRedo`
- RENDERS → `InsertCard`
- RENDERS → `InsertGrid`

<!-- source: interface-export.md -->

# Export

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/parser/interfaces/code-parser.interface.ts` (line 58)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `'default' | 'named'` |

<!-- source: function-generateallsequencediagrams.md -->

# generateAllSequenceDiagrams

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/sequence-diagram.generator.ts` (line 540)

Generate sequence diagrams for all API endpoints

## Signature

```ts
function generateAllSequenceDiagrams(entities: Entity[], relationships: Relationship[], options: SequenceDiagramOptions): Map<string, SequenceDiagramResult>
```

## Parameters

| Name | Type |
|---|---|
| `entities` | `Entity[]` |
| `relationships` | `Relationship[]` |
| `options` | `SequenceDiagramOptions` |

**Returns:** `Map<string, SequenceDiagramResult>`

<!-- source: component-generatebutton.md -->

# GenerateButton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/ApiReferenceReader.tsx` (line 162)

## Diagram

```mermaid
graph TD
    component_GenerateButton_5296dcc["GenerateButton"]
    class component_GenerateButton_5296dcc rootComponent
```

## Relationships

- RENDERS → `ArrowPathIcon`

## Referenced By

- `ApiReferenceReader` (RENDERS)

<!-- source: interface-linkelement.md -->

# LinkElement

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/template-analysis.interface.ts` (line 40)

Link/anchor element detected in template

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `path` | `string` |
| `isRouterLink` | `boolean` |
| `isDynamic` | `boolean` |
| `line` | `number` |
| `conditionalOn` | `string` |

<!-- source: function-markdownengine.md -->

# markdownEngine

**Kind:** Function

**Source:** `atloria-monorepo/packages/markdown-engine/src/lib/markdown-engine.ts` (line 1)

## Signature

```ts
function markdownEngine(): string
```

**Returns:** `string`

<!-- source: interface-mcpstdiooptions.md -->

# McpStdioOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/mcp/mcp-client.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `transport` | `'stdio'` |
| `command` | `string` |
| `args` | `string[]` |
| `env` | `Record<string, string>` |

<!-- source: service-pageregenservice.md -->

# PageRegenService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/docs-pr/page-regen.service.ts` (line 42)

Regenerates ONE doc page's markdown straight from the code entity graph, using the
exact same deterministic renderer the whole-project materializer uses — scoped to a
single document. This is Rung 1 of the freshness ladder (scoped redraft).

Grounding is preserved: `renderEntityPage` renders only from the entity + its
relationships + its stored AI enrichment, so every line traces to a code symbol.
No LLM, no whole-project rebuild.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `regenerateFromCode` | `regenerateFromCode(documentId: string)` | `Promise<RegeneratedPage | null>` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: class-redactboxdto.md -->

# RedactBoxDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/capture/dto/create-flow.dto.ts` (line 32)

A rectangular region (PERCENT 0-100 of the natural screenshot) the owner marked
to be blacked-out. Unlike annotation overlays (coordinates only), a redaction is
BURNED into the stored asset by the worker on the next (re)shoot — the underlying
pixels are destroyed, so a leaked value can never be recovered from the image.

## Properties

| Property | Type |
|---|---|
| `x` | `number` |
| `y` | `number` |
| `w` | `number` |
| `h` | `number` |

<!-- source: function-revieworfull.md -->

# reviewOrFull

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/prompt-sections.ts` (line 105)

Mode is review or full

## Signature

```ts
function reviewOrFull(ctx: SectionContext): boolean
```

## Parameters

| Name | Type |
|---|---|
| `ctx` | `SectionContext` |

**Returns:** `boolean`

<!-- source: interface-themetokens.md -->

# ThemeTokens

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/theme-presets.ts` (line 7)

Theme presets (4.2): whole-page token packs for the published docs viewer.
Light-spectrum on purpose — content surfaces stay readable without a dark-mode
overhaul of every page. A preset sets page/sidebar/border tokens plus default
primary/accent; explicit custom brand colors always override the preset's.

## Properties

| Property | Type |
|---|---|
| `primary` | `string` |
| `accent` | `string` |
| `pageBg` | `string` |
| `surface` | `string` |
| `border` | `string` |
| `sidebarText` | `string` |
| `dark` | `boolean` |
| `text` | `string` |
| `textMuted` | `string` |
| `codeBg` | `string` |

<!-- source: function-timeago-3.md -->

# timeAgo

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/cr-shared.ts` (line 96)

## Signature

```ts
function timeAgo(date: string): string
```

## Parameters

| Name | Type |
|---|---|
| `date` | `string` |

**Returns:** `string`

<!-- source: class-timeouterror.md -->

# TimeoutError

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/types/errors.ts` (line 77)

Timeout error

**Extends:** `NetworkError`

<!-- source: type-upsertoperation.md -->

# UpsertOperation

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 264)

Upsert operation type

## Definition

```ts
'create' | 'update' | 'skip'
```

<!-- source: interface-claudegenerateoptions.md -->

# ClaudeGenerateOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/claude.provider.ts` (line 197)

## Properties

| Property | Type |
|---|---|
| `maxTokens` | `number` |
| `temperature` | `number` |
| `systemPrompt` | `string` |
| `messages` | `ClaudeMessage[]` |
| `stopSequences` | `string[]` |

<!-- source: api-endpoint-diffdocument.md -->

# diffDocument

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 85)

## Endpoint

`GET /doc-versions/:projectId/compare/document`

| Parameter | In | Type | Required |
|---|---|---|---|
| `docA` | query | `string` | ✓ |
| `docB` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: constant-disabledstate.md -->

# disabledState

**Kind:** Constant

**Source:** `atloria-monorepo/packages/ui-core/src/utils/styles.ts` (line 43)

<!-- source: component-example-6.md -->

# Example

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/realm-plugin.tsx` (line 30)

## Diagram

```mermaid
graph TD
    component_Example_138f5b4c["Example"]
    class component_Example_138f5b4c rootComponent
```

## Relationships

- RENDERS → `RealmWithPlugins`
- RENDERS → `Child`
- USES_HOOK → `useState`

<!-- source: interface-extractedkeywords.md -->

# ExtractedKeywords

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/keyword-extractor.service.ts` (line 6)

Extracted keywords with metadata

## Properties

| Property | Type |
|---|---|
| `primary` | `string[]` |
| `secondary` | `string[]` |
| `technical` | `string[]` |
| `actions` | `string[]` |
| `entities` | `string[]` |

<!-- source: function-generateallstatemachinediagrams.md -->

# generateAllStateMachineDiagrams

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/state-machine-diagram.generator.ts` (line 416)

Generate multiple diagrams for all state machines in a component

## Signature

```ts
function generateAllStateMachineDiagrams(stateMachines: StateMachine[], screenshots: EnhancedScreenshotMetadata[], interactions: UIInteraction[], options: StateMachineDiagramOptions): Array<{ name: string; result: DiagramGenerationResult }>
```

## Parameters

| Name | Type |
|---|---|
| `stateMachines` | `StateMachine[]` |
| `screenshots` | `EnhancedScreenshotMetadata[]` |
| `interactions` | `UIInteraction[]` |
| `options` | `StateMachineDiagramOptions` |

**Returns:** `Array<{ name: string; result: DiagramGenerationResult }>`

<!-- source: component-generatedocmodal.md -->

# GenerateDocModal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/page.tsx` (line 1137)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `visible` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `onReopen` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_GenerateDocModal_5453a0cb["GenerateDocModal"]
    class component_GenerateDocModal_5453a0cb rootComponent
```

## Relationships

- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

## Referenced By

- `ProjectPage` (RENDERS)

<!-- source: interface-linkinfo-2.md -->

# LinkInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 986)

Link information

## Properties

| Property | Type |
|---|---|
| `text` | `string` |
| `url` | `string` |
| `line` | `number` |
| `isInternal` | `boolean` |

<!-- source: interface-mcpstdioserverconfig.md -->

# McpStdioServerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/mcp/mcp-manager.ts` (line 34)

## Properties

| Property | Type |
|---|---|
| `command` | `string` |
| `args` | `string[]` |
| `env` | `Record<string, string>` |

<!-- source: function-mdastdirectivevisitor.md -->

# MdastDirectiveVisitor

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/directives/MdastDirectiveVisitor.ts` (line 17)

## Signature

```ts
function MdastDirectiveVisitor(escapeUnknownTextDirectives)
```

## Parameters

| Name | Type |
|---|---|
| `escapeUnknownTextDirectives` | `any` |

<!-- source: service-parserservice.md -->

# ParserService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/parser/parser.service.ts` (line 11)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `parse` | `parse(code: string, language: string, filename: string)` | `Promise<ParseResult>` |
| `parseDocument` | `parseDocument(documentId: string)` | `Promise<any>` |
| `getSupportedLanguages` | `getSupportedLanguages()` | `string[]` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `typescriptparser`
- DEPENDS_ON → `javascriptparser`
- DEPENDS_ON → `pythonparser`

<!-- source: class-refreshtokendto.md -->

# RefreshTokenDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/auth/dto/refresh-token.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `refreshToken` | `string` |

<!-- source: function-runevaluation.md -->

# runEvaluation

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/swebench-evaluator.ts` (line 144)

Run the SWE-bench Docker evaluation harness.

This executes the official harness which:
1. Pulls pre-built Docker images per task (correct Python, conda, deps)
2. Applies the agent's patch to a clean repo checkout
3. Runs the gold test patch and tests
4. Reports pass/fail per task

## Signature

```ts
function runEvaluation(options: EvalCommandOptions, log: (msg: string) => void): EvalResult[]
```

## Parameters

| Name | Type |
|---|---|
| `options` | `EvalCommandOptions` |
| `log` | `(msg: string) => void` |

**Returns:** `EvalResult[]`

<!-- source: interface-tickettopicproposal.md -->

# TicketTopicProposal

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/deskTypes.ts` (line 107)

## Properties

| Property | Type |
|---|---|
| `topicKey` | `string` |
| `title` | `string` |
| `ticketCount` | `number` |
| `exampleQuestions` | `string[]` |
| `suggestedAnswerSourcePages` | `Array<{ slug: string; title: string }>` |

<!-- source: class-timeouterror-2.md -->

# TimeoutError

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/errors.ts` (line 233)

Error thrown when operation times out

**Extends:** `PipelineError`

## Properties

| Property | Type |
|---|---|
| `timeoutMs` | `number` |
| `operation` | `string` |

<!-- source: function-trackcustomevent.md -->

# trackCustomEvent

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/analytics/usePageTracking.ts` (line 337)

Track custom events (e.g., button clicks, downloads)

## Signature

```ts
async function trackCustomEvent(options: {
  projectId: string;
  eventName: string;
  metadata?: Record<string, any>;
})
```

## Parameters

| Name | Type |
|---|---|
| `options` | `{
  projectId: string;
  eventName: string;
  metadata?: Record<string, any>;
}` |

<!-- source: type-v2progresscallback.md -->

# V2ProgressCallback

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/orchestrator.ts` (line 290)

## Definition

```ts
(update: V2ProgressUpdate) => void | Promise<void>
```

<!-- source: interface-claudemessage.md -->

# ClaudeMessage

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/claude.provider.ts` (line 184)

## Properties

| Property | Type |
|---|---|
| `role` | `'user' | 'assistant'` |
| `content` | `string` |

<!-- source: constant-disableimageresize.md -->

# disableImageResize$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 161)

Holds the disable image resize configuration flag.

<!-- source: api-endpoint-disconnect.md -->

# disconnect

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/bitbucket/bitbucket.controller.ts` (line 89)

## Endpoint

`POST /bitbucket/disconnect`

## Referenced By

- `BitbucketController` (MODULE_DECLARES)

<!-- source: component-example-7.md -->

# Example

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/remote.tsx` (line 18)

## Diagram

```mermaid
graph TD
    component_Example_1c49d601["Example"]
    class component_Example_1c49d601 rootComponent
```

## Relationships

- RENDERS → `RemoteMDXEditorRealmProvider`
- RENDERS → `ExampleRemoteRealmAccessor`
- RENDERS → `MDXEditor`
- USES_HOOK → `useRef`

<!-- source: interface-feature.md -->

# Feature

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/ai/services/business-context-parser.service.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `category` | `string` |
| `capabilities` | `string[]` |

<!-- source: function-generateapiflowcss.md -->

# generateAPIFlowCSS

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/api-flow-diagram.generator.ts` (line 462)

Generate CSS for API flow diagram styling

## Signature

```ts
function generateAPIFlowCSS(): string
```

**Returns:** `string`

<!-- source: component-githubicon.md -->

# GitHubIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/scenes/SceneUrlInput.tsx` (line 8)

## Diagram

```mermaid
graph TD
    component_GitHubIcon_2dd13e9a["GitHubIcon"]
    class component_GitHubIcon_2dd13e9a rootComponent
```

## Referenced By

- `SceneUrlInput` (RENDERS)

<!-- source: interface-llmsdoc.md -->

# LlmsDoc

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/llms-txt.ts` (line 28)

## Properties

| Property | Type |
|---|---|
| `projectName` | `string` |
| `summary` | `string` |
| `pages` | `LlmsPage[]` |

<!-- source: interface-mcptooldefinition.md -->

# McpToolDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/mcp/mcp-client.ts` (line 51)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `inputSchema` | `Record<string, unknown>` |

<!-- source: function-mergestyleattributes.md -->

# mergeStyleAttributes

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/mergeStyleAttributes.ts` (line 1)

## Signature

```ts
function mergeStyleAttributes(style1: string, style2: string): string
```

## Parameters

| Name | Type |
|---|---|
| `style1` | `string` |
| `style2` | `string` |

**Returns:** `string`

<!-- source: service-parsingservice.md -->

# ParsingService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/parsing/parsing.service.ts` (line 7)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `startParsing` | `startParsing(projectId: string, dto: ParseProjectDto)` | `Promise<ParseStatusDto>` |
| `getParseStatus` | `getParseStatus(projectId: string, jobId: string)` | `Promise<ParseStatusDto>` |
| `cancelParsing` | `cancelParsing(projectId: string, jobId: string)` | `Promise<{ success: boolean; message: string }>` |
| `getProjectParsingJobs` | `getProjectParsingJobs(projectId: string, limit: number)` | `Promise<ParseStatusDto[]>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `parsingqueue`

<!-- source: class-registerdto.md -->

# RegisterDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/auth/dto/register.dto.ts` (line 14)

Public registration DTO.

SECURITY: This DTO deliberately does NOT accept `organizationId` or `role`.
Open registration always creates a fresh organization with the registrant
as its ADMIN. Joining an existing organization is only possible through
the invitation-token flow (see InvitationService). The global
ValidationPipe uses `whitelist` + `forbidNonWhitelisted`, so payloads
carrying extra fields like `organizationId` are rejected with 400.

## Properties

| Property | Type |
|---|---|
| `email` | `string` |
| `name` | `string` |
| `password` | `string` |

<!-- source: function-runpreflightchecks.md -->

# runPreflightChecks

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/test-watcher.ts` (line 307)

Run pre-flight environment checks before agent starts.

## Signature

```ts
function runPreflightChecks(config: PreflightConfig): PreflightResult[]
```

## Parameters

| Name | Type |
|---|---|
| `config` | `PreflightConfig` |

**Returns:** `PreflightResult[]`

<!-- source: interface-timeserieschartprops.md -->

# TimeSeriesChartProps

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/TimeSeriesChart.tsx` (line 21)

## Properties

| Property | Type |
|---|---|
| `data` | `TimeSeriesDataPoint[]` |
| `loading` | `boolean` |
| `title` | `string` |
| `height` | `number` |

<!-- source: class-tokenlimiterror.md -->

# TokenLimitError

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/errors.ts` (line 85)

Error thrown when token limit is exceeded

**Extends:** `PipelineError`

## Properties

| Property | Type |
|---|---|
| `tokenCount` | `number` |
| `maxTokens` | `number` |

<!-- source: function-tracksearch.md -->

# trackSearch

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/analytics/usePageTracking.ts` (line 317)

Track search queries

## Signature

```ts
async function trackSearch(options: {
  projectId: string;
  docVersionId?: string;
  query: string;
  resultsCount: number;
  clickedDocId?: string;
})
```

## Parameters

| Name | Type |
|---|---|
| `options` | `{
  projectId: string;
  docVersionId?: string;
  query: string;
  resultsCount: number;
  clickedDocId?: string;
}` |

<!-- source: type-viewmode-2.md -->

# ViewMode

**Kind:** Type

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 854)

## Definition

```ts
'rich-text' | 'source' | 'diff'
```

<!-- source: interface-clauderesponse.md -->

# ClaudeResponse

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/claude.provider.ts` (line 189)

## Properties

| Property | Type |
|---|---|
| `content` | `string` |
| `inputTokens` | `number` |
| `outputTokens` | `number` |
| `model` | `string` |
| `stopReason` | `string` |

<!-- source: constant-disableimagesettingsbutton.md -->

# disableImageSettingsButton$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 340)

<!-- source: api-endpoint-disconnect-2.md -->

# disconnect

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/github/github.controller.ts` (line 109)

Disconnect GitHub from user account

## Endpoint

`POST /github/disconnect`

## Referenced By

- `GitHubController` (MODULE_DECLARES)

<!-- source: component-expressionattributes.md -->

# ExpressionAttributes

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/jsx.tsx` (line 202)

## Diagram

```mermaid
graph TD
    component_ExpressionAttributes_148b0091["ExpressionAttributes"]
    class component_ExpressionAttributes_148b0091 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: interface-featuredocumentation.md -->

# FeatureDocumentation

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/feature-docs-generator.service.ts` (line 9)

Generated feature documentation

## Properties

| Property | Type |
|---|---|
| `feature` | `DetectedFeature` |
| `content` | `{
    overview: string;
    gettingStarted: string;
    howItWorks: string;
    usageGuide: string;
    configuration: string;
    examples: string;
    bestPractices: string;
    troubleshooting: string;
    apiReference: string;
  }` |
| `metadata` | `{
    generatedAt: Date;
    estimatedReadTime: string;
    complexity: string;
  }` |

<!-- source: function-generateapiflowdiagram.md -->

# generateAPIFlowDiagram

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/api-flow-diagram.generator.ts` (line 418)

Generate API flow diagram

## Signature

```ts
function generateAPIFlowDiagram(endpoint: APIEndpointEntity, allEntities: Entity[], relationships: Relationship[], options: APIFlowDiagramOptions): APIFlowDiagramResult
```

## Parameters

| Name | Type |
|---|---|
| `endpoint` | `APIEndpointEntity` |
| `allEntities` | `Entity[]` |
| `relationships` | `Relationship[]` |
| `options` | `APIFlowDiagramOptions` |

**Returns:** `APIFlowDiagramResult`

<!-- source: component-gitlabicon.md -->

# GitLabIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/scenes/SceneUrlInput.tsx` (line 14)

## Diagram

```mermaid
graph TD
    component_GitLabIcon_20b6c0ce["GitLabIcon"]
    class component_GitLabIcon_20b6c0ce rootComponent
```

## Referenced By

- `SceneUrlInput` (RENDERS)

<!-- source: interface-llmspage.md -->

# LlmsPage

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/llms-txt.ts` (line 16)

Agent-native docs layer — llms.txt + llms-full.txt generators (llmstxt.org).

`llms.txt` is a curated, link-based INDEX an LLM reads to navigate the docs: an H1 project
name, a blockquote summary, then `##` sections each holding a bullet list of
`[title](path.md): description`. A section literally named `## Optional` is lower-priority
(an agent may skip it under a tight context budget) and is emitted last.

`llms-full.txt` is the entire documentation concatenated into one markdown file for a single
ingest, each page prefixed with a `<!-- source: … -->` comment for traceability.

Both are pure functions over a generic doc shape so the CLI and the web materializer can feed
their own doc sets in.

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `path` | `string` |
| `section` | `string` |
| `description` | `string` |
| `markdown` | `string` |
| `importance` | `number` |

<!-- source: interface-memorymanagerconfig.md -->

# MemoryManagerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/memory/types.ts` (line 105)

## Properties

| Property | Type |
|---|---|
| `storageDir` | `string` |
| `maxMemoriesPerProject` | `number` |
| `stalenessDays` | `number` |
| `maxContextMemories` | `number` |

<!-- source: function-noop.md -->

# noop

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/fp.ts` (line 81)

an empty function

<!-- source: service-playwrightgeneratorservice.md -->

# PlaywrightGeneratorService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/ai/services/playwright-generator.service.ts` (line 47)

Playwright Test Generator Service

Generates comprehensive Playwright tests from UI documentation:
1. Page Object Models
2. Test suites with fixtures
3. Selectors and utilities
4. Test data generators

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generateTestSuite` | `generateTestSuite(pageDoc: {
    path: string;
    component: string;
    title: string;
    description: string;
    elements: any[];
    validations: any[];
    interactions: any[];
  })` | `Promise<PlaywrightTestSuite>` |
| `writeTestSuite` | `writeTestSuite(suite: PlaywrightTestSuite, outputDir: string)` | `Promise<void>` |

## Relationships

- DEPENDS_ON → `aiservice`

<!-- source: class-reordercolumnsdto.md -->

# ReorderColumnsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/boards/dto/column.dto.ts` (line 48)

## Properties

| Property | Type |
|---|---|
| `columnIds` | `string[]` |

<!-- source: function-runprocessorpipeline.md -->

# runProcessorPipeline

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/context/history-processors.ts` (line 286)

Run the processor pipeline over input items.
Returns the transformed items (never mutates the originals).

## Signature

```ts
function runProcessorPipeline(processors: HistoryProcessor[], items: AgentInputItem[]): AgentInputItem[]
```

## Parameters

| Name | Type |
|---|---|
| `processors` | `HistoryProcessor[]` |
| `items` | `AgentInputItem[]` |

**Returns:** `AgentInputItem[]`

<!-- source: interface-timeseriesdatapoint.md -->

# TimeSeriesDataPoint

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/TimeSeriesChart.tsx` (line 15)

## Properties

| Property | Type |
|---|---|
| `date` | `string` |
| `views` | `number` |
| `uniqueVisitors` | `number` |

<!-- source: class-tokentracker.md -->

# TokenTracker

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/pipeline/token-tracker.ts` (line 54)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `recordUsage` | `recordUsage(usage: Omit<TokenUsage, 'timestamp' | 'cost'>)` | `TokenUsage` |
| `calculateCost` | `calculateCost(inputTokens: number, outputTokens: number, model: 'claude' | 'openai')` | `number` |
| `hasCapacity` | `hasCapacity(estimatedTokens: number)` | `boolean` |
| `getRemainingBudget` | `getRemainingBudget()` | `number` |
| `getStageUsage` | `getStageUsage(stage: JobStage)` | `StageTokenSummary` |
| `getSummary` | `getSummary()` | `TokenSummary` |
| `getHistory` | `getHistory()` | `TokenUsage[]` |
| `estimateCost` | `estimateCost(estimatedInputTokens: number, estimatedOutputTokens: number, model: 'claude' | 'openai')` | `{
    estimatedCostUsd: number;
    withinBudget: boolean;
    budgetRemaining: number;
  }` |
| `reset` | `reset()` | `void` |

<!-- source: function-uifmt.md -->

# uiFmt

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/uiStrings.ts` (line 532)

Localized UI string with `{token}` replacement.

## Signature

```ts
function uiFmt(lang: string | null | undefined, key: UiStringKey, params: Record<string, string | number>): string
```

## Parameters

| Name | Type |
|---|---|
| `lang` | `string | null | undefined` |
| `key` | `UiStringKey` |
| `params` | `Record<string, string | number>` |

**Returns:** `string`

<!-- source: type-workercaptureprogresscallback.md -->

# WorkerCaptureProgressCallback

**Kind:** Type

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/worker-capturer.service.ts` (line 37)

## Definition

```ts
(progress: WorkerCaptureProgress) => void
```

<!-- source: interface-clientconfig.md -->

# ClientConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/types/config.ts` (line 4)

Configuration for the Atloria API client

## Properties

| Property | Type |
|---|---|
| `baseURL` | `string` |
| `token` | `string` |
| `timeout` | `number` |
| `maxRetries` | `number` |
| `enableDeduplication` | `boolean` |
| `enableLogging` | `boolean` |
| `headers` | `Record<string, string>` |
| `onTokenRefresh` | `(token: string) => void` |
| `onAuthError` | `() => void` |

<!-- source: api-endpoint-disconnect-3.md -->

# disconnect

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/gitlab/gitlab.controller.ts` (line 109)

Disconnect GitLab from user account

## Endpoint

`POST /gitlab/disconnect`

## Referenced By

- `GitLabController` (MODULE_DECLARES)

<!-- source: constant-documentation-critical-patterns.md -->

# DOCUMENTATION_CRITICAL_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 529)

<!-- source: component-fakeimage.md -->

# FakeImage

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/images.tsx` (line 83)

## Diagram

```mermaid
graph TD
    component_FakeImage_3a618d69["FakeImage"]
    class component_FakeImage_3a618d69 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `InsertImage`

<!-- source: interface-filediff.md -->

# FileDiff

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/change-request/diff.types.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `path` | `string` |
| `status` | `'added'|'modified'|'deleted'` |
| `additions` | `number` |
| `deletions` | `number` |
| `hunks` | `DiffHunk[]` |
| `sections` | `SectionDiff[]` |

<!-- source: function-generatecomponenthierarchydiagram.md -->

# generateComponentHierarchyDiagram

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/component-hierarchy-diagram.generator.ts` (line 363)

Generate component hierarchy diagram

## Signature

```ts
function generateComponentHierarchyDiagram(rootComponent: ComponentEntity, allComponents: ComponentEntity[], relationships: Relationship[], options: ComponentHierarchyDiagramOptions): HierarchyDiagramResult
```

## Parameters

| Name | Type |
|---|---|
| `rootComponent` | `ComponentEntity` |
| `allComponents` | `ComponentEntity[]` |
| `relationships` | `Relationship[]` |
| `options` | `ComponentHierarchyDiagramOptions` |

**Returns:** `HierarchyDiagramResult`

<!-- source: component-issuedetailpageinner.md -->

# IssueDetailPageInner

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/[ticketId]/page.tsx` (line 476)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_IssueDetailPageInner_22b710c4["IssueDetailPageInner"]
    class component_IssueDetailPageInner_22b710c4 rootComponent
```

## Relationships

- RENDERS → `Shimmer`
- RENDERS → `Button`
- RENDERS → `ArrowLeftIcon`
- RENDERS → `motion-div`
- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `CopyButton`
- RENDERS → `ArrowTopRightOnSquareIcon`
- RENDERS → `currentStatus-icon`
- RENDERS → `ChatBubbleLeftEllipsisIcon`
- RENDERS → `CategoryIcon`
- RENDERS → `CheckCircleSolid`
- RENDERS → `UserCircleIcon`
- RENDERS → `StatusJourney`
- RENDERS → `ClockIcon`
- RENDERS → `CheckCircleIcon`
- RENDERS → `ArrowPathIcon`
- RENDERS → `ViewColumnsIcon`
- RENDERS → `card-icon`
- RENDERS → `Card`
- RENDERS → `DocumentTextIcon`
- RENDERS → `EditableDescription`
- RENDERS → `AnimatePresence`
- RENDERS → `EyeSlashIcon`
- RENDERS → `ActionIcon`
- RENDERS → `PaperAirplaneIcon`
- RENDERS → `AdjustmentsHorizontalIcon`
- RENDERS → `PropertyRow`
- RENDERS → `ColoredSelect`
- RENDERS → `Badge`
- RENDERS → `ComputerDesktopIcon`
- RENDERS → `motion-button`
- RENDERS → `RIcon`
- RENDERS → `TrashIcon`
- RENDERS → `XCircleIcon`
- RENDERS → `BoardPicker`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useRouter`
- USES_HOOK → `useRef`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`
- USES_HOOK → `useMemo`

## Referenced By

- `IssueDetailPage` (RENDERS)

<!-- source: interface-llmstxtoptions.md -->

# LlmsTxtOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/llms-txt.ts` (line 34)

## Properties

| Property | Type |
|---|---|
| `baseUrl` | `string` |
| `tierThreshold` | `number` |
| `topCount` | `number` |

<!-- source: interface-memorymanageroptions.md -->

# MemoryManagerOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/memory/memory-manager.ts` (line 34)

## Properties

| Property | Type |
|---|---|
| `store` | `MemoryStore` |
| `modelCall` | `(prompt: string) => Promise<string>` |

<!-- source: function-normalize.md -->

# normalize

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-normalizer/src/lib/normalize.ts` (line 27)

## Signature

```ts
function normalize(markdown: string): string
```

## Parameters

| Name | Type |
|---|---|
| `markdown` | `string` |

**Returns:** `string`

<!-- source: service-pmeservice.md -->

# PmeService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/pme/pme.service.ts` (line 9)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createJob` | `createJob(dto: CreatePmeJobDto, userId: string)` | `unknown` |
| `getJob` | `getJob(jobId: string)` | `unknown` |
| `getJobsByProject` | `getJobsByProject(projectId: string)` | `unknown` |
| `getVariants` | `getVariants(jobId: string)` | `unknown` |
| `selectVariant` | `selectVariant(variantId: string)` | `unknown` |
| `startStrategy` | `startStrategy(dto: CreatePmeJobDto, userId: string)` | `unknown` |
| `finalizePage` | `finalizePage(dto: FinalizePmePageDto)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `queue`

<!-- source: class-repositorycredentialsdto.md -->

# RepositoryCredentialsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/parsing/dto/parse-project.dto.ts` (line 47)

## Properties

| Property | Type |
|---|---|
| `username` | `string` |
| `password` | `string` |
| `sshKey` | `string` |

<!-- source: function-runwithretry.md -->

# runWithRetry

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/retry-runner.ts` (line 69)

Run a benchmark task with retries, picking the best result.

## Signature

```ts
async function runWithRetry(task: BenchmarkTask, runOnce: (task: BenchmarkTask, temperature?: number) => Promise<TaskResult>, config: RetryConfig, log: (msg: string) => void): Promise<RetryResult>
```

## Parameters

| Name | Type |
|---|---|
| `task` | `BenchmarkTask` |
| `runOnce` | `(task: BenchmarkTask, temperature?: number) => Promise<TaskResult>` |
| `config` | `RetryConfig` |
| `log` | `(msg: string) => void` |

**Returns:** `Promise<RetryResult>`

<!-- source: interface-toastaction.md -->

# ToastAction

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Boards/Toast.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `onClick` | `() => void` |

<!-- source: class-troubleshootinggenerator.md -->

# TroubleshootingGenerator

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-14-meta/generators/troubleshooting.generator.ts` (line 45)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `extractTroubleshootingSections` | `extractTroubleshootingSections(documents: Array<{ title: string; slug: string; content?: string }>)` | `ExtractedTroubleshootingSection[]` |
| `generate` | `generate(input: TroubleshootingGeneratorInput, templates: FixedDocTemplate[], reference: MetaCategoryReference)` | `Promise<{
    documents: GeneratedDocument[];
    promptTokens: number;
    completionTokens: number;
  }>` |
| `generateOverview` | `generateOverview(input: TroubleshootingGeneratorInput, templates: FixedDocTemplate[], reference: MetaCategoryReference)` | `Promise<{
    documents: GeneratedDocument[];
    promptTokens: number;
    completionTokens: number;
  }>` |

<!-- source: function-uiplural.md -->

# uiPlural

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/uiStrings.ts` (line 549)

Simple one/other pluralization over `<base>_one` / `<base>_other` keys.
(Approximation for languages with richer plural rules — good enough for
viewer chrome; counts are also shown as digits.)

## Signature

```ts
function uiPlural(lang: string | null | undefined, base: | 'resultCount'
    | 'documentCount'
    | 'categoryCount'
    | 'documentsAvailable'
    | 'articleCount', n: number): string
```

## Parameters

| Name | Type |
|---|---|
| `lang` | `string | null | undefined` |
| `base` | `| 'resultCount'
    | 'documentCount'
    | 'categoryCount'
    | 'documentsAvailable'
    | 'articleCount'` |
| `n` | `number` |

**Returns:** `string`

<!-- source: interface-clip.md -->

# Clip

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 55)

Clip region for partial page screenshots

## Properties

| Property | Type |
|---|---|
| `x` | `number` |
| `y` | `number` |
| `width` | `number` |
| `height` | `number` |

<!-- source: constant-documentation-dependency-rules.md -->

# DOCUMENTATION_DEPENDENCY_RULES

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 568)

<!-- source: api-endpoint-downloadsdk.md -->

# downloadSdk

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-mcp.controller.ts` (line 255)

## Endpoint

`GET /technical-docs/:projectId/sdk.ts`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsMcpController` (MODULE_DECLARES)

<!-- source: component-faqaccordion-2.md -->

# FaqAccordion

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/faq/faq-accordion.tsx` (line 14)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `items` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FaqAccordion_6193292f["FaqAccordion"]
    class component_FaqAccordion_6193292f rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `AccordionItem`
- USES_HOOK → `useTranslation`

<!-- source: interface-flow.md -->

# Flow

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/graph/interfaces/entity.interface.ts` (line 54)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `stages` | `FlowStage[]` |
| `entities` | `KGEntity[]` |

<!-- source: function-generatecoveragecss.md -->

# generateCoverageCSS

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/state-machine-diagram.generator.ts` (line 377)

Generate CSS for coverage visualization

## Signature

```ts
function generateCoverageCSS(colorScheme: Record<string, string>): string
```

## Parameters

| Name | Type |
|---|---|
| `colorScheme` | `Record<string, string>` |

**Returns:** `string`

<!-- source: component-issuesallpageinner.md -->

# IssuesAllPageInner

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/all/page.tsx` (line 190)

## Diagram

```mermaid
graph TD
    component_IssuesAllPageInner_5dae5991["IssuesAllPageInner"]
    class component_IssuesAllPageInner_5dae5991 rootComponent
```

## Relationships

- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `ArrowLeftIcon`
- RENDERS → `IssuesViewTabs`
- RENDERS → `Bars3BottomLeftIcon`
- RENDERS → `ArrowDownTrayIcon`
- RENDERS → `ArrowPathIcon`
- RENDERS → `FilterSelect`
- RENDERS → `Squares2X2Icon`
- RENDERS → `AdjustmentsHorizontalIcon`
- RENDERS → `MagnifyingGlassIcon`
- RENDERS → `ChipActive`
- RENDERS → `ViewColumnsIcon`
- RENDERS → `BoardPicker`
- RENDERS → `React-Fragment`
- RENDERS → `Badge`
- RENDERS → `ChatBubbleLeftRightIcon`
- RENDERS → `EllipsisHorizontalIcon`
- RENDERS → `ChevronLeftIcon`
- RENDERS → `ChevronRightIcon`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`
- USES_HOOK → `useMemo`

## Referenced By

- `IssuesAllPage` (RENDERS)

<!-- source: interface-loadingstatepattern.md -->

# LoadingStatePattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-management.interface.ts` (line 439)

Loading state pattern

## Properties

| Property | Type |
|---|---|
| `loadingField` | `string` |
| `indicatorType` | `'spinner' | 'skeleton' | 'progress' | 'overlay'` |
| `disabledElements` | `string[]` |
| `loadingMessage` | `string` |
| `hasOptimisticUpdate` | `boolean` |

<!-- source: interface-memoryquery.md -->

# MemoryQuery

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/memory/types.ts` (line 59)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `category` | `MemoryRecord['category'] | MemoryRecord['category'][]` |
| `tags` | `string[]` |
| `relatedFiles` | `string[]` |
| `minConfidence` | `'high' | 'medium' | 'low'` |
| `limit` | `number` |
| `excludeSuperseded` | `boolean` |
| `excludeExpired` | `boolean` |
| `search` | `string` |

<!-- source: function-normalizepath.md -->

# normalizePath

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/services/entity-mapper.service.ts` (line 304)

Normalize a file path: resolve and convert backslashes to forward slashes.

## Signature

```ts
function normalizePath(filePath: string): string
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string` |

**Returns:** `string`

<!-- source: service-projectdomainsservice.md -->

# ProjectDomainsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/project/project-domains.service.ts` (line 38)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `get` | `get(projectId: string, user: JwtPayload)` | `Promise<CustomDomainView | null>` |
| `create` | `create(projectId: string, user: JwtPayload, rawDomain: string)` | `Promise<CustomDomainView>` |
| `check` | `check(projectId: string, user: JwtPayload)` | `unknown` |
| `retry` | `retry(projectId: string, user: JwtPayload)` | `Promise<CustomDomainView>` |
| `remove` | `remove(projectId: string, user: JwtPayload)` | `Promise<{ ok: boolean; warning?: string }>` |
| `resolvePublicHost` | `resolvePublicHost(host: string)` | `Promise<{ publishedSlug: string; urlId: string } | null>` |
| `reconcile` | `reconcile()` | `unknown` |
| `monitor` | `monitor()` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `domaindnsservice`
- DEPENDS_ON → `k8singressservice`
- DEPENDS_ON → `emailservice`

<!-- source: class-resetpassworddto.md -->

# ResetPasswordDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/auth/dto/password.dto.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `token` | `string` |
| `password` | `string` |

<!-- source: function-savepredictions.md -->

# savePredictions

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/swebench-evaluator.ts` (line 84)

Save TaskResults as a JSONL predictions file for the SWE-bench harness.
Skips results with empty/whitespace-only patches.

## Signature

```ts
function savePredictions(results: TaskResult[], outputPath: string, modelName: string): void
```

## Parameters

| Name | Type |
|---|---|
| `results` | `TaskResult[]` |
| `outputPath` | `string` |
| `modelName` | `string` |

**Returns:** `void`

<!-- source: class-uilibrarydetector.md -->

# UILibraryDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/ui-library-detector.ts` (line 51)

UI Library Detector

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detect` | `detect(entities: Entity[])` | `DetectedUIComponent[]` |
| `getSummary` | `getSummary(components: DetectedUIComponent[])` | `UILibrarySummary[]` |
| `getComponentSummary` | `getComponentSummary(component: DetectedUIComponent)` | `string` |

<!-- source: function-uistr.md -->

# uiStr

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/uiStrings.ts` (line 527)

Localized UI string; unknown language → English.

## Signature

```ts
function uiStr(lang: string | null | undefined, key: UiStringKey): string
```

## Parameters

| Name | Type |
|---|---|
| `lang` | `string | null | undefined` |
| `key` | `UiStringKey` |

**Returns:** `string`

<!-- source: interface-updateconfigdto.md -->

# UpdateConfigDto

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationConfig.ts` (line 77)

DTO for updating config

## Properties

| Property | Type |
|---|---|
| `repositoryUrl` | `string` |
| `repositoryBranch` | `string` |
| `frontendPath` | `string` |
| `backendPath` | `string` |
| `siteUrl` | `string` |
| `siteLoginUrl` | `string` |
| `siteEmail` | `string` |
| `sitePassword` | `string` |
| `repoUsername` | `string` |
| `repoPassword` | `string` |
| `skeletonStructure` | `SkeletonStructure` |
| `targetAudience` | `string` |
| `autoPublish` | `boolean` |

<!-- source: interface-codeblockeditorcontextvalue.md -->

# CodeBlockEditorContextValue

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/CodeBlockNode.tsx` (line 165)

## Properties

| Property | Type |
|---|---|
| `setCode` | `(code: string) => void` |
| `setLanguage` | `(language: string) => void` |
| `setMeta` | `(meta: string) => void` |
| `lexicalNode` | `CodeBlockNode` |
| `parentEditor` | `LexicalEditor` |

<!-- source: api-endpoint-draft.md -->

# draft

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/capture/capture.controller.ts` (line 109)

## Endpoint

`POST /capture/:projectId/flows/:id/draft`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `CaptureController` (MODULE_DECLARES)

<!-- source: constant-dramatic.md -->

# dramatic

**Kind:** Constant

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/animations.ts` (line 92)

Dramatic entrance — for hero sections

## Definition

```ts
Variants
```

<!-- source: component-faqtwocolumn-2.md -->

# FaqTwoColumn

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/faq/faq-two-column.tsx` (line 14)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `items` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FaqTwoColumn_347ec384["FaqTwoColumn"]
    class component_FaqTwoColumn_347ec384 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `AccordionItem`
- USES_HOOK → `useTranslation`

<!-- source: interface-flowstage.md -->

# FlowStage

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/graph/interfaces/entity.interface.ts` (line 61)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `order` | `number` |
| `entities` | `KGEntity[]` |

<!-- source: function-generatedatabaseschemadiagram.md -->

# generateDatabaseSchemaDiagram

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/database-schema-diagram.generator.ts` (line 304)

Generate database schema diagram

## Signature

```ts
function generateDatabaseSchemaDiagram(models: DatabaseModelEntity[], options: DatabaseSchemaDiagramOptions): DatabaseSchemaDiagramResult
```

## Parameters

| Name | Type |
|---|---|
| `models` | `DatabaseModelEntity[]` |
| `options` | `DatabaseSchemaDiagramOptions` |

**Returns:** `DatabaseSchemaDiagramResult`

<!-- source: component-issuetrendchart.md -->

# IssueTrendChart

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/page.tsx` (line 125)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `data` | `TrendPoint[]` | ✓ | - |
| `height` | `number` | - | 260 |

## Diagram

```mermaid
graph TD
    component_IssueTrendChart_62728ae7["IssueTrendChart"]
    class component_IssueTrendChart_62728ae7 rootComponent
```

## Relationships

- RENDERS → `ResponsiveContainer`
- RENDERS → `AreaChart`
- RENDERS → `CartesianGrid`
- RENDERS → `XAxis`
- RENDERS → `YAxis`
- RENDERS → `RTooltip`
- RENDERS → `Area`

## Referenced By

- `IssuesListPage` (RENDERS)

<!-- source: interface-loopblock.md -->

# LoopBlock

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/template-analysis.interface.ts` (line 117)

Loop block (ngFor, v-for)

## Properties

| Property | Type |
|---|---|
| `type` | `'for'` |
| `variable` | `string` |
| `collection` | `string` |
| `line` | `number` |
| `indexVariable` | `string` |
| `elements` | `TemplateElement[]` |

<!-- source: interface-memoryrecord.md -->

# MemoryRecord

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/memory/types.ts` (line 18)

Memory Persistence Types

Extends the existing SessionMemory extraction system with persistence,
lifecycle management, and cross-session recall.

Storage: JSON index + individual markdown files (Claude Code pattern).
Zero dependencies — uses Node.js fs only.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `projectId` | `string` |
| `category` | `'pattern' | 'pitfall' | 'environment' | 'optimization' | 'decision' | 'preference'` |
| `title` | `string` |
| `content` | `string` |
| `confidence` | `'high' | 'medium' | 'low'` |
| `createdAt` | `string` |
| `lastAccessedAt` | `string` |
| `accessCount` | `number` |
| `updatedAt` | `string` |
| `tags` | `string[]` |
| `relatedFiles` | `string[]` |
| `expiresAt` | `string` |
| `supersededBy` | `string` |

<!-- source: function-parsedirectives.md -->

# parseDirectives

**Kind:** Function

**Source:** `atloria-monorepo/packages/core/src/rendering/directive-parser.ts` (line 726)

Convenience function to parse markdown content

## Signature

```ts
function parseDirectives(content: string, options: ParserOptions): DocumentAST
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |
| `options` | `ParserOptions` |

**Returns:** `DocumentAST`

<!-- source: service-projectorgguard.md -->

# ProjectOrgGuard

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/auth/guards/project-org.guard.ts` (line 22)

ProjectOrgGuard — enforce that the authenticated user's organization OWNS the project named
by `:projectId`. OrganizationGuard only checks an explicit `organizationId` in the request,
so a project-scoped route (which carries only a `projectId`) sails past it — a user from org
A could act on org B's project. This guard closes that hole: it loads the project, 404s when
it does not exist, and 403s unless project.organizationId === user.organizationId.

Fail-closed: an unauthenticated request or a missing project context is rejected, never
allowed through.

`ProjectOrgGuard` is a NestJS authorization guard for project-scoped routes. It loads the project identified by `:projectId`, returns `404` when the project does not exist, and rejects requests with `403` when the authenticated user's organization does not own that project. The guard fails closed: missing authentication or project context is never allowed through.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `canActivate` | `canActivate(context: ExecutionContext)` | `Promise<boolean>` |

## Diagram

```mermaid
sequenceDiagram
  participant Client
  participant Guard as ProjectOrgGuard
  participant ProjectService
  participant Controller

  Client->>Guard: Request with :projectId and authenticated user
  Guard->>Guard: Read user.organizationId and params.projectId

  alt Missing user or projectId
    Guard-->>Client: 403 Forbidden
  else Context available
    Guard->>ProjectService: Find project by projectId

    alt Project not found
      ProjectService-->>Guard: null
      Guard-->>Client: 404 Not Found
    else Project found
      ProjectService-->>Guard: project.organizationId

      alt Organization does not match
        Guard-->>Client: 403 Forbidden
      else Organization matches
        Guard->>Controller: Allow request
        Controller-->>Client: Route response
      end
    end
  end
```

## Usage

```ts
import { Controller, Delete, Param, UseGuards } from '@nestjs/common';
import { JwtAuthGuard } from '../auth/guards/jwt-auth.guard';
import { ProjectOrgGuard } from '../auth/guards/project-org.guard';
import { ProjectsService } from './projects.service';

@Controller('projects')
@UseGuards(JwtAuthGuard, ProjectOrgGuard)
export class ProjectsController {
  constructor(private readonly projectsService: ProjectsService) {}

  @Delete(':projectId')
  async remove(@Param('projectId') projectId: string) {
    return this.projectsService.remove(projectId);
  }
}
```

## AI Coding Instructions

- Apply `ProjectOrgGuard` to every route scoped by `:projectId`, especially mutation routes such as update, delete, membership, and resource-management endpoints.
- Ensure an authentication guard runs before this guard so `request.user.organizationId` is populated.
- Keep the route parameter named `projectId`, or update the guard consistently if a different parameter name is required.
- Preserve fail-closed behavior: missing user data, missing organization IDs, or missing project IDs must deny access rather than bypass authorization.
- Return `404` for nonexistent projects and `403` only when an existing project belongs to another organization.

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: class-reshootlocalesdto.md -->

# ReshootLocalesDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/capture/dto/update-flow.dto.ts` (line 62)

SUPERIOR: re-shoot the WHOLE recipe under N locales in one run, emitting a
localized screenshot set per locale (blob-namespaced by locale).

## Properties

| Property | Type |
|---|---|
| `locales` | `string[]` |
| `viewport` | `ReshootViewportDto` |

<!-- source: function-serializehistoryitems.md -->

# serializeHistoryItems

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/context/model-compactor.ts` (line 91)

Serialize SDK input items into a text representation for the compaction model.
Handles the various formats the OpenAI Agents SDK uses.

## Signature

```ts
function serializeHistoryItems(items: unknown[]): string
```

## Parameters

| Name | Type |
|---|---|
| `items` | `unknown[]` |

**Returns:** `string`

<!-- source: class-unrecognizedmarkdownconstructerror.md -->

# UnrecognizedMarkdownConstructError

**Kind:** Class

**Source:** `atloria-monorepo/packages/editor/src/importMarkdownToLexical.ts` (line 174)

**Extends:** `Error`

<!-- source: interface-uploadedimage.md -->

# UploadedImage

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useImageUpload.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `url` | `string` |
| `filename` | `string` |
| `size` | `number` |
| `width` | `number` |
| `height` | `number` |
| `altText` | `string` |
| `caption` | `string` |
| `audiences` | `string[]` |

<!-- source: function-useai.md -->

# useAI

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/AI/useAI.ts` (line 50)

Custom hook for AI operations with SSE streaming support

Handles:
- Multiple AI providers (Azure Claude, Azure OpenAI)
- Streaming responses via Server-Sent Events
- Document enhancement, outline generation, text improvement, summarization
- Error handling and loading states
- Provider selection

## Signature

```ts
function useAI(options: UseAIOptions): UseAIReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseAIOptions` |

**Returns:** `UseAIReturn`

<!-- source: interface-codeblockeditordescriptor.md -->

# CodeBlockEditorDescriptor

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/index.ts` (line 54)

## Properties

| Property | Type |
|---|---|
| `priority` | `number` |
| `match` | `(language: string | null | undefined, meta: string | null | undefined) => boolean` |
| `Editor` | `React.ComponentType<CodeBlockEditorProps>` |

<!-- source: api-endpoint-drafttickettopic.md -->

# draftTicketTopic

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/manuals-insights/manuals-insights.controller.ts` (line 55)

## Endpoint

`POST /manuals-insights/:projectId/ticket-topics/draft`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `ManualsInsightsController` (MODULE_DECLARES)

<!-- source: constant-editimagetoolbarcomponent.md -->

# editImageToolbarComponent$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 359)

Holds the custom EditImageToolbar component.

<!-- source: component-featureicon-2.md -->

# FeatureIcon

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/feature-icon.tsx` (line 17)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `icon` | `LucideIcon` | ✓ | - |
| `size` | `number` | - | 24 |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_FeatureIcon_a8d7b68["FeatureIcon"]
    class component_FeatureIcon_a8d7b68 rootComponent
```

## Relationships

- RENDERS → `Icon`

<!-- source: interface-formattedragcontext.md -->

# FormattedRagContext

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/support-agent/prompts/rag-context-formatter.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `text` | `string` |
| `hasResults` | `boolean` |
| `sourceCount` | `number` |

<!-- source: function-generatedeploymentcss.md -->

# generateDeploymentCSS

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/deployment-diagram.generator.ts` (line 531)

Generate CSS for deployment diagram styling

## Signature

```ts
function generateDeploymentCSS(): string
```

**Returns:** `string`

<!-- source: component-jobrow.md -->

# JobRow

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/DocAutomation/JobHistory.tsx` (line 133)

Individual job row component

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `job` | `DocumentationJobEntry` | ✓ | - |
| `liveProgress` | `LiveJobProgress` | - | - |
| `allLiveProgress` | `Record` | ✓ | - |
| `projectId` | `string` | ✓ | - |
| `onRegenerate` | `Function` | - | - |
| `onCancelJob` | `Function` | - | - |
| `onDeleteJobDocuments` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_JobRow_4f8f4a36["JobRow"]
    class component_JobRow_4f8f4a36 rootComponent
```

## Relationships

- RENDERS → `StatusIcon`
- RENDERS → `Clock`
- RENDERS → `FileText`
- RENDERS → `StopCircle`
- RENDERS → `ChevronUp`
- RENDERS → `ChevronDown`
- RENDERS → `motion-div`
- RENDERS → `AnimatePresence`
- RENDERS → `CompletionSummary`
- RENDERS → `AlertTriangle`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`

## Referenced By

- `JobHistory` (RENDERS)

<!-- source: interface-markdowndocentity-2.md -->

# MarkdownDocEntity

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 936)

Markdown document entity

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.MARKDOWN_DOC` |
| `title` | `string` |
| `headings` | `HeadingInfo[]` |
| `codeBlocks` | `CodeBlockInfo[]` |
| `links` | `LinkInfo[]` |
| `frontMatter` | `Record<string, unknown>` |

<!-- source: interface-memorystore.md -->

# MemoryStore

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/memory/types.ts` (line 84)

<!-- source: function-parseextractionresponse.md -->

# parseExtractionResponse

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/services/business-context-extractor.ts` (line 76)

Parse the AI response into a BusinessContext object.
Handles JSON extraction from various response formats (raw, code blocks, wrapped).

## Signature

```ts
function parseExtractionResponse(response: string, sources: ContextSource[], rawText: string): BusinessContext
```

## Parameters

| Name | Type |
|---|---|
| `response` | `string` |
| `sources` | `ContextSource[]` |
| `rawText` | `string` |

**Returns:** `BusinessContext`

<!-- source: service-projectservice.md -->

# ProjectService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/project/project.service.ts` (line 40)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `create` | `create(dto: CreateProjectDto, user: JwtPayload)` | `Promise<Project>` |
| `list` | `list(user: JwtPayload)` | `Promise<Project[]>` |
| `get` | `get(id: string, user: JwtPayload)` | `Promise<Project>` |
| `update` | `update(id: string, dto: UpdateProjectDto, user: JwtPayload)` | `Promise<Project>` |
| `delete` | `delete(id: string, user: JwtPayload)` | `Promise<void>` |
| `getMembers` | `getMembers(id: string, user: JwtPayload)` | `Promise<ProjectMember[]>` |
| `addMember` | `addMember(id: string, dto: AddMemberDto, user: JwtPayload)` | `Promise<ProjectMember>` |
| `updateMemberRole` | `updateMemberRole(id: string, userId: string, dto: UpdateMemberRoleDto, user: JwtPayload)` | `Promise<ProjectMember>` |
| `removeMember` | `removeMember(id: string, userId: string, user: JwtPayload)` | `Promise<void>` |
| `getSettings` | `getSettings(id: string, user: JwtPayload)` | `Promise<Record<string, any>>` |
| `updateSettings` | `updateSettings(id: string, dto: UpdateSettingsDto, user: JwtPayload)` | `Promise<Project>` |
| `getStats` | `getStats(id: string, user: JwtPayload)` | `unknown` |
| `publish` | `publish(id: string, user: JwtPayload)` | `Promise<PublishedProjectResult>` |
| `resolveAvailableSlug` | `resolveAvailableSlug(desired: string, selfId: string)` | `Promise<string>` |
| `checkSlugAvailability` | `checkSlugAvailability(id: string, desired: string, user: JwtPayload)` | `unknown` |
| `setPublishedSlug` | `setPublishedSlug(id: string, desired: string, user: JwtPayload)` | `unknown` |
| `unpublish` | `unpublish(id: string, user: JwtPayload)` | `Promise<Project>` |
| `getPublishedByUrlId` | `getPublishedByUrlId(urlId: string)` | `Promise<Project>` |
| `getPublishedBySlug` | `getPublishedBySlug(publishedSlug: string)` | `Promise<Project>` |
| `getProjectAudiences` | `getProjectAudiences(id: string, docVersionId: string | string[])` | `unknown` |
| `getAudienceDocuments` | `getAudienceDocuments(projectId: string, audienceSlug: string, docVersionId: string)` | `unknown` |
| `getPublishedDocument` | `getPublishedDocument(projectId: string, audienceSlug: string, documentSlug: string, docVersionId: string)` | `Promise<{
    id: string;
    title: string;
    slug: string;
    content: string;
    toc: TocEntry[];
    order: number | null;
    categoryId: string | null;
    pageType: string | null;
    updatedAt: Date;
    category: {
      id: string;
      name: string;
      slug: string;
      icon: string | null;
      color: string | null;
    } | null;
  }>` |
| `getRelatedDocuments` | `getRelatedDocuments(projectId: string, audienceSlug: string, documentSlug: string, docVersionId: string, limit: unknown)` | `Promise<
    Array<{
      id: string;
      slug: string;
      title: string;
      category: { name: string; slug: string } | null;
    }>
  >` |
| `resolvePublicDocVersionId` | `resolvePublicDocVersionId(projectId: string, opts: { version?: string; lang?: string; audienceScope?: string })` | `Promise<string | null>` |
| `getActiveScopeDocVersionIds` | `getActiveScopeDocVersionIds(projectId: string, lang: string)` | `Promise<string[]>` |
| `resolveVersion` | `resolveVersion(projectId: string, versionNumber: number)` | `unknown` |
| `getPublishedVersions` | `getPublishedVersions(projectId: string)` | `unknown` |
| `getPublishedLanguages` | `getPublishedLanguages(projectId: string)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `urlservice`
- DEPENDS_ON → `tocbuilderservice`
- DEPENDS_ON → `techdocsragservice`

<!-- source: class-reshootstepdto.md -->

# ReshootStepDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/capture/dto/update-flow.dto.ts` (line 45)

Re-shoot ONE step of a stored flow. The worker walks the recipe up to this step
(in one Playwright context) and re-captures just its screenshot, optionally at a
new viewport size / UI locale. Any redaction boxes stored on the step are burned
into the fresh asset before upload.

## Properties

| Property | Type |
|---|---|
| `viewport` | `ReshootViewportDto` |
| `locale` | `string` |

<!-- source: function-setupreliability.md -->

# setupReliability

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/reliability-config.ts` (line 96)

Wire all reliability features into a session.

## Signature

```ts
function setupReliability(session: SessionLike, options: ReliabilityOptions, existingGateProvider: QualityGateProvider): ReliabilityContext
```

## Parameters

| Name | Type |
|---|---|
| `session` | `SessionLike` |
| `options` | `ReliabilityOptions` |
| `existingGateProvider` | `QualityGateProvider` |

**Returns:** `ReliabilityContext`

<!-- source: class-uploaderror.md -->

# UploadError

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/errors.ts` (line 207)

Error thrown when upload fails

**Extends:** `PipelineError`

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `statusCode` | `number` |

<!-- source: interface-uploadimageoptions.md -->

# UploadImageOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useImageUpload.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `file` | `File` |
| `altText` | `string` |
| `caption` | `string` |
| `tags` | `string[]` |
| `audiences` | `string[]` |

<!-- source: function-useaiproviders.md -->

# useAIProviders

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useAIProviders.ts` (line 10)

Custom hook to fetch and manage AI providers

<!-- source: interface-codeblockeditorprops.md -->

# CodeBlockEditorProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/index.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `code` | `string` |
| `language` | `string` |
| `meta` | `string` |
| `nodeKey` | `string` |
| `focusEmitter` | `VoidEmitter` |

<!-- source: api-endpoint-duplicate.md -->

# duplicate

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 920)

## Endpoint

`POST /documents/:id/duplicate`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: constant-editorinfocus.md -->

# editorInFocus$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 477)

The currently focused editor

<!-- source: component-featuresalternating-2.md -->

# FeaturesAlternating

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/features/features-alternating.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `features` | `Feature[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FeaturesAlternating_3ede4484["FeaturesAlternating"]
    class component_FeaturesAlternating_3ede4484 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- USES_HOOK → `useTranslation`

<!-- source: interface-generateddocumentation.md -->

# GeneratedDocumentation

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/user-docs-generator.service.ts` (line 12)

Generated documentation structure

## Properties

| Property | Type |
|---|---|
| `workflows` | `WorkflowDocumentation[]` |
| `overview` | `string` |
| `tableOfContents` | `TableOfContentsItem[]` |
| `metadata` | `{
    generatedAt: Date;
    totalPages: number;
    totalWorkflows: number;
    estimatedReadTime: string;
  }` |

<!-- source: function-generatedeploymentdiagram.md -->

# generateDeploymentDiagram

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/deployment-diagram.generator.ts` (line 492)

Generate deployment diagram from entities and relationships

## Signature

```ts
function generateDeploymentDiagram(entities: Entity[], relationships: Relationship[], options: DeploymentDiagramOptions): DeploymentDiagramResult
```

## Parameters

| Name | Type |
|---|---|
| `entities` | `Entity[]` |
| `relationships` | `Relationship[]` |
| `options` | `DeploymentDiagramOptions` |

**Returns:** `DeploymentDiagramResult`

<!-- source: component-kbpanel.md -->

# KbPanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/page.tsx` (line 244)

## Diagram

```mermaid
graph TD
    component_KbPanel_792a2d1d["KbPanel"]
    class component_KbPanel_792a2d1d rootComponent
```

## Relationships

- RENDERS → `PreviewShell`

## Referenced By

- `HomePage` (RENDERS)

<!-- source: interface-mcptooldef.md -->

# McpToolDef

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/mcp-toolset.ts` (line 27)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `inputSchema` | `{ type: 'object'; properties: Record<string, unknown>; required?: string[] }` |

<!-- source: interface-memorytooloptions.md -->

# MemoryToolOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/memory.tool.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `memoryManager` | `MemoryManager` |

<!-- source: function-parseimagedimension.md -->

# parseImageDimension

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 361)

## Signature

```ts
function parseImageDimension(value: string | number | undefined)
```

## Parameters

| Name | Type |
|---|---|
| `value` | `string | number | undefined` |

<!-- source: service-ragchatmodelservice.md -->

# RagChatModelService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/rag/chat-model.service.ts` (line 12)

Generation model for grounded chat. Uses gpt-5.6-terra via chat/completions on the Azure
Foundry resource (AZURE_RESPONSES_*), which hosts the gpt-5.6 deployments (the legacy primary
Azure OpenAI resource only had gpt-5.5). terra is a reasoning model, so we send
`max_completion_tokens` (not `max_tokens`) and omit `temperature` (rejected by reasoning
models). Endpoint/key/deployment are overridable via RAG_CHAT_* for a dedicated resource.

`RagChatModelService` is a NestJS service that generates grounded chat completions using the **gpt-5.5** reasoning model on the **primary Azure OpenAI** resource via the `chat/completions` API. It is intentionally self-contained because the shared Responses provider targets a different Azure resource that does not host gpt-5.5. It also applies reasoning-model constraints by sending `max_completion_tokens` (not `max_tokens`) and omitting `temperature`.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `complete` | `complete(prompt: string, maxCompletionTokens: unknown)` | `Promise<string>` |
| `completeStream` | `completeStream(prompt: string, maxCompletionTokens: unknown)` | `AsyncGenerator<string, { text: string; inputTokens: number; outputTokens: number; totalTokens: number }, void>` |
| `completeWithUsage` | `completeWithUsage(prompt: string, maxCompletionTokens: unknown)` | `Promise<{ text: string; inputTokens: number; outputTokens: number; totalTokens: number }>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant Caller as API Handler / RAG Orchestrator
  participant RagSvc as RagChatModelService
  participant Azure as Azure OpenAI (Primary Resource)
  participant Model as gpt-5.5 (reasoning)

  Caller->>RagSvc: build messages (system + user + grounded context)
  RagSvc->>RagSvc: validate reasoning-model params\n(no temperature, use max_completion_tokens)
  RagSvc->>Azure: POST /chat/completions\n{ model: "gpt-5.5", messages, max_completion_tokens, ... }
  Azure->>Model: Run reasoning completion
  Model-->>Azure: completion output
  Azure-->>RagSvc: response (choices/message)
  RagSvc-->>Caller: grounded assistant message/content
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { RagChatModelService } from './technical-docs/rag/chat-model.service';

@Injectable()
export class RagAnswerService {
  constructor(private readonly ragChatModel: RagChatModelService) {}

  async answer(question: string, contextChunks: string[]) {
    const groundedContext = contextChunks.map((c, i) => `Source ${i + 1}:\n${c}`).join('\n\n');

    // Typical RAG shape: system rules + user question + grounded context
    const messages = [
      {
        role: 'system',
        content:
          'You are a helpful assistant. Use ONLY the provided sources. ' +
          'If the answer is not in the sources, say you do not know.',
      },
      { role: 'user', content: `Question:\n${question}\n\nSources:\n${groundedContext}` },
    ];

    // NOTE: reasoning model usage: omit temperature; use max_completion_tokens
    const result = await this.ragChatModel.createChatCompletion({
      model: 'gpt-5.5',
      messages,
      max_completion_tokens: 800,
    });

    return {
      answer: result.choices?.[0]?.message?.content ?? '',
      raw: result,
    };
  }
}
```

## AI Coding Instructions

- Keep this service **self-contained**: do not “refactor to shared Responses provider” unless the target Azure resource is confirmed to host **gpt-5.5**.
- For **reasoning models**, send `max_completion_tokens` and **do not** include `temperature` (Azure/OpenAI will reject it for reasoning models).
- Preserve the grounded-chat contract: callers should pass **messages that include the retrieved context** and system constraints (e.g., “use only sources”).
- When integrating, verify the **Azure OpenAI deployment/model name** and endpoint correspond to the **primary resource** intended for gpt-5.5 `chat/completions`.

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: class-reshootviewportdto.md -->

# ReshootViewportDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/capture/dto/update-flow.dto.ts` (line 34)

Optional viewport override for a single-step / locale reshoot.

## Properties

| Property | Type |
|---|---|
| `width` | `number` |
| `height` | `number` |

<!-- source: function-shouldautosubmit.md -->

# shouldAutosubmit

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/agent-hardening.ts` (line 91)

Determine if we should extract and submit a partial patch.

Pattern from SWE-agent: On ANY non-success exit (timeout, max turns,
cost limit, API error), submit whatever git diff exists. A partial
fix is better than no submission.

Returns false if: task passed cleanly, or no changes exist.

## Signature

```ts
function shouldAutosubmit(result: {
  passed?: boolean;
  timedOut?: boolean;
  hasChanges?: boolean;
  error?: string;
}): boolean
```

## Parameters

| Name | Type |
|---|---|
| `result` | `{
  passed?: boolean;
  timedOut?: boolean;
  hasChanges?: boolean;
  error?: string;
}` |

**Returns:** `boolean`

<!-- source: function-useaisettings.md -->

# useAISettings

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useAISettings.ts` (line 20)

Custom hook to manage AI settings with localStorage persistence

<!-- source: interface-usecollaborationoptions.md -->

# UseCollaborationOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useCollaboration.ts` (line 64)

Options for the useCollaboration hook

## Properties

| Property | Type |
|---|---|
| `serverUrl` | `string` |
| `autoReconnect` | `boolean` |
| `maxReconnectAttempts` | `number` |
| `reconnectDelay` | `number` |

<!-- source: class-userendpoints.md -->

# UserEndpoints

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/users.ts` (line 32)

User endpoints

## Methods

| Method | Signature | Returns |
|---|---|---|
| `me` | `me()` | `Promise<User>` |
| `list` | `list(params: UserListParams)` | `Promise<User[]>` |
| `get` | `get(id: string)` | `Promise<User>` |
| `update` | `update(id: string, dto: UpdateUserDto)` | `Promise<User>` |
| `updateMe` | `updateMe(dto: UpdateUserDto)` | `Promise<User>` |
| `delete` | `delete(id: string)` | `Promise<void>` |

<!-- source: interface-codesampledata.md -->

# CodeSampleData

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/CodeSample.ts` (line 11)

Matches the OpenAPI `x-codeSamples` entries the spec pipeline generates (lang + source).

## Properties

| Property | Type |
|---|---|
| `lang` | `string` |
| `source` | `string` |

<!-- source: api-endpoint-duplicate-2.md -->

# duplicate

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/desk.controller.ts` (line 98)

## Endpoint

`POST /desk/:projectId/threads/:id/duplicate`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `DeskController` (MODULE_DECLARES)

<!-- source: constant-editorrootelementref.md -->

# editorRootElementRef$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 325)

A reference to a DOM element. used for the various popups, dialogs, and tooltips

<!-- source: component-featuresbentomodern-2.md -->

# FeaturesBentoModern

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/features/features-bento-modern.tsx` (line 28)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `features` | `BentoFeature[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FeaturesBentoModern_54694613["FeaturesBentoModern"]
    class component_FeaturesBentoModern_54694613 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `FeatureIcon`
- USES_HOOK → `useTranslation`

<!-- source: function-generateentityid-3.md -->

# generateEntityId

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 597)

Generate a unique entity ID

## Signature

```ts
function generateEntityId(filePath: string, name: string, type: string): string
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string` |
| `name` | `string` |
| `type` | `string` |

**Returns:** `string`

<!-- source: interface-generateoptions.md -->

# GenerateOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/ai/interfaces/ai-provider.interface.ts` (line 1)

## Properties

| Property | Type |
|---|---|
| `model` | `string` |
| `temperature` | `number` |
| `maxTokens` | `number` |
| `stream` | `boolean` |

<!-- source: component-kpicard.md -->

# KpiCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/DeflectionCockpit.tsx` (line 94)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `label` | `string` | ✓ | - |
| `subtitle` | `string` | ✓ | - |
| `rate` | `number | null` | ✓ | - |
| `sub` | `string` | ✓ | - |
| `spark` | `number[]` | ✓ | - |
| `color` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_KpiCard_1ea8fc1b["KpiCard"]
    class component_KpiCard_1ea8fc1b rootComponent
```

## Relationships

- RENDERS → `Sparkline`

## Referenced By

- `DeflectionCockpit` (RENDERS)

<!-- source: interface-methodcall.md -->

# MethodCall

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 67)

## Properties

| Property | Type |
|---|---|
| `type` | `'http' | 'internal'` |
| `target` | `string` |
| `method` | `string` |

<!-- source: interface-modelcapabilityprofile.md -->

# ModelCapabilityProfile

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-profiles.ts` (line 15)

Model Capability Profiles

Describes what each model needs at the API level and prompt level.
This makes AgentSession and buildAdaptivePrompt model-agnostic:
instead of scattering `if (model.includes('gpt-5'))` checks, callers
declare what a model needs via a profile.

Resolution order (first wins):
  1. Explicit `modelProfile` on AzureModelProviderConfig (deployer knows their model)
  2. Name-based detection via getDefaultProfile(modelId) (well-known slugs)
  3. STANDARD_PROFILE (safe default — preserves current GPT-5.4 behavior)

## Properties

| Property | Type |
|---|---|
| `supportsReasoningEffort` | `boolean` |
| `supportsTemperature` | `boolean` |
| `supportsStrictTools` | `boolean` |
| `defaults` | `{
    /**
     * Reasoning effort applied when the agent has tools and the caller
     * hasn't explicitly set reasoningEffort.
     * GPT-5.4: 'medium' (defaults to 'none' otherwise, skipping tool calls).
     * Claude / GPT-4.x: undefined (field not sent).
     */
    reasoningEffort?: 'none' | 'low' | 'medium' | 'high';

    /**
     * toolChoice for the FIRST turn only.
     * After turn 1, the session resets to 'auto' to prevent loops.
     * GPT-5.4: 'required' (forces at least one tool call on turn 1).
     * Claude / GPT-4.x: undefined.
     *
     * IMPORTANT: Do NOT set 'required' when built-in tools (web_search,
     * code_interpreter) are in the tool list — the API rejects mixed types
     * with tool_choice: 'required'.
     */
    toolChoiceFirstTurn?: 'required' | 'auto';

    /**
     * Whether to request strict schema validation for tool calls.
     * GPT-5.4: true.
     */
    strictToolSchemas?: boolean;

    /**
     * Whether to run tool calls in parallel.
     * GPT-5.4: true (default behavior, but explicit is safer).
     */
    parallelToolCalls?: boolean;
  }` |
| `needsToolPersistence` | `boolean` |
| `needsApplyPatchFormat` | `boolean` |
| `needsPreambleGuidance` | `boolean` |
| `guidanceLevel` | `'minimal' | 'standard' | 'verbose'` |

<!-- source: function-prop.md -->

# prop

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/fp.ts` (line 37)

Returns a function which extracts the property from from the passed object.

## Signature

```ts
function prop(property: keyof T)
```

## Parameters

| Name | Type |
|---|---|
| `property` | `keyof T` |

<!-- source: service-ratelimitguard.md -->

# RateLimitGuard

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/ai/guards/rate-limit.guard.ts` (line 7)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `canActivate` | `canActivate(context: ExecutionContext)` | `Promise<boolean>` |
| `onModuleDestroy` | `onModuleDestroy()` | `unknown` |

## Relationships

- DEPENDS_ON → `configservice`

<!-- source: class-resolvechangerequestdto.md -->

# ResolveChangeRequestDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/change-request/dto/change-request.dto.ts` (line 63)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `resolvedContent` | `string` |

<!-- source: function-tagoverlap.md -->

# tagOverlap

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/memory/consolidator.ts` (line 214)

Tag overlap ratio: intersection / union.

## Signature

```ts
function tagOverlap(a: string[], b: string[]): number
```

## Parameters

| Name | Type |
|---|---|
| `a` | `string[]` |
| `b` | `string[]` |

**Returns:** `number`

<!-- source: function-useauth-2.md -->

# useAuth

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useAuth.ts` (line 10)

Convenience wrapper around NextAuth's useSession.
Returns { session, status } where session is the typed Session object.

<!-- source: interface-usecollaborationreturn.md -->

# UseCollaborationReturn

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useCollaboration.ts` (line 78)

Return value of the useCollaboration hook

## Properties

| Property | Type |
|---|---|
| `ydoc` | `Y.Doc | null` |
| `ytext` | `Y.Text | null` |
| `awareness` | `awarenessProtocol.Awareness | null` |
| `synced` | `boolean` |
| `activeUsers` | `CollaborationUser[]` |
| `connectionStatus` | `ConnectionStatus` |
| `error` | `Error | null` |
| `updateCursor` | `(cursor: CursorPosition) => void` |
| `updateSelection` | `(selection: SelectionRange) => void` |
| `disconnect` | `() => void` |
| `reconnect` | `() => void` |
| `version` | `number` |

<!-- source: class-v2pipelineorchestrator.md -->

# V2PipelineOrchestrator

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/orchestrator.ts` (line 350)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getStore` | `getStore()` | `StageResultStore` |
| `run` | `run(progressCallback: V2ProgressCallback)` | `Promise<V2PipelineResult>` |
| `cancel` | `cancel()` | `void` |

<!-- source: interface-colorscale.md -->

# ColorScale

**Kind:** Interface

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 5)

Design Tokens - Complete type definitions for the Atloria design system

## Properties

| Property | Type |
|---|---|
| `50` | `string` |
| `100` | `string` |
| `200` | `string` |
| `300` | `string` |
| `400` | `string` |
| `500` | `string` |
| `600` | `string` |
| `700` | `string` |
| `800` | `string` |
| `900` | `string` |

<!-- source: constant-editorwrapperelementref.md -->

# editorWrapperElementRef$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 330)

<!-- source: api-endpoint-enhance.md -->

# enhance

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/ai/ai.controller.ts` (line 77)

## Endpoint

`POST /ai/enhance`

## Referenced By

- `AIController` (MODULE_DECLARES)

<!-- source: component-featuresgridcards-2.md -->

# FeaturesGridCards

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/features/features-grid-cards.tsx` (line 22)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `labelKey` | `string` | - | - |
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `features` | `Feature[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FeaturesGridCards_4309208b["FeaturesGridCards"]
    class component_FeaturesGridCards_4309208b rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-span`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `FeatureIcon`
- USES_HOOK → `useTranslation`

<!-- source: function-generatehierarchycss.md -->

# generateHierarchyCSS

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/component-hierarchy-diagram.generator.ts` (line 411)

Generate CSS for hierarchy diagram styling

## Signature

```ts
function generateHierarchyCSS(): string
```

**Returns:** `string`

<!-- source: interface-graphentity.md -->

# GraphEntity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/search-index.ts` (line 59)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `type` | `string` |

<!-- source: component-languageproviderwrapper.md -->

# LanguageProviderWrapper

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/PublicLayoutShell.tsx` (line 267)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_LanguageProviderWrapper_8238777["LanguageProviderWrapper"]
    class component_LanguageProviderWrapper_8238777 rootComponent
```

## Relationships

- RENDERS → `LanguageProvider`
- USES_HOOK → `usePathname`

## Referenced By

- `PublicLayoutShell` (RENDERS)

<!-- source: interface-methodcaller.md -->

# MethodCaller

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 73)

## Properties

| Property | Type |
|---|---|
| `component` | `string` |
| `method` | `string` |

<!-- source: interface-modelcompactorconfig.md -->

# ModelCompactorConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/compaction-types.ts` (line 83)

## Properties

| Property | Type |
|---|---|
| `endpoint` | `string` |
| `apiKey` | `string` |
| `model` | `string` |
| `apiVersion` | `string` |
| `useV1Endpoint` | `boolean` |
| `maxSummaryTokens` | `number` |
| `domainFields` | `string[]` |
| `parallel` | `boolean` |
| `timeout` | `number` |
| `onCompactionComplete` | `(summary: CompactionSummary, durationMs: number) => void` |
| `onCompactionError` | `(error: Error) => void` |

<!-- source: function-realmplugin.md -->

# realmPlugin

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/RealmWithPlugins.tsx` (line 20)

A function that creates an editor plugin.

## Signature

```ts
function realmPlugin(plugin: {
  /**
   * Called when the MDXEditor component is mounted and the plugin is initialized.
   */
  init?: (realm: Realm, params?: Params) => void

  /**
   * Called after the MDXEditor component is mounted and all plugins are initialized.
   */
  postInit?: (realm: Realm, params?: Params) => void
  /**
   * Called on each re-render. Use this to update the realm with updated property values.
   */
  update?: (realm: Realm, params?: Params) => void
}): (params?: Params) => RealmPlugin
```

## Parameters

| Name | Type |
|---|---|
| `plugin` | `{
  /**
   * Called when the MDXEditor component is mounted and the plugin is initialized.
   */
  init?: (realm: Realm, params?: Params) => void

  /**
   * Called after the MDXEditor component is mounted and all plugins are initialized.
   */
  postInit?: (realm: Realm, params?: Params) => void
  /**
   * Called on each re-render. Use this to update the realm with updated property values.
   */
  update?: (realm: Realm, params?: Params) => void
}` |

**Returns:** `(params?: Params) => RealmPlugin`

<!-- source: service-reconcilerservice.md -->

# ReconcilerService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/docs-repo/reconciler.service.ts` (line 66)

ReconcilerService — the DB-wins rebuild that makes a project's docs repo DISPOSABLE.

Postgres is the authority; the repo is a derived, rebuildable projection of it. `rebuild`
loads the CURRENTLY-SERVED doc set (the same resolution public serving uses — the ACTIVE
version per audience scope, else the latest PUBLISHED) and writes every published+public
page to docs/<scope>/<lang>/<slug>.md, then commits as atloria-generator. `driftCheck`
proves the invariant by diffing the repo tree against a fresh render.

Version resolution mirrors ProjectService.resolvePublicDocVersionId (default path). It is
replicated here against Prisma rather than importing ProjectModule so the substrate stays
a leaf with no module cycle; the query is intentionally identical.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `rebuild` | `rebuild(projectId: string, opts: RebuildOptions)` | `Promise<RebuildResult>` |
| `driftCheck` | `driftCheck(projectId: string)` | `Promise<DriftResult>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `docsreposervice`

<!-- source: class-reviewsuggestiondto.md -->

# ReviewSuggestionDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/suggestion/dto/review-suggestion.dto.ts` (line 3)

## Properties

| Property | Type |
|---|---|
| `reviewComment` | `string` |

<!-- source: function-titlesimilarity.md -->

# titleSimilarity

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/memory/consolidator.ts` (line 196)

Simple title similarity using normalized Levenshtein-like comparison.
For our use case (short titles < 80 chars), word overlap is sufficient.

## Signature

```ts
function titleSimilarity(a: string, b: string): number
```

## Parameters

| Name | Type |
|---|---|
| `a` | `string` |
| `b` | `string` |

**Returns:** `number`

<!-- source: function-useboardstoast.md -->

# useBoardsToast

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/Boards/Toast.tsx` (line 32)

## Signature

```ts
function useBoardsToast(): ToastContextValue
```

**Returns:** `ToastContextValue`

<!-- source: interface-usedocumentationconfigoptions.md -->

# UseDocumentationConfigOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationConfig.ts` (line 96)

Hook options

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `apiUrl` | `string` |
| `getToken` | `() => string | null` |
| `autoLoad` | `boolean` |

<!-- source: class-validationdetector.md -->

# ValidationDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/validation-detector.ts` (line 67)

Validation Detector

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detect` | `detect(entities: Entity[])` | `DetectedValidation[]` |
| `describeValidation` | `describeValidation(validation: DetectedValidation)` | `string` |

<!-- source: interface-commentlistparams.md -->

# CommentListParams

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/comments.ts` (line 12)

Comment list query parameters

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `resolved` | `boolean` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: constant-editorwrappers.md -->

# editorWrappers$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 758)

<!-- source: api-endpoint-enrich.md -->

# enrich

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-mcp.controller.ts` (line 126)

## Endpoint

`POST /technical-docs/:projectId/enrich`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsMcpController` (MODULE_DECLARES)

<!-- source: component-featureshorizontalflow-2.md -->

# FeaturesHorizontalFlow

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/features/features-horizontal-flow.tsx` (line 25)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `features` | `Feature[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FeaturesHorizontalFlow_87b510d["FeaturesHorizontalFlow"]
    class component_FeaturesHorizontalFlow_87b510d rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: function-generatemermaiddiagram.md -->

# generateMermaidDiagram

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/state-machine-analyzer.ts` (line 273)

Generate Mermaid state diagram from state machine definition

Creates a Mermaid stateDiagram-v2 syntax representation of the workflow.

## Signature

```ts
function generateMermaidDiagram(stateMachine: StateMachine): string
```

## Parameters

| Name | Type |
|---|---|
| `stateMachine` | `StateMachine` |

**Returns:** `string`

<!-- source: interface-graphrelationship.md -->

# GraphRelationship

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/search-index.ts` (line 64)

## Properties

| Property | Type |
|---|---|
| `sourceId` | `string` |
| `targetId` | `string` |
| `type` | `string` |

<!-- source: component-linechart.md -->

# LineChart

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/DeflectionCockpit.tsx` (line 58)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `trend` | `TrendPoint[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_LineChart_164f39d1["LineChart"]
    class component_LineChart_164f39d1 rootComponent
```

## Referenced By

- `DeflectionCockpit` (RENDERS)

<!-- source: interface-methoddefinition-2.md -->

# MethodDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 850)

Method definition

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `returnType` | `string` |
| `parameters` | `ParameterDefinition[]` |
| `isAsync` | `boolean` |
| `description` | `string` |
| `decorators` | `string[]` |

<!-- source: interface-modelproviderrequest.md -->

# ModelProviderRequest

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-provider-interface.ts` (line 37)

Request to the model provider.

## Properties

| Property | Type |
|---|---|
| `systemInstructions` | `string` |
| `input` | `ModelInputItem[]` |
| `tools` | `ToolSchema[]` |
| `modelSettings` | `AgentModelSettings` |
| `previousResponseId` | `string` |
| `signal` | `AbortSignal` |

<!-- source: function-renderdocument.md -->

# renderDocument

**Kind:** Function

**Source:** `atloria-monorepo/packages/core/src/rendering/audience-renderer.ts` (line 242)

Convenience function to render a document AST

## Signature

```ts
function renderDocument(ast: DocumentAST, options: RenderOptions): string
```

## Parameters

| Name | Type |
|---|---|
| `ast` | `DocumentAST` |
| `options` | `RenderOptions` |

**Returns:** `string`

<!-- source: service-resourceorgguard.md -->

# ResourceOrgGuard

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/auth/guards/resource-org.guard.ts` (line 80)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `canActivate` | `canActivate(context: ExecutionContext)` | `Promise<boolean>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `reflector`

<!-- source: class-samlstrategy.md -->

# SamlStrategy

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/auth/saml/saml.strategy.ts` (line 6)

**Extends:** `PassportStrategy(Strategy, 'saml')`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `validate` | `validate(req: any, profile: Profile | null)` | `Promise<any>` |

<!-- source: function-tokenize-2.md -->

# tokenize

**Kind:** Function

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/bm25.ts` (line 19)

BM25 (Okapi BM25) — Inline Implementation

Standard BM25 ranking with k1=1.2, b=0.75.
Zero external dependencies — pure TypeScript.

## Signature

```ts
function tokenize(text: string): string[]
```

## Parameters

| Name | Type |
|---|---|
| `text` | `string` |

**Returns:** `string[]`

<!-- source: function-usebranding.md -->

# useBranding

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/BrandingContext.tsx` (line 169)

<!-- source: interface-usedocumentationconfigreturn.md -->

# UseDocumentationConfigReturn

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationConfig.ts` (line 106)

Hook return type

## Properties

| Property | Type |
|---|---|
| `config` | `DocumentationConfig | null` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `hasConfig` | `boolean` |
| `localSkeleton` | `SkeletonStructure | null` |
| `isDirty` | `boolean` |
| `loadConfig` | `() => Promise<DocumentationConfig | null>` |
| `createConfig` | `(data: CreateConfigDto) => Promise<DocumentationConfig>` |
| `updateConfig` | `(data: UpdateConfigDto) => Promise<DocumentationConfig>` |
| `deleteConfig` | `() => Promise<void>` |
| `addCategory` | `(category: Omit<SkeletonCategory, 'documents'>) => void` |
| `removeCategory` | `(slug: string) => void` |
| `updateCategory` | `(slug: string, updates: Partial<Omit<SkeletonCategory, 'documents'>>) => void` |
| `addDocument` | `(categorySlug: string, document: SkeletonDocument) => void` |
| `removeDocument` | `(categorySlug: string, documentSlug: string) => void` |
| `updateDocument` | `(categorySlug: string, documentSlug: string, updates: Partial<SkeletonDocument>) => void` |
| `reorderCategories` | `(categoryIds: string[]) => void` |
| `reorderDocuments` | `(categorySlug: string, documentSlugs: string[]) => void` |
| `resetLocalChanges` | `() => void` |
| `saveLocalChanges` | `() => Promise<DocumentationConfig>` |

<!-- source: class-validationerror.md -->

# ValidationError

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/types/errors.ts` (line 30)

Validation error (400 Bad Request)

**Extends:** `APIError`

<!-- source: interface-commentwithuser.md -->

# CommentWithUser

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/comment.dto.ts` (line 7)

Comment DTO with populated user relation

## Properties

| Property | Type |
|---|---|
| `user` | `Pick<User, 'id' | 'name' | 'email'>` |
| `replies` | `CommentWithUser[]` |

<!-- source: api-endpoint-escalate.md -->

# escalate

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-chat.controller.ts` (line 126)

## Endpoint

`POST /technical-docs/:projectId/chat/sessions/:sessionId/escalate`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `sessionId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsChatController` (MODULE_DECLARES)

<!-- source: constant-exportvisitors.md -->

# exportVisitors$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 289)

Contains the currently registered export visitors.

<!-- source: component-featuresinteractivetabs-2.md -->

# FeaturesInteractiveTabs

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/features/features-interactive-tabs.tsx` (line 35)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `tabs` | `Tab[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FeaturesInteractiveTabs_4a709f55["FeaturesInteractiveTabs"]
    class component_FeaturesInteractiveTabs_4a709f55 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `Icon`
- RENDERS → `motion-span`
- RENDERS → `AnimatePresence`
- USES_HOOK → `useTranslation`
- USES_HOOK → `useState`

<!-- source: function-generatemermaidflowchart.md -->

# generateMermaidFlowchart

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/user-journey-diagram.generator.ts` (line 796)

Generate Mermaid flowchart syntax from a UserJourneyFlow

## Signature

```ts
function generateMermaidFlowchart(flow: UserJourneyFlow): string
```

## Parameters

| Name | Type |
|---|---|
| `flow` | `UserJourneyFlow` |

**Returns:** `string`

<!-- source: interface-import.md -->

# Import

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/parser/interfaces/code-parser.interface.ts` (line 51)

## Properties

| Property | Type |
|---|---|
| `module` | `string` |
| `symbols` | `string[]` |
| `isDefault` | `boolean` |
| `alias` | `string` |

<!-- source: component-loadinggrid.md -->

# LoadingGrid

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Documents/DocumentList.tsx` (line 435)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `viewMode` | `ViewMode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_LoadingGrid_6ac76090["LoadingGrid"]
    class component_LoadingGrid_6ac76090 rootComponent
```

## Referenced By

- `DocumentList` (RENDERS)

<!-- source: interface-modaldefinition.md -->

# ModalDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/modal-extractor.ts` (line 28)

A modal/popup/dialog discovered in source code.
Compatible with ModalDefinition from interaction-map.types.ts.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `title` | `string` |
| `triggerType` | `ModalTriggerType` |
| `triggerSelector` | `string` |
| `triggerMethod` | `string` |
| `closeMethod` | `ModalCloseMethod` |
| `closeButtonTexts` | `string[]` |
| `conditionalOn` | `string` |
| `hostComponent` | `string` |
| `sourceFile` | `string` |
| `line` | `number` |

<!-- source: interface-modelproviderresponse.md -->

# ModelProviderResponse

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-provider-interface.ts` (line 73)

Response from the model provider.

## Properties

| Property | Type |
|---|---|
| `output` | `ModelResponseItem[]` |
| `usage` | `{ inputTokens: number; outputTokens: number }` |
| `responseId` | `string` |
| `providerData` | `unknown` |

<!-- source: function-rendermarkdowntohtml.md -->

# renderMarkdownToHtml

**Kind:** Function

**Source:** `atloria-monorepo/packages/markdown-engine/src/lib/render.ts` (line 55)

Render a Markdown string to an HTML fragment (no <html>/<body> wrapper).
Returns an empty string for empty input.

## Signature

```ts
async function renderMarkdownToHtml(markdown: string): Promise<string>
```

## Parameters

| Name | Type |
|---|---|
| `markdown` | `string` |

**Returns:** `Promise<string>`

<!-- source: service-rolesguard.md -->

# RolesGuard

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/auth/guards/roles.guard.ts` (line 10)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `canActivate` | `canActivate(context: ExecutionContext)` | `boolean` |

## Relationships

- DEPENDS_ON → `reflector`

<!-- source: class-saveastemplatedto.md -->

# SaveAsTemplateDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/template/dto/save-as-template.dto.ts` (line 10)

DTO for saving an existing document as a new template.
Allows users to convert their documents into reusable templates.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `category` | `TemplateCategory` |
| `isPrivate` | `boolean` |

<!-- source: function-usecollaboration.md -->

# useCollaboration

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useCollaboration.ts` (line 138)

Hook for real-time document collaboration using Yjs

## Signature

```ts
function useCollaboration(documentId: string | null | undefined, userId: string | null | undefined, userName: string | null | undefined, options: UseCollaborationOptions): UseCollaborationReturn
```

## Parameters

| Name | Type |
|---|---|
| `documentId` | `string | null | undefined` |
| `userId` | `string | null | undefined` |
| `userName` | `string | null | undefined` |
| `options` | `UseCollaborationOptions` |

**Returns:** `UseCollaborationReturn`

<!-- source: interface-usedocumentationgeneratoroptions.md -->

# UseDocumentationGeneratorOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationGenerator.ts` (line 50)

Hook options

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `apiUrl` | `string` |
| `getToken` | `() => string | null` |

<!-- source: class-verificationerror.md -->

# VerificationError

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/errors.ts` (line 177)

Error thrown when verification fails below threshold

**Extends:** `PipelineError`

## Properties

| Property | Type |
|---|---|
| `accuracyScore` | `number` |
| `threshold` | `number` |
| `documentId` | `string` |

<!-- source: interface-comparisonfeaturetableprops-2.md -->

# ComparisonFeatureTableProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/comparison/comparison-feature-table.tsx` (line 14)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `columns` | `{ nameKey: string; highlighted?: boolean }[]` |
| `features` | `{ featureKey: string; values: (boolean | string)[] }[]` |

<!-- source: api-endpoint-escalatepublicchat.md -->

# escalatePublicChat

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 875)

## Endpoint

`POST /public/p/:slugWithId/chat/escalate`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-fadein.md -->

# fadeIn

**Kind:** Constant

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/animations.ts` (line 21)

Simple opacity fade

## Definition

```ts
Variants
```

<!-- source: component-focusempty.md -->

# FocusEmpty

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 90)

## Diagram

```mermaid
graph TD
    component_FocusEmpty_396e6a1f["FocusEmpty"]
    class component_FocusEmpty_396e6a1f rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useRef`

<!-- source: function-generatemodelschemadiagram.md -->

# generateModelSchemaDiagram

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/database-schema-diagram.generator.ts` (line 333)

Generate schema diagram for a single model and its direct relations

## Signature

```ts
function generateModelSchemaDiagram(model: DatabaseModelEntity, allModels: DatabaseModelEntity[], options: DatabaseSchemaDiagramOptions): DatabaseSchemaDiagramResult
```

## Parameters

| Name | Type |
|---|---|
| `model` | `DatabaseModelEntity` |
| `allModels` | `DatabaseModelEntity[]` |
| `options` | `DatabaseSchemaDiagramOptions` |

**Returns:** `DatabaseSchemaDiagramResult`

<!-- source: interface-jobcompletiondata.md -->

# JobCompletionData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/doc-automation.service.ts` (line 69)

## Properties

| Property | Type |
|---|---|
| `documentsCreated` | `number` |
| `documentsUpdated` | `number` |
| `categoriesCreated` | `number` |
| `screenshotsCaptured` | `number` |
| `durationMs` | `number` |
| `commitHash` | `string` |
| `publishedUrl` | `string` |
| `routeMappings` | `unknown` |
| `metrics` | `unknown` |
| `stageResults` | `unknown` |

<!-- source: component-loadingspinner.md -->

# LoadingSpinner

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/MessageList.tsx` (line 116)

Loading spinner animation

## Diagram

```mermaid
graph TD
    component_LoadingSpinner_5fa13a3["LoadingSpinner"]
    class component_LoadingSpinner_5fa13a3 rootComponent
```

## Referenced By

- `MessageList` (RENDERS)

<!-- source: interface-modaltrigger.md -->

# ModalTrigger

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/template-analysis.interface.ts` (line 186)

Modal/dialog trigger

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `action` | `string` |
| `modalRef` | `string` |
| `line` | `number` |
| `conditionalOn` | `string` |

<!-- source: interface-modelroute.md -->

# ModelRoute

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-router.ts` (line 45)

A single route entry: maps a category to a model deployment name.

## Properties

| Property | Type |
|---|---|
| `model` | `string` |

<!-- source: function-resetglobalratelimiter.md -->

# resetGlobalRateLimiter

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/rate-limiter.ts` (line 183)

Reset the global rate limiter (useful for testing)

## Signature

```ts
function resetGlobalRateLimiter(): void
```

**Returns:** `void`

<!-- source: service-samlservice.md -->

# SamlService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/auth/saml/saml.service.ts` (line 6)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getConfigByOrgSlug` | `getConfigByOrgSlug(orgSlug: string)` | `unknown` |
| `getConfig` | `getConfig(orgId: string)` | `unknown` |
| `configureSaml` | `configureSaml(orgId: string, dto: { entityId: string; ssoUrl: string; certificate: string })` | `unknown` |
| `toggleSaml` | `toggleSaml(orgId: string, isEnabled: boolean)` | `unknown` |
| `getLoginUrl` | `getLoginUrl(config: any)` | `Promise<string>` |
| `generateToken` | `generateToken(user: any)` | `Promise<string>` |
| `getMetadata` | `getMetadata(orgId: string)` | `Promise<string>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `jwtservice`

<!-- source: class-screenshotfiltersdto.md -->

# ScreenshotFiltersDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/screenshot/dto/screenshot-filters.dto.ts` (line 8)

DTO for filtering screenshots

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `url` | `string` |
| `viewport` | `string` |
| `browser` | `string` |
| `isBaseline` | `boolean` |
| `flowStepId` | `string` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: function-usecurrentprojectid.md -->

# useCurrentProjectId

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/stores/projectContext.ts` (line 198)

Hook to get current project ID (useful for API calls)

## Signature

```ts
function useCurrentProjectId(): string | null
```

**Returns:** `string | null`

<!-- source: interface-usedocumentationgeneratorreturn.md -->

# UseDocumentationGeneratorReturn

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationGenerator.ts` (line 59)

Hook return type

## Properties

| Property | Type |
|---|---|
| `job` | `DocumentationJob | null` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `progress` | `number` |
| `currentStage` | `string | null` |
| `stageProgress` | `number` |
| `currentItem` | `string | null` |
| `elapsedMs` | `number` |
| `estimatedRemainingMs` | `number` |
| `isRunning` | `boolean` |
| `isCompleted` | `boolean` |
| `isFailed` | `boolean` |
| `isCancelled` | `boolean` |
| `result` | `JobResult | null` |
| `screenshotProgress` | `{
    batchIndex: number;
    totalBatches: number;
    captured: number;
    totalMappings: number;
  } | null` |
| `startGeneration` | `(options?: { includeScreenshots?: boolean }) => Promise<DocumentationJob>` |
| `cancel` | `() => Promise<void>` |
| `reset` | `() => void` |

<!-- source: class-vuedetector.md -->

# VueDetector

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/vue-detector.ts` (line 55)

Vue Detector

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detect` | `detect(entities: Entity[])` | `DetectedVueComponent[]` |
| `getComponentSummary` | `getComponentSummary(component: DetectedVueComponent)` | `string` |

<!-- source: interface-comparisonrowprops-2.md -->

# ComparisonRowProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/comparison-row.tsx` (line 11)

## Properties

| Property | Type |
|---|---|
| `featureKey` | `string` |
| `values` | `(boolean | string)[]` |

<!-- source: api-endpoint-exportconfluence.md -->

# exportConfluence

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 316)

## Endpoint

`POST /technical-docs/:projectId/export/confluence`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: constant-fadeup.md -->

# fadeUp

**Kind:** Constant

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/animations.ts` (line 11)

Fade in from below — default for most sections

## Definition

```ts
Variants
```

<!-- source: component-footer.md -->

# Footer

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/layout/footer.tsx` (line 29)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `brandName` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `linkGroups` | `FooterLinkGroup[]` | ✓ | - |
| `socialLinks` | `SocialLink[]` | - | [] |
| `legalLinks` | `unknown[]` | - | [] |

## Diagram

```mermaid
graph TD
    component_Footer_1b0f62e8["Footer"]
    class component_Footer_1b0f62e8 rootComponent
```

## Relationships

- USES_HOOK → `useTranslation`

<!-- source: function-generaterelationshipid-3.md -->

# generateRelationshipId

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 623)

Generate a relationship ID

## Signature

```ts
function generateRelationshipId(sourceId: string, targetId: string, type: string): string
```

## Parameters

| Name | Type |
|---|---|
| `sourceId` | `string` |
| `targetId` | `string` |
| `type` | `string` |

**Returns:** `string`

<!-- source: interface-jobfailuredata.md -->

# JobFailureData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/doc-automation.service.ts` (line 84)

## Properties

| Property | Type |
|---|---|
| `error` | `string` |
| `errorStage` | `string` |
| `errorStack` | `string` |
| `durationMs` | `number` |
| `metrics` | `unknown` |
| `stageResults` | `unknown` |

<!-- source: component-manualpanel.md -->

# ManualPanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/page.tsx` (line 276)

## Diagram

```mermaid
graph TD
    component_ManualPanel_41e3c52c["ManualPanel"]
    class component_ManualPanel_41e3c52c rootComponent
```

## Relationships

- RENDERS → `PreviewShell`

## Referenced By

- `HomePage` (RENDERS)

<!-- source: interface-modelroutingtable.md -->

# ModelRoutingTable

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-router.ts` (line 54)

Full routing configuration.
Pass to CLI via --routing-table or API via payload.routingTable.

## Properties

| Property | Type |
|---|---|
| `default` | `string` |
| `routes` | `Partial<Record<TaskCategory, ModelRoute>>` |

<!-- source: interface-moduleentity-2.md -->

# ModuleEntity

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 895)

Module entity (NestJS, Angular)

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.MODULE` |
| `imports` | `string[]` |
| `controllers` | `string[]` |
| `providers` | `string[]` |
| `exports` | `string[]` |
| `isGlobal` | `boolean` |

<!-- source: service-scheduledreportsservice.md -->

# ScheduledReportsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/analytics/export/scheduled-reports.service.ts` (line 35)

ScheduledReportsService — CRUD for saved scheduled reports + the cron
evaluator that fires due reports every 5 minutes.

The evaluator is intentionally simple: every tick it queries enabled
reports, computes their next-run time from `cron` and `lastRunAt`, and
fires any that are overdue. Failed reports record their error in
`lastStatus` but never crash the loop.

`ScheduledReportsService` manages CRUD operations for saved scheduled reports and evaluates enabled schedules on a five-minute cron tick. For each due report, it calculates the next execution time from its cron expression and `lastRunAt`, triggers the export workflow, and records success or failure status without allowing one failed report to interrupt the evaluator.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `list` | `list(projectId: string)` | `unknown` |
| `get` | `get(projectId: string, id: string)` | `unknown` |
| `create` | `create(projectId: string, userId: string, dto: CreateScheduledReportDto)` | `unknown` |
| `update` | `update(projectId: string, id: string, dto: UpdateScheduledReportDto)` | `unknown` |
| `remove` | `remove(projectId: string, id: string)` | `unknown` |
| `runNow` | `runNow(projectId: string, id: string)` | `unknown` |
| `evaluateScheduledReports` | `evaluateScheduledReports()` | `unknown` |

## Diagram

```mermaid
sequenceDiagram
  participant Cron as NestJS Cron Scheduler
  participant Service as ScheduledReportsService
  participant DB as Scheduled Reports Repository
  participant Export as Report Export Service

  Cron->>Service: evaluateDueReports() every 5 minutes
  Service->>DB: Find enabled scheduled reports
  DB-->>Service: Enabled reports

  loop Each enabled report
    Service->>Service: Compute next run from cron + lastRunAt
    alt Report is due
      Service->>Export: Generate and deliver report
      alt Export succeeds
        Export-->>Service: Export result
        Service->>DB: Update lastRunAt and lastStatus
      else Export fails
        Export-->>Service: Error
        Service->>DB: Record failure in lastStatus
      end
    end
  end
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { ScheduledReportsService } from './scheduled-reports.service';

@Injectable()
export class AnalyticsAdminService {
  constructor(
    private readonly scheduledReportsService: ScheduledReportsService,
  ) {}

  async createWeeklySalesReport(userId: string) {
    return this.scheduledReportsService.create({
      name: 'Weekly sales summary',
      cron: '0 9 * * 1', // Every Monday at 09:00
      enabled: true,
      reportType: 'sales-summary',
      createdById: userId,
      recipients: ['analytics@example.com'],
      filters: {
        period: 'previous-week',
      },
    });
  }

  async pauseReport(reportId: string) {
    return this.scheduledReportsService.update(reportId, {
      enabled: false,
    });
  }

  async listActiveReports() {
    return this.scheduledReportsService.findAll({
      enabled: true,
    });
  }
}
```

## AI Coding Instructions

- Keep scheduled-report CRUD and execution concerns in this service; delegate report generation and delivery to the existing export/report workflow.
- Treat cron evaluation as fault-isolated: catch and persist errors per report so one failed export never stops the five-minute evaluator.
- When updating execution state, correctly maintain `lastRunAt` and `lastStatus`; these fields determine whether a report is considered overdue on subsequent ticks.
- Validate cron expressions and schedule configuration during create/update operations to prevent invalid schedules from reaching the evaluator.
- Preserve enabled-report filtering in the cron loop; disabled schedules must never be evaluated or executed.

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `analyticsexportservice`
- DEPENDS_ON → `emailservice`

<!-- source: function-scorestructure.md -->

# scoreStructure

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/structure-scorer.ts` (line 65)

## Signature

```ts
function scoreStructure(content: string, docType: DocType, options: ScoringOptions): StructureScore
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |
| `docType` | `DocType` |
| `options` | `ScoringOptions` |

**Returns:** `StructureScore`

<!-- source: class-screenshotjobfiltersdto.md -->

# ScreenshotJobFiltersDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/screenshot/dto/screenshot-filters.dto.ts` (line 84)

DTO for filtering screenshot jobs

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `status` | `string` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: function-usecurrentversionid.md -->

# useCurrentVersionId

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/stores/versionContext.ts` (line 98)

Helper: get just the current version ID

<!-- source: interface-usedocumentationjobsoptions.md -->

# UseDocumentationJobsOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationJobs.ts` (line 41)

Hook options

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `limit` | `number` |
| `apiUrl` | `string` |
| `getToken` | `() => string | null` |
| `autoLoad` | `boolean` |

<!-- source: class-websocketclient.md -->

# WebSocketClient

**Kind:** Class

**Source:** `atloria-monorepo/packages/api-client/src/clients/WebSocketClient.ts` (line 66)

WebSocket client for real-time updates

## Methods

| Method | Signature | Returns |
|---|---|---|
| `connect` | `connect(url: string, token: string)` | `void` |
| `disconnect` | `disconnect()` | `void` |
| `subscribe` | `subscribe(channel: string, callback: (data: unknown) => void)` | `() => void` |
| `unsubscribe` | `unsubscribe(channel: string, callback: (data: unknown) => void)` | `void` |
| `send` | `send(channel: string, data: unknown)` | `void` |
| `getState` | `getState()` | `WebSocketState` |
| `isConnected` | `isConnected()` | `boolean` |

<!-- source: interface-componentservicedependency.md -->

# ComponentServiceDependency

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/cross-language.types.ts` (line 102)

Component-to-Service dependency tracking

Tracks which components use which services to build user journey maps.

## Properties

| Property | Type |
|---|---|
| `componentFile` | `string` |
| `componentName` | `string` |
| `injectedServices` | `Array<{
    serviceName: string;
    serviceFile: string;
    methodsCalled: string[]; // Which service methods this component calls
  }>` |

<!-- source: api-endpoint-exportcsv.md -->

# exportCSV

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/audit/audit.controller.ts` (line 39)

## Endpoint

`GET /audit/:projectId/export/csv`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `AuditController` (MODULE_DECLARES)

<!-- source: constant-fixed-doc-templates.md -->

# FIXED_DOC_TEMPLATES

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 241)

Fixed doc templates per category. Each defines a doc to generate.
No AI decides WHAT to generate -- only the CONTENT is AI-generated.

## Definition

```ts
FixedDocTemplate[]
```

<!-- source: component-frontmatter.md -->

# Frontmatter

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 265)

## Diagram

```mermaid
graph TD
    component_Frontmatter_65c8f0a0["Frontmatter"]
    class component_Frontmatter_65c8f0a0 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `InsertFrontmatter`

<!-- source: function-generateschemacss.md -->

# generateSchemaCSS

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/database-schema-diagram.generator.ts` (line 366)

Generate CSS for database schema diagram styling

## Signature

```ts
function generateSchemaCSS(): string
```

**Returns:** `string`

<!-- source: interface-jobprogressupdate.md -->

# JobProgressUpdate

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/doc-automation.service.ts` (line 59)

## Properties

| Property | Type |
|---|---|
| `status` | `DocumentationJobStatus` |
| `progress` | `number` |
| `currentStage` | `string` |
| `stageProgress` | `number` |
| `currentItem` | `string` |
| `elapsedMs` | `number` |
| `estimatedRemainingMs` | `number` |

<!-- source: component-menuitem.md -->

# MenuItem

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/boards/page.tsx` (line 430)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |
| `icon` | `unknown` | ✓ | - |
| `onClick` | `Function` | ✓ | - |
| `danger` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_MenuItem_70ac4127["MenuItem"]
    class component_MenuItem_70ac4127 rootComponent
```

## Referenced By

- `BoardListCard` (RENDERS)

<!-- source: interface-modeltoolcall.md -->

# ModelToolCall

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-provider-interface.ts` (line 64)

Tool call from the model's response.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `arguments` | `string` |

<!-- source: interface-networkzone.md -->

# NetworkZone

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/deployment-diagram.generator.ts` (line 80)

Network/subnet grouping

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `type` | `'public' | 'private' | 'dmz' | 'internal'` |
| `nodeIds` | `string[]` |

<!-- source: service-screenshotservice-2.md -->

# ScreenshotService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/screenshot/screenshot.service.ts` (line 19)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `captureScreenshot` | `captureScreenshot(dto: CaptureScreenshotDto, user: JwtPayload)` | `unknown` |
| `listScreenshots` | `listScreenshots(filters: ScreenshotFiltersDto, user: JwtPayload)` | `unknown` |
| `getScreenshot` | `getScreenshot(id: string, user: JwtPayload)` | `unknown` |
| `deleteScreenshot` | `deleteScreenshot(id: string, user: JwtPayload)` | `unknown` |
| `bulkCaptureScreenshots` | `bulkCaptureScreenshots(dto: BulkCaptureScreenshotsDto, user: JwtPayload)` | `unknown` |
| `listJobs` | `listJobs(filters: ScreenshotJobFiltersDto, user: JwtPayload)` | `unknown` |
| `getJob` | `getJob(id: string, user: JwtPayload)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `assetsservice`

<!-- source: function-scrolltosection.md -->

# scrollToSection

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useActiveSection.ts` (line 112)

Scroll to a section smoothly

## Signature

```ts
function scrollToSection(id: string, offset: number): void
```

## Parameters

| Name | Type |
|---|---|
| `id` | `string` |
| `offset` | `number` |

**Returns:** `void`

<!-- source: class-searchdocumentsdto.md -->

# SearchDocumentsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/search-document.dto.ts` (line 9)

DTO for searching documents with full-text and filters

## Properties

| Property | Type |
|---|---|
| `q` | `string` |
| `projectId` | `string` |
| `categoryId` | `string` |
| `state` | `DocumentState` |
| `type` | `DocumentType` |
| `author` | `string` |
| `dateFrom` | `string` |
| `dateTo` | `string` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: function-usedoccontext.md -->

# useDocContext

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/doc/[...segments]/doc-context.tsx` (line 222)

<!-- source: interface-usedocumentationjobsreturn.md -->

# UseDocumentationJobsReturn

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationJobs.ts` (line 52)

Hook return type

## Properties

| Property | Type |
|---|---|
| `jobs` | `DocumentationJobEntry[]` |
| `total` | `number` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `liveProgress` | `Record<string, LiveJobProgress>` |
| `refresh` | `() => Promise<void>` |
| `startRegeneration` | `(projectId: string) => Promise<DocumentationJob>` |
| `cancelJob` | `(jobId: string) => Promise<void>` |
| `deleteJobDocuments` | `(jobId: string) => Promise<void>` |

<!-- source: class-welcomegenerator.md -->

# WelcomeGenerator

**Kind:** Class

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-14-meta/generators/welcome.generator.ts` (line 23)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generate` | `generate(input: MetaDocumentationInput, templates: FixedDocTemplate[], reference: MetaCategoryReference)` | `Promise<{
    documents: GeneratedDocument[];
    promptTokens: number;
    completionTokens: number;
  }>` |

<!-- source: interface-conditionalcontentsoption.md -->

# ConditionalContentsOption

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/toolbar.tsx` (line 247)

## Properties

| Property | Type |
|---|---|
| `when` | `(rootNode: EditorInFocus | null) => boolean` |
| `contents` | `() => React.ReactNode` |

<!-- source: api-endpoint-exporthtml.md -->

# exportHTML

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 561)

## Endpoint

`GET /doc-versions/:projectId/:versionId/export/html`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: constant-fixed-meta-categories.md -->

# FIXED_META_CATEGORIES

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 161)

Fixed top-level categories. These never change across runs.
Order determines navigation order in the final docs portal.

<!-- source: component-frontmattereditor.md -->

# FrontmatterEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/frontmatter/FrontmatterEditor.tsx` (line 18)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `yaml` | `string` | ✓ | - |
| `onChange` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FrontmatterEditor_3f108175["FrontmatterEditor"]
    class component_FrontmatterEditor_3f108175 rootComponent
```

## Relationships

- RENDERS → `Dialog-Root`
- RENDERS → `Dialog-Portal`
- RENDERS → `Dialog-Overlay`
- RENDERS → `Dialog-Content`
- RENDERS → `Dialog-Title`
- RENDERS → `TableInput`
- RENDERS → `Dialog-Close`
- USES_HOOK → `useCellValues`
- USES_HOOK → `useTranslation`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useMemo`
- USES_HOOK → `useForm`
- USES_HOOK → `useFieldArray`
- USES_HOOK → `useCallback`

<!-- source: function-generatescreenshotinstructions.md -->

# generateScreenshotInstructions

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/screenshot-instruction-generator.ts` (line 176)

Generate screenshot instructions from coverage report

## Signature

```ts
function generateScreenshotInstructions(entities: Entity[], existingScreenshots: EnhancedScreenshotMetadata[], options: {
    baseUrl?: string;
    includeWorkflows?: boolean;
  }): ScreenshotPlan
```

## Parameters

| Name | Type |
|---|---|
| `entities` | `Entity[]` |
| `existingScreenshots` | `EnhancedScreenshotMetadata[]` |
| `options` | `{
    baseUrl?: string;
    includeWorkflows?: boolean;
  }` |

**Returns:** `ScreenshotPlan`

<!-- source: interface-joindocumentdata.md -->

# JoinDocumentData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/collaboration/interfaces/collaboration.interfaces.ts` (line 46)

Data for joining a document collaboration session

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `userId` | `string` |
| `userName` | `string` |

<!-- source: component-messagebody.md -->

# MessageBody

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/ThreadView.tsx` (line 60)

Message bodies are MARKDOWN (agents format replies; the tracking page renders the same). `invert` flips prose colors for the dark agent bubble.

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `body` | `string` | ✓ | - |
| `invert` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_MessageBody_21b87892["MessageBody"]
    class component_MessageBody_21b87892 rootComponent
```

## Relationships

- RENDERS → `ReactMarkdown`

## Referenced By

- `ThreadView` (RENDERS)

<!-- source: interface-multieditoptions.md -->

# MultiEditOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/multi-edit.tool.ts` (line 16)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `maxFileSize` | `number` |

<!-- source: interface-ngrxactionpattern.md -->

# NgRxActionPattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ngrx-pattern-detector.ts` (line 19)

NgRx action pattern

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `actionType` | `string` |
| `line` | `number` |
| `hasPayload` | `boolean` |
| `payloadType` | `string` |
| `asyncGroup` | `{
    type: 'start' | 'success' | 'failure';
    baseName: string;
  }` |

<!-- source: service-screenshotstalenessservice.md -->

# ScreenshotStalenessService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/doc-version/screenshot-staleness.service.ts` (line 15)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getStalenessLevel` | `getStalenessLevel(capturedAt: string | Date | null, isCurrentVersion: boolean)` | `StalenessLevel` |
| `getDaysAge` | `getDaysAge(date: string | Date)` | `number` |
| `getStalenessReason` | `getStalenessReason(level: StalenessLevel, age: number)` | `string` |

<!-- source: function-setanalyticsconsent.md -->

# setAnalyticsConsent

**Kind:** Function

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/analytics.ts` (line 31)

Set cookie consent status. Analytics won't fire until consent is true.

## Signature

```ts
function setAnalyticsConsent(consent: boolean)
```

## Parameters

| Name | Type |
|---|---|
| `consent` | `boolean` |

<!-- source: class-skeletonstructuredto.md -->

# SkeletonStructureDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/documentation/dto/doc-automation.dto.ts` (line 60)

## Properties

| Property | Type |
|---|---|
| `categories` | `CategorySkeletonDto[]` |
| `defaultLanguage` | `string` |

<!-- source: function-usedocumentationconfig.md -->

# useDocumentationConfig

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationConfig.ts` (line 137)

Custom hook for documentation configuration

Manages auto-doc configuration for projects including:
- Loading/Creating/Updating/Deleting config
- Local skeleton structure editing
- Dirty state tracking

## Signature

```ts
function useDocumentationConfig(options: UseDocumentationConfigOptions): UseDocumentationConfigReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseDocumentationConfigOptions` |

**Returns:** `UseDocumentationConfigReturn`

<!-- source: interface-useimageuploadreturn.md -->

# UseImageUploadReturn

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useImageUpload.ts` (line 26)

## Properties

| Property | Type |
|---|---|
| `uploadImage` | `(file: File, options?: Omit<UploadImageOptions, 'file'>) => Promise<string>` |
| `uploading` | `boolean` |
| `error` | `Error | null` |
| `progress` | `number` |

<!-- source: interface-consistencycheckinput.md -->

# ConsistencyCheckInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-11.types.ts` (line 72)

CrossDocumentConsistencyCheck - Batch review of all documents

After individual document verification, OpenAI reviews all documents
together to catch inconsistencies that wouldn't be visible when
looking at documents in isolation.

## Properties

| Property | Type |
|---|---|
| `documents` | `DocumentSummary[]` |
| `projectContext` | `{
    appName: string;
    primaryAudience: string;
    userRoles: string[];
  }` |

<!-- source: api-endpoint-exportjson.md -->

# exportJSON

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/audit/audit.controller.ts` (line 56)

## Endpoint

`GET /audit/:projectId/export/json`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `AuditController` (MODULE_DECLARES)

<!-- source: constant-fixture.md -->

# fixture

**Kind:** Constant

**Source:** `atloria-monorepo/packages/ui-core/src/test-helpers.ts` (line 12)

Create a test fixture with proper typing

<!-- source: function-generatesequencecss.md -->

# generateSequenceCSS

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/sequence-diagram.generator.ts` (line 477)

Generate CSS for sequence diagram styling

## Signature

```ts
function generateSequenceCSS(): string
```

**Returns:** `string`

<!-- source: component-genericdirectiveeditor.md -->

# GenericDirectiveEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/directive-editors/GenericDirectiveEditor.tsx` (line 17)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `mdastNode` | `any` | ✓ | - |
| `descriptor` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_GenericDirectiveEditor_3317ab78["GenericDirectiveEditor"]
    class component_GenericDirectiveEditor_3317ab78 rootComponent
```

## Relationships

- RENDERS → `PropertyPopover`
- RENDERS → `NestedLexicalEditor`
- USES_HOOK → `useMdastNodeUpdater`
- USES_HOOK → `useMemo`
- USES_HOOK → `useCallback`

<!-- source: interface-jwtpayload.md -->

# JwtPayload

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/auth/decorators/current-user.decorator.ts` (line 5)

## Properties

| Property | Type |
|---|---|
| `sub` | `string` |
| `email` | `string` |
| `role` | `string` |
| `organizationId` | `string` |
| `audienceIds` | `string[]` |

<!-- source: component-methodstable.md -->

# MethodsTable

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/entity/[entityId]/page.tsx` (line 98)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `methods` | `any[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_MethodsTable_19c91718["MethodsTable"]
    class component_MethodsTable_19c91718 rootComponent
```

## Relationships

- RENDERS → `Code`

## Referenced By

- `EntityDetailPage` (RENDERS)

<!-- source: interface-ngrxeffectpattern.md -->

# NgRxEffectPattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ngrx-pattern-detector.ts` (line 122)

NgRx effect pattern

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `line` | `number` |
| `triggerAction` | `string` |
| `successAction` | `string` |
| `errorAction` | `string` |
| `isLegacy` | `boolean` |

<!-- source: interface-notebookeditoptions.md -->

# NotebookEditOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/notebook-edit.tool.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |

<!-- source: function-simulatekeypress.md -->

# simulateKeyPress

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-core/src/test-helpers.ts` (line 49)

Helper to simulate keyboard events

## Signature

```ts
function simulateKeyPress(element: HTMLElement, key: string, options: Partial<KeyboardEventInit>): void
```

## Parameters

| Name | Type |
|---|---|
| `element` | `HTMLElement` |
| `key` | `string` |
| `options` | `Partial<KeyboardEventInit>` |

**Returns:** `void`

<!-- source: service-stalealertservice.md -->

# StaleAlertService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/stale-alert.service.ts` (line 38)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `notifyStaleTransition` | `notifyStaleTransition(projectId: string, info: StaleTransitionInfo)` | `Promise<void>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `emailservice`
- DEPENDS_ON → `configservice`

<!-- source: class-startdocjobdto.md -->

# StartDocJobDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/documentation/dto/doc-automation.dto.ts` (line 355)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `skipCloneIfExists` | `boolean` |
| `skipScreenshots` | `boolean` |
| `screenshotsOnly` | `boolean` |
| `useV4dStructure` | `boolean` |
| `skipUpload` | `boolean` |
| `useAgentWriter` | `boolean` |
| `enableAgentVerification` | `boolean` |
| `includePaths` | `string[]` |
| `excludePaths` | `string[]` |
| `targetAudience` | `'beginner' | 'intermediate' | 'advanced'` |
| `audienceScope` | `string` |
| `tone` | `'formal' | 'friendly' | 'technical'` |
| `docKind` | `'api'` |
| `apiStyle` | `'reference-dense' | 'reference-blend' | 'tutorial-first'` |
| `maxDocuments` | `number` |
| `commitHash` | `string` |
| `branch` | `string` |
| `gitTag` | `string` |
| `versionLabel` | `string` |
| `versionDescription` | `string` |
| `triggeredBy` | `'manual' | 'webhook' | 'schedule' | 'cli'` |
| `useExternalOutput` | `boolean` |
| `externalOutputPath` | `string` |
| `updateAssetsOnly` | `boolean` |
| `onlySlugs` | `string[]` |
| `deltaMerge` | `boolean` |
| `removedSlugs` | `string[]` |
| `captureOnlySlugs` | `string[]` |

<!-- source: function-usedocumentationgenerator.md -->

# useDocumentationGenerator

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationGenerator.ts` (line 94)

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`

<!-- source: interface-useofflinesyncoptions.md -->

# UseOfflineSyncOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useOfflineSync.ts` (line 29)

Options for the useOfflineSync hook

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `userId` | `string` |
| `onSync` | `(updates: PendingUpdate[]) => Promise<void>` |
| `maxAge` | `number` |
| `autoSync` | `boolean` |

<!-- source: interface-consistencycorrection.md -->

# ConsistencyCorrection

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-11.types.ts` (line 107)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `original` | `string` |
| `corrected` | `string` |
| `reason` | `string` |
| `autoApplied` | `boolean` |

<!-- source: api-endpoint-exportmarkdown.md -->

# exportMarkdown

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 551)

## Endpoint

`GET /doc-versions/:projectId/:versionId/export/markdown`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: constant-flask-blueprint-patterns.md -->

# FLASK_BLUEPRINT_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/flask.patterns.ts` (line 48)

<!-- source: function-generatesequencediagram.md -->

# generateSequenceDiagram

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/sequence-diagram.generator.ts` (line 437)

Generate sequence diagram for an API endpoint or function

## Signature

```ts
function generateSequenceDiagram(entity: Entity, allEntities: Entity[], allRelationships: Relationship[], options: SequenceDiagramOptions): SequenceDiagramResult
```

## Parameters

| Name | Type |
|---|---|
| `entity` | `Entity` |
| `allEntities` | `Entity[]` |
| `allRelationships` | `Relationship[]` |
| `options` | `SequenceDiagramOptions` |

**Returns:** `SequenceDiagramResult`

<!-- source: component-genericjsxeditor.md -->

# GenericJsxEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/jsx-editors/GenericJsxEditor.tsx` (line 68)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `mdastNode` | `any` | ✓ | - |
| `descriptor` | `any` | ✓ | - |
| `PropertyEditor` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_GenericJsxEditor_3c825878["GenericJsxEditor"]
    class component_GenericJsxEditor_3c825878 rootComponent
```

## Relationships

- RENDERS → `PropertyEditorComponent`
- RENDERS → `NestedLexicalEditor`
- USES_HOOK → `useMdastNodeUpdater`
- USES_HOOK → `useMemo`
- USES_HOOK → `useCallback`

<!-- source: interface-kgentity-2.md -->

# KGEntity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/graph/interfaces/entity.interface.ts` (line 23)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `type` | `EntityType` |
| `name` | `string` |
| `description` | `string` |
| `documentId` | `string` |
| `projectId` | `string` |
| `metadata` | `Record<string, any>` |
| `createdAt` | `Date` |
| `updatedAt` | `Date` |

<!-- source: component-methodstable-2.md -->

# MethodsTable

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/technical/entity/[entityId]/page.tsx` (line 56)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `methods` | `any[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_MethodsTable_7b993f6b["MethodsTable"]
    class component_MethodsTable_7b993f6b rootComponent
```

## Relationships

- RENDERS → `Code`

## Referenced By

- `PublicEntityDetailPage` (RENDERS)

<!-- source: interface-ngrxreducerpattern.md -->

# NgRxReducerPattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ngrx-pattern-detector.ts` (line 57)

NgRx reducer pattern

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `sliceName` | `string` |
| `line` | `number` |
| `initialState` | `Record<string, unknown>` |
| `handlesActions` | `string[]` |
| `stateShape` | `Record<string, string>` |

<!-- source: interface-notebookreadoptions.md -->

# NotebookReadOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/notebook-read.tool.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `maxOutputLength` | `number` |

<!-- source: function-specstoworkerbatch.md -->

# specsToWorkerBatch

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/agent-screenshot-mapper.ts` (line 629)

Convert agent screenshot specs to the BatchScreenshotItem format
expected by the screenshot worker.

## Signature

```ts
function specsToWorkerBatch(specs: AgentScreenshotSpec[], siteUrl: string): any[]
```

## Parameters

| Name | Type |
|---|---|
| `specs` | `AgentScreenshotSpec[]` |
| `siteUrl` | `string` |

**Returns:** `any[]`

<!-- source: class-startfullsyncdto.md -->

# StartFullSyncDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/sync-job.dto.ts` (line 86)

Start full sync request DTO

## Properties

| Property | Type |
|---|---|
| `scope` | `SyncJobScope` |
| `projectId` | `string` |
| `force` | `boolean` |

<!-- source: service-suggestionservice.md -->

# SuggestionService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/suggestion/suggestion.service.ts` (line 18)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `create` | `create(documentId: string, dto: CreateSuggestionDto, user: JwtPayload)` | `unknown` |
| `list` | `list(documentId: string)` | `unknown` |
| `accept` | `accept(id: string, user: JwtPayload, reviewDto: ReviewSuggestionDto)` | `unknown` |
| `reject` | `reject(id: string, user: JwtPayload, reviewDto: ReviewSuggestionDto)` | `unknown` |
| `delete` | `delete(id: string, user: JwtPayload)` | `unknown` |
| `getById` | `getById(id: string)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `documentgateway`
- DEPENDS_ON → `activityservice`
- DEPENDS_ON → `notificationservice`
- DEPENDS_ON → `documentservice`

<!-- source: function-usedocumentationjobs.md -->

# useDocumentationJobs

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useDocumentationJobs.ts` (line 72)

Custom hook for fetching documentation job history

Manages:
- Fetching recent jobs for a project
- Live WebSocket progress for RUNNING/PENDING jobs
- Re-generation (starting a new job)

## Signature

```ts
function useDocumentationJobs(options: UseDocumentationJobsOptions): UseDocumentationJobsReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseDocumentationJobsOptions` |

**Returns:** `UseDocumentationJobsReturn`

<!-- source: interface-useofflinesyncreturn.md -->

# UseOfflineSyncReturn

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useOfflineSync.ts` (line 45)

Return value of the useOfflineSync hook

## Properties

| Property | Type |
|---|---|
| `isOnline` | `boolean` |
| `hasPendingUpdates` | `boolean` |
| `pendingCount` | `number` |
| `isSyncing` | `boolean` |
| `error` | `Error | null` |
| `queueUpdate` | `(content: string) => void` |
| `sync` | `() => Promise<void>` |
| `clearPendingUpdates` | `() => void` |
| `getPendingUpdates` | `() => PendingUpdate[]` |

<!-- source: interface-consistencyissue.md -->

# ConsistencyIssue

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-11.types.ts` (line 99)

## Properties

| Property | Type |
|---|---|
| `type` | `'terminology' | 'role' | 'navigation' | 'contradiction'` |
| `severity` | `'critical' | 'major' | 'minor'` |
| `description` | `string` |
| `affectedDocuments` | `string[]` |
| `examples` | `string[]` |

<!-- source: api-endpoint-exportnotion.md -->

# exportNotion

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 327)

## Endpoint

`POST /technical-docs/:projectId/export/notion`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: constant-flask-detection-config.md -->

# FLASK_DETECTION_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/flask.patterns.ts` (line 247)

## Definition

```ts
FlaskDetectionConfig
```

<!-- source: function-generatestatemachinediagram.md -->

# generateStateMachineDiagram

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/state-machine-diagram.generator.ts` (line 240)

Generate Mermaid state machine diagram

## Signature

```ts
function generateStateMachineDiagram(stateMachine: StateMachine, screenshots: EnhancedScreenshotMetadata[], interactions: UIInteraction[], options: StateMachineDiagramOptions): DiagramGenerationResult
```

## Parameters

| Name | Type |
|---|---|
| `stateMachine` | `StateMachine` |
| `screenshots` | `EnhancedScreenshotMetadata[]` |
| `interactions` | `UIInteraction[]` |
| `options` | `StateMachineDiagramOptions` |

**Returns:** `DiagramGenerationResult`

<!-- source: component-getmarkdowninsourcemode.md -->

# GetMarkdownInSourceMode

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/diff-source.tsx` (line 14)

## Diagram

```mermaid
graph TD
    component_GetMarkdownInSourceMode_1fd8740c["GetMarkdownInSourceMode"]
    class component_GetMarkdownInSourceMode_1fd8740c rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useRef`

<!-- source: interface-kgrelation.md -->

# KGRelation

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/graph/interfaces/entity.interface.ts` (line 40)

## Properties

| Property | Type |
|---|---|
| `from` | `string` |
| `to` | `string` |
| `type` | `RelationType` |
| `metadata` | `Record<string, any>` |
| `weight` | `number` |

<!-- source: component-mobilenavigation.md -->

# MobileNavigation

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Layout/DocumentLayout.tsx` (line 129)

Mobile navigation component - collapsible drawer

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `items` | `DocumentTreeNode[]` | ✓ | - |
| `activeId` | `string` | - | - |
| `loading` | `boolean` | ✓ | - |
| `onItemClick` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_MobileNavigation_199792c["MobileNavigation"]
    class component_MobileNavigation_199792c rootComponent
```

## Relationships

- RENDERS → `NavigationTree`
- USES_HOOK → `useState`

## Referenced By

- `DocumentLayout` (RENDERS)

<!-- source: interface-ngrxselectorpattern.md -->

# NgRxSelectorPattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ngrx-pattern-detector.ts` (line 92)

NgRx selector pattern

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `line` | `number` |
| `isMemoized` | `boolean` |
| `statePath` | `string[]` |
| `dependsOn` | `string[]` |

<!-- source: interface-orchestrationcallbacks.md -->

# OrchestrationCallbacks

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/orchestrator.ts` (line 106)

Callbacks for orchestration lifecycle

## Properties

| Property | Type |
|---|---|
| `onPhaseStart` | `(phaseId: string, phaseName: string) => void` |
| `onAgentStart` | `(phaseId: string, agentName: string) => void` |
| `onAgentComplete` | `(phaseId: string, result: AgentResult) => void` |
| `onPhaseComplete` | `(result: PhaseResult) => void | Promise<void>` |
| `onApprovalRequired` | `(phaseId: string, synthesis: string) => Promise<boolean>` |

<!-- source: class-summarizedocumentdto.md -->

# SummarizeDocumentDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/ai/dto/summarize-document.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `provider` | `string` |

<!-- source: service-supportagentservice.md -->

# SupportAgentService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.service.ts` (line 24)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `getConfig` | `getConfig(projectId: string)` | `unknown` |
| `upsertConfig` | `upsertConfig(projectId: string, organizationId: string, dto: UpsertSupportAgentConfigDto)` | `unknown` |
| `listAgents` | `listAgents(projectId: string)` | `unknown` |
| `createAgent` | `createAgent(projectId: string, organizationId: string, dto: any)` | `unknown` |
| `getAgent` | `getAgent(agentId: string)` | `unknown` |
| `updateAgent` | `updateAgent(agentId: string, dto: any)` | `unknown` |
| `deleteAgent` | `deleteAgent(agentId: string)` | `unknown` |
| `chat` | `chat(projectId: string, agentId: string, organizationId: string, message: string, opts: {
      versionNumber?: number;
      conversationHistory?: Array<{ role: string; content: string }>;
      sessionId?: string;
    })` | `unknown` |
| `chatStream` | `chatStream(projectId: string, agentId: string, organizationId: string, message: string, opts: {
      versionNumber?: number;
      conversationHistory?: Array<{ role: string; content: string }>;
      sessionId?: string;
    })` | `unknown` |
| `getChatHistory` | `getChatHistory(projectId: string, agentId: string, limit: unknown)` | `unknown` |
| `clearChatHistory` | `clearChatHistory(projectId: string, agentId: string)` | `unknown` |
| `search` | `search(projectId: string, organizationId: string, query: string, limit: unknown, docVersionId: string)` | `unknown` |
| `searchAll` | `searchAll(projectId: string, organizationId: string, query: string, limit: unknown)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `azuresearchservice`
- DEPENDS_ON → `languagedetectorservice`
- DEPENDS_ON → `agentadapterservice`

<!-- source: function-tap.md -->

# tap

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/fp.ts` (line 45)

Calls callback with the first argument, and returns it.

## Signature

```ts
function tap(arg: T, proc: (arg: T) => unknown): T
```

## Parameters

| Name | Type |
|---|---|
| `arg` | `T` |
| `proc` | `(arg: T) => unknown` |

**Returns:** `T`

<!-- source: function-usedocumentcollaborators.md -->

# useDocumentCollaborators

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useProjectMembers.ts` (line 170)

useDocumentCollaborators - Hook for fetching users who can be mentioned in a document

This is a convenience wrapper that determines the appropriate members to fetch
based on the document context.

## Signature

```ts
function useDocumentCollaborators(documentId: string): UseProjectMembersReturn
```

## Parameters

| Name | Type |
|---|---|
| `documentId` | `string` |

**Returns:** `UseProjectMembersReturn`

<!-- source: interface-useparseroptions.md -->

# UseParserOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useParser.ts` (line 7)

## Properties

| Property | Type |
|---|---|
| `apiUrl` | `string` |
| `getToken` | `() => string | null` |

<!-- source: interface-consistencyreport.md -->

# ConsistencyReport

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-11.types.ts` (line 92)

## Properties

| Property | Type |
|---|---|
| `overallScore` | `number` |
| `issues` | `ConsistencyIssue[]` |
| `corrections` | `ConsistencyCorrection[]` |
| `glossary` | `TermDefinition[]` |

<!-- source: api-endpoint-exportnow.md -->

# exportNow

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/export/analytics-export.controller.ts` (line 46)

## Endpoint

`POST /analytics/:projectId/export`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `format` | query | `'pdf' | 'csv'` | ✓ |

## Referenced By

- `AnalyticsExportController` (MODULE_DECLARES)

<!-- source: constant-flask-error-patterns.md -->

# FLASK_ERROR_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/flask.patterns.ts` (line 220)

<!-- source: function-generatetypescriptsdk.md -->

# generateTypeScriptSdk

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/sdk-generator.ts` (line 97)

Generate the full sdk.ts source for a spec.

## Signature

```ts
function generateTypeScriptSdk(spec: {
  info?: { title?: string; version?: string };
  servers?: Array<{ url?: string }>;
  paths?: Record<string, Record<string, OpenApiOperation>>;
  components?: { schemas?: Record<string, JsonSchema> };
}): string
```

## Parameters

| Name | Type |
|---|---|
| `spec` | `{
  info?: { title?: string; version?: string };
  servers?: Array<{ url?: string }>;
  paths?: Record<string, Record<string, OpenApiOperation>>;
  components?: { schemas?: Record<string, JsonSchema> };
}` |

**Returns:** `string`

<!-- source: component-getselectionmarkdown.md -->

# GetSelectionMarkdown

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/get-selection-markdown.tsx` (line 33)

## Diagram

```mermaid
graph TD
    component_GetSelectionMarkdown_66ab9fef["GetSelectionMarkdown"]
    class component_GetSelectionMarkdown_66ab9fef rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useRef`
- USES_HOOK → `useState`

<!-- source: interface-learningpath.md -->

# LearningPath

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/tutorial-detector.service.ts` (line 76)

Learning path grouping related tutorials

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `description` | `string` |
| `category` | `string` |
| `difficulty` | `'beginner' | 'intermediate' | 'advanced'` |
| `estimatedTime` | `string` |
| `tutorials` | `string[]` |
| `outcomes` | `string[]` |

<!-- source: interface-openapifragment.md -->

# OpenApiFragment

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/schema-resolver.ts` (line 185)

## Properties

| Property | Type |
|---|---|
| `paths` | `Record<string, Record<string, unknown>>` |
| `components` | `{ schemas: Record<string, Record<string, unknown>> }` |
| `resolvedCount` | `number` |

<!-- source: component-orb.md -->

# Orb

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/page.tsx` (line 396)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `style` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Orb_374b21d5["Orb"]
    class component_Orb_374b21d5 rootComponent
```

## Relationships

- RENDERS → `motion-div`

## Referenced By

- `HomePage` (RENDERS)

<!-- source: interface-orchestrationplan.md -->

# OrchestrationPlan

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/orchestrator.ts` (line 82)

A complete multi-phase workflow

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `phases` | `Phase[]` |

<!-- source: service-symbolindexservice.md -->

# SymbolIndexService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/parser/services/symbol-index.service.ts` (line 7)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `indexDocument` | `indexDocument(documentId: string)` | `Promise<void>` |
| `searchSymbols` | `searchSymbols(query: string, type: string)` | `Promise<any[]>` |
| `getSymbolsByDocument` | `getSymbolsByDocument(documentId: string)` | `Promise<any[]>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `parserservice`

<!-- source: class-syncbatchdto.md -->

# SyncBatchDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/sync.dto.ts` (line 84)

Batch sync request DTO

## Properties

| Property | Type |
|---|---|
| `documents` | `SyncDocumentDto[]` |
| `conflictStrategy` | `'skip' | 'overwrite' | 'version'` |
| `autoCreateCategories` | `boolean` |
| `deleteOrphans` | `boolean` |
| `docVersionId` | `string` |

<!-- source: function-thrush.md -->

# thrush

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/fp.ts` (line 13)

Takes a value and applies a function to it.

## Signature

```ts
function thrush(arg: I, proc: (arg: I) => K)
```

## Parameters

| Name | Type |
|---|---|
| `arg` | `I` |
| `proc` | `(arg: I) => K` |

<!-- source: function-usehasprojectselected.md -->

# useHasProjectSelected

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/stores/projectContext.ts` (line 205)

Hook to check if a project is selected

## Signature

```ts
function useHasProjectSelected(): boolean
```

**Returns:** `boolean`

<!-- source: interface-useparserreturn.md -->

# UseParserReturn

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useParser.ts` (line 12)

## Properties

| Property | Type |
|---|---|
| `parse` | `(code: string, language: string, filename?: string) => Promise<ParseResult>` |
| `parseDocument` | `(documentId: string) => Promise<ParseResult>` |
| `getSupportedLanguages` | `() => Promise<string[]>` |
| `parseResult` | `ParseResult | null` |
| `loading` | `boolean` |
| `error` | `Error | null` |

<!-- source: interface-contextrequest.md -->

# ContextRequest

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-04-analysis/iterative-deep-loader.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `type` | `'entity' | 'file' | 'dependency' | 'related'` |
| `identifier` | `string` |
| `reason` | `string` |

<!-- source: api-endpoint-exportpdf.md -->

# exportPDF

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 571)

## Endpoint

`GET /doc-versions/:projectId/:versionId/export/pdf`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |
| `format` | query | `string` | - |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: constant-flask-extensions-patterns.md -->

# FLASK_EXTENSIONS_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/flask.patterns.ts` (line 156)

<!-- source: function-generateuserjourneydiagrams.md -->

# generateUserJourneyDiagrams

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/user-journey-diagram.generator.ts` (line 80)

Main function to generate user journey diagrams from parsed entities

## Signature

```ts
function generateUserJourneyDiagrams(entities: Entity[], options: UserJourneyGenerationOptions): UserJourneyDiagramResult
```

## Parameters

| Name | Type |
|---|---|
| `entities` | `Entity[]` |
| `options` | `UserJourneyGenerationOptions` |

**Returns:** `UserJourneyDiagramResult`

<!-- source: component-headings.md -->

# Headings

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 167)

## Diagram

```mermaid
graph TD
    component_Headings_74f4b005["Headings"]
    class component_Headings_74f4b005 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: interface-leavedocumentdata.md -->

# LeaveDocumentData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/collaboration/interfaces/collaboration.interfaces.ts` (line 75)

Leave document payload

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |

<!-- source: interface-openapiref.md -->

# OpenApiRef

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/schema-resolver.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `schema` | `Record<string, unknown>` |

<!-- source: interface-orchestrationresult.md -->

# OrchestrationResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/orchestrator.ts` (line 98)

Result of executing a full orchestration plan

## Properties

| Property | Type |
|---|---|
| `planName` | `string` |
| `phaseResults` | `PhaseResult[]` |
| `totalUsage` | `TokenUsage` |
| `totalDurationMs` | `number` |

<!-- source: component-overflowindicator.md -->

# OverflowIndicator

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/CollaborationStatusBar.tsx` (line 121)

Overflow indicator showing additional users count

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `count` | `number` | ✓ | - |
| `users` | `CollaborationUser[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_OverflowIndicator_2dc14045["OverflowIndicator"]
    class component_OverflowIndicator_2dc14045 rootComponent
```

## Relationships

- USES_HOOK → `useState`

## Referenced By

- `CollaborationStatusBar` (RENDERS)

<!-- source: class-syncbatchresponsedto.md -->

# SyncBatchResponseDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/sync.dto.ts` (line 161)

Batch sync response

## Properties

| Property | Type |
|---|---|
| `success` | `number` |
| `failed` | `number` |
| `skipped` | `number` |
| `results` | `SyncResultDto[]` |
| `categoriesCreated` | `string[]` |

<!-- source: service-syncjobservice.md -->

# SyncJobService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/project/sync-job.service.ts` (line 35)

SyncJobService

Manages background sync jobs for reindexing documents across organization or project.
Provides progress tracking and status reporting.

`SyncJobService` manages background synchronization jobs used to reindex documents for an organization or individual project. It creates and tracks job progress, exposes status information for clients, and coordinates the work required to keep indexed content current.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `startFullSync` | `startFullSync(dto: StartFullSyncDto, organizationId: string, userId: string)` | `Promise<SyncJobDto>` |
| `getJobStatus` | `getJobStatus(jobId: string, organizationId: string)` | `Promise<SyncJobDto>` |
| `getOrganizationJobs` | `getOrganizationJobs(organizationId: string)` | `Promise<SyncJobDto[]>` |
| `cancelJob` | `cancelJob(jobId: string, organizationId: string)` | `Promise<SyncJobDto>` |

## Diagram

```mermaid
sequenceDiagram
  participant Client
  participant Controller
  participant SyncJobService
  participant JobStore
  participant Indexer

  Client->>Controller: Request document reindex
  Controller->>SyncJobService: createSyncJob(scope)
  SyncJobService->>JobStore: Create job (pending)
  JobStore-->>SyncJobService: Job ID
  SyncJobService->>Indexer: Start background reindex

  loop For each document
    Indexer->>SyncJobService: Report progress
    SyncJobService->>JobStore: Update progress/status
  end

  Indexer->>SyncJobService: Complete or fail
  SyncJobService->>JobStore: Save final status
  Client->>Controller: Get sync job status
  Controller->>SyncJobService: getJobStatus(jobId)
  SyncJobService->>JobStore: Read job state
  JobStore-->>SyncJobService: Job status
  SyncJobService-->>Controller: Progress and result
  Controller-->>Client: Sync job status
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { SyncJobService } from './sync-job.service';

@Injectable()
export class ProjectReindexService {
  constructor(private readonly syncJobService: SyncJobService) {}

  async reindexProject(projectId: string, organizationId: string) {
    const job = await this.syncJobService.createSyncJob({
      organizationId,
      projectId,
    });

    return {
      jobId: job.id,
      status: job.status,
    };
  }

  async getReindexStatus(jobId: string) {
    return this.syncJobService.getJobStatus(jobId);
  }
}
```

## AI Coding Instructions

- Create sync jobs before starting long-running reindex work so callers can immediately receive a job identifier and poll for status.
- Update progress consistently during document processing, including terminal `completed` or `failed` states.
- Preserve organization and project scope when creating or querying jobs to prevent cross-tenant status access.
- Keep expensive indexing operations asynchronous; do not block HTTP request handlers while a sync job is running.
- Propagate indexing failures to the job record with actionable error details so clients can distinguish retryable failures from completed jobs.

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `documentindexingservice`

<!-- source: function-togglebg.md -->

# toggleBg

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/examples/assets/dataCode.ts` (line 3)

## Signature

```ts
function toggleBg(index: number)
```

## Parameters

| Name | Type |
|---|---|
| `index` | `number` |

<!-- source: function-useimageupload.md -->

# useImageUpload

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useImageUpload.ts` (line 67)

useImageUpload - Hook for uploading images to Azure Blob Storage

Provides a simple interface for uploading images from the editor.
Returns the CDN URL of the uploaded image for embedding in documents.

## Signature

```ts
function useImageUpload(): UseImageUploadReturn
```

**Returns:** `UseImageUploadReturn`

<!-- source: interface-useprojectmembersoptions.md -->

# UseProjectMembersOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useProjectMembers.ts` (line 21)

Options for useProjectMembers hook

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `organizationId` | `string` |
| `autoFetch` | `boolean` |

<!-- source: interface-contextresolverconfig.md -->

# ContextResolverConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/context-resolver.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `maxDeepLoadIterations` | `number` |
| `maxTokensForCrossChunk` | `number` |
| `charsPerToken` | `number` |

<!-- source: api-endpoint-extractentities.md -->

# extractEntities

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/graph.controller.ts` (line 143)

## Endpoint

`POST /knowledge-graph/document/:id/extract`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `GraphController` (MODULE_DECLARES)

<!-- source: constant-flask-request-response-patterns.md -->

# FLASK_REQUEST_RESPONSE_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/flask.patterns.ts` (line 66)

<!-- source: function-generateworkflowdocumentation.md -->

# generateWorkflowDocumentation

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/workflow-documentation.generator.ts` (line 42)

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

| Name | Type |
|---|---|
| `screenshots` | `EnhancedScreenshotMetadata[]` |
| `options` | `WorkflowDocGenerationOptions` |

**Returns:** `WorkflowDocumentation[]`

<!-- source: component-herobentogrid-2.md -->

# HeroBentoGrid

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/hero/hero-bento-grid.tsx` (line 27)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `subheadlineKey` | `string` | ✓ | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `badgeKey` | `string` | - | - |
| `gridItems` | `unknown[]` | - | - |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_HeroBentoGrid_6437694a["HeroBentoGrid"]
    class component_HeroBentoGrid_6437694a rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h1`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: interface-listnotificationsoptions.md -->

# ListNotificationsOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/notification/notification.service.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `unreadOnly` | `boolean` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: interface-orchestratorconfig-2.md -->

# OrchestratorConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/config.interface.ts` (line 191)

Parser orchestrator configuration

## Properties

| Property | Type |
|---|---|
| `defaultParsers` | `string[]` |
| `maxConcurrency` | `number` |
| `fileTimeout` | `number` |
| `projectTimeout` | `number` |
| `enableCaching` | `boolean` |
| `cacheDir` | `string` |
| `parserConfigs` | `Record<string, ParserConfig>` |

<!-- source: interface-otlpexporterconfig.md -->

# OtlpExporterConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tracing/otlp-exporter.ts` (line 31)

## Properties

| Property | Type |
|---|---|
| `endpoint` | `string` |
| `serviceName` | `string` |
| `enabled` | `boolean` |
| `batchSize` | `number` |
| `flushIntervalMs` | `number` |
| `headers` | `Record<string, string>` |
| `onExportError` | `(error: Error, droppedSpanCount: number) => void` |

<!-- source: component-parsercard.md -->

# ParserCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/languages/page.tsx` (line 390)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `parser` | `unknown` | ✓ | - |
| `color` | `string` | ✓ | - |
| `bg` | `string` | ✓ | - |
| `border` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ParserCard_261c8a8d["ParserCard"]
    class component_ParserCard_261c8a8d rootComponent
```

## Referenced By

- `LanguagesPage` (RENDERS)

<!-- source: class-syncdocumentdto.md -->

# SyncDocumentDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/sync.dto.ts` (line 18)

Document sync DTO for batch operations

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `slug` | `string` |
| `content` | `string` |
| `type` | `string` |
| `description` | `string` |
| `audiences` | `string[]` |
| `categoryName` | `string` |
| `kgEntityId` | `string` |
| `kgEntityType` | `string` |
| `canRegenerate` | `boolean` |
| `order` | `number` |
| `parentSlug` | `string` |

<!-- source: service-syncservice.md -->

# SyncService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/project/sync.service.ts` (line 14)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `syncBatch` | `syncBatch(projectId: string, dto: SyncBatchDto, user: JwtPayload)` | `Promise<SyncBatchResponseDto>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `documentservice`
- DEPENDS_ON → `documentversionservice`
- DEPENDS_ON → `documentindexingservice`

<!-- source: function-torelativepath.md -->

# toRelativePath

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/services/entity-mapper.service.ts` (line 312)

Convert an absolute file path to a path relative to the repo root.
Always uses forward slashes.

## Signature

```ts
function toRelativePath(absolutePath: string, normalizedRepoPath: string): string
```

## Parameters

| Name | Type |
|---|---|
| `absolutePath` | `string` |
| `normalizedRepoPath` | `string` |

**Returns:** `string`

<!-- source: function-useknowledgegraph.md -->

# useKnowledgeGraph

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useKnowledgeGraph.ts` (line 32)

Hook to fetch and manage knowledge graph data for the current project

<!-- source: interface-useprojectmembersreturn.md -->

# UseProjectMembersReturn

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useProjectMembers.ts` (line 33)

Return type for useProjectMembers hook

## Properties

| Property | Type |
|---|---|
| `members` | `MemberUser[]` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `refresh` | `() => Promise<void>` |

<!-- source: interface-contextsource.md -->

# ContextSource

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/services/business-context-extractor.ts` (line 17)

A source of business context

## Properties

| Property | Type |
|---|---|
| `type` | `'pdf' | 'url' | 'file' | 'text'` |
| `path` | `string` |
| `content` | `string` |

<!-- source: api-endpoint-feedback.md -->

# feedback

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-chat.controller.ts` (line 142)

## Endpoint

`POST /technical-docs/:projectId/chat/messages/:messageId/feedback`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `messageId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsChatController` (MODULE_DECLARES)

<!-- source: constant-flask-route-patterns.md -->

# FLASK_ROUTE_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/flask.patterns.ts` (line 11)

Flask Pattern Detection

Patterns for detecting Flask routes, blueprints, and extensions.

<!-- source: function-generateworkflowdocumentationfile.md -->

# generateWorkflowDocumentationFile

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/workflow-documentation.generator.ts` (line 213)

Generate workflow documentation and write to file

## Signature

```ts
async function generateWorkflowDocumentationFile(screenshots: EnhancedScreenshotMetadata[], outputPath: string, options: WorkflowDocGenerationOptions): Promise<WorkflowDocGenerationResult[]>
```

## Parameters

| Name | Type |
|---|---|
| `screenshots` | `EnhancedScreenshotMetadata[]` |
| `outputPath` | `string` |
| `options` | `WorkflowDocGenerationOptions` |

**Returns:** `Promise<WorkflowDocGenerationResult[]>`

<!-- source: component-heroclassicsplit-2.md -->

# HeroClassicSplit

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/hero/hero-classic-split.tsx` (line 24)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `subheadlineKey` | `string` | ✓ | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `badgeKey` | `string` | - | - |
| `badgeIcon` | `LucideIcon` | - | - |
| `imageSrc` | `string` | ✓ | - |
| `imageAlt` | `string` | ✓ | - |
| `trustItems` | `unknown[]` | - | - |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_HeroClassicSplit_7cdf55b8["HeroClassicSplit"]
    class component_HeroClassicSplit_7cdf55b8 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-span`
- RENDERS → `BadgeIcon`
- RENDERS → `motion-h1`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- RENDERS → `motion-ul`
- RENDERS → `Check`
- USES_HOOK → `useTranslation`

<!-- source: interface-loadingstatemetadata.md -->

# LoadingStateMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/tutorial-detector.service.ts` (line 7)

Loading state metadata for tutorial generation

## Properties

| Property | Type |
|---|---|
| `indicatorType` | `'spinner' | 'skeleton' | 'progress' | 'overlay'` |
| `disabledElements` | `string[]` |
| `loadingMessage` | `string` |

<!-- source: interface-outputguardraildefinition.md -->

# OutputGuardrailDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 163)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `execute` | `(output: string) => Promise<GuardrailResult>` |

<!-- source: interface-parameterdefinition-2.md -->

# ParameterDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 576)

Parameter definition (path, query, header)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `required` | `boolean` |
| `description` | `string` |
| `example` | `unknown` |
| `defaultValue` | `unknown` |

<!-- source: component-portaltableofcontents.md -->

# PortalTableOfContents

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/[audienceSlug]/[documentSlug]/page.tsx` (line 165)

Portal-Compatible ToC Component Uses same hooks as TableOfContents but adapted for portal rendering

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `entries` | `TocEntry[]` | ✓ | - |
| `title` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PortalTableOfContents_640b163e["PortalTableOfContents"]
    class component_PortalTableOfContents_640b163e rootComponent
```

## Relationships

- RENDERS → `ChevronDown`
- RENDERS → `ChevronRight`
- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useMemo`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useActiveSection`
- USES_HOOK → `useCallback`

## Referenced By

- `PublicDocumentPage` (RENDERS)

<!-- source: class-syncentitiesdto.md -->

# SyncEntitiesDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/graph/dto/sync-entities.dto.ts` (line 66)

Request body for bulk entity sync

## Properties

| Property | Type |
|---|---|
| `entities` | `SyncEntityDto[]` |
| `workflowSignals` | `WorkflowSignals` |
| `enableAiWorkflows` | `boolean` |
| `aiModel` | `string` |
| `forceWorkflowDiscovery` | `boolean` |
| `businessContext` | `string` |

<!-- source: service-techdocschatservice.md -->

# TechDocsChatService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/rag/techdocs-chat.service.ts` (line 17)

Foundation F3: conversational grounded chat — sessions, memory, streaming, feedback.
Wraps the one-shot TechDocsRagService with per-session history so follow-up questions
("what about its retry behavior?") resolve against the conversation, and records
answered/refused/feedback signals into the F2 event stream for the deflection dashboard.

`TechDocsChatService` provides session-based, grounded conversational chat over technical documentation. It wraps the one-shot `TechDocsRagService` by maintaining per-session message history (memory) so follow-up questions resolve in context, supports streaming responses, and records answered/refused/feedback signals into the F2 event stream for deflection analytics.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `createSession` | `createSession(projectId: string, organizationId: string | null, channel: string, userId: string | null)` | `unknown` |
| `askStream` | `askStream(projectId: string, sessionId: string, question: string)` | `AsyncGenerator<string, {
    messageId: string;
    citations: string[];
    sources: DocSearchHit[];
    usage: { inputTokens: number; outputTokens: number; totalTokens: number };
  }, void>` |
| `escalate` | `escalate(projectId: string, sessionId: string, dto: { email?: string; note?: string; pageUrl?: string })` | `unknown` |
| `feedback` | `feedback(projectId: string, messageId: string, rating: 'up' | 'down', comment: string)` | `unknown` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  actor User
  participant API as Controller/Resolver
  participant Chat as TechDocsChatService
  participant Store as Session Memory Store
  participant RAG as TechDocsRagService
  participant F2 as F2 Event Stream

  User->>API: sendMessage(sessionId, prompt)
  API->>Chat: chat(sessionId, prompt, opts)
  Chat->>Store: loadHistory(sessionId)
  Store-->>Chat: history[]
  Chat->>RAG: ask({ prompt, history, streaming: true })
  RAG-->>Chat: stream tokens / final answer
  Chat-->>API: stream to client
  Chat->>Store: appendTurn(sessionId, user+assistant)
  Chat->>F2: emit(answered|refused, metadata)
  User->>API: submitFeedback(sessionId, messageId, vote)
  API->>Chat: recordFeedback(...)
  Chat->>F2: emit(feedback, metadata)
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { TechDocsChatService } from './technical-docs/rag/techdocs-chat.service';

@Injectable()
export class TechDocsChatController {
  constructor(private readonly chat: TechDocsChatService) {}

  // Pseudo-handler; adapt to your transport (REST/GraphQL/WebSocket/SSE)
  async ask(sessionId: string, prompt: string) {
    // Non-streaming example (if supported by your method signature)
    const result = await this.chat.chat({
      sessionId,
      message: prompt,
      // optional: userId/tenantId/document scope/etc. depending on your app
    });

    return {
      sessionId,
      answer: result.answer,
      refused: result.refused,
      citations: result.citations,
    };
  }

  // Streaming example (SSE/WebSocket): consume async iterator/callback stream
  async askStream(sessionId: string, prompt: string, onToken: (t: string) => void) {
    const stream = await this.chat.chatStream({ sessionId, message: prompt });

    for await (const chunk of stream) {
      // chunk could be token/text delta depending on implementation
      onToken(chunk.text ?? String(chunk));
    }
  }

  async feedback(sessionId: string, messageId: string, vote: 'up' | 'down') {
    await this.chat.recordFeedback({ sessionId, messageId, vote });
    return { ok: true };
  }
}
```

## AI Coding Instructions

- Preserve the “one-shot RAG + session memory” layering: `TechDocsChatService` should manage history/streaming/telemetry, while `TechDocsRagService` stays focused on retrieval + answer generation.
- Always load and append conversation turns atomically per `sessionId` to avoid interleaving history when multiple requests stream concurrently.
- Emit consistent F2 events for answered/refused and feedback, including stable identifiers (sessionId, messageId, doc scope) so the deflection dashboard can aggregate correctly.
- When adding new options (e.g., doc filters, tenant scoping), pass them through to the RAG call and include them in event metadata; avoid storing large retrieved context blobs in session memory.

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `techdocsragservice`
- DEPENDS_ON → `ragchatmodelservice`
- DEPENDS_ON → `eventsservice`
- DEPENDS_ON → `issuesservice`

<!-- source: function-trackevent.md -->

# trackEvent

**Kind:** Function

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/analytics.ts` (line 122)

Track a custom event.

## Signature

```ts
function trackEvent(name: string, properties: Record<string, string>)
```

## Parameters

| Name | Type |
|---|---|
| `name` | `string` |
| `properties` | `Record<string, string>` |

<!-- source: function-uselanguagecontext.md -->

# useLanguageContext

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/LanguageContext.tsx` (line 50)

<!-- source: interface-useprojectpublishreturn.md -->

# UseProjectPublishReturn

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useProjectPublish.ts` (line 25)

Return type for useProjectPublish hook

## Properties

| Property | Type |
|---|---|
| `publish` | `(projectId: string) => Promise<PublishedProjectResponse>` |
| `unpublish` | `(projectId: string) => Promise<Project>` |
| `loading` | `boolean` |
| `error` | `Error | null` |

<!-- source: interface-createaudiencedto.md -->

# CreateAudienceDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/audiences.ts` (line 8)

Audience creation DTO

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `color` | `string` |
| `icon` | `string` |
| `description` | `string` |

<!-- source: api-endpoint-finalizepage.md -->

# finalizePage

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/pme/pme.controller.ts` (line 119)

## Endpoint

`POST /pme/finalize`

## Referenced By

- `PmeController` (MODULE_DECLARES)

<!-- source: constant-flask-validation-patterns.md -->

# FLASK_VALIDATION_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/flask.patterns.ts` (line 107)

<!-- source: function-generateworkflowmdx.md -->

# generateWorkflowMDX

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/workflow-documentation.generator.ts` (line 80)

Generate MDX content from workflow documentation

## Signature

```ts
function generateWorkflowMDX(workflow: WorkflowDocumentation, options: WorkflowDocGenerationOptions): string
```

## Parameters

| Name | Type |
|---|---|
| `workflow` | `WorkflowDocumentation` |
| `options` | `WorkflowDocGenerationOptions` |

**Returns:** `string`

<!-- source: component-herodarkcentered-2.md -->

# HeroDarkCentered

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/hero/hero-dark-centered.tsx` (line 34)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `subheadlineKey` | `string` | ✓ | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `badgeKey` | `string` | - | - |
| `floatingStats` | `unknown[]` | - | - |
| `imageSrc` | `string` | - | - |
| `imageAlt` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_HeroDarkCentered_804c1f6["HeroDarkCentered"]
    class component_HeroDarkCentered_804c1f6 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h1`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- USES_HOOK → `useTranslation`

<!-- source: interface-managedsession.md -->

# ManagedSession

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/agent/agent.service.ts` (line 71)

## Properties

| Property | Type |
|---|---|
| `session` | `AgentSession` |
| `todoManager` | `TodoManager` |
| `workspace` | `string` |
| `reliability` | `ReliabilityContext` |
| `bashSession` | `BashSession` |
| `pluginManager` | `PluginManager` |
| `orchestrator` | `Orchestrator` |
| `cronScheduler` | `CronScheduler` |
| `remoteTriggerServer` | `RemoteTriggerServer` |
| `mcpManager` | `McpManager` |

<!-- source: interface-parseerror-3.md -->

# ParseError

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/parse-result.interface.ts` (line 53)

Error encountered during parsing

## Properties

| Property | Type |
|---|---|
| `message` | `string` |
| `code` | `string` |
| `severity` | `'error' | 'warning'` |
| `line` | `number` |
| `column` | `number` |
| `filePath` | `string` |
| `stack` | `string` |
| `suggestion` | `string` |

<!-- source: interface-passatkresult.md -->

# PassAtKResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/types.ts` (line 129)

Per-task result for pass@k evaluation.

## Properties

| Property | Type |
|---|---|
| `taskId` | `string` |
| `k` | `number` |
| `attempts` | `TaskResult[]` |
| `passedAny` | `boolean` |
| `firstPassAttempt` | `number` |

<!-- source: component-previewpane.md -->

# PreviewPane

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/branding/page.tsx` (line 1423)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `form` | `BrandingState` | ✓ | - |
| `project` | `unknown | null` | ✓ | - |
| `device` | `unknown | unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PreviewPane_a6dfc30["PreviewPane"]
    class component_PreviewPane_a6dfc30 rootComponent
```

## Referenced By

- `BrandingSettingsPage` (RENDERS)

<!-- source: class-syncentitiesresponsedto.md -->

# SyncEntitiesResponseDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/graph/dto/sync-entities.dto.ts` (line 120)

Response for bulk entity sync

## Properties

| Property | Type |
|---|---|
| `success` | `number` |
| `failed` | `number` |
| `updated` | `number` |
| `created` | `number` |
| `errors` | `Array<{ entityId: string; error: string }>` |

<!-- source: service-techdocsconnectorsservice.md -->

# TechDocsConnectorsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/techdocs-connectors.service.ts` (line 52)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `create` | `create(projectId: string, userId: string, dto: CreateConnectorDto)` | `unknown` |
| `list` | `list(projectId: string, userId: string)` | `unknown` |
| `setEnabled` | `setEnabled(projectId: string, userId: string, id: string, enabled: boolean)` | `unknown` |
| `remove` | `remove(projectId: string, userId: string, id: string)` | `unknown` |
| `syncNow` | `syncNow(projectId: string, userId: string, id: string)` | `unknown` |
| `syncDue` | `syncDue()` | `unknown` |
| `syncOne` | `syncOne(id: string)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `techdocssourcesservice`

<!-- source: function-trackpageview.md -->

# trackPageView

**Kind:** Function

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/analytics.ts` (line 146)

Track a page view.

## Signature

```ts
function trackPageView(path: string)
```

## Parameters

| Name | Type |
|---|---|
| `path` | `string` |

<!-- source: function-usenewprojectwizard.md -->

# useNewProjectWizard

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/useNewProjectWizard.ts` (line 143)

## Signature

```ts
function useNewProjectWizard(apiClient: any)
```

## Parameters

| Name | Type |
|---|---|
| `apiClient` | `any` |

<!-- source: interface-usepublishreturn.md -->

# UsePublishReturn

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/usePublish.ts` (line 11)

Return type for usePublish hook

## Properties

| Property | Type |
|---|---|
| `publish` | `(documentId: string) => Promise<Document>` |
| `unpublish` | `(documentId: string) => Promise<Document>` |
| `loading` | `boolean` |
| `error` | `Error | null` |

<!-- source: interface-createcategorydto.md -->

# CreateCategoryDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/category.dto.ts` (line 6)

DTO for creating a new category

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `icon` | `string` |
| `color` | `string` |
| `order` | `number` |
| `projectId` | `string` |
| `parentId` | `string` |
| `defaultDocId` | `string` |

<!-- source: api-endpoint-findpath.md -->

# findPath

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/graph.controller.ts` (line 107)

## Endpoint

`GET /knowledge-graph/path`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `from` | query | `string` | ✓ |
| `to` | query | `string` | ✓ |

## Referenced By

- `GraphController` (MODULE_DECLARES)

<!-- source: constant-focusring.md -->

# focusRing

**Kind:** Constant

**Source:** `atloria-monorepo/packages/ui-core/src/utils/styles.ts` (line 7)

Common CSS utilities and mixins for Atloria components

<!-- source: function-getlowestcoveragestatemachines.md -->

# getLowestCoverageStateMachines

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/coverage-calculator.ts` (line 376)

Get state machines with lowest coverage

## Signature

```ts
function getLowestCoverageStateMachines(report: CoverageReport, limit): StateMachineCoverage[]
```

## Parameters

| Name | Type |
|---|---|
| `report` | `CoverageReport` |
| `limit` | `any` |

**Returns:** `StateMachineCoverage[]`

<!-- source: component-herogradientsplit-2.md -->

# HeroGradientSplit

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/hero/hero-gradient-split.tsx` (line 26)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `subheadlineKey` | `string` | ✓ | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `imageSrc` | `string` | ✓ | - |
| `imageAlt` | `string` | ✓ | - |
| `badges` | `unknown[]` | - | - |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_HeroGradientSplit_3ffb7904["HeroGradientSplit"]
    class component_HeroGradientSplit_3ffb7904 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h1`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- RENDERS → `motion-span`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: interface-materializeoptions.md -->

# MaterializeOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-materializer.service.ts` (line 130)

## Properties

| Property | Type |
|---|---|
| `projectName` | `string` |
| `readme` | `string` |
| `enrichment` | `Map<string, EntityEnrichment>` |

<!-- source: interface-parseerror-4.md -->

# ParseError

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/storybook/types.ts` (line 180)

Parse error

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `message` | `string` |
| `line` | `number` |
| `column` | `number` |
| `stack` | `string` |

<!-- source: interface-phase.md -->

# Phase

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/orchestrator.ts` (line 68)

A phase in a multi-agent workflow

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `agents` | `AgentTemplate[]` |
| `requiresApproval` | `boolean` |
| `synthesize` | `(results: AgentResult[]) => string` |
| `maxTurnsPerAgent` | `number` |

<!-- source: component-prioritygauge.md -->

# PriorityGauge

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/page.tsx` (line 298)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `data` | `PriorityDatum[]` | ✓ | - |
| `total` | `number` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PriorityGauge_708c9494["PriorityGauge"]
    class component_PriorityGauge_708c9494 rootComponent
```

## Relationships

- RENDERS → `ResponsiveContainer`
- RENDERS → `PieChart`
- RENDERS → `Pie`
- RENDERS → `Cell`
- RENDERS → `RTooltip`

## Referenced By

- `IssuesListPage` (RENDERS)

<!-- source: class-syncentitydto.md -->

# SyncEntityDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/graph/dto/sync-entities.dto.ts` (line 20)

Entity DTO for bulk sync operations from CLI
Matches the format sent by CLI's ApiProvider

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `type` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `startLine` | `number` |
| `endLine` | `number` |
| `framework` | `string` |
| `metadata` | `Record<string, unknown>` |

<!-- source: service-techdocsexportservice.md -->

# TechDocsExportService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/techdocs-export.service.ts` (line 70)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `exportToConfluence` | `exportToConfluence(projectId: string, userId: string, dto: ConfluenceExportDto)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `technicaldocsmaterializerservice`

<!-- source: function-types.md -->

# types

**Kind:** Function

**Source:** `atloria-monorepo/packages/types/src/lib/types.ts` (line 1)

## Signature

```ts
function types(): string
```

**Returns:** `string`

<!-- source: function-useofflinesync.md -->

# useOfflineSync

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useOfflineSync.ts` (line 152)

Hook for offline document synchronization

Provides:
- Online/offline status detection
- Queuing updates when offline
- Automatic sync when back online
- Manual sync trigger
- Persistent storage in localStorage

## Signature

```ts
function useOfflineSync(options: UseOfflineSyncOptions): UseOfflineSyncReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseOfflineSyncOptions` |

**Returns:** `UseOfflineSyncReturn`

<!-- source: interface-userwithposition.md -->

# UserWithPosition

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/Editor/UserCursors.tsx` (line 10)

Extended user type with cursor position coordinates

## Properties

| Property | Type |
|---|---|
| `position` | `{
    x: number;
    y: number;
    /** Height of the line the cursor sits on, in pixels */
    height: number;
  }` |

<!-- source: interface-createcodeblocknodeoptions.md -->

# CreateCodeBlockNodeOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/CodeBlockNode.tsx` (line 22)

The options necessary to construct a new code block node.

## Properties

| Property | Type |
|---|---|
| `code` | `string` |
| `language` | `string` |
| `meta` | `string` |

<!-- source: api-endpoint-forgotpassword.md -->

# forgotPassword

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/auth.controller.ts` (line 93)

## Endpoint

`POST /auth/forgot-password`

## Referenced By

- `AuthController` (MODULE_DECLARES)

<!-- source: constant-formattingvisitors.md -->

# formattingVisitors

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/MdastFormattingVisitor.ts` (line 87)

<!-- source: function-getprioritystates.md -->

# getPriorityStates

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/coverage-calculator.ts` (line 393)

Get priority states that need screenshots

## Signature

```ts
function getPriorityStates(report: CoverageReport): Array<{
  stateMachine: string;
  state: string;
  priority: 'critical' | 'high' | 'medium';
  reason: string;
}>
```

## Parameters

| Name | Type |
|---|---|
| `report` | `CoverageReport` |

**Returns:** `Array<{
  stateMachine: string;
  state: string;
  priority: 'critical' | 'high' | 'medium';
  reason: string;
}>`

<!-- source: component-herominimalcentered-2.md -->

# HeroMinimalCentered

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/hero/hero-minimal-centered.tsx` (line 28)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `subheadlineKey` | `string` | ✓ | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `badgeKey` | `string` | - | - |
| `badgeIcon` | `LucideIcon` | - | - |
| `dividerIcons` | `LucideIcon[]` | - | - |
| `imageSrc` | `string` | - | - |
| `imageAlt` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_HeroMinimalCentered_2e836aac["HeroMinimalCentered"]
    class component_HeroMinimalCentered_2e836aac rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `BadgeIcon`
- RENDERS → `motion-h1`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: interface-materializeresult.md -->

# MaterializeResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-materializer.service.ts` (line 453)

## Properties

| Property | Type |
|---|---|
| `docVersionId` | `string` |
| `versionNumber` | `number` |
| `categoriesCreated` | `number` |
| `documentsCreated` | `number` |

<!-- source: interface-parsefileinput-2.md -->

# ParseFileInput

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/parser.interface.ts` (line 42)

Input for parsing a file

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `content` | `string` |
| `metadata` | `Record<string, unknown>` |

<!-- source: interface-phaseresult.md -->

# PhaseResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/orchestrator.ts` (line 89)

Result of executing a single phase

## Properties

| Property | Type |
|---|---|
| `phaseId` | `string` |
| `agentResults` | `AgentResult[]` |
| `synthesis` | `string` |
| `totalUsage` | `TokenUsage` |
| `durationMs` | `number` |

<!-- source: component-projectcardcustom.md -->

# ProjectCardCustom

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/page.tsx` (line 255)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `project` | `Project` | ✓ | - |
| `onClick` | `Function` | ✓ | - |
| `onDelete` | `Function` | ✓ | - |
| `showMenu` | `boolean` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ProjectCardCustom_12efb7c9["ProjectCardCustom"]
    class component_ProjectCardCustom_12efb7c9 rootComponent
```

## Relationships

- RENDERS → `FolderIcon`

## Referenced By

- `ProjectsPage` (RENDERS)

<!-- source: class-syncjobdto.md -->

# SyncJobDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/sync-job.dto.ts` (line 51)

Sync job response DTO

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `status` | `SyncJobStatus` |
| `scope` | `SyncJobScope` |
| `organizationId` | `string` |
| `projectId` | `string` |
| `progress` | `SyncJobProgress` |
| `startedAt` | `Date` |
| `completedAt` | `Date` |
| `error` | `string` |
| `initiatedBy` | `string` |

<!-- source: service-techdocsnotionexportservice.md -->

# TechDocsNotionExportService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/techdocs-notion-export.service.ts` (line 28)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `exportToNotion` | `exportToNotion(projectId: string, userId: string, dto: NotionExportDto)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `technicaldocsmaterializerservice`

<!-- source: function-uicore.md -->

# uiCore

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-core/src/lib/ui-core.ts` (line 1)

## Signature

```ts
function uiCore(): string
```

**Returns:** `string`

<!-- source: function-usepagetracking.md -->

# usePageTracking

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/lib/analytics/usePageTracking.ts` (line 182)

Hook to track page views with time on page and scroll depth

Best practices implemented:
1. Session-based tracking (browser session)
2. Time on page measurement
3. Scroll depth tracking
4. Debounced scroll events
5. Beacon API for reliable tracking on page unload
6. No PII collection (anonymous tracking)

## Signature

```ts
function usePageTracking(options: PageTrackingOptions)
```

## Parameters

| Name | Type |
|---|---|
| `options` | `PageTrackingOptions` |

<!-- source: interface-usetemplatesoptions.md -->

# UseTemplatesOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useTemplates.ts` (line 20)

Options for useTemplates hook

## Properties

| Property | Type |
|---|---|
| `filters` | `TemplateFiltersDto` |
| `autoFetch` | `boolean` |

<!-- source: interface-createcommentdto.md -->

# CreateCommentDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/comment.dto.ts` (line 15)

Create comment DTO

## Properties

| Property | Type |
|---|---|
| `content` | `string` |
| `selectionText` | `string` |
| `positionStart` | `number` |
| `positionEnd` | `number` |
| `parentCommentId` | `string` |

<!-- source: constant-framework-detection-configs.md -->

# FRAMEWORK_DETECTION_CONFIGS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/framework.types.ts` (line 173)

Default framework detection configurations

## Definition

```ts
FrameworkDetectionConfig[]
```

<!-- source: api-endpoint-freshness.md -->

# freshness

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/manuals-insights/manuals-insights.controller.ts` (line 68)

PUBLIC — powers the reader-facing freshness badge. No guard by design.

## Endpoint

`GET /manuals-insights/:projectId/freshness`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `slug` | query | `string` | ✓ |

## Referenced By

- `ManualsInsightsController` (MODULE_DECLARES)

<!-- source: function-getreactlifecyclemethods-2.md -->

# getReactLifecycleMethods

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 689)

Get lifecycle methods for React class components

## Signature

```ts
function getReactLifecycleMethods(): string[]
```

**Returns:** `string[]`

<!-- source: component-herowavesplit-2.md -->

# HeroWaveSplit

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/hero/hero-wave-split.tsx` (line 23)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `subheadlineKey` | `string` | ✓ | - |
| `primaryCtaKey` | `string` | ✓ | - |
| `primaryCtaUrl` | `string` | ✓ | - |
| `secondaryCtaKey` | `string` | - | - |
| `secondaryCtaUrl` | `string` | - | - |
| `imageSrc` | `string` | ✓ | - |
| `imageAlt` | `string` | ✓ | - |
| `stats` | `unknown[]` | - | - |
| `trustTextKey` | `string` | - | - |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_HeroWaveSplit_4fd6800e["HeroWaveSplit"]
    class component_HeroWaveSplit_4fd6800e rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h1`
- RENDERS → `motion-p`
- RENDERS → `ArrowRight`
- USES_HOOK → `useTranslation`

<!-- source: interface-metadatadiff.md -->

# MetadataDiff

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/dto/compare-document.dto.ts` (line 64)

Metadata diff

## Properties

| Property | Type |
|---|---|
| `field` | `string` |
| `changed` | `boolean` |
| `from` | `any` |
| `to` | `any` |

<!-- source: interface-parsemetadata-2.md -->

# ParseMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/parse-result.interface.ts` (line 144)

Metadata about the parse operation

## Properties

| Property | Type |
|---|---|
| `duration` | `number` |
| `linesOfCode` | `number` |
| `fileSize` | `number` |
| `language` | `string` |
| `framework` | `string` |
| `fileHash` | `string` |
| `complexity` | `number` |

<!-- source: interface-planmodefilteroptions.md -->

# PlanModeFilterOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/plan-mode-filter.ts` (line 37)

## Properties

| Property | Type |
|---|---|
| `additionalAllowed` | `string[]` |
| `additionalBlocked` | `string[]` |
| `blockMessage` | `string` |

<!-- source: component-promptcard.md -->

# PromptCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/PromptLibrary.tsx` (line 110)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `prompt` | `PromptTemplate` | ✓ | - |
| `onEdit` | `Function` | ✓ | - |
| `onDelete` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PromptCard_158cdc5a["PromptCard"]
    class component_PromptCard_158cdc5a rootComponent
```

## Relationships

- RENDERS → `CategoryBadge`
- USES_HOOK → `useState`

## Referenced By

- `PromptLibrary` (RENDERS)

<!-- source: class-syncjobprogress.md -->

# SyncJobProgress

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/sync-job.dto.ts` (line 25)

Sync job progress information

## Properties

| Property | Type |
|---|---|
| `total` | `number` |
| `processed` | `number` |
| `succeeded` | `number` |
| `failed` | `number` |
| `skipped` | `number` |
| `percentage` | `number` |
| `currentDocument` | `string` |

<!-- source: service-techdocsragservice.md -->

# TechDocsRagService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/rag/techdocs-rag.service.ts` (line 38)

Grounded codebase chat (GraphRAG) over the technical docs.

 index(projectId): embed each published page → upsert as (:TechChunk) with its vector in Neo4j,
 backed by a native vector index.
 ask(projectId, q): embed the question → Neo4j vector search (scoped to the project) → feed the
 top hits to gpt-5.x with citation-forced grounding → return an answer + validated citations
 (invented references are dropped by validateCitations).

The same ask() backs both the web "ask about this codebase" endpoint and the MCP ask_question tool.

`TechDocsRagService` provides grounded, citation-backed Q&A over a project’s published technical documentation using a GraphRAG-style pipeline. It indexes docs by embedding each published page into vectorized `(:TechChunk)` nodes in Neo4j (with a native vector index), then answers questions by running scoped vector search and prompting `gpt-5.x` with strict citation grounding. It powers both the web “ask about this codebase” endpoint and the MCP `ask_question` tool, dropping any invented references via `validateCitations`.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `index` | `index(projectId: string)` | `Promise<{ indexed: number; embeddingTokens: number }>` |
| `retrieve` | `retrieve(projectId: string, question: string, k: unknown, docTypes: Array<'technical' | 'user_manual' | 'external'>)` | `Promise<DocSearchHit[]>` |
| `purgePath` | `purgePath(projectId: string, pathPrefix: string)` | `Promise<void>` |
| `purgeProject` | `purgeProject(projectId: string)` | `Promise<void>` |
| `askFn` | `askFn(projectId: string)` | `AskFn` |
| `ask` | `ask(projectId: string, question: string)` | `Promise<{
    answer: string;
    citations: string[];
    sources: DocSearchHit[];
    usage: { inputTokens: number; outputTokens: number; totalTokens: number };
  }>` |
| `assistPage` | `assistPage(projectId: string, currentMarkdown: string, instruction: string, pageTitle: unknown)` | `Promise<{
    content: string;
    citations: string[];
    sources: DocSearchHit[];
    usage: { inputTokens: number; outputTokens: number; totalTokens: number };
  }>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  actor User
  participant API as API Endpoint / MCP Tool
  participant Svc as TechDocsRagService
  participant Embed as Embeddings Provider
  participant Neo4j as Neo4j (Vector Index)
  participant LLM as gpt-5.x
  participant Val as validateCitations

  rect rgb(245,245,245)
    note over Svc,Neo4j: Indexing: index(projectId)
    Svc->>API: index(projectId) triggered
    Svc->>Embed: Embed each published page
    Embed-->>Svc: Page vectors
    Svc->>Neo4j: Upsert (:TechChunk) + vector<br/>scoped to projectId
    Neo4j-->>Svc: Indexed
  end

  rect rgb(245,245,245)
    note over User,Val: Q&A: ask(projectId, q)
    User->>API: Ask question (q)
    API->>Svc: ask(projectId, q)
    Svc->>Embed: Embed question
    Embed-->>Svc: Question vector
    Svc->>Neo4j: Vector search (projectId scope)
    Neo4j-->>Svc: Top-k matching chunks (+ metadata)
    Svc->>LLM: Prompt with chunks + citation-forced grounding
    LLM-->>Svc: Draft answer + citations
    Svc->>Val: Validate citations (drop invented refs)
    Val-->>Svc: Answer + validated citations
    Svc-->>API: Response
    API-->>User: Grounded answer
  end
```

## Usage

```ts
// NestJS-style usage (e.g., in a controller or another service)
import { Controller, Post, Param, Body } from '@nestjs/common';
import { TechDocsRagService } from './technical-docs/rag/techdocs-rag.service';

@Controller('projects/:projectId/techdocs')
export class TechDocsController {
  constructor(private readonly techDocsRag: TechDocsRagService) {}

  @Post('index')
  async index(@Param('projectId') projectId: string) {
    // Embeds each published page and upserts (:TechChunk) with vectors into Neo4j
    await this.techDocsRag.index(projectId);
    return { ok: true };
  }

  @Post('ask')
  async ask(
    @Param('projectId') projectId: string,
    @Body() body: { q: string },
  ) {
    // Vector-searches within the project scope and returns an answer + validated citations
    const result = await this.techDocsRag.ask(projectId, body.q);
    return result; // typically: { answer: string, citations: [...] }
  }
}
```

## AI Coding Instructions

- Keep `ask(projectId, q)` strictly grounded: only feed Neo4j-retrieved chunks to the model and run `validateCitations` to drop any invented references.
- Always scope retrieval and indexing by `projectId` (both Neo4j upserts and vector searches) to prevent cross-project leakage.
- Treat `index(projectId)` as idempotent: upsert `(:TechChunk)` deterministically so re-indexing doesn’t duplicate or drift.
- When modifying prompts or chunk metadata, preserve the citation contract (stable identifiers/URLs/anchors) so validation can reliably match citations to retrieved chunks.
- Watch for embedding/vector index mismatches (dimension/model changes): ensure Neo4j vector index configuration stays aligned with the embedding provider used by both `index` and `ask`.

## Relationships

- DEPENDS_ON → `neo4jservice`
- DEPENDS_ON → `embeddingsservice`
- DEPENDS_ON → `ragchatmodelservice`
- DEPENDS_ON → `technicaldocsmaterializerservice`

<!-- source: function-useactivesection.md -->

# useActiveSection

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useActiveSection.ts` (line 22)

## Signature

```ts
function useActiveSection(headingIds: string[]): {
  activeId: string | null;
  setActiveId: (id: string | null) => void;
}
```

## Parameters

| Name | Type |
|---|---|
| `headingIds` | `string[]` |

**Returns:** `{
  activeId: string | null;
  setActiveId: (id: string | null) => void;
}`

<!-- source: function-useparser.md -->

# useParser

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useParser.ts` (line 24)

Custom hook for parsing code

## Signature

```ts
function useParser(options: UseParserOptions): UseParserReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseParserOptions` |

**Returns:** `UseParserReturn`

<!-- source: interface-usetemplatesreturn.md -->

# UseTemplatesReturn

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/hooks/useTemplates.ts` (line 28)

Return type for useTemplates hook

## Properties

| Property | Type |
|---|---|
| `templates` | `DocumentTemplate[]` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `refresh` | `() => Promise<void>` |
| `getTemplate` | `(id: string) => Promise<DocumentTemplate>` |
| `useTemplate` | `(id: string, dto: CreateFromTemplateDto) => Promise<Document>` |
| `saveAsTemplate` | `(documentId: string, dto: SaveAsTemplateDto) => Promise<DocumentTemplate>` |
| `categories` | `TemplateCategory[]` |

<!-- source: interface-createdocumentdto.md -->

# CreateDocumentDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/document.dto.ts` (line 7)

DTO for creating a new document

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `slug` | `string` |
| `content` | `string` |
| `contentHtml` | `string` |
| `type` | `DocumentType` |
| `source` | `DocumentSource` |
| `audiences` | `Audience[]` |
| `projectId` | `string` |
| `createdById` | `string` |
| `kgEntityId` | `string` |
| `kgEntityType` | `string` |
| `isPublic` | `boolean` |
| `canRegenerate` | `boolean` |

<!-- source: constant-framework-types.md -->

# FRAMEWORK_TYPES

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 23)

Supported framework types

<!-- source: api-endpoint-generate.md -->

# generate

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 69)

Generate the full technical doc set for a project:
clone → parse → TechnicalSnapshot (navMap + apiSpec), then materialize a
browsable 'technical' doc set (entity reference pages in a DocVersion with
audienceScope='technical') and activate it — without touching the user
manual's ACTIVE version. Tracked as a DocumentationJob when the project
has an auto-doc config; otherwise poll GET :projectId/status.

## Endpoint

`POST /technical-docs/:projectId/generate`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: function-groupbyenvironment.md -->

# groupByEnvironment

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/deployment-diagram.generator.ts` (line 617)

Group nodes by deployment environment

## Signature

```ts
function groupByEnvironment(nodes: DeploymentNode[]): Map<string, DeploymentNode[]>
```

## Parameters

| Name | Type |
|---|---|
| `nodes` | `DeploymentNode[]` |

**Returns:** `Map<string, DeploymentNode[]>`

<!-- source: component-highlighttoggle.md -->

# HighlightToggle

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/HighlightToggle.tsx` (line 11)

## Diagram

```mermaid
graph TD
    component_HighlightToggle_5db46bbf["HighlightToggle"]
    class component_HighlightToggle_5db46bbf rootComponent
```

## Relationships

- RENDERS → `MultipleChoiceToggleGroup`
- USES_HOOK → `useCellValues`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useTranslation`

<!-- source: interface-notionblock.md -->

# NotionBlock

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/md-to-notion-blocks.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `object` | `'block'` |
| `type` | `string` |

<!-- source: interface-parseprojectconfig-2.md -->

# ParseProjectConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/config.interface.ts` (line 16)

Project parse configuration

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `parsers` | `string[]` |
| `includePatterns` | `string[]` |
| `excludePatterns` | `string[]` |
| `incremental` | `boolean` |
| `maxFiles` | `number` |
| `parallel` | `boolean` |
| `concurrency` | `number` |
| `metadata` | `Record<string, unknown>` |

<!-- source: interface-pluginmanifest.md -->

# PluginManifest

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/plugins/plugin-types.ts` (line 16)

Plugin System Type Definitions

Defines the contract for Atloria's plugin architecture. Plugins let users
extend the agent with custom commands, agents, skills, and hooks by dropping
markdown files with YAML frontmatter into a plugins directory.

Inspired by Claude Code's plugin architecture.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `version` | `string` |
| `description` | `string` |
| `author` | `string | { name: string; email?: string }` |

<!-- source: component-promptform.md -->

# PromptForm

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/PromptLibrary.tsx` (line 173)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `initialData` | `PromptTemplate` | - | - |
| `onSave` | `Function` | ✓ | - |
| `onCancel` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PromptForm_158b4aa6["PromptForm"]
    class component_PromptForm_158b4aa6 rootComponent
```

## Relationships

- USES_HOOK → `useState`

## Referenced By

- `PromptLibrary` (RENDERS)

<!-- source: class-syncrelationshipdto.md -->

# SyncRelationshipDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/graph/dto/sync-relationships.dto.ts` (line 17)

Relationship DTO for bulk sync operations from CLI
Matches the format sent by CLI's ApiProvider

## Properties

| Property | Type |
|---|---|
| `sourceId` | `string` |
| `targetId` | `string` |
| `type` | `string` |
| `metadata` | `Record<string, unknown>` |

<!-- source: service-techdocssourcesservice.md -->

# TechDocsSourcesService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/techdocs-sources.service.ts` (line 50)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `importUrl` | `importUrl(projectId: string, userId: string, rawUrl: string)` | `unknown` |
| `importPdf` | `importPdf(projectId: string, userId: string, buffer: Buffer, filename: string)` | `unknown` |
| `importZendesk` | `importZendesk(projectId: string, userId: string, dto: { subdomain?: string; email?: string; apiToken?: string; max?: number })` | `unknown` |
| `importIntercom` | `importIntercom(projectId: string, userId: string, dto: { accessToken?: string; max?: number })` | `unknown` |
| `pullZendesk` | `pullZendesk(config: { subdomain?: string; email?: string; apiToken?: string; max?: number }, since: string, max: unknown)` | `Promise<TicketItem[]>` |
| `pullIntercom` | `pullIntercom(config: { accessToken?: string; max?: number }, since: string, max: unknown)` | `Promise<TicketItem[]>` |
| `ingestTickets` | `ingestTickets(projectId: string, organizationId: string, userId: string, provider: 'zendesk' | 'intercom', tickets: TicketItem[], connectorId: string)` | `unknown` |
| `list` | `list(projectId: string, userId: string)` | `unknown` |
| `remove` | `remove(projectId: string, userId: string, documentId: string)` | `unknown` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `technicaldocsqueue`
- DEPENDS_ON → `techdocsragservice`

<!-- source: function-useapiclient.md -->

# useAPIClient

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-react/src/providers/AtloriaProvider.tsx` (line 78)

Hook to access the API client

## Signature

```ts
function useAPIClient(): APIClient
```

**Returns:** `APIClient`

<!-- source: function-usepme.md -->

# usePme

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/usePme.ts` (line 24)

<!-- source: interface-wizardstate.md -->

# WizardState

**Kind:** Interface

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/useNewProjectWizard.ts` (line 7)

## Properties

| Property | Type |
|---|---|
| `currentScene` | `WizardScene` |
| `completedSteps` | `number[]` |
| `repoUrl` | `string` |
| `detectedProvider` | `'github' | 'gitlab' | 'bitbucket' | null` |
| `detectedOwner` | `string` |
| `detectedRepo` | `string` |
| `projectName` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `branch` | `string` |
| `frontendPath` | `string` |
| `backendPath` | `string` |
| `siteUrl` | `string` |
| `loginUrl` | `string` |
| `siteEmail` | `string` |
| `sitePassword` | `string` |
| `needsAuth` | `boolean` |
| `authMethod` | `'token' | 'ssh' | null` |
| `repoUsername` | `string` |
| `accessToken` | `string` |
| `connectionTested` | `boolean` |
| `githubConnected` | `boolean` |
| `gitlabConnected` | `boolean` |
| `bitbucketConnected` | `boolean` |
| `selectedDocTypes` | `string[]` |
| `createdProjectId` | `string | null` |

<!-- source: interface-createorganizationdto.md -->

# CreateOrganizationDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/organization.dto.ts` (line 4)

DTO for creating a new organization

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |

<!-- source: constant-frontmatterdialogopen.md -->

# frontmatterDialogOpen$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/frontmatter/index.ts` (line 34)

Whether the frontmatter dialog is open.

<!-- source: api-endpoint-generate-2.md -->

# generate

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/trial/trial.controller.ts` (line 20)

## Endpoint

`POST /trial/generate`

## Referenced By

- `TrialController` (MODULE_DECLARES)

<!-- source: function-hashstring-2.md -->

# hashString

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 610)

Simple hash function for generating unique IDs

## Signature

```ts
function hashString(str: string): string
```

## Parameters

| Name | Type |
|---|---|
| `str` | `string` |

**Returns:** `string`

<!-- source: component-howitworkscardsgrid-2.md -->

# HowItWorksCardsGrid

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/how-it-works/how-it-works-cards-grid.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `labelKey` | `string` | - | - |
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `steps` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_HowItWorksCardsGrid_1987d9c3["HowItWorksCardsGrid"]
    class component_HowItWorksCardsGrid_1987d9c3 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-span`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `StepIndicator`
- USES_HOOK → `useTranslation`

<!-- source: interface-notionexportdto.md -->

# NotionExportDto

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/techdocs-notion-export.service.ts` (line 17)

## Properties

| Property | Type |
|---|---|
| `integrationToken` | `string` |
| `parentPageId` | `string` |
| `scope` | `'technical' | 'user'` |
| `dryRun` | `boolean` |

<!-- source: interface-parserconfig-2.md -->

# ParserConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/parser.interface.ts` (line 16)

Configuration for parser initialization

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `tsconfigPath` | `string` |
| `options` | `Record<string, unknown>` |
| `debug` | `boolean` |
| `excludePatterns` | `string[]` |
| `maxFileSize` | `number` |
| `timeout` | `number` |

<!-- source: interface-preflightcheck.md -->

# PreflightCheck

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/test-watcher.ts` (line 284)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `check` | `() => PreflightResult` |

<!-- source: component-propertyrow.md -->

# PropertyRow

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/[ticketId]/page.tsx` (line 292)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `label` | `string` | ✓ | - |
| `icon` | `unknown` | - | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PropertyRow_2c1b40be["PropertyRow"]
    class component_PropertyRow_2c1b40be rootComponent
```

## Relationships

- RENDERS → `Icon`

## Referenced By

- `IssueDetailPageInner` (RENDERS)

<!-- source: class-syncrelationshipsdto.md -->

# SyncRelationshipsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/graph/dto/sync-relationships.dto.ts` (line 42)

Request body for bulk relationship sync

## Properties

| Property | Type |
|---|---|
| `relationships` | `SyncRelationshipDto[]` |

<!-- source: service-technicaldocsenrichmentservice.md -->

# TechnicalDocsEnrichmentService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-enrichment.service.ts` (line 30)

Enriches parsed entities with AI-generated documentation:
- Description (if entity has no JSDoc / thin metadata)
- Mermaid diagram (sequence for services, ER for models, component hierarchy)
- Usage example
- AI coding instructions (Cursor / Claude Code style)

Each enrichment is stored as a Document record:
  source: 'AI', type: 'AI_ENRICHMENT', kgEntityId: entity.id

Enrichments survive re-parses — upsert is keyed by deterministic Document.id.
Runs async/non-blocking from TechnicalDocsParserService after snapshot is saved.

`TechnicalDocsEnrichmentService` generates AI-powered documentation for parsed knowledge-graph entities, including missing descriptions, Mermaid diagrams, usage examples, and coding guidance. It runs asynchronously after `TechnicalDocsParserService` saves a snapshot, persisting each result as an `AI_ENRICHMENT` `Document` keyed by a deterministic ID so enrichments survive subsequent parses.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `enrichProject` | `enrichProject(projectId: string, organizationId: string, userId: string, limit: number)` | `Promise<{ entities: number; enriched: number }>` |
| `enrichSnapshot` | `enrichSnapshot(projectId: string, organizationId: string, entities: Entity[], userId: string, limit: number, relationships: Relationship[])` | `Promise<number>` |

## Diagram

```mermaid
sequenceDiagram
    participant Parser as TechnicalDocsParserService
    participant Enrichment as TechnicalDocsEnrichmentService
    participant AI as AI Provider
    participant DB as Document Repository

    Parser->>DB: Save parsed entity snapshot
    Parser-->>Enrichment: Trigger enrichment asynchronously
    Enrichment->>Enrichment: Identify missing/thin metadata
    Enrichment->>AI: Generate description, diagram, examples, instructions
    AI-->>Enrichment: Return generated documentation
    Enrichment->>DB: Upsert AI_ENRICHMENT Documents
    Note over DB: Deterministic Document.id preserves<br/>enrichments across re-parses
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { TechnicalDocsEnrichmentService } from './technical-docs-enrichment.service';

@Injectable()
export class TechnicalDocsParserService {
  constructor(
    private readonly enrichmentService: TechnicalDocsEnrichmentService,
  ) {}

  async parseAndSave(sourcePath: string) {
    const snapshot = await this.parseSource(sourcePath);
    const entities = await this.saveSnapshot(snapshot);

    // Do not block parsing or snapshot persistence on AI generation.
    void Promise.allSettled(
      entities.map((entity) =>
        this.enrichmentService.enrichEntity(entity),
      ),
    );

    return entities;
  }

  private async parseSource(sourcePath: string) {
    // Parse source files into a technical-documentation snapshot.
  }

  private async saveSnapshot(snapshot: unknown) {
    // Persist entities and return the saved entity records.
    return [];
  }
}
```

## AI Coding Instructions

- Trigger enrichment only after the parsed snapshot and its entities have been persisted; enrichment documents require a stable `kgEntityId`.
- Keep enrichment non-blocking (`void` or a background job) so AI provider latency or failures never prevent parsing from completing.
- Persist generated output as `Document` records with `source: 'AI'`, `type: 'AI_ENRICHMENT'`, and the associated `kgEntityId`.
- Use deterministic `Document.id` values when upserting enrichments to preserve AI-generated content across source re-parses.
- Generate diagrams appropriate to the entity type: sequence diagrams for services, ER diagrams for models, and component hierarchies for structural entities.

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `aiprovider`
- DEPENDS_ON → `aiusageservice`

<!-- source: function-useatloriacontext.md -->

# useAtloriaContext

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-react/src/providers/AtloriaProvider.tsx` (line 59)

Hook to access the Atloria context

## Signature

```ts
function useAtloriaContext(): AtloriaContextValue
```

**Returns:** `AtloriaContextValue`

<!-- source: function-useprojectmembers.md -->

# useProjectMembers

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useProjectMembers.ts` (line 66)

useProjectMembers - Hook for fetching project/organization members

Used for

## Signature

```ts
function useProjectMembers(options: UseProjectMembersOptions): UseProjectMembersReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseProjectMembersOptions` |

**Returns:** `UseProjectMembersReturn`

<!-- source: interface-createprojectdto.md -->

# CreateProjectDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/project.dto.ts` (line 4)

DTO for creating a new project

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `organizationId` | `string` |
| `themeId` | `string` |
| `repoUrl` | `string` |
| `repoBranch` | `string` |

<!-- source: constant-frontmatterplugin.md -->

# frontmatterPlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/frontmatter/index.ts` (line 91)

A plugin that adds support for frontmatter.

<!-- source: api-endpoint-generatefromneo4j.md -->

# generateFromNeo4j

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/documentation.controller.ts` (line 78)

## Endpoint

`POST /documentation/generate-from-neo4j`

## Referenced By

- `DocumentationController` (MODULE_DECLARES)

<!-- source: function-hasjsxinpath-2.md -->

# hasJSXInPath

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 56)

Check if an AST node contains JSX

## Signature

```ts
function hasJSXInPath(path: NodePath): boolean
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath` |

**Returns:** `boolean`

<!-- source: component-howitworkshorizontal-2.md -->

# HowItWorksHorizontal

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/how-it-works/how-it-works-horizontal.tsx` (line 16)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `labelKey` | `string` | - | - |
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `steps` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_HowItWorksHorizontal_519d839e["HowItWorksHorizontal"]
    class component_HowItWorksHorizontal_519d839e rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-span`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `StepIndicator`
- USES_HOOK → `useTranslation`

<!-- source: interface-notionrichtext.md -->

# NotionRichText

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/md-to-notion-blocks.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `type` | `'text'` |
| `text` | `{ content: string; link: { url: string } | null }` |
| `annotations` | `{ bold?: boolean; italic?: boolean; code?: boolean }` |

<!-- source: interface-parseresult-3.md -->

# ParseResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/parse-result.interface.ts` (line 208)

Result of parsing a single file

## Properties

| Property | Type |
|---|---|
| `parserName` | `string` |
| `filePath` | `string` |
| `timestamp` | `Date` |
| `status` | `ParseStatus` |
| `entities` | `Entity[]` |
| `relationships` | `Relationship[]` |
| `errors` | `ParseError[]` |
| `warnings` | `ParseWarning[]` |
| `metadata` | `ParseMetadata` |

<!-- source: interface-preflightconfig.md -->

# PreflightConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/test-watcher.ts` (line 295)

## Properties

| Property | Type |
|---|---|
| `cwd` | `string` |
| `testCommand` | `string` |
| `customChecks` | `PreflightCheck[]` |

<!-- source: component-providerselector.md -->

# ProviderSelector

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/AIAssistant.tsx` (line 265)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `providers` | `Array` | ✓ | - |
| `selectedProvider` | `string` | ✓ | - |
| `onSelect` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ProviderSelector_76e8d801["ProviderSelector"]
    class component_ProviderSelector_76e8d801 rootComponent
```

## Relationships

- RENDERS → `ChevronDown`
- USES_HOOK → `useState`

## Referenced By

- `AIAssistant` (RENDERS)

<!-- source: class-syncrelationshipsresponsedto.md -->

# SyncRelationshipsResponseDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/graph/dto/sync-relationships.dto.ts` (line 58)

Response for bulk relationship sync

## Properties

| Property | Type |
|---|---|
| `success` | `number` |
| `failed` | `number` |
| `updated` | `number` |
| `created` | `number` |
| `errors` | `Array<{ relationshipId: string; error: string }>` |

<!-- source: service-technicaldocsgenerationservice.md -->

# TechnicalDocsGenerationService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-generation.service.ts` (line 36)

The technical-docs generation UNIT OF WORK (clone → parse → snapshot → materialize).

Extracted from the controller so it runs OFF the API request path: a queue worker (its own
deployment, sized for parsing) calls process(), not the api pod. This is what keeps a large-
repo parse — which can consume several GB — from OOM-ing the pod that serves users. The method
is self-contained and records progress/outcome on the DocumentationJob so it never throws into
the worker; the worker just needs to run it.

`TechnicalDocsGenerationService` executes the technical documentation generation unit of work: clone a repository, parse its source, create a snapshot, and materialize generated documentation. It is invoked by a dedicated queue worker rather than the API request path, isolating memory-intensive repository parsing from user-serving API pods. The service records progress and final outcomes on the associated `DocumentationJob` and handles failures internally so they do not escape to the worker.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `process` | `process(jobId: string | null, options: TechnicalDocsJobPayload)` | `Promise<boolean>` |

## Diagram

```mermaid
sequenceDiagram
    participant Worker as Queue Worker
    participant Service as TechnicalDocsGenerationService
    participant Job as DocumentationJob
    participant Git as Git Repository
    participant Parser as Source Parser
    participant Storage as Docs/Snapshot Storage

    Worker->>Service: process(jobId)
    Service->>Job: Mark running / update progress
    Service->>Git: Clone repository
    Git-->>Service: Local repository checkout
    Service->>Parser: Parse source code
    Parser-->>Service: Parsed entities and relationships
    Service->>Storage: Create snapshot
    Storage-->>Service: Snapshot reference
    Service->>Storage: Materialize generated docs
    Service->>Job: Mark completed / save result
    Service-->>Worker: Resolve without throwing

    Note over Service,Job: On failure, record failed status and error details
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { TechnicalDocsGenerationService } from './technical-docs-generation.service';

@Injectable()
export class TechnicalDocsWorker {
  constructor(
    private readonly technicalDocsGenerationService: TechnicalDocsGenerationService,
  ) {}

  async handleGenerationJob(documentationJobId: string): Promise<void> {
    // The service owns progress updates and failure handling.
    // Do not run this work in an API controller request handler.
    await this.technicalDocsGenerationService.process(documentationJobId);
  }
}
```

## AI Coding Instructions

- Keep `process()` self-contained: update `DocumentationJob` status and progress throughout every major generation phase.
- Do not let clone, parse, snapshot, or materialization errors escape the service; persist failure details on the job instead.
- Invoke this service only from the dedicated queue worker deployment, never directly from an API request handler.
- Treat repository parsing as memory-intensive work; avoid adding API-pod dependencies or request-scoped behavior.
- Preserve the generation order: clone repository → parse source → create snapshot → materialize documentation.

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `technicaldocsparserservice`
- DEPENDS_ON → `technicaldocsmaterializerservice`
- DEPENDS_ON → `technicaldocsservice`
- DEPENDS_ON → `opsalertservice`
- DEPENDS_ON → `aiusageservice`
- DEPENDS_ON → `notificationservice`
- DEPENDS_ON → `emailservice`

<!-- source: function-useaudiences.md -->

# useAudiences

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useAudiences.ts` (line 68)

useAudiences - Hook for managing audience data

Provides a list of audiences with CRUD operations.

## Signature

```ts
function useAudiences(options: UseAudiencesOptions): UseAudiencesReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseAudiencesOptions` |

**Returns:** `UseAudiencesReturn`

<!-- source: function-useprojectpublish.md -->

# useProjectPublish

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useProjectPublish.ts` (line 68)

useProjectPublish - Hook for publishing and unpublishing projects

Provides a simple interface for changing project publication state.
Requires MAINTAINER or ADMIN role.

## Signature

```ts
function useProjectPublish(): UseProjectPublishReturn
```

**Returns:** `UseProjectPublishReturn`

<!-- source: interface-createsuggestiondto.md -->

# CreateSuggestionDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/suggestion.dto.ts` (line 15)

Create suggestion DTO

## Properties

| Property | Type |
|---|---|
| `originalText` | `string` |
| `suggestedText` | `string` |
| `positionStart` | `number` |
| `positionEnd` | `number` |

<!-- source: api-endpoint-generateoutline.md -->

# generateOutline

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/ai/ai.controller.ts` (line 101)

## Endpoint

`POST /ai/outline`

## Referenced By

- `AIController` (MODULE_DECLARES)

<!-- source: constant-hasfrontmatter.md -->

# hasFrontmatter$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/frontmatter/index.ts` (line 77)

Whether the markdown document has a frontmatter node.

<!-- source: component-howitworkstimeline-2.md -->

# HowItWorksTimeline

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/how-it-works/how-it-works-timeline.tsx` (line 59)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `steps` | `Step[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_HowItWorksTimeline_41381868["HowItWorksTimeline"]
    class component_HowItWorksTimeline_41381868 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `StepCircle`
- RENDERS → `StepCard`
- USES_HOOK → `useTranslation`

<!-- source: function-impactedentities.md -->

# impactedEntities

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/staleness.ts` (line 82)

Given the files that changed in a push, return the set of entity ids that must be
regenerated: the entities DEFINED in those files, expanded to their dependents (things that
reference them) up to `hops` levels via the relationship graph. This is the SCIP-style
incremental fan-out — regenerate the transitive closure, not the whole repo.

## Signature

```ts
function impactedEntities(changedFiles: string[], entities: Entity[], relationships: Relationship[], opts: { hops?: number }): Set<string>
```

## Parameters

| Name | Type |
|---|---|
| `changedFiles` | `string[]` |
| `entities` | `Entity[]` |
| `relationships` | `Relationship[]` |
| `opts` | `{ hops?: number }` |

**Returns:** `Set<string>`

<!-- source: interface-openorupdateprinput.md -->

# OpenOrUpdatePrInput

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-pr/git-write/git-write.adapter.ts` (line 8)

## Properties

| Property | Type |
|---|---|
| `repoUrl` | `string` |
| `baseBranch` | `string` |
| `branchName` | `string` |
| `files` | `DocFileChange[]` |
| `title` | `string` |
| `body` | `string` |
| `token` | `string` |

<!-- source: interface-parseresult-4.md -->

# ParseResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/storybook/types.ts` (line 166)

Parse result

## Properties

| Property | Type |
|---|---|
| `files` | `StoryFile[]` |
| `config` | `ConfigInfo` |
| `totalStories` | `number` |
| `errors` | `ParseError[]` |

<!-- source: interface-preflightresult.md -->

# PreflightResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/test-watcher.ts` (line 289)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `passed` | `boolean` |
| `message` | `string` |

<!-- source: component-publicprojectlayoutinner.md -->

# PublicProjectLayoutInner

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/PublicLayoutShell.tsx` (line 19)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PublicProjectLayoutInner_16664031["PublicProjectLayoutInner"]
    class component_PublicProjectLayoutInner_16664031 rootComponent
```

## Relationships

- RENDERS → `HeaderByStyle`
- RENDERS → `ChevronLeft`
- RENDERS → `ChevronRight`
- RENDERS → `VersionSeoHead`
- RENDERS → `VersionBanners`
- RENDERS → `SupportChatWidget`
- USES_HOOK → `usePublicProjectContext`
- USES_HOOK → `usePathname`
- USES_HOOK → `useVersionContext`
- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

## Referenced By

- `PublicLayoutShell` (RENDERS)

<!-- source: class-syncresultdto.md -->

# SyncResultDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/sync.dto.ts` (line 131)

Single sync result

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `slug` | `string` |
| `status` | `'created' | 'updated' | 'skipped' | 'failed'` |
| `error` | `string` |
| `version` | `number` |

<!-- source: service-technicaldocsmaterializerservice.md -->

# TechnicalDocsMaterializerService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-materializer.service.ts` (line 460)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `materialize` | `materialize(projectId: string, organizationId: string, createdById: string)` | `Promise<MaterializeResult>` |
| `materializeDelta` | `materializeDelta(projectId: string, organizationId: string, createdById: string)` | `Promise<(MaterializeResult & { mode: 'delta'; changed: number; added: number; removed: number }) | null>` |
| `buildRagCorpus` | `buildRagCorpus(projectId: string)` | `Promise<{
    projectName: string;
    organizationId: string;
    pages: Array<LlmsPage & { docType: 'technical' | 'user_manual' | 'external'; entityId?: string | null }>;
  } | null>` |
| `getStaticSearchIndex` | `getStaticSearchIndex(projectId: string, slugWithId: string)` | `Promise<StaticSearchIndex | null>` |
| `buildMcpCorpus` | `buildMcpCorpus(projectId: string)` | `Promise<DocsCorpus | null>` |
| `getLlmsTxt` | `getLlmsTxt(projectId: string)` | `Promise<string | null>` |
| `getLlmsFullTxt` | `getLlmsFullTxt(projectId: string)` | `Promise<string | null>` |
| `getPublicLlmsTxt` | `getPublicLlmsTxt(projectId: string)` | `Promise<string | null>` |
| `getPublicLlmsFullTxt` | `getPublicLlmsFullTxt(projectId: string)` | `Promise<string | null>` |
| `buildPublicMcpCorpus` | `buildPublicMcpCorpus(projectId: string)` | `Promise<DocsCorpus | null>` |
| `getPublicPageMarkdown` | `getPublicPageMarkdown(projectId: string, slug: string)` | `Promise<string | null>` |
| `getPageMarkdown` | `getPageMarkdown(projectId: string, slug: string)` | `Promise<string | null>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `docversionservice`

<!-- source: function-useauth-3.md -->

# useAuth

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useAuth.ts` (line 39)

useAuth - Hook for authentication

Provides user state and authentication methods.
All business logic is handled by the backend.

## Signature

```ts
function useAuth(): UseAuthReturn
```

**Returns:** `UseAuthReturn`

<!-- source: function-usepublicprojectcontext.md -->

# usePublicProjectContext

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/project-context.tsx` (line 253)

<!-- source: interface-createthemedto.md -->

# CreateThemeDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/theme.dto.ts` (line 6)

DTO for creating a new theme

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `organizationId` | `string` |
| `projectId` | `string` |
| `colors` | `ThemeColors` |
| `typography` | `ThemeTypography` |
| `layout` | `ThemeLayout` |
| `customCss` | `string` |
| `darkModeEnabled` | `boolean` |
| `darkModeDefault` | `string` |
| `darkModeColors` | `ThemeColors` |
| `whiteLabelEnabled` | `boolean` |
| `hidePoweredBy` | `boolean` |
| `customDomain` | `string` |
| `customFooter` | `string` |
| `audienceThemes` | `AudienceThemes` |

<!-- source: api-endpoint-generateuserdocumentation.md -->

# generateUserDocumentation

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/documentation.controller.ts` (line 21)

## Endpoint

`POST /documentation/generate-user-docs`

## Referenced By

- `DocumentationController` (MODULE_DECLARES)

<!-- source: constant-headingsplugin.md -->

# headingsPlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/headings/index.ts` (line 75)

A plugin that adds support for markdown headings.

<!-- source: component-htag.md -->

# HTag

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/html.tsx` (line 32)

## Diagram

```mermaid
graph TD
    component_HTag_2263c682["HTag"]
    class component_HTag_2263c682 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: function-isangularfile.md -->

# isAngularFile

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/framework-detect.ts` (line 48)

True for a file that imports from any '@angular/…' package.

## Signature

```ts
function isAngularFile(filePath: string, content: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string` |
| `content` | `string` |

**Returns:** `boolean`

<!-- source: interface-openorupdateprresult.md -->

# OpenOrUpdatePrResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-pr/git-write/git-write.adapter.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `prNumber` | `number` |
| `prUrl` | `string` |
| `headSha` | `string` |
| `created` | `boolean` |

<!-- source: interface-parsermetadata-2.md -->

# ParserMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/parser.interface.ts` (line 104)

Parser metadata for registration

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `version` | `string` |
| `supportedPatterns` | `string[]` |
| `description` | `string` |
| `category` | `ParserCategory` |
| `languages` | `string[]` |
| `author` | `string` |

<!-- source: interface-promptsection.md -->

# PromptSection

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/prompt-sections.ts` (line 28)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `condition` | `(ctx: SectionContext) => boolean` |
| `content` | `string` |
| `priority` | `number` |

<!-- source: component-quickactionbutton.md -->

# QuickActionButton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/PromptInput.tsx` (line 157)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `icon` | `unknown` | ✓ | - |
| `label` | `string` | ✓ | - |
| `onClick` | `Function` | - | - |
| `disabled` | `boolean` | - | - |

## Diagram

```mermaid
graph TD
    component_QuickActionButton_74cffc6c["QuickActionButton"]
    class component_QuickActionButton_74cffc6c rootComponent
```

## Referenced By

- `PromptInput` (RENDERS)

<!-- source: service-technicaldocsparserservice.md -->

# TechnicalDocsParserService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-parser.service.ts` (line 57)

Parses a git repository and builds a TechnicalSnapshot:
- entity graph (Entity[] + Relationship[])
- navMap (3-level: apps/libs → type → entities)
- OpenAPI spec (from API_ENDPOINT entities)

Also imports standalone repo MD files as Documents linked via kgEntityId,
and indexes all entities into Azure AI Search as technical_ref.

`TechnicalDocsParserService` scans a git repository to produce a `TechnicalSnapshot` used by the platform’s technical documentation and knowledge graph features. It builds the entity graph (entities + relationships), a 3-level navigation map (apps/libs → type → entities), and derives an OpenAPI spec from `API_ENDPOINT` entities. It also ingests standalone Markdown files as `Document` nodes linked via `kgEntityId`, and indexes all parsed entities into Azure AI Search under the `technical_ref` index.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `run` | `run(options: TechnicalDocsJobOptions)` | `Promise<TechnicalDocsJobResult>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant Caller
  participant Parser as TechnicalDocsParserService
  participant Repo as Git Repo (apps/libs)
  participant MD as Standalone MD Files
  participant KG as TechnicalSnapshot (graph+navMap+openapi)
  participant Search as Azure AI Search (technical_ref)

  Caller->>Parser: parseRepository(repoPath | gitRef)
  Parser->>Repo: traverse source tree
  Repo-->>Parser: code entities (apps/libs/types)
  Parser->>Parser: build Entity[] + Relationship[]
  Parser->>Parser: build navMap (apps/libs → type → entities)
  Parser->>Parser: derive OpenAPI spec from API_ENDPOINT entities

  Parser->>MD: scan/import *.md
  MD-->>Parser: Documents (linked via kgEntityId)

  Parser-->>KG: TechnicalSnapshot
  Parser->>Search: index entities as technical_ref
  Search-->>Parser: indexing result
  Parser-->>Caller: return TechnicalSnapshot
```

## Usage

```ts
// Example in a NestJS context (e.g., inside a controller or another service)
import { Injectable } from '@nestjs/common';
import { TechnicalDocsParserService } from './technical-docs-parser.service';

@Injectable()
export class TechnicalDocsJob {
  constructor(private readonly parser: TechnicalDocsParserService) {}

  async run() {
    // Adjust inputs to match your app’s configuration (repo path, git ref, tenant/project id, etc.)
    const snapshot = await this.parser.parseRepository({
      repoPath: '/var/repos/atloria-monorepo',
      // gitRef: 'main',
      // includeDocs: true,
      // indexToSearch: true,
    });

    // Use snapshot outputs downstream
    console.log('Entities:', snapshot.entities.length);
    console.log('Relationships:', snapshot.relationships.length);
    console.log('NavMap keys:', Object.keys(snapshot.navMap));
    console.log('OpenAPI paths:', Object.keys(snapshot.openApi?.paths ?? {}));
  }
}
```

## AI Coding Instructions

- Keep parsing deterministic: stable entity IDs, consistent relationship directions, and sorted outputs to avoid noisy diffs and re-index churn.
- Treat `API_ENDPOINT` entities as the single source of truth for OpenAPI generation; validate required fields early to prevent producing partial specs.
- When importing standalone Markdown, always link to the KG via `kgEntityId` and avoid creating duplicate `Document` nodes for the same target.
- Azure AI Search integration should be idempotent and resilient: batch indexing, handle retries, and ensure the `technical_ref` schema stays compatible with entity shape changes.
- Maintain the 3-level `navMap` contract (apps/libs → type → entities); changing its shape will break consumers in docs UI and graph explorers.

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `gitcloneservice`
- DEPENDS_ON → `technicaldocsservice`
- DEPENDS_ON → `documentindexingservice`
- DEPENDS_ON → `technicaldocsenrichmentservice`

<!-- source: class-templatefiltersdto.md -->

# TemplateFiltersDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/template/dto/template-filters.dto.ts` (line 10)

DTO for filtering templates in list queries.
Supports filtering by category and organization.

## Properties

| Property | Type |
|---|---|
| `category` | `TemplateCategory` |
| `organizationId` | `string` |
| `search` | `string` |

<!-- source: function-usecodeblockeditorcontext.md -->

# useCodeBlockEditorContext

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/CodeBlockNode.tsx` (line 228)

Use this hook in your custom code block editors to modify the underlying node code, language, and meta.

<!-- source: function-usepublish.md -->

# usePublish

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/usePublish.ts` (line 53)

usePublish - Hook for publishing and unpublishing documents

Provides a simple interface for changing document publication state.
Requires MAINTAINER or ADMIN role.

## Signature

```ts
function usePublish(): UsePublishReturn
```

**Returns:** `UsePublishReturn`

<!-- source: interface-createuserdto.md -->

# CreateUserDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/user.dto.ts` (line 6)

DTO for creating a new user

## Properties

| Property | Type |
|---|---|
| `email` | `string` |
| `name` | `string` |
| `passwordHash` | `string` |
| `role` | `UserRole` |
| `organizationId` | `string` |

<!-- source: api-endpoint-generatewebhooksecret.md -->

# generateWebhookSecret

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 314)

## Endpoint

`POST /doc-automation/config/:projectId/webhook-secret`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: constant-historystate.md -->

# historyState$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 779)

<!-- source: component-html.md -->

# Html

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/jsx.tsx` (line 125)

## Diagram

```mermaid
graph TD
    component_Html_5759f2f5["Html"]
    class component_Html_5759f2f5 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: function-isjunkentity.md -->

# isJunkEntity

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/significance.ts` (line 47)

True when an entity should never get a reference page / nav entry / search doc.

## Signature

```ts
function isJunkEntity(entity: SignificanceCheckable): boolean
```

## Parameters

| Name | Type |
|---|---|
| `entity` | `SignificanceCheckable` |

**Returns:** `boolean`

<!-- source: interface-outboxauthor.md -->

# OutboxAuthor

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/outbox.service.ts` (line 9)

Who caused the content mutation an outbox event records. Travels INSIDE the event payload
(payload.author) — record()'s signature is unchanged — so the committer can credit a human
save as the git AUTHOR on the coalesced reconcile commit (S2.0 attribution).

## Properties

| Property | Type |
|---|---|
| `userId` | `string` |
| `type` | `'human' | 'generator' | 'agent'` |

<!-- source: interface-parseroptions.md -->

# ParserOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/storybook/types.ts` (line 148)

Parser options

## Properties

| Property | Type |
|---|---|
| `projectRoot` | `string` |
| `enableCSF2` | `boolean` |
| `enableCSF3` | `boolean` |
| `autoDetectConfig` | `boolean` |
| `stories` | `string[]` |
| `exclude` | `string[]` |

<!-- source: interface-qualitygate.md -->

# QualityGate

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/autonomous-loop.ts` (line 41)

A quality gate is a concrete, measurable condition the agent must meet
before it can consider the task done.

Domain layers define these; the autonomous loop checks and injects them.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `description` | `string` |
| `passed` | `boolean` |

<!-- source: component-recenttickets.md -->

# RecentTickets

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/page.tsx` (line 488)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `items` | `any[]` | ✓ | - |
| `onOpen` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_RecentTickets_5067c2eb["RecentTickets"]
    class component_RecentTickets_5067c2eb rootComponent
```

## Relationships

- RENDERS → `Badge`
- RENDERS → `ArrowTopRightOnSquareIcon`

## Referenced By

- `IssuesListPage` (RENDERS)

<!-- source: service-technicaldocsqueue.md -->

# TechnicalDocsQueue

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-queue.service.ts` (line 32)

Queues technical-docs generation OFF the api request path (BullMQ, like the parsing queue).

The api pods only ENQUEUE. The heavy clone+parse (several GB for a big repo) runs in the WORKER,
which is gated by TECHNICAL_DOCS_WORKER=true — so it only spins up in a dedicated worker
deployment (sized for parsing, like atlorix-runner), never in the request-serving pods. If a
parse OOMs, only that job fails/retries; the api keeps serving. Concurrency is bounded so a
couple of large parses can't pile up.

`TechnicalDocsQueue` moves technical-documentation generation off the API request path by enqueueing BullMQ jobs rather than cloning and parsing repositories synchronously. API pods only submit work; a dedicated worker deployment, enabled with `TECHNICAL_DOCS_WORKER=true`, performs the memory-intensive clone and parse operation with bounded concurrency and isolated retry failures.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `onModuleInit` | `onModuleInit()` | `unknown` |
| `enqueue` | `enqueue(data: TechnicalDocsQueueJob)` | `Promise<string | undefined>` |
| `onModuleDestroy` | `onModuleDestroy()` | `unknown` |

## Diagram

```mermaid
sequenceDiagram
    participant Client
    participant API as API Pod
    participant Queue as BullMQ Queue
    participant Worker as Technical Docs Worker
    participant Repo as Git Repository
    participant Docs as Generated Docs Storage

    Client->>API: Request technical docs generation
    API->>Queue: Enqueue generation job
    API-->>Client: Return accepted response

    Note over Worker: Runs only when<br/>TECHNICAL_DOCS_WORKER=true
    Worker->>Queue: Claim job (bounded concurrency)
    Worker->>Repo: Clone repository
    Worker->>Worker: Parse source and generate docs
    Worker->>Docs: Persist generated documentation
    Worker->>Queue: Mark job complete

    Note over Queue,Worker: Failed/OOM jobs are retried<br/>without affecting API availability
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { TechnicalDocsQueue } from './technical-docs-queue.service';

@Injectable()
export class RepositoryService {
  constructor(
    private readonly technicalDocsQueue: TechnicalDocsQueue,
  ) {}

  async requestTechnicalDocs(repositoryId: string, branch = 'main') {
    const job = await this.technicalDocsQueue.enqueue({
      repositoryId,
      branch,
    });

    return {
      jobId: job.id,
      status: 'queued',
    };
  }
}
```

## AI Coding Instructions

- Enqueue technical-docs work from request-facing services; do not clone, parse, or generate documentation directly in API handlers.
- Keep worker processing gated behind `TECHNICAL_DOCS_WORKER=true` so heavy repository operations run only in the dedicated worker deployment.
- Configure bounded BullMQ concurrency and retries carefully; large repositories can consume several GB of memory.
- Ensure queued job payloads contain stable identifiers and minimal metadata needed for the worker to reload repository state.
- Treat job failures as asynchronous outcomes: surface job status/errors through persisted state or queue inspection rather than failing the original API request.

## Relationships

- DEPENDS_ON → `configservice`
- DEPENDS_ON → `technicaldocsgenerationservice`
- DEPENDS_ON → `techdocsragservice`
- DEPENDS_ON → `technicaldocsenrichmentservice`
- DEPENDS_ON → `technicaldocsmaterializerservice`
- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `opsalertservice`
- DEPENDS_ON → `aiusageservice`

<!-- source: class-ticketcsatdto.md -->

# TicketCsatDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/issues/dto/public-ticket.dto.ts` (line 16)

Ticket-level CSAT from the public tracking page

## Properties

| Property | Type |
|---|---|
| `score` | `number` |

<!-- source: function-usecodemirrorref.md -->

# useCodeMirrorRef

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/sandpack/useCodeMirrorRef.ts` (line 9)

## Signature

```ts
function useCodeMirrorRef(nodeKey: string, editorType: 'codeblock' | 'sandpack', language: string, focusEmitter: VoidEmitter)
```

## Parameters

| Name | Type |
|---|---|
| `nodeKey` | `string` |
| `editorType` | `'codeblock' | 'sandpack'` |
| `language` | `string` |
| `focusEmitter` | `VoidEmitter` |

<!-- source: function-useresizable.md -->

# useResizable

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/doc/[...segments]/useResizable.ts` (line 28)

Hook for creating resizable panels with drag functionality

## Signature

```ts
function useResizable({
  initialWidth,
  minWidth,
  maxWidth,
  storageKey,
  direction,
}: UseResizableOptions): UseResizableReturn
```

## Parameters

| Name | Type |
|---|---|
| `{
  initialWidth,
  minWidth,
  maxWidth,
  storageKey,
  direction,
}` | `UseResizableOptions` |

**Returns:** `UseResizableReturn`

<!-- source: interface-crosslanguagemapping.md -->

# CrossLanguageMapping

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/cross-language.types.ts` (line 23)

CrossLanguageMapping - Links frontend to backend for user journey docs

Example: When user clicks "Submit Order":
- React: OrderForm.tsx -> POST /api/orders -> Express/NestJS route
- Angular: OrderFormComponent.ts -> POST /api/orders -> .NET Controller
- Vue: OrderForm.vue -> POST /api/orders -> FastAPI endpoint

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `frontendStack` | `FrontendFramework` |
| `backendStack` | `BackendFramework` |
| `screenMappings` | `ScreenToApiMapping[]` |
| `apiCallPatterns` | `ApiCallPattern[]` |

<!-- source: api-endpoint-get.md -->

# get

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/audience/audience.controller.ts` (line 39)

## Endpoint

`GET /audiences/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `AudienceController` (MODULE_DECLARES)

<!-- source: component-htmlimage.md -->

# HtmlImage

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/images.tsx` (line 161)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `readOnly` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_HtmlImage_71a0dd2d["HtmlImage"]
    class component_HtmlImage_71a0dd2d rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`

<!-- source: constant-htmltags.md -->

# htmlTags

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/MdastHTMLNode.ts` (line 55)

All the HTML tags supported by the generic html node.

## Definition

```ts
string[]
```

<!-- source: function-isjunkpath.md -->

# isJunkPath

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/significance.ts` (line 31)

Source path that can never yield hand-written API surface (generated/build/vendor/test).

## Signature

```ts
function isJunkPath(filePath: string | undefined): boolean
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string | undefined` |

**Returns:** `boolean`

<!-- source: interface-outboxbatch.md -->

# OutboxBatch

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/outbox.service.ts` (line 26)

Pending events for one project, oldest first.

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `events` | `OutboxEvent[]` |

<!-- source: interface-parserstats-2.md -->

# ParserStats

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/parse-result.interface.ts` (line 388)

Statistics for a single parser

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `filesProcessed` | `number` |
| `entitiesFound` | `number` |
| `relationshipsFound` | `number` |
| `duration` | `number` |
| `errors` | `number` |
| `warnings` | `number` |

<!-- source: interface-rankeditem.md -->

# RankedItem

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/hybrid-search.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `chunk` | `CodeChunk` |
| `score` | `number` |

<!-- source: component-redactioncanvas.md -->

# RedactionCanvas

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/StepEditor.tsx` (line 386)

Draw/clear rectangular redaction regions on a step's screenshot. Coordinates are stored as PERCENT (0-100) of the natural image so they survive re-shoots at any viewport. Drag to add a box; click an existing box to remove it.

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `src` | `string` | - | - |
| `boxes` | `RedactBox[]` | ✓ | - |
| `onChange` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_RedactionCanvas_2030974d["RedactionCanvas"]
    class component_RedactionCanvas_2030974d rootComponent
```

## Relationships

- USES_HOOK → `useRef`
- USES_HOOK → `useState`

## Referenced By

- `StepEditor` (RENDERS)

<!-- source: service-technicaldocsservice.md -->

# TechnicalDocsService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.service.ts` (line 31)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `resolveProjectForJob` | `resolveProjectForJob(projectId: string, user: JwtPayload, opts: { requireRepo?: boolean })` | `unknown` |
| `getSnapshot` | `getSnapshot(projectId: string)` | `unknown` |
| `getApiDocSet` | `getApiDocSet(projectId: string, userId: string)` | `unknown` |
| `setCuration` | `setCuration(projectId: string, userId: string, dto: { pinned?: unknown; hidden?: unknown })` | `Promise<TechdocsCuration>` |
| `setPlaygroundTestToken` | `setPlaygroundTestToken(projectId: string, userId: string, token: unknown)` | `Promise<{ hasTestToken: boolean }>` |
| `setEscalationConfig` | `setEscalationConfig(projectId: string, userId: string, dto: { webhookUrl?: string })` | `unknown` |
| `getEscalationConfig` | `getEscalationConfig(projectId: string, userId: string)` | `unknown` |
| `getApiTargetConfig` | `getApiTargetConfig(projectId: string, userId: string)` | `Promise<ApiTargetPublicConfig>` |
| `setApiTargetConfig` | `setApiTargetConfig(projectId: string, userId: string, dto: { baseUrl?: string; authHeaderName?: string; authHeaderValue?: string; allowWrites?: boolean; enabled?: boolean })` | `Promise<ApiTargetPublicConfig>` |
| `getApiExecRuntimeConfig` | `getApiExecRuntimeConfig(projectId: string)` | `Promise<ApiExecRuntimeConfig | null>` |
| `getEntity` | `getEntity(projectId: string, entityId: string)` | `unknown` |
| `getApiSpec` | `getApiSpec(projectId: string)` | `unknown` |
| `getJobStatus` | `getJobStatus(projectId: string)` | `unknown` |
| `upsertSnapshot` | `upsertSnapshot(projectId: string, data: {
      entitiesJson: any[];
      relationshipsJson: any[];
      apiSpecJson?: any;
      navMapJson: any;
      // Baseline for incremental staleness: the commit/branch these docs were generated from.
      generatedFromCommit?: string | null;
      generatedFromBranch?: string | null;
    })` | `unknown` |
| `checkStaleness` | `checkStaleness(projectId: string, changedFiles: string[], commit: string, branch: string)` | `Promise<{ staleCount: number } | null>` |
| `getStaleEntityIds` | `getStaleEntityIds(projectId: string)` | `Promise<string[]>` |
| `clearStaleness` | `clearStaleness(projectId: string)` | `Promise<void>` |
| `createTrackedJob` | `createTrackedJob(projectId: string, organizationId: string, userId: string, stage: string, branch: string | null)` | `Promise<string | null>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `documentindexingservice`
- DEPENDS_ON → `stalealertservice`

<!-- source: class-typescriptparser.md -->

# TypeScriptParser

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/parser/parsers/typescript.parser.ts` (line 16)

**Implements:** `CodeParser`

## Methods

| Method | Signature | Returns |
|---|---|---|
| `parse` | `parse(code: string, filename: undefined)` | `Promise<ParseResult>` |
| `extractSymbols` | `extractSymbols(code: string)` | `Promise<ParserSymbol[]>` |
| `extractDependencies` | `extractDependencies(code: string)` | `Promise<Dependency[]>` |

## Properties

| Property | Type |
|---|---|
| `language` | `any` |
| `supportedExtensions` | `any` |

<!-- source: function-usecomments.md -->

# useComments

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useComments.ts` (line 61)

useComments - Hook for comment management with real-time updates

Provides comment state and operations with WebSocket support.

## Signature

```ts
function useComments(options: UseCommentsOptions): UseCommentsReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseCommentsOptions` |

**Returns:** `UseCommentsReturn`

<!-- source: function-usetemplates.md -->

# useTemplates

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/hooks/useTemplates.ts` (line 65)

useTemplates - Hook for fetching and managing document templates

Provides a list of templates with optional filtering by category.
Also provides actions for using templates and saving documents as templates.

## Signature

```ts
function useTemplates(options: UseTemplatesOptions): UseTemplatesReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseTemplatesOptions` |

**Returns:** `UseTemplatesReturn`

<!-- source: interface-crossmodulerelationship.md -->

# CrossModuleRelationship

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-05.types.ts` (line 23)

## Properties

| Property | Type |
|---|---|
| `sourceArea` | `string` |
| `targetArea` | `string` |
| `sharedEntities` | `string[]` |
| `strength` | `number` |

<!-- source: api-endpoint-get-2.md -->

# get

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/capture/capture.controller.ts` (line 55)

## Endpoint

`GET /capture/:projectId/flows/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `CaptureController` (MODULE_DECLARES)

<!-- source: component-i18nprovider.md -->

# I18nProvider

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/i18n.tsx` (line 74)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `defaultLocale` | `string` | - | "en" |
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_I18nProvider_2ae60c3d["I18nProvider"]
    class component_I18nProvider_2ae60c3d rootComponent
```

## Relationships

- RENDERS → `I18nContext-Provider`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: constant-iconcomponentfor.md -->

# iconComponentFor$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 491)

A callback that returns the icon component for the given name.

<!-- source: function-islifecyclemethod-2.md -->

# isLifecycleMethod

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 706)

Check if a method name is a React lifecycle method

## Signature

```ts
function isLifecycleMethod(methodName: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `methodName` | `string` |

**Returns:** `boolean`

<!-- source: interface-outboxevent.md -->

# OutboxEvent

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/outbox.service.ts` (line 16)

One pending DocsOutbox row (the fields the poller/committer needs).

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `projectId` | `string` |
| `eventType` | `string` |
| `payload` | `unknown` |
| `attempts` | `number` |
| `createdAt` | `Date` |

<!-- source: interface-parsesummary-2.md -->

# ParseSummary

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/parse-result.interface.ts` (line 333)

Summary statistics for a project parse

## Properties

| Property | Type |
|---|---|
| `totalFiles` | `number` |
| `successfulFiles` | `number` |
| `failedFiles` | `number` |
| `skippedFiles` | `number` |
| `totalEntities` | `number` |
| `totalRelationships` | `number` |
| `totalDuration` | `number` |
| `entitiesByType` | `Record<string, number>` |
| `relationshipsByType` | `Record<string, number>` |
| `parserStats` | `Record<string, ParserStats>` |

<!-- source: interface-readfileoptions.md -->

# ReadFileOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/read-file.tool.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `maxFileSize` | `number` |
| `maxLines` | `number` |
| `maxImageSize` | `number` |

<!-- source: component-relitem.md -->

# RelItem

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/RelationsPanel.tsx` (line 70)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `entityId` | `string` | ✓ | - |
| `relType` | `string` | ✓ | - |
| `entityMap` | `Record` | ✓ | - |
| `projectId` | `string` | ✓ | - |
| `entityHrefBase` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_RelItem_48d06e52["RelItem"]
    class component_RelItem_48d06e52 rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `TypeIcon`

## Referenced By

- `RelationsPanel` (RENDERS)

<!-- source: service-templateservice.md -->

# TemplateService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/template/template.service.ts` (line 18)

Service for managing document templates.
Provides CRUD operations and template usage tracking.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `list` | `list(filters: TemplateFiltersDto, user: JwtPayload)` | `Promise<DocumentTemplate[]>` |
| `getById` | `getById(id: string, user: JwtPayload)` | `Promise<DocumentTemplate>` |
| `create` | `create(dto: CreateTemplateDto, user: JwtPayload)` | `Promise<DocumentTemplate>` |
| `createDocumentFromTemplate` | `createDocumentFromTemplate(templateId: string, dto: CreateFromTemplateDto, user: JwtPayload)` | `Promise<Document>` |
| `saveAsTemplate` | `saveAsTemplate(documentId: string, dto: SaveAsTemplateDto, userId: string)` | `Promise<DocumentTemplate>` |
| `update` | `update(id: string, dto: Partial<CreateTemplateDto>, user: JwtPayload)` | `Promise<DocumentTemplate>` |
| `delete` | `delete(id: string, user: JwtPayload)` | `Promise<void>` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: class-unpublishdocumentdto.md -->

# UnpublishDocumentDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/publish-document.dto.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `reason` | `string` |

<!-- source: function-usedocument.md -->

# useDocument

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useDocument.ts` (line 65)

useDocument - Hook for document management

Provides document state and operations.
Business logic (validation, permissions) is delegated to DocumentManager from

## Signature

```ts
function useDocument(options: UseDocumentOptions): UseDocumentReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseDocumentOptions` |

**Returns:** `UseDocumentReturn`

<!-- source: function-useversioncontext.md -->

# useVersionContext

**Kind:** Function

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/VersionContext.tsx` (line 35)

<!-- source: interface-crossstackevidence.md -->

# CrossStackEvidence

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-03-features/cross-stack-mapper.ts` (line 29)

Evidence for a cross-stack mapping

## Properties

| Property | Type |
|---|---|
| `frontendSnippet` | `string` |
| `backendSnippet` | `string` |
| `matchedPath` | `string` |
| `matchedName` | `string` |

<!-- source: api-endpoint-get-3.md -->

# get

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.controller.ts` (line 57)

## Endpoint

`GET /projects/:projectId/change-requests/:crId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `crId` | query | `string` | ✓ |

## Referenced By

- `ChangeRequestController` (MODULE_DECLARES)

<!-- source: component-imageasdirective.md -->

# ImageAsDirective

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/directives.tsx` (line 305)

## Diagram

```mermaid
graph TD
    component_ImageAsDirective_17466cab["ImageAsDirective"]
    class component_ImageAsDirective_17466cab rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: constant-imageautocompletesuggestions.md -->

# imageAutocompleteSuggestions$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 155)

Holds the autocomplete suggestions for image sources.

<!-- source: function-isnestjsfile.md -->

# isNestJsFile

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/framework-detect.ts` (line 43)

True for a file that imports from any '@nestjs/…' package.

## Signature

```ts
function isNestJsFile(filePath: string, content: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string` |
| `content` | `string` |

**Returns:** `boolean`

<!-- source: interface-pageidentity.md -->

# PageIdentity

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/sidecar.ts` (line 29)

The `.atloria/` identity sidecar — the stable-identity layer that makes ACCUMULATION
(delta generation instead of full sweeps) possible in S3/S4.

Two files, both written OUTSIDE docs/ so ReconcilerService.driftCheck (which compares only
docs/) never sees them as drift:

  • `.atloria/pages.json`      — a per-page manifest: for every served page, its stable
                                 docUuid, natural key (kgEntityId/type), contentHash +
                                 generatorFingerprint (the split-oracle inputs), source
                                 screen provenance, and the section map (toc ids+levels).
                                 A PURE PROJECTION of the current DB set (rebuilt each time).

  • `.atloria/slug-registry.json` — the ACCUMULATING identity ledger keyed by docUuid:
                                 current slug + the history of previous slugs. This is the
                                 one file that carries history the DB does not retain, so a
                                 rename is followed (same docUuid) rather than seen as a
                                 delete+add. It is read-merged, never rebuilt from scratch.

HARD INVARIANT — DETERMINISM. Both serializers are byte-stable for the same logical input:
keys are sorted, there are NO wall-clock timestamps, and section order (reading order) is
preserved while set-like arrays (screen slugs) are sorted+deduped. This is load-bearing:
the committer only writes a commit when `git status` is dirty, so a non-deterministic sidecar
would fabricate a commit on every reconcile and destroy the idempotent-no-op guarantee the
substrate depends on. Every change here is covered by an idempotency property test.

## Properties

| Property | Type |
|---|---|
| `path` | `string` |
| `docUuid` | `string` |
| `scope` | `string` |
| `lang` | `string` |
| `slug` | `string` |
| `kgEntityId` | `string | null` |
| `kgEntityType` | `string | null` |
| `contentHash` | `string | null` |
| `generatorFingerprint` | `string | null` |
| `sourceScreenSlugs` | `string[]` |
| `sections` | `{ id: string; level: number }[]` |

<!-- source: interface-parsewarning-2.md -->

# ParseWarning

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/parse-result.interface.ts` (line 108)

Warning encountered during parsing (non-blocking)

## Properties

| Property | Type |
|---|---|
| `message` | `string` |
| `code` | `string` |
| `line` | `number` |
| `suggestion` | `string` |

<!-- source: interface-rehydrationconfig.md -->

# RehydrationConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/rehydration.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `maxCharsPerFile` | `number` |
| `maxTotalChars` | `number` |
| `maxFiles` | `number` |

<!-- source: component-replycomposer.md -->

# ReplyComposer

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/issues/[ticketNumber]/page.tsx` (line 993)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `slugId` | `string` | ✓ | - |
| `ticketNumber` | `number` | ✓ | - |
| `onPosted` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ReplyComposer_2610e661["ReplyComposer"]
    class component_ReplyComposer_2610e661 rootComponent
```

## Relationships

- USES_HOOK → `useState`

## Referenced By

- `PublicTicketPage` (RENDERS)

<!-- source: service-tenantcontextinterceptor.md -->

# TenantContextInterceptor

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/common/tenant-context.interceptor.ts` (line 22)

Binds the authenticated caller's organization into an AsyncLocalStorage context for the duration
of the request handler, so the PrismaService tenant backstop (defense-in-depth) can observe/scope
data-layer queries.

WHY an interceptor and not middleware: middleware runs BEFORE guards, so `req.user` isn't
populated yet. Interceptors run AFTER guards — the JWT is verified and `req.user` is set. We wrap
the handler's subscription inside `runWithTenantContext(...)` so the context stays active across
every awaited query the handler makes.

Requests with no authenticated user (public routes, webhooks) run with NO context — the backstop
treats that as system and does nothing, exactly like background work.

`TenantContextInterceptor` binds the authenticated caller’s organization ID into an `AsyncLocalStorage` tenant context for the lifetime of a NestJS request handler. It runs after authentication guards have populated `req.user`, allowing Prisma’s tenant backstop to scope tenant-aware queries across awaited calls; unauthenticated requests intentionally run without tenant context.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `intercept` | `intercept(context: ExecutionContext, next: CallHandler)` | `Observable<unknown>` |

## Diagram

```mermaid
sequenceDiagram
    participant Client
    participant Guard as JWT/Auth Guard
    participant Interceptor as TenantContextInterceptor
    participant Context as AsyncLocalStorage
    participant Handler as Controller Handler
    participant Prisma as PrismaService

    Client->>Guard: HTTP request with token
    Guard->>Guard: Verify token and set req.user
    Guard->>Interceptor: Continue request pipeline

    alt Authenticated request
        Interceptor->>Context: runWithTenantContext(organizationId)
        Context->>Handler: Execute handler subscription
        Handler->>Prisma: Execute query
        Prisma->>Context: Read active tenant context
        Prisma-->>Handler: Tenant-scoped result
    else Public route or webhook
        Interceptor->>Handler: Execute without tenant context
        Handler->>Prisma: Execute query
        Prisma->>Prisma: Treat as system/background work
    end

    Handler-->>Client: HTTP response
```

## Usage

```ts
import {
  CallHandler,
  ExecutionContext,
  Injectable,
  NestInterceptor,
} from '@nestjs/common';
import { Observable } from 'rxjs';
import { runWithTenantContext } from './tenant-context';

@Injectable()
export class TenantContextInterceptor implements NestInterceptor {
  intercept(context: ExecutionContext, next: CallHandler): Observable<unknown> {
    const request = context.switchToHttp().getRequest();
    const organizationId = request.user?.organizationId;

    // Public routes and webhooks intentionally have no tenant context.
    if (!organizationId) {
      return next.handle();
    }

    // The context remains available throughout awaited handler/service work.
    return runWithTenantContext(organizationId, () => next.handle());
  }
}

// Apply globally after authentication guards are configured.
app.useGlobalInterceptors(new TenantContextInterceptor());
```

## AI Coding Instructions

- Keep this logic in an interceptor, not middleware: middleware runs before guards and cannot reliably access `req.user`.
- Only create tenant context when an authenticated user provides a valid organization/tenant identifier; public and webhook requests must remain context-free.
- Wrap the handler execution with `runWithTenantContext(...)` so `AsyncLocalStorage` remains active through asynchronous service and Prisma calls.
- Do not rely on this interceptor as the sole authorization mechanism; route guards and service-level authorization remain responsible for access control.
- Ensure Prisma tenant-scoping code treats missing context as intentional system/background execution rather than as an error.

<!-- source: class-updateaudiencedto.md -->

# UpdateAudienceDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/audience/dto/update-audience.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `color` | `string` |
| `icon` | `string` |
| `description` | `string` |

<!-- source: function-usedocuments.md -->

# useDocuments

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useDocuments.ts` (line 54)

useDocuments - Hook for fetching lists of documents

Provides a list of documents with optional filtering, searching, and pagination.

## Signature

```ts
function useDocuments(options: UseDocumentsOptions): UseDocumentsReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseDocumentsOptions` |

**Returns:** `UseDocumentsReturn`

<!-- source: interface-crossstackfeature.md -->

# CrossStackFeature

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-03-features/cross-stack-mapper.ts` (line 39)

Cross-stack feature (full-stack feature)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `frontendComponents` | `string[]` |
| `backendEndpoints` | `string[]` |
| `dataFlow` | `DataFlowStep[]` |
| `actions` | `UserAction[]` |
| `confidence` | `number` |

<!-- source: api-endpoint-get-4.md -->

# get

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/change-request/docs-config.controller.ts` (line 25)

## Endpoint

`GET /projects/:projectId/docs-config`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocsConfigController` (MODULE_DECLARES)

<!-- source: component-imagedialog.md -->

# ImageDialog

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/ImageDialog.tsx` (line 27)

## Diagram

```mermaid
graph TD
    component_ImageDialog_13a9e0e4["ImageDialog"]
    class component_ImageDialog_13a9e0e4 rootComponent
```

## Relationships

- RENDERS → `Dialog-Root`
- RENDERS → `Dialog-Portal`
- RENDERS → `Dialog-Overlay`
- RENDERS → `Dialog-Content`
- RENDERS → `Dialog-Title`
- RENDERS → `DownshiftAutoComplete`
- RENDERS → `Dialog-Close`
- USES_HOOK → `useCellValues`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useTranslation`
- USES_HOOK → `useForm`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`

<!-- source: constant-imagedialogstate.md -->

# imageDialogState$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 185)

Holds the current state of the image dialog.

<!-- source: function-isreactclasscomponent-2.md -->

# isReactClassComponent

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 83)

Check if a class extends React.Component or React.PureComponent

## Signature

```ts
function isReactClassComponent(path: NodePath<t.ClassDeclaration>): boolean
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath<t.ClassDeclaration>` |

**Returns:** `boolean`

<!-- source: interface-pagesmanifest.md -->

# PagesManifest

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/sidecar.ts` (line 50)

## Properties

| Property | Type |
|---|---|
| `normalizerVersion` | `string` |
| `pages` | `Array<{
    path: string;
    docUuid: string;
    scope: string;
    lang: string;
    slug: string;
    kgEntityId: string | null;
    kgEntityType: string | null;
    contentHash: string | null;
    generatorFingerprint: string | null;
    sourceScreenSlugs: string[];
    sections: { id: string; level: number }[];
  }>` |

<!-- source: interface-permissioncheck.md -->

# PermissionCheck

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/permission-extractor.ts` (line 22)

A permission check found in source code

## Properties

| Property | Type |
|---|---|
| `permission` | `string` |
| `checkType` | `'route-guard' | 'template-conditional' | 'code-check' | 'decorator'` |
| `affectedElement` | `string` |
| `location` | `string` |
| `sourceFile` | `string` |
| `line` | `number` |

<!-- source: interface-rehydrationitem.md -->

# RehydrationItem

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/types.ts` (line 27)

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `content` | `string` |
| `success` | `boolean` |

<!-- source: component-resetpasswordform.md -->

# ResetPasswordForm

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(auth)/reset-password/page.tsx` (line 9)

## Diagram

```mermaid
graph TD
    component_ResetPasswordForm_429d4524["ResetPasswordForm"]
    class component_ResetPasswordForm_429d4524 rootComponent
```

## Relationships

- RENDERS → `Link`
- USES_HOOK → `useSearchParams`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`

## Referenced By

- `ResetPasswordPage` (RENDERS)

<!-- source: service-tocbuilderservice.md -->

# TocBuilderService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/document/services/toc-builder.service.ts` (line 10)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `extractToc` | `extractToc(content: string)` | `TocEntry[]` |

<!-- source: class-updateboarddto.md -->

# UpdateBoardDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/boards/dto/update-board.dto.ts` (line 3)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `color` | `string` |
| `isDefault` | `boolean` |
| `settings` | `Record<string, unknown>` |

<!-- source: function-uselexicalnoderemove.md -->

# useLexicalNodeRemove

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/NestedLexicalEditor.tsx` (line 129)

A hook that returns a function that removes the lexical node from the editor.

<!-- source: interface-crossstackmapping.md -->

# CrossStackMapping

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-03-features/cross-stack-mapper.ts` (line 17)

A cross-stack mapping between frontend and backend

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `frontendEntity` | `string` |
| `backendEntity` | `string` |
| `type` | `'api-call' | 'route-match' | 'name-correlation'` |
| `confidence` | `'high' | 'medium' | 'low'` |
| `evidence` | `CrossStackEvidence` |

<!-- source: api-endpoint-get-5.md -->

# get

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 134)

## Endpoint

`GET /doc-versions/:projectId/:versionId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-imagedialogbuttonexample.md -->

# ImageDialogButtonExample

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/images.tsx` (line 238)

## Diagram

```mermaid
graph TD
    component_ImageDialogButtonExample_732330ae["ImageDialogButtonExample"]
    class component_ImageDialogButtonExample_732330ae rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `InsertImage`

<!-- source: constant-imageplaceholder.md -->

# imagePlaceholder$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 179)

Holds the image placeholder.

<!-- source: function-isreactcomponent-2.md -->

# isReactComponent

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 72)

Check if a function component is a React component (returns JSX)

## Signature

```ts
function isReactComponent(path: NodePath<
    t.FunctionDeclaration | t.ArrowFunctionExpression | t.FunctionExpression
  >): boolean
```

## Parameters

| Name | Type |
|---|---|
| `path` | `NodePath<
    t.FunctionDeclaration | t.ArrowFunctionExpression | t.FunctionExpression
  >` |

**Returns:** `boolean`

<!-- source: interface-parameter.md -->

# Parameter

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/parser/interfaces/code-parser.interface.ts` (line 63)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `optional` | `boolean` |
| `defaultValue` | `string` |

<!-- source: interface-piniaactionpattern.md -->

# PiniaActionPattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/pinia-pattern-detector.ts` (line 59)

Pinia action pattern

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `storeName` | `string` |
| `line` | `number` |
| `isAsync` | `boolean` |
| `asyncGroup` | `{
    type: 'start' | 'success' | 'failure';
    baseName: string;
  }` |

<!-- source: interface-reliabilitycontext.md -->

# ReliabilityContext

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/reliability-config.ts` (line 58)

## Properties

| Property | Type |
|---|---|
| `testWatcher` | `TestWatcher | null` |
| `circleDetector` | `CircleDetector | null` |
| `preflightResults` | `PreflightResult[]` |
| `qualityGateProvider` | `QualityGateProvider | undefined` |
| `preflightSummary` | `string` |
| `dispose` | `() => void` |

<!-- source: component-resolutiontimechart.md -->

# ResolutionTimeChart

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/page.tsx` (line 388)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `buckets` | `ResolutionBucket[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ResolutionTimeChart_3705964["ResolutionTimeChart"]
    class component_ResolutionTimeChart_3705964 rootComponent
```

## Referenced By

- `IssuesListPage` (RENDERS)

<!-- source: service-trialservice.md -->

# TrialService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/trial/trial.service.ts` (line 23)

One-click public-repo trial (Phase 1.1) — the answer to DeepWiki's zero-friction entry.
Paste a public GitHub URL → docs hub + grounded chat + MCP + SDK, no signup. Public repos
clone anonymously, so this needs NO GitHub App/OAuth. Guardrails: URL shape validation,
per-repo dedupe (same repo → same trial project, regenerations reused), a global daily
cap, and per-IP rate limiting at the controller. All trials live under a system org whose
credits are auto-topped — normal metering still records every token for cost visibility.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `startTrial` | `startTrial(repoUrl: string)` | `Promise<{
    projectId: string;
    status: 'ready' | 'generating';
    repo: string;
  }>` |
| `status` | `status(projectId: string)` | `unknown` |
| `claim` | `claim(projectId: string, user: JwtPayload)` | `Promise<{ projectId: string; claimed: boolean }>` |
| `cleanupExpiredTrials` | `cleanupExpiredTrials()` | `Promise<void>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `technicaldocsqueue`
- DEPENDS_ON → `technicaldocsservice`
- DEPENDS_ON → `projectservice`

<!-- source: class-updatecategorydto.md -->

# UpdateCategoryDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/category.dto.ts` (line 60)

DTO for updating an existing category

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `icon` | `string` |
| `color` | `string` |
| `parentId` | `string` |
| `defaultDocId` | `string` |
| `order` | `number` |

<!-- source: function-usemdastnodeupdater.md -->

# useMdastNodeUpdater

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/NestedLexicalEditor.tsx` (line 107)

A hook that returns a function that can be used to update the mdast node. Use this in your custom editor components.

<!-- source: interface-crossstackmappingresult.md -->

# CrossStackMappingResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-03-features/cross-stack-mapper.ts` (line 73)

Result of cross-stack mapping

## Properties

| Property | Type |
|---|---|
| `mappings` | `CrossStackMapping[]` |
| `crossStackFeatures` | `CrossStackFeature[]` |
| `stats` | `{
    totalMappings: number;
    apiCallMappings: number;
    routeMatchMappings: number;
    nameCorrelationMappings: number;
  }` |

<!-- source: api-endpoint-get-6.md -->

# get

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/category.controller.ts` (line 70)

Get a single category

## Endpoint

`GET /categories/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `CategoryController` (MODULE_DECLARES)

<!-- source: component-imagedimensionsexample.md -->

# ImageDimensionsExample

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/images.tsx` (line 263)

## Diagram

```mermaid
graph TD
    component_ImageDimensionsExample_1021eb3f["ImageDimensionsExample"]
    class component_ImageDimensionsExample_1021eb3f rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `InsertImage`

<!-- source: constant-imageplugin.md -->

# imagePlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 372)

A plugin that adds support for images.

<!-- source: function-isreactfile-2.md -->

# isReactFile

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 634)

Check if a file is a React/JSX file

## Signature

```ts
function isReactFile(filePath: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string` |

**Returns:** `boolean`

<!-- source: interface-parseddocumenturl-2.md -->

# ParsedDocumentUrl

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/services/url.service.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `slug` | `string` |
| `urlId` | `string` |
| `audience` | `string` |

<!-- source: interface-piniagetterpattern.md -->

# PiniaGetterPattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/pinia-pattern-detector.ts` (line 92)

Pinia getter pattern

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `storeName` | `string` |
| `line` | `number` |
| `statePath` | `string[]` |
| `dependsOn` | `string[]` |

<!-- source: interface-reliabilityoptions.md -->

# ReliabilityOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/reliability-config.ts` (line 33)

## Properties

| Property | Type |
|---|---|
| `testCommand` | `string` |
| `cwd` | `string` |
| `enableTestWatcher` | `boolean` |
| `enableTestGate` | `boolean` |
| `enablePreflight` | `boolean` |
| `enableCircleDetection` | `boolean` |
| `debounceMs` | `number` |
| `testTimeoutMs` | `number` |
| `reportPassingTests` | `boolean` |
| `preflightChecks` | `PreflightCheck[]` |
| `circleDetectorOptions` | `CircleDetectorOptions` |

<!-- source: component-retentionpolicysection.md -->

# RetentionPolicySection

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/page.tsx` (line 1071)

Phase 8: Retention policy configuration.

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_RetentionPolicySection_16afe4e0["RetentionPolicySection"]
    class component_RetentionPolicySection_16afe4e0 rootComponent
```

## Relationships

- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`

## Referenced By

- `ProjectPage` (RENDERS)

<!-- source: service-tutorialdetectorservice.md -->

# TutorialDetectorService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/tutorial-detector.service.ts` (line 108)

Tutorial Detector Service

Detects single-step tutorials from state transitions.
Each state transition becomes a quick-start tutorial (2-5 minutes).

Strategy:
1. Find all state machines
2. For each transition, create a tutorial
3. Link tutorials via prerequisites/next steps
4. Group into learning paths by category

Example:
- State machine: JobStageEnum
- Transition: Offer → Order (convertToOrder)
- Tutorial: "How to Convert an Offer to an Order"
- Difficulty: Beginner
- Time: 2-3 minutes
- Prerequisites: "How to Create a Job Offer"
- Next steps: "How to Deliver an Order"

`TutorialDetectorService` scans application state machines and derives micro-tutorials from their state transitions. Each transition becomes a single-step quick-start tutorial (typically 2–5 minutes), enriched with difficulty, estimated time, and navigation links (prerequisites/next steps). It helps automatically generate structured learning paths by grouping tutorials by domain/category.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectTutorials` | `detectTutorials(entities: any[], appMap: any, features: any[])` | `Promise<{
    tutorials: DetectedTutorial[];
    learningPaths: LearningPath[];
  }>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant Caller as API/CLI/Job
  participant TDS as TutorialDetectorService
  participant SM as StateMachineRegistry
  participant GEN as TutorialGenerator
  participant LINK as TutorialLinker
  participant PATH as LearningPathGrouper
  participant OUT as Docs/DB Output

  Caller->>TDS: detectTutorials()
  TDS->>SM: listStateMachines()
  SM-->>TDS: stateMachines[]
  loop for each stateMachine
    TDS->>SM: getTransitions(stateMachine)
    SM-->>TDS: transitions[]
    loop for each transition
      TDS->>GEN: createTutorialFromTransition(transition)
      GEN-->>TDS: tutorial
    end
  end
  TDS->>LINK: linkPrerequisitesAndNextSteps(tutorials)
  LINK-->>TDS: linkedTutorials
  TDS->>PATH: groupByCategory(linkedTutorials)
  PATH-->>TDS: learningPaths
  TDS->>OUT: persistOrRender(learningPaths)
  OUT-->>Caller: result
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { TutorialDetectorService } from './documentation/services/tutorial-detector.service';

@Injectable()
export class DocsGenerationJob {
  constructor(private readonly tutorialDetector: TutorialDetectorService) {}

  async run() {
    // Detect tutorials derived from all known state machine transitions.
    const result = await this.tutorialDetector.detectTutorials();

    // Example: iterate and print a few generated tutorial titles.
    for (const path of result.learningPaths ?? []) {
      console.log(`Learning Path: ${path.title}`);
      for (const tutorial of path.tutorials.slice(0, 3)) {
        console.log(` - ${tutorial.title} (${tutorial.difficulty}, ${tutorial.estimatedTime})`);
        console.log(`   prereq: ${tutorial.prerequisites?.join(', ') ?? 'none'}`);
        console.log(`   next:   ${tutorial.nextSteps?.join(', ') ?? 'none'}`);
      }
    }

    return result;
  }
}
```

## AI Coding Instructions

- Treat each state transition as the single source of truth for tutorial generation; avoid hand-curated tutorial definitions that drift from the state machine.
- Keep tutorial titles/action verbs deterministic (e.g., derived from transition name like `convertToOrder`) so linking and deduplication remain stable across runs.
- When adding or renaming states/transitions, ensure the detector can still resolve prerequisites/next steps (ordering or adjacency rules are a common failure point).
- Integrate category/grouping from domain metadata (state machine ownership/module) rather than parsing strings from enum names whenever possible.
- Prefer idempotent outputs (stable IDs/keys for tutorials and learning paths) so re-running generation doesn’t create duplicates in persisted docs/DB.

<!-- source: class-updatecolumndto.md -->

# UpdateColumnDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/boards/dto/column.dto.ts` (line 28)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `color` | `string` |
| `mapsToStatus` | `IssueStatus | null` |
| `wipLimit` | `number | null` |

<!-- source: function-usenestededitorcontext.md -->

# useNestedEditorContext

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/NestedLexicalEditor.tsx` (line 95)

<!-- source: interface-ctacardprops-2.md -->

# CtaCardProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/cta/cta-card.tsx` (line 14)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `primaryCtaKey` | `string` |
| `primaryCtaUrl` | `string` |
| `secondaryCtaKey` | `string` |
| `secondaryCtaUrl` | `string` |
| `icon` | `LucideIcon` |

<!-- source: api-endpoint-get-7.md -->

# get

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 123)

## Endpoint

`GET /documents/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: component-imageeditor.md -->

# ImageEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/ImageEditor.tsx` (line 113)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `src` | `string` | ✓ | - |
| `title` | `string` | - | - |
| `alt` | `string` | - | - |
| `nodeKey` | `string` | ✓ | - |
| `width` | `number | unknown` | ✓ | - |
| `height` | `number | unknown` | ✓ | - |
| `rest` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ImageEditor_214d8dbc["ImageEditor"]
    class component_ImageEditor_214d8dbc rootComponent
```

## Relationships

- RENDERS → `React-Suspense`
- RENDERS → `ImagePlaceholderComponent`
- RENDERS → `LazyImage`
- RENDERS → `ImageResizer`
- RENDERS → `EditImageToolbar`
- USES_HOOK → `useCellValues`
- USES_HOOK → `useRef`
- USES_HOOK → `useLexicalNodeSelection`
- USES_HOOK → `useLexicalComposerContext`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`
- USES_HOOK → `useMemo`

<!-- source: constant-imagepreviewhandler.md -->

# imagePreviewHandler$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 173)

Holds the image preview handler callback.

<!-- source: function-istypescriptfile-2.md -->

# isTypeScriptFile

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 641)

Check if a file is a TypeScript file

## Signature

```ts
function isTypeScriptFile(filePath: string): boolean
```

## Parameters

| Name | Type |
|---|---|
| `filePath` | `string` |

**Returns:** `boolean`

<!-- source: interface-parsedrepourl.md -->

# ParsedRepoUrl

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/parsing/git-clone.service.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `provider` | `RepositoryProvider` |
| `owner` | `string` |
| `repo` | `string` |
| `organization` | `string` |
| `project` | `string` |

<!-- source: interface-piniastorepattern.md -->

# PiniaStorePattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/pinia-pattern-detector.ts` (line 19)

Pinia store pattern

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `storeId` | `string` |
| `line` | `number` |
| `isCompositionAPI` | `boolean` |
| `stateProps` | `Array<{ name: string; type?: string }>` |
| `getters` | `string[]` |
| `actions` | `Array<{ name: string; isAsync: boolean }>` |

<!-- source: interface-repomapconfig.md -->

# RepoMapConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/repo-map.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `tokenBudget` | `number` |
| `includePatterns` | `RegExp[]` |
| `excludeDirs` | `string[]` |
| `maxFiles` | `number` |

<!-- source: component-reveal.md -->

# Reveal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/languages/page.tsx` (line 379)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |
| `delay` | `number` | - | 0 |
| `style` | `unknown` | - | - |

## Diagram

```mermaid
graph TD
    component_Reveal_3d467d8b["Reveal"]
    class component_Reveal_3d467d8b rootComponent
```

## Relationships

- RENDERS → `motion-div`
- USES_HOOK → `useRef`
- USES_HOOK → `useInView`

## Referenced By

- `LanguagesPage` (RENDERS)

<!-- source: service-tutorialgeneratorservice.md -->

# TutorialGeneratorService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/tutorial-generator.service.ts` (line 72)

Tutorial Generator Service

Generates beginner-friendly tutorial content using AI.
Each tutorial teaches a single state transition (2-5 minutes).

Leverages Phase 2.1 & 3 context:
- State machines → explain state changes
- UI interactions → use exact button labels
- Screenshots → reference visuals

Multi-agent approach:
- Generator (Claude): Creates initial content
- Reviewer (OpenAI): Reviews for clarity and beginner-friendliness

`TutorialGeneratorService` is a NestJS backend service that generates short, beginner-friendly tutorials (2–5 minutes) that each teach a single state transition in the product. It builds tutorials using app context (state machine transitions, exact UI button labels, and referenced screenshots) and improves quality via a multi-agent pipeline where one model generates and another reviews for clarity and approachability.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generateTutorial` | `generateTutorial(tutorial: DetectedTutorial, options: {
      generatorProvider?: 'azure-claude' | 'azure-openai';
      reviewerProvider?: 'azure-claude' | 'azure-openai';
      enableReviewer?: boolean;
    })` | `Promise<TutorialContent>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant Caller as API/Controller
  participant TGS as TutorialGeneratorService
  participant Ctx as Context Builder<br/>(Phase 2.1/3)
  participant Gen as Generator Agent<br/>(Claude)
  participant Rev as Reviewer Agent<br/>(OpenAI)
  participant Store as Output/DB/Filesystem

  Caller->>TGS: generateTutorial(request)
  TGS->>Ctx: collect state machine + UI labels + screenshots
  Ctx-->>TGS: tutorial context package
  TGS->>Gen: create draft tutorial(context)
  Gen-->>TGS: draft tutorial content
  TGS->>Rev: review & refine(draft, context)
  Rev-->>TGS: approved/refined tutorial
  TGS->>Store: persist/return tutorial
  Store-->>Caller: tutorial result
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { TutorialGeneratorService } from './documentation/services/tutorial-generator.service';

@Injectable()
export class TutorialsControllerFacade {
  constructor(private readonly tutorialGenerator: TutorialGeneratorService) {}

  async generateBeginnerTutorial() {
    // Example request shape (adjust to your actual DTO/interface)
    const request = {
      // The single transition the tutorial should teach
      transition: {
        fromState: 'Draft',
        toState: 'Published',
        event: 'PUBLISH_CLICKED',
      },
      // UI constraints: exact button label(s) to reference
      ui: {
        primaryActionLabel: 'Publish',
        confirmActionLabel: 'Confirm publish',
      },
      // Optional: screenshot identifiers/URLs to reference in steps
      screenshots: [
        { id: 'editor-toolbar', description: 'Toolbar with Publish button' },
        { id: 'publish-confirmation', description: 'Publish confirmation modal' },
      ],
      audience: 'beginner',
      targetDurationMinutes: 3,
    };

    // Returns a tutorial artifact (e.g., markdown/steps + metadata)
    return this.tutorialGenerator.generateTutorial(request);
  }
}
```

## AI Coding Instructions

- Keep tutorials scoped to **one** state transition only; do not combine multiple transitions or “advanced” detours even if context includes them.
- When describing UI actions, **use exact button labels** from context (case-sensitive) and avoid inventing UI text; reference screenshots by their provided IDs/descriptions.
- Preserve the multi-agent flow: generator produces a draft, reviewer refines for beginner clarity; avoid bypassing review unless explicitly configured.
- Ensure the output stays within **2–5 minutes** and is step-based with clear “what to click” instructions tied to the state change being taught.
- When adding new context fields (state machine/UI/screenshot metadata), thread them through both generator and reviewer prompts to prevent hallucinated steps.

## Relationships

- DEPENDS_ON → `azureclaudeprovider`
- DEPENDS_ON → `azureopenaiprovider`

<!-- source: class-updatecommentdto.md -->

# UpdateCommentDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/comment/dto/update-comment.dto.ts` (line 7)

DTO for updating an existing comment

## Properties

| Property | Type |
|---|---|
| `content` | `string` |

<!-- source: function-useproject.md -->

# useProject

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useProject.ts` (line 66)

useProject - Hook for project management

Provides project state and operations.
Business logic (validation, permissions) is delegated to ProjectManager from

## Signature

```ts
function useProject(options: UseProjectOptions): UseProjectReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseProjectOptions` |

**Returns:** `UseProjectReturn`

<!-- source: interface-dataflowstep.md -->

# DataFlowStep

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-03-features/cross-stack-mapper.ts` (line 53)

A step in the data flow

## Properties

| Property | Type |
|---|---|
| `step` | `number` |
| `layer` | `'frontend' | 'api' | 'service' | 'database'` |
| `entity` | `string` |
| `action` | `string` |

<!-- source: api-endpoint-get-8.md -->

# get

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/invitation/invitation.controller.ts` (line 26)

## Endpoint

`GET /invitations/:token`

| Parameter | In | Type | Required |
|---|---|---|---|
| `token` | query | `string` | ✓ |

## Referenced By

- `InvitationController` (MODULE_DECLARES)

<!-- source: component-imageplaceholder.md -->

# ImagePlaceholder

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/ImagePlaceholder.tsx` (line 6)

## Diagram

```mermaid
graph TD
    component_ImagePlaceholder_5a3f4c56["ImagePlaceholder"]
    class component_ImagePlaceholder_5a3f4c56 rootComponent
```

## Relationships

- RENDERS → `ImageIcon`

<!-- source: constant-imageuploadhandler.md -->

# imageUploadHandler$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 167)

Holds the image upload handler callback.

<!-- source: function-kindlabel.md -->

# kindLabel

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/entity-page.ts` (line 54)

"DATABASE_MODEL" → "Database Model", "API_ENDPOINT" → "API Endpoint", "SERVICE" → "Service".

## Signature

```ts
function kindLabel(type: string): string
```

## Parameters

| Name | Type |
|---|---|
| `type` | `string` |

**Returns:** `string`

<!-- source: interface-parseerror-2.md -->

# ParseError

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/parser/interfaces/code-parser.interface.ts` (line 70)

## Properties

| Property | Type |
|---|---|
| `message` | `string` |
| `line` | `number` |
| `column` | `number` |
| `severity` | `'error' | 'warning'` |

<!-- source: interface-progresscallback.md -->

# ProgressCallback

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/config.interface.ts` (line 265)

Progress callback for long-running operations

<!-- source: interface-repomapresult.md -->

# RepoMapResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/repo-map.ts` (line 48)

## Properties

| Property | Type |
|---|---|
| `content` | `string` |
| `definitionCount` | `number` |
| `totalDefinitions` | `number` |
| `tokenCount` | `number` |
| `filesScanned` | `number` |

<!-- source: component-reveal-2.md -->

# Reveal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/page.tsx` (line 408)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |
| `delay` | `number` | - | 0 |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_Reveal_6b57f6e9["Reveal"]
    class component_Reveal_6b57f6e9 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- USES_HOOK → `useRef`
- USES_HOOK → `useInView`

## Referenced By

- `HomePage` (RENDERS)

<!-- source: service-uianalyzerservice.md -->

# UIAnalyzerService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/ai/services/ui-analyzer.service.ts` (line 115)

UI Analyzer Service

Extracts UI elements, routes, interactions from frontend code
Builds comprehensive documentation for:
1. Manual testing
2. Playwright automation
3. Architecture understanding
4. Visual diagrams

Handles large codebases incrementally with progress tracking

`UIAnalyzerService` analyzes frontend source code to extract UI elements, routes, interactions, and related application structure. It incrementally processes large codebases with progress tracking, producing documentation that supports manual testing, Playwright automation, architecture discovery, and visual diagrams.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `analyzeApplication` | `analyzeApplication(options: {
    baseDir: string;
    framework: 'react' | 'angular' | 'vue';
    modules?: string[]; // Specific modules to analyze
    resume?: boolean; // Resume from last checkpoint
  })` | `Promise<ApplicationMap>` |
| `analyzeModule` | `analyzeModule(baseDir: string, modulePath: string, framework: 'react' | 'angular' | 'vue')` | `Promise<ModuleDocumentation>` |
| `generatePlaywrightTests` | `generatePlaywrightTests(pageDoc: PageDocumentation)` | `Promise<PlaywrightTestConfig>` |
| `exportDocumentation` | `exportDocumentation(map: ApplicationMap, format: 'markdown' | 'html' | 'json')` | `Promise<string>` |

## Diagram

```mermaid
sequenceDiagram
    participant Client as API/Caller
    participant Service as UIAnalyzerService
    participant Filesystem as Frontend Source Files
    participant Analyzer as Code Analysis Pipeline
    participant Output as Documentation Output

    Client->>Service: analyze(projectPath, options)
    Service->>Filesystem: Discover frontend files
    Filesystem-->>Service: File list

    loop Incremental analysis
        Service->>Analyzer: Parse component, route, and interaction data
        Analyzer-->>Service: Extracted UI metadata
        Service-->>Client: Report progress
    end

    Service->>Output: Build testing and architecture documentation
    Output-->>Service: Documentation artifacts
    Service-->>Client: Return analysis result
```

## Usage

```ts
import { UIAnalyzerService } from './ai/services/ui-analyzer.service';

async function analyzeFrontend(
  uiAnalyzerService: UIAnalyzerService,
): Promise<void> {
  const result = await uiAnalyzerService.analyze({
    projectPath: '/workspace/apps/web',
    onProgress: (progress) => {
      console.log(
        `Analyzed ${progress.processedFiles}/${progress.totalFiles} files`,
      );
    },
  });

  console.log('Routes:', result.routes);
  console.log('UI elements:', result.uiElements);
  console.log('Generated testing documentation:', result.documentation);
}
```

## AI Coding Instructions

- Preserve incremental processing and progress reporting when adding new analysis stages; large frontend repositories must not require a single in-memory pass.
- Keep extracted metadata structured and traceable to its source file, component, route, or selector so generated test documentation remains actionable.
- Treat route discovery, component parsing, and interaction extraction as separate concerns; add new framework-specific parsers behind the existing analysis pipeline.
- Ensure generated Playwright guidance uses stable selectors and user-visible behaviors rather than implementation-specific DOM assumptions.
- Validate file paths and handle unreadable, unsupported, or malformed source files gracefully so one invalid file does not stop a complete analysis.

## Relationships

- DEPENDS_ON → `filecontextservice`
- DEPENDS_ON → `aiservice`
- DEPENDS_ON → `prismaservice`

<!-- source: class-updatedocautomationconfigdto.md -->

# UpdateDocAutomationConfigDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/documentation/dto/doc-automation.dto.ts` (line 219)

## Properties

| Property | Type |
|---|---|
| `repositoryUrl` | `string` |
| `repositoryBranch` | `string` |
| `frontendPath` | `string` |
| `backendPath` | `string` |
| `siteUrl` | `string` |
| `siteLoginUrl` | `string` |
| `siteEmail` | `string` |
| `sitePassword` | `string` |
| `repoUsername` | `string` |
| `repoPassword` | `string` |
| `skeletonStructure` | `SkeletonStructureDto` |
| `includeApiDocs` | `boolean` |
| `includeDiagrams` | `boolean` |
| `includeScreenshots` | `boolean` |
| `aiEnhancement` | `boolean` |
| `outputFormat` | `string` |
| `screenshotFormat` | `string` |
| `screenshotQuality` | `number` |
| `maxConcurrency` | `number` |
| `timeout` | `number` |
| `excludePatterns` | `string[]` |
| `targetAudience` | `string` |
| `autoPublish` | `boolean` |
| `businessDomain` | `string` |

<!-- source: function-useprojects.md -->

# useProjects

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useProjects.ts` (line 49)

useProjects - Hook for fetching lists of projects

Provides a list of projects with optional filtering by organization.

## Signature

```ts
function useProjects(options: UseProjectsOptions): UseProjectsReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseProjectsOptions` |

**Returns:** `UseProjectsReturn`

<!-- source: interface-deeploaderconfig.md -->

# DeepLoaderConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-04-analysis/iterative-deep-loader.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `maxIterations` | `number` |
| `entityResolver` | `(entityId: string) => Entity | undefined` |
| `fileLoader` | `(filePath: string, startLine?: number, endLine?: number) => Promise<string>` |
| `largeFileIndexes` | `LargeFileIndex[]` |

<!-- source: api-endpoint-get-9.md -->

# get

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/organization/organization.controller.ts` (line 51)

## Endpoint

`GET /organizations/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `OrganizationController` (MODULE_DECLARES)

<!-- source: component-imageresizer.md -->

# ImageResizer

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/ImageResizer.tsx` (line 27)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onResizeStart` | `Function` | ✓ | - |
| `onResizeEnd` | `Function` | ✓ | - |
| `imageRef` | `unknown` | ✓ | - |
| `maxWidth` | `number` | - | - |
| `editor` | `LexicalEditor` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ImageResizer_48b7bb40["ImageResizer"]
    class component_ImageResizer_48b7bb40 rootComponent
```

## Relationships

- USES_HOOK → `useRef`

<!-- source: constant-importvisitors.md -->

# importVisitors$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 274)

<!-- source: function-linkinteractionstoscreenshot.md -->

# linkInteractionsToScreenshot

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ui-interaction-detector.ts` (line 398)

Link UI interactions to screenshots

Takes a screenshot URL and a list of interactions, and determines
which interactions are available on that screenshot based on the
current state detected from the URL.

## Signature

```ts
function linkInteractionsToScreenshot(_screenshotUrl: string, interactions: UIInteraction[], currentState: string): UIInteraction[]
```

## Parameters

| Name | Type |
|---|---|
| `_screenshotUrl` | `string` |
| `interactions` | `UIInteraction[]` |
| `currentState` | `string` |

**Returns:** `UIInteraction[]`

<!-- source: interface-parsejobdata.md -->

# ParseJobData

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/parsing/parsing.queue.ts` (line 11)

## Properties

| Property | Type |
|---|---|
| `jobId` | `string` |
| `projectId` | `string` |
| `repositoryUrl` | `string` |
| `branch` | `string` |
| `provider` | `RepositoryProvider` |
| `credentials` | `{
    username?: string;
    password?: string;
  }` |
| `options` | `{
    include?: string[];
    exclude?: string[];
    frameworks?: string[];
    screenshots?: boolean;
  }` |
| `autoSync` | `boolean` |

<!-- source: interface-progressinfo.md -->

# ProgressInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/config.interface.ts` (line 276)

Progress information

## Properties

| Property | Type |
|---|---|
| `percent` | `number` |
| `phase` | `string` |
| `filesProcessed` | `number` |
| `totalFiles` | `number` |
| `currentFile` | `string` |
| `elapsedTime` | `number` |
| `estimatedTimeRemaining` | `number` |

<!-- source: interface-repomaptooloptions.md -->

# RepoMapToolOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/repo-map.tool.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `tokenBudget` | `number` |
| `includePatterns` | `RegExp[]` |
| `excludeDirs` | `string[]` |
| `maxFiles` | `number` |

<!-- source: component-reveal-3.md -->

# Reveal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/privacy/page.tsx` (line 7)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |
| `delay` | `number` | - | 0 |

## Diagram

```mermaid
graph TD
    component_Reveal_35e5367e["Reveal"]
    class component_Reveal_35e5367e rootComponent
```

## Relationships

- RENDERS → `motion-div`
- USES_HOOK → `useRef`
- USES_HOOK → `useInView`

## Referenced By

- `PrivacyPage` (RENDERS)

<!-- source: class-updatedocsconfigdto.md -->

# UpdateDocsConfigDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/change-request/dto/docs-config.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `requireReview` | `boolean` |

<!-- source: service-urlservice.md -->

# UrlService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/document/services/url.service.ts` (line 27)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `generateUrlId` | `generateUrlId(maxAttempts: unknown)` | `Promise<string>` |
| `generateCollectionUrlId` | `generateCollectionUrlId(maxAttempts: unknown)` | `Promise<string>` |
| `generateProjectUrlId` | `generateProjectUrlId(maxAttempts: unknown)` | `Promise<string>` |
| `buildProjectUrl` | `buildProjectUrl(slug: string, urlId: string)` | `string` |
| `parseProjectUrl` | `parseProjectUrl(path: string)` | `{ slug: string; urlId: string } | null` |
| `generateSlug` | `generateSlug(title: string)` | `string` |
| `parseDocumentUrl` | `parseDocumentUrl(path: string)` | `ParsedDocumentUrl | null` |
| `buildDocumentUrl` | `buildDocumentUrl(slug: string, urlId: string, audience: string)` | `string` |
| `buildCollectionUrl` | `buildCollectionUrl(slug: string, urlId: string)` | `string` |
| `isValidUrlId` | `isValidUrlId(urlId: string)` | `boolean` |
| `isValidSlug` | `isValidSlug(slug: string)` | `boolean` |
| `isValidAudienceSlug` | `isValidAudienceSlug(slug: string)` | `boolean` |
| `extractUrlIdFromPath` | `extractUrlIdFromPath(path: string)` | `string | null` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: function-user.md -->

# user

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/examples/assets/dataCode.ts` (line 7)

## Signature

```ts
function user(index)
```

## Parameters

| Name | Type |
|---|---|
| `index` | `any` |

<!-- source: interface-deeploaderresult.md -->

# DeepLoaderResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-04-analysis/iterative-deep-loader.ts` (line 31)

## Properties

| Property | Type |
|---|---|
| `finalResponse` | `ClaudeResponse` |
| `iterations` | `number` |
| `additionalContext` | `string[]` |

<!-- source: api-endpoint-get-10.md -->

# get

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 76)

## Endpoint

`GET /projects/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: component-images.md -->

# Images

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 244)

## Diagram

```mermaid
graph TD
    component_Images_45f45a42["Images"]
    class component_Images_45f45a42 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: constant-infocus.md -->

# inFocus$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 165)

Holds whether the editor is in focus or not.

<!-- source: function-looksminifiedname.md -->

# looksMinifiedName

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/significance.ts` (line 36)

Minified-looking name: 1-2 chars, or 3 chars with a digit / no vowel — unless allowlisted.

## Signature

```ts
function looksMinifiedName(name: string | undefined): boolean
```

## Parameters

| Name | Type |
|---|---|
| `name` | `string | undefined` |

**Returns:** `boolean`

<!-- source: interface-parseresult-2.md -->

# ParseResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/parser/interfaces/code-parser.interface.ts` (line 9)

## Properties

| Property | Type |
|---|---|
| `language` | `string` |
| `symbols` | `Symbol[]` |
| `dependencies` | `Dependency[]` |
| `imports` | `Import[]` |
| `exports` | `Export[]` |
| `ast` | `any` |
| `errors` | `ParseError[]` |

<!-- source: interface-projectparseresult-2.md -->

# ProjectParseResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/parse-result.interface.ts` (line 278)

Result of parsing an entire project

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `rootDir` | `string` |
| `parsers` | `string[]` |
| `timestamp` | `Date` |
| `status` | `ParseStatus` |
| `results` | `ParseResult[]` |
| `summary` | `ParseSummary` |
| `entities` | `Entity[]` |
| `relationships` | `Relationship[]` |
| `workflowSignals` | `WorkflowSignals` |

<!-- source: interface-resumedsession.md -->

# ResumedSession

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/session-manager.ts` (line 27)

What gets passed back on resume — everything needed to restore a session

## Properties

| Property | Type |
|---|---|
| `meta` | `SessionMeta` |
| `conversationHistory` | `AgentHistoryItem[]` |
| `sdkHistory` | `unknown[]` |

<!-- source: component-reveal-4.md -->

# Reveal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/terms/page.tsx` (line 7)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |
| `delay` | `number` | - | 0 |

## Diagram

```mermaid
graph TD
    component_Reveal_6bbfa161["Reveal"]
    class component_Reveal_6bbfa161 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- USES_HOOK → `useRef`
- USES_HOOK → `useInView`

## Referenced By

- `TermsPage` (RENDERS)

<!-- source: class-updatedocsprconfigdto.md -->

# UpdateDocsPrConfigDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/docs-pr/dto/update-docs-pr-config.dto.ts` (line 4)

Update a project's Freshness-as-PRs config. All fields optional (partial update).

## Properties

| Property | Type |
|---|---|
| `enabled` | `boolean` |
| `targetBranch` | `string` |
| `docsPathPrefix` | `string` |
| `provider` | `string` |
| `rung2Enabled` | `boolean` |

<!-- source: service-userdocsgeneratorservice.md -->

# UserDocsGeneratorService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/user-docs-generator.service.ts` (line 67)

Multi-agent service for generating user documentation

Architecture:
1. Generator Agent (Azure Claude) - Creates initial documentation
2. Reviewer Agent (Azure OpenAI) - Humanizes and improves language (optional)

`UserDocsGeneratorService` is a NestJS backend service that orchestrates a multi-agent pipeline to generate end-user documentation from internal inputs (e.g., domain context, feature notes, or source artifacts). It delegates first-pass drafting to a “Generator” agent (Azure Claude) and can optionally pass the draft through a “Reviewer” agent (Azure OpenAI) to improve tone, clarity, and human readability. This service sits in the API layer and acts as the coordination point between application code and external LLM providers.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `setCompetitorContext` | `setCompetitorContext(competitorContext: string | null)` | `void` |
| `generateDocumentation` | `generateDocumentation(appMap: any, screenshots: Record<string, any[]>, workflows: DetectedWorkflow[], businessContext: {
      marketing: string[];
      workflows: string[];
      brand: string[];
      processes: string[];
    }, options: {
      generatorProvider?: 'azure-claude' | 'azure-openai';
      reviewerProvider?: 'azure-claude' | 'azure-openai';
      enableReviewer?: boolean;
      competitorContext?: string; // NEW: Optional competitor docs context
    })` | `Promise<GeneratedDocumentation>` |
| `generateDocumentationWithSaving` | `generateDocumentationWithSaving(projectId: string, user: JwtPayload, appMap: any, screenshots: Record<string, any[]>, workflows: DetectedWorkflow[], businessContext: {
      marketing: string[];
      workflows: string[];
      brand: string[];
      processes: string[];
    }, options: {
      generatorProvider?: 'azure-claude' | 'azure-openai';
      reviewerProvider?: 'azure-claude' | 'azure-openai';
      enableReviewer?: boolean;
      competitorContext?: string;
    })` | `Promise<SyncBatchResponseDto>` |

## Diagram

```mermaid
sequenceDiagram
  autonumber
  participant Caller as API/Controller/Job
  participant Service as UserDocsGeneratorService
  participant Gen as Generator Agent (Azure Claude)
  participant Rev as Reviewer Agent (Azure OpenAI, optional)

  Caller->>Service: generateUserDocs(input, options)
  Service->>Gen: createInitialDocumentation(input)
  Gen-->>Service: draftDocs

  alt reviewer enabled
    Service->>Rev: refineLanguage(draftDocs)
    Rev-->>Service: reviewedDocs
    Service-->>Caller: reviewedDocs
  else reviewer disabled
    Service-->>Caller: draftDocs
  end
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { UserDocsGeneratorService } from './documentation/services/user-docs-generator.service';

@Injectable()
export class DocsJob {
  constructor(private readonly userDocs: UserDocsGeneratorService) {}

  async run() {
    const input = {
      productName: 'Atloria',
      audience: 'End users',
      features: [
        { name: 'Workspaces', notes: 'Create and organize projects and docs.' },
        { name: 'Search', notes: 'Find content across the workspace.' },
      ],
      constraints: {
        tone: 'Clear, friendly, non-technical',
        format: 'Markdown',
      },
    };

    // Optionally enable a second pass to humanize wording and improve flow.
    const options = { reviewerEnabled: true };

    const docsMarkdown = await this.userDocs.generateUserDocs(input, options);

    // Persist, return, or publish documentation content.
    return docsMarkdown;
  }
}
```

## AI Coding Instructions

- Keep the service as an **orchestrator**: generation logic lives in the agent adapters/clients; this service should coordinate steps, inputs, and outputs.
- Treat the Reviewer step as **optional** and make it a clear, explicit flag; avoid silently adding reviewer calls (cost/latency).
- Normalize and validate the model inputs (tone/format/audience) before sending to providers to prevent prompt drift and inconsistent outputs.
- Handle provider failures deterministically: timeouts, retries, and fallbacks should be centralized so callers get a predictable error/result shape.

## Relationships

- DEPENDS_ON → `azureclaudeprovider`
- DEPENDS_ON → `azureopenaiprovider`
- DEPENDS_ON → `syncservice`

<!-- source: function-useremotemdxeditorrealm.md -->

# useRemoteMDXEditorRealm

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/remote/index.tsx` (line 81)

## Signature

```ts
function useRemoteMDXEditorRealm(editorId: string)
```

## Parameters

| Name | Type |
|---|---|
| `editorId` | `string` |

<!-- source: interface-deeploadrequest.md -->

# DeepLoadRequest

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-10.types.ts` (line 92)

DeepLoadRequest - AI requests additional code context

During generation, if AI is uncertain about something, it can
request the full implementation of a specific entity.
Max 3 iterations per document to prevent infinite loops.

## Properties

| Property | Type |
|---|---|
| `entityName` | `string` |
| `reason` | `string` |
| `requestedBy` | `'generator' | 'verifier'` |
| `urgency` | `'required' | 'helpful'` |

<!-- source: api-endpoint-getaccess.md -->

# getAccess

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 624)

## Endpoint

`GET /doc-versions/:projectId/:versionId/access`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-imagewithbackend.md -->

# ImageWithBackend

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/images.tsx` (line 59)

## Diagram

```mermaid
graph TD
    component_ImageWithBackend_375df930["ImageWithBackend"]
    class component_ImageWithBackend_375df930 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `InsertImage`

<!-- source: constant-initialmarkdown.md -->

# initialMarkdown$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 236)

<!-- source: function-makegroundedask.md -->

# makeGroundedAsk

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/grounded-ask.ts` (line 55)

Make an AskFn from an LLM completion function. Retrieval is done upstream (the toolset passes
the retrieved `context`); this grounds the prompt, calls the LLM, and returns only validated
citations. Refuses (no LLM call) when context is empty.

## Signature

```ts
function makeGroundedAsk(complete: LlmComplete): AskFn
```

## Parameters

| Name | Type |
|---|---|
| `complete` | `LlmComplete` |

**Returns:** `AskFn`

<!-- source: interface-path.md -->

# Path

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/graph/interfaces/entity.interface.ts` (line 48)

## Properties

| Property | Type |
|---|---|
| `entities` | `KGEntity[]` |
| `relationships` | `KGRelation[]` |
| `length` | `number` |

<!-- source: interface-projectstats.md -->

# ProjectStats

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 27)

Project statistics for context

## Properties

| Property | Type |
|---|---|
| `totalEntities` | `number` |
| `entityTypeBreakdown` | `Record<string, number>` |
| `totalRelationships` | `number` |
| `relationshipTypeBreakdown` | `Record<string, number>` |
| `framework` | `string` |

<!-- source: interface-retentionpolicy.md -->

# RetentionPolicy

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/checkpoint-backend.ts` (line 61)

## Properties

| Property | Type |
|---|---|
| `maxSnapshotsPerFile` | `number` |
| `maxTotalSnapshots` | `number` |
| `maxAgeDays` | `number` |
| `maxTotalBytes` | `number` |

<!-- source: component-revisioncard.md -->

# RevisionCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Document/VersionHistoryPanel.tsx` (line 343)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `revision` | `DocumentRevision` | ✓ | - |
| `isCurrent` | `boolean` | ✓ | - |
| `isSelected` | `boolean` | ✓ | - |
| `isSelectedForCompare` | `boolean` | ✓ | - |
| `compareMode` | `boolean` | ✓ | - |
| `isRestoring` | `boolean` | ✓ | - |
| `onSelect` | `Function` | ✓ | - |
| `onRestore` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_RevisionCard_268b157f["RevisionCard"]
    class component_RevisionCard_268b157f rootComponent
```

## Relationships

- RENDERS → `CheckIcon`
- RENDERS → `TagIcon`
- RENDERS → `ArrowPathIcon`

## Referenced By

- `VersionHistoryPanel` (RENDERS)

<!-- source: class-updatedocumentdto.md -->

# UpdateDocumentDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/update-document.dto.ts` (line 5)

**Extends:** `PartialType(CreateDocumentDto)`

<!-- source: function-usesuggestions.md -->

# useSuggestions

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useSuggestions.ts` (line 61)

useSuggestions - Hook for suggestion management with real-time updates

Provides suggestion state and operations with WebSocket support.

## Signature

```ts
function useSuggestions(options: UseSuggestionsOptions): UseSuggestionsReturn
```

## Parameters

| Name | Type |
|---|---|
| `options` | `UseSuggestionsOptions` |

**Returns:** `UseSuggestionsReturn`

<!-- source: service-versionaccessguard.md -->

# VersionAccessGuard

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/doc-version/version-access.guard.ts` (line 4)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `canActivate` | `canActivate(context: ExecutionContext)` | `Promise<boolean>` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: interface-deeploadresponse.md -->

# DeepLoadResponse

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-10.types.ts` (line 99)

## Properties

| Property | Type |
|---|---|
| `entityName` | `string` |
| `found` | `boolean` |
| `content` | `string` |
| `relatedEntities` | `string[]` |
| `tokenCost` | `number` |

<!-- source: api-endpoint-getactive.md -->

# getActive

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 63)

## Endpoint

`GET /doc-versions/:projectId/active`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `scope` | query | `string` | - |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-imagewithnobackend.md -->

# ImageWithNoBackend

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/images.tsx` (line 37)

## Diagram

```mermaid
graph TD
    component_ImageWithNoBackend_191a5931["ImageWithNoBackend"]
    class component_ImageWithNoBackend_191a5931 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `InsertImage`

<!-- source: constant-initialmarkdownnormalize.md -->

# initialMarkdownNormalize$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 244)

<!-- source: function-operationcodesamples.md -->

# operationCodeSamples

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/code-samples.ts` (line 38)

Samples for a single operation; [] on any failure (never throws into the spec build).

## Signature

```ts
function operationCodeSamples(spec: any, path: string, method: string, targets: string[]): CodeSample[]
```

## Parameters

| Name | Type |
|---|---|
| `spec` | `any` |
| `path` | `string` |
| `method` | `string` |
| `targets` | `string[]` |

**Returns:** `CodeSample[]`

<!-- source: interface-promptcontext.md -->

# PromptContext

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/support-agent/prompts/system-prompt-layers.ts` (line 9)

Layered System Prompt Architecture for Support Agent

Each layer serves a specific purpose and they are assembled in order.
Core layers (1-6) are IMMUTABLE and cannot be overridden by user customization.
Layer 7 (custom) is where user-specific personality/behavior is added.

## Properties

| Property | Type |
|---|---|
| `projectName` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `docVersion` | `string` |
| `agentName` | `string` |
| `userSystemPrompt` | `string` |
| `language` | `string` |

<!-- source: interface-propdefinition-2.md -->

# PropDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 419)

Prop definition for a component

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `required` | `boolean` |
| `defaultValue` | `string` |
| `description` | `string` |

<!-- source: interface-retryconfig-2.md -->

# RetryConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/retry-runner.ts` (line 16)

## Properties

| Property | Type |
|---|---|
| `maxAttempts` | `number` |
| `strategy` | `'best_patch' | 'first_pass'` |
| `scorer` | `(patch: string, task: BenchmarkTask) => Promise<number>` |
| `temperatureSchedule` | `number[]` |

<!-- source: component-row.md -->

# Row

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/IssueSidePanel.tsx` (line 914)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `icon` | `any` | ✓ | - |
| `label` | `string` | ✓ | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Row_1c8760b0["Row"]
    class component_Row_1c8760b0 rootComponent
```

## Relationships

- RENDERS → `Icon`

## Referenced By

- `IssueSidePanel` (RENDERS)

<!-- source: class-updatedocversiondto.md -->

# UpdateDocVersionDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/doc-version/dto/doc-version.dto.ts` (line 41)

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `description` | `string` |

<!-- source: function-usetranslation.md -->

# useTranslation

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 1075)

<!-- source: service-versioncarryforwardservice.md -->

# VersionCarryForwardService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/doc-version/carry-forward.service.ts` (line 20)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `carryForward` | `carryForward(newVersionId: string)` | `Promise<CarryForwardResult>` |
| `resolveFlag` | `resolveFlag(previousDocId: string, newVersionId: string, action: 'keep_previous' | 'use_new' | 'discard')` | `Promise<void>` |
| `extractPlaceholders` | `extractPlaceholders(docs: Array<{ id: string; content: string }>)` | `Array<{ text: string; routePath: string; documentId: string }>` |
| `carryForwardScreenshots` | `carryForwardScreenshots(previousVersionId: string, newVersionId: string)` | `Promise<{ carried: number; missing: number }>` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `docversionservice`

<!-- source: interface-dependencyedge.md -->

# DependencyEdge

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 229)

## Properties

| Property | Type |
|---|---|
| `from` | `string` |
| `to` | `string` |
| `type` | `DependencyType` |
| `isDocumentationRelevant` | `boolean` |

<!-- source: api-endpoint-getagent.md -->

# getAgent

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.controller.ts` (line 126)

## Endpoint

`GET /support-agent/:projectId/agents/:agentId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `agentId` | query | `string` | ✓ |

## Referenced By

- `SupportAgentController` (MODULE_DECLARES)

<!-- source: component-imagewithpreviewhook.md -->

# ImageWithPreviewHook

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/images.tsx` (line 214)

## Diagram

```mermaid
graph TD
    component_ImageWithPreviewHook_365a54b9["ImageWithPreviewHook"]
    class component_ImageWithPreviewHook_365a54b9 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`

<!-- source: constant-insert-image-command.md -->

# INSERT_IMAGE_COMMAND

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 421)

## Definition

```ts
LexicalCommand<InsertImagePayload>
```

<!-- source: function-parsestateenum.md -->

# parseStateEnum

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/state-machine-analyzer.ts` (line 55)

Parse a state enum from code and extract all states

## Signature

```ts
function parseStateEnum(code: string, enumName: string): StateNode[]
```

## Parameters

| Name | Type |
|---|---|
| `code` | `string` |
| `enumName` | `string` |

**Returns:** `StateNode[]`

<!-- source: interface-propertydefinition-2.md -->

# PropertyDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 616)

Property definition within a schema

## Properties

| Property | Type |
|---|---|
| `type` | `string` |
| `description` | `string` |
| `example` | `unknown` |
| `format` | `string` |
| `enum` | `string[]` |

<!-- source: interface-publishedprojectresult.md -->

# PublishedProjectResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/project/project.service.ts` (line 29)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `slug` | `string` |
| `urlId` | `string` |
| `publishedSlug` | `string` |
| `publicUrl` | `string` |
| `publishedAt` | `Date` |
| `isPublic` | `boolean` |

<!-- source: interface-retryresult.md -->

# RetryResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/retry-runner.ts` (line 45)

## Properties

| Property | Type |
|---|---|
| `best` | `TaskResult` |
| `attempts` | `AttemptResult[]` |
| `passedAny` | `boolean` |
| `firstPassAttempt` | `number` |

<!-- source: component-runningjobcard.md -->

# RunningJobCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/versions/page.tsx` (line 55)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `job` | `any` | ✓ | - |
| `onViewDetails` | `Function` | ✓ | - |
| `onForceComplete` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_RunningJobCard_2f1856eb["RunningJobCard"]
    class component_RunningJobCard_2f1856eb rootComponent
```

## Referenced By

- `VersionsContent` (RENDERS)

<!-- source: class-updateflowstepsdto.md -->

# UpdateFlowStepsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/capture/dto/update-flow.dto.ts` (line 25)

Owner edits to a captured flow's step list (F2 step-list editor).

The client sends the FULL desired ordered array — reorders, caption edits,
deletions and redaction boxes already applied. The service re-sanitizes +
re-redacts every value (defense in depth) and re-indexes `order` before storing,
so a tampered client can never smuggle a secret back in.

## Properties

| Property | Type |
|---|---|
| `steps` | `CapturedStepDto[]` |

<!-- source: function-usetranslation-2.md -->

# useTranslation

**Kind:** Function

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/i18n.tsx` (line 157)

## Signature

```ts
function useTranslation(): I18nContextValue
```

**Returns:** `I18nContextValue`

<!-- source: service-versiondiffservice.md -->

# VersionDiffService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/doc-version/version-diff.service.ts` (line 54)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `compareVersions` | `compareVersions(versionAId: string, versionBId: string)` | `Promise<VersionDiff>` |
| `diffDocument` | `diffDocument(docIdA: string, docIdB: string)` | `unknown` |
| `computeDiffStats` | `computeDiffStats(contentA: string, contentB: string)` | `DiffStats` |

## Relationships

- DEPENDS_ON → `prismaservice`

<!-- source: interface-descriptors.md -->

# Descriptors

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/importMarkdownToLexical.ts` (line 28)

The registered descriptors for composite nodes (jsx, directives, code blocks).

## Properties

| Property | Type |
|---|---|
| `jsxComponentDescriptors` | `JsxComponentDescriptor[]` |
| `directiveDescriptors` | `DirectiveDescriptor[]` |
| `codeBlockEditorDescriptors` | `CodeBlockEditorDescriptor[]` |

<!-- source: api-endpoint-getapidocset.md -->

# getApiDocSet

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 153)

## Endpoint

`GET /technical-docs/:projectId/api-docs`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: component-importstatements.md -->

# ImportStatements

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/jsx.tsx` (line 231)

## Diagram

```mermaid
graph TD
    component_ImportStatements_cf34037["ImportStatements"]
    class component_ImportStatements_cf34037 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useRef`
- USES_HOOK → `useState`

<!-- source: constant-insertcodeblock.md -->

# insertCodeBlock$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/index.ts` (line 82)

A signal that inserts a new code block into the editor with the published options.

<!-- source: interface-propinfo-2.md -->

# PropInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ast-helpers.ts` (line 30)

Information about a prop definition

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `required` | `boolean` |
| `defaultValue` | `string` |
| `description` | `string` |

<!-- source: interface-ragsearchresult.md -->

# RagSearchResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/support-agent/prompts/rag-context-formatter.ts` (line 8)

RAG Context Formatter

Formats search results into a structured context that the AI can understand
and reference in its responses.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `content` | `string` |
| `description` | `string` |
| `score` | `number` |
| `documentType` | `string` |

<!-- source: function-registerdefaultparsers.md -->

# registerDefaultParsers

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/orchestrator/create-default-orchestrator.ts` (line 54)

Register the default parser set onto an existing orchestrator (idempotent per name).

## Signature

```ts
function registerDefaultParsers(orchestrator: ParserOrchestrator): ParserOrchestrator
```

## Parameters

| Name | Type |
|---|---|
| `orchestrator` | `ParserOrchestrator` |

**Returns:** `ParserOrchestrator`

<!-- source: interface-reversibilityresult.md -->

# ReversibilityResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/permission-gate.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `tier` | `ReversibilityTier` |
| `label` | `string` |
| `warning` | `string` |
| `blocked` | `boolean` |

<!-- source: component-screenshotreviewsection.md -->

# ScreenshotReviewSection

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/versions/[versionId]/review/page.tsx` (line 346)

Phase 4: Screenshot review section with coverage threshold check.

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `versionId` | `string` | ✓ | - |
| `router` | `any` | ✓ | - |
| `apiClient` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ScreenshotReviewSection_604f38c3["ScreenshotReviewSection"]
    class component_ScreenshotReviewSection_604f38c3 rootComponent
```

## Relationships

- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

## Referenced By

- `ReviewPage` (RENDERS)

<!-- source: class-updateissuedto.md -->

# UpdateIssueDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/issues/dto/update-issue.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `status` | `IssueStatus` |
| `priority` | `IssuePriority` |
| `assigneeId` | `string | null` |
| `closedReason` | `IssueCloseReason` |
| `description` | `string` |

<!-- source: function-uuidv4.md -->

# uuidv4

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/uuid4.ts` (line 2)

<!-- source: service-webcrawlerservice.md -->

# WebCrawlerService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/web-crawler.service.ts` (line 19)

Simple web crawler for documentation pages
Fetches and converts HTML to markdown

`WebCrawlerService` is a NestJS service that retrieves documentation pages from the web and converts their HTML content into Markdown. It provides a reusable backend integration point for importing external documentation into the application's documentation pipeline.

## Methods

| Method | Signature | Returns |
|---|---|---|
| `crawlPage` | `crawlPage(url: string)` | `Promise<CrawledPage | null>` |
| `crawlPages` | `crawlPages(urls: string[], concurrency: unknown)` | `Promise<CrawledPage[]>` |
| `extractText` | `extractText(page: CrawledPage)` | `string` |
| `summarize` | `summarize(page: CrawledPage, maxLength: unknown)` | `string` |
| `validateUrl` | `validateUrl(url: string)` | `Promise<boolean>` |
| `healthCheck` | `healthCheck()` | `Promise<boolean>` |

## Diagram

```mermaid
sequenceDiagram
    participant Client as Documentation Consumer
    participant Service as WebCrawlerService
    participant Remote as External Documentation Site
    participant Converter as HTML-to-Markdown Converter

    Client->>Service: crawl(url)
    Service->>Remote: Fetch HTML page
    Remote-->>Service: HTML response
    Service->>Converter: Convert HTML content
    Converter-->>Service: Markdown content
    Service-->>Client: Return crawled Markdown
```

## Usage

```ts
import { Injectable } from '@nestjs/common';
import { WebCrawlerService } from './web-crawler.service';

@Injectable()
export class DocumentationImportService {
  constructor(private readonly webCrawlerService: WebCrawlerService) {}

  async importExternalDocs(url: string) {
    const markdown = await this.webCrawlerService.crawl(url);

    return {
      sourceUrl: url,
      content: markdown,
    };
  }
}
```

## AI Coding Instructions

- Keep network access inside `WebCrawlerService`; callers should provide URLs and consume normalized Markdown results.
- Validate and sanitize input URLs before crawling, especially when URLs originate from user-controlled sources.
- Handle fetch failures, redirects, timeouts, and non-HTML responses with clear NestJS-compatible errors.
- Preserve meaningful document structure during HTML-to-Markdown conversion, including headings, links, code blocks, and lists.
- Integrate the service through NestJS dependency injection rather than constructing it manually.

<!-- source: interface-detectedangularcomponent.md -->

# DetectedAngularComponent

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/angular-detector.ts` (line 17)

Detected Angular component

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `selector` | `string` |
| `templateType` | `'inline' | 'external'` |
| `styleType` | `'inline' | 'external' | 'none'` |
| `inputs` | `AngularInput[]` |
| `outputs` | `string[]` |
| `injectedServices` | `string[]` |
| `formType` | `'reactive' | 'template-driven'` |
| `lifecycleHooks` | `string[]` |
| `rxjsOperators` | `string[]` |
| `childComponents` | `string[]` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getapispec.md -->

# getApiSpec

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 388)

## Endpoint

`GET /technical-docs/:projectId/api-spec`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: component-importstatementsnested.md -->

# ImportStatementsNested

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/jsx.tsx` (line 263)

## Diagram

```mermaid
graph TD
    component_ImportStatementsNested_53e55220["ImportStatementsNested"]
    class component_ImportStatementsNested_53e55220 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `Button`
- USES_HOOK → `useRef`
- USES_HOOK → `useState`
- USES_HOOK → `usePublisher`

<!-- source: constant-insertdecoratornode.md -->

# insertDecoratorNode$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 815)

Inserts a decorator node (constructed by the published factory) at the current selection.

<!-- source: interface-ratelimitinfo-2.md -->

# RateLimitInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 667)

Rate limit configuration

## Properties

| Property | Type |
|---|---|
| `requests` | `number` |
| `period` | `string` |
| `scope` | `'user' | 'ip' | 'global'` |

<!-- source: interface-rawindexpage.md -->

# RawIndexPage

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/search-index.ts` (line 50)

## Properties

| Property | Type |
|---|---|
| `slug` | `string` |
| `title` | `string` |
| `content` | `string` |
| `docType` | `'technical' | 'user_manual'` |
| `entityId` | `string | null` |

<!-- source: function-renderentitypage.md -->

# renderEntityPage

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/entity-page.ts` (line 71)

## Signature

```ts
function renderEntityPage(entity: Entity, ctx: EntityPageContext): string
```

## Parameters

| Name | Type |
|---|---|
| `entity` | `Entity` |
| `ctx` | `EntityPageContext` |

**Returns:** `string`

<!-- source: interface-reviewissue.md -->

# ReviewIssue

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/self-review.ts` (line 13)

Self-Review Pass

After implementation, generates a review prompt analyzing the diff
for quality issues, bugs, and missed edge cases.

Design: The review runs as a sub-agent with read-only tools, or as
a nudge injected into the main agent's instructions.

Opt-in via AutonomousTurnHookOptions.selfReview

## Properties

| Property | Type |
|---|---|
| `severity` | `'error' | 'warning' | 'info'` |
| `file` | `string` |
| `line` | `number` |
| `description` | `string` |

<!-- source: component-screenshotscontent.md -->

# ScreenshotsContent

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/versions/[versionId]/screenshots/page.tsx` (line 25)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `versionId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ScreenshotsContent_5ae8d135["ScreenshotsContent"]
    class component_ScreenshotsContent_5ae8d135 rootComponent
```

## Relationships

- USES_HOOK → `useSession`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useEffect`

## Referenced By

- `ScreenshotDashboard` (RENDERS)

<!-- source: class-updatememberroledto.md -->

# UpdateMemberRoleDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/update-member-role.dto.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `role` | `UserRole` |

<!-- source: function-validatedocument.md -->

# validateDocument

**Kind:** Function

**Source:** `atloria-monorepo/packages/core/src/validators/document-validator.ts` (line 10)

Validates a document

## Signature

```ts
function validateDocument(doc: Partial<Document>): ValidationResult
```

## Parameters

| Name | Type |
|---|---|
| `doc` | `Partial<Document>` |

**Returns:** `ValidationResult`

<!-- source: service-webhookservice.md -->

# WebhookService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/webhooks/webhook.service.ts` (line 25)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `verifyGitHubSignature` | `verifyGitHubSignature(signature: string, body: string | Buffer, secret: string)` | `void` |
| `verifyGitLabToken` | `verifyGitLabToken(token: string, secret: string)` | `void` |
| `verifyAzureDevOpsAuth` | `verifyAzureDevOpsAuth(authHeader: string, secret: string)` | `void` |
| `findProjectByRepoUrl` | `findProjectByRepoUrl(repoUrl: string, event: 'push' | 'tag_create' | 'release')` | `unknown` |
| `getTriggerConfig` | `getTriggerConfig(projectId: string)` | `unknown` |
| `handleTagCreate` | `handleTagCreate(repoUrl: string, tagName: string, commitHash: string, provider: string, rawPayload: any, verify: WebhookVerification)` | `Promise<{ status: string; jobId?: string }>` |
| `handlePush` | `handlePush(repoUrl: string, branch: string, commitHash: string, provider: string, rawPayload: any, verify: WebhookVerification)` | `Promise<{ status: string; jobId?: string }>` |
| `handleRelease` | `handleRelease(repoUrl: string, tagName: string, releaseName: string, commitHash: string, provider: string, rawPayload: any, verify: WebhookVerification)` | `Promise<{ status: string; jobId?: string }>` |
| `generateWebhookSecret` | `generateWebhookSecret()` | `string` |

## Relationships

- DEPENDS_ON → `prismaservice`
- DEPENDS_ON → `docautomationservice`
- DEPENDS_ON → `technicaldocsservice`
- DEPENDS_ON → `docsprtrigger`
- DEPENDS_ON → `githubappservice`

<!-- source: interface-detectedangularservice.md -->

# DetectedAngularService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/angular-detector.ts` (line 58)

Detected Angular service

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `providedIn` | `'root' | 'any' | 'platform' | string` |
| `methods` | `string[]` |
| `dependencies` | `string[]` |
| `httpMethods` | `string[]` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getapitarget.md -->

# getApiTarget

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 368)

## Endpoint

`GET /technical-docs/:projectId/api-target`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: component-insertadmonition.md -->

# InsertAdmonition

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/InsertAdmonition.tsx` (line 15)

## Diagram

```mermaid
graph TD
    component_InsertAdmonition_7d1df671["InsertAdmonition"]
    class component_InsertAdmonition_7d1df671 rootComponent
```

## Relationships

- RENDERS → `ButtonOrDropdownButton`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useCellValue`
- USES_HOOK → `useTranslation`
- USES_HOOK → `useMemo`

<!-- source: constant-insertdirective.md -->

# insertDirective$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/directives/index.ts` (line 81)

A signal that inserts a new directive node with the published payload.

<!-- source: interface-rebuildoptions.md -->

# RebuildOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/reconciler.service.ts` (line 31)

S2.0 attribution for a rebuild commit. Default (absent) is unchanged behaviour: the commit
is authored AND committed by atloria-generator.

## Properties

| Property | Type |
|---|---|
| `author` | `CommitAuthor` |
| `coAuthors` | `CommitAuthor[]` |

<!-- source: interface-reduxactionpattern.md -->

# ReduxActionPattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/redux-pattern-detector.ts` (line 19)

Redux action pattern

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `actionType` | `string` |
| `line` | `number` |
| `hasPayload` | `boolean` |
| `payloadType` | `string` |
| `asyncGroup` | `{
    type: 'start' | 'success' | 'failure';
    baseName: string;
  }` |

<!-- source: function-researchcompetitorsonly.md -->

# researchCompetitorsOnly

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/ai-enhancement.ts` (line 150)

Research competitors without enhancing documentation
Useful for preview/testing

## Signature

```ts
async function researchCompetitorsOnly(aiProvider: { generateText: (prompt: string, options?: any) => Promise<string> }, projectType: string, projectDescription: string, maxCompetitors): Promise<CompetitorResearchResult>
```

## Parameters

| Name | Type |
|---|---|
| `aiProvider` | `{ generateText: (prompt: string, options?: any) => Promise<string> }` |
| `projectType` | `string` |
| `projectDescription` | `string` |
| `maxCompetitors` | `any` |

**Returns:** `Promise<CompetitorResearchResult>`

<!-- source: interface-reviewresult.md -->

# ReviewResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/self-review.ts` (line 20)

## Properties

| Property | Type |
|---|---|
| `issues` | `ReviewIssue[]` |
| `approved` | `boolean` |
| `summary` | `string` |

<!-- source: component-section.md -->

# Section

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/IssueSidePanel.tsx` (line 903)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `title` | `string` | ✓ | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Section_9863545["Section"]
    class component_Section_9863545 rootComponent
```

## Referenced By

- `IssueSidePanel` (RENDERS)

<!-- source: class-updateorganizationdto.md -->

# UpdateOrganizationDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/organization/dto/update-organization.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |

<!-- source: function-validateproject.md -->

# validateProject

**Kind:** Function

**Source:** `atloria-monorepo/packages/core/src/validators/project-validator.ts` (line 10)

Validates a project

## Signature

```ts
function validateProject(project: Partial<Project>): ValidationResult
```

## Parameters

| Name | Type |
|---|---|
| `project` | `Partial<Project>` |

**Returns:** `ValidationResult`

<!-- source: service-workflowdetectorservice.md -->

# WorkflowDetectorService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/documentation/services/workflow-detector.service.ts` (line 52)

Service for detecting business workflows from various sources

Detection strategies:
1. Business context files (workflow diagrams, process docs)
2. Navigation patterns (sequences of page visits)
3. Form sequences (multi-step processes)
4. User journey analysis (common paths through the app)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `detectWorkflows` | `detectWorkflows(appMap: any, businessContext: {
      marketing: string[];
      workflows: string[];
      brand: string[];
      processes: string[];
    })` | `Promise<DetectedWorkflow[]>` |

<!-- source: interface-detectedapicall.md -->

# DetectedAPICall

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/api-call-mapper.ts` (line 14)

A detected API call from frontend code

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `method` | `'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'` |
| `path` | `string` |
| `sourceEntityId` | `string` |
| `sourceFile` | `string` |
| `lineNumber` | `number` |
| `requestBody` | `string` |
| `responseType` | `string` |
| `apiClient` | `'fetch' | 'axios' | 'ky' | 'got' | 'custom' | 'unknown'` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getapproval.md -->

# getApproval

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 750)

## Endpoint

`GET /doc-versions/:projectId/:versionId/approval`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-insertblocknodewithexpressionattribute.md -->

# InsertBlockNodeWithExpressionAttribute

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/jsx.tsx` (line 184)

## Diagram

```mermaid
graph TD
    component_InsertBlockNodeWithExpressionAttribute_66701348["InsertBlockNodeWithExpressionAttribute"]
    class component_InsertBlockNodeWithExpressionAttribute_66701348 rootComponent
```

## Relationships

- RENDERS → `Button`
- USES_HOOK → `usePublisher`

<!-- source: constant-insertfrontmatter.md -->

# insertFrontmatter$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/frontmatter/index.ts` (line 40)

Inserts a frontmatter node at the beginning of the markdown document.

<!-- source: interface-rebuildresult.md -->

# RebuildResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/reconciler.service.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `commit` | `string` |
| `fileCount` | `number` |

<!-- source: interface-reduxreducerpattern.md -->

# ReduxReducerPattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/redux-pattern-detector.ts` (line 57)

Redux reducer pattern

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `sliceName` | `string` |
| `line` | `number` |
| `initialState` | `Record<string, unknown>` |
| `handlesActions` | `string[]` |
| `stateShape` | `Record<string, string>` |

<!-- source: function-resolveopenapischemas.md -->

# resolveOpenApiSchemas

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/schema-resolver.ts` (line 198)

Resolve request/response schemas for a set of endpoints against a ts-morph Project,
assembling OpenAPI 3.1 `paths` (with `content.application/json.schema`) and the shared
`components.schemas`. Endpoints whose method/type cannot be resolved fall back to a bare
response description — they simply carry no schema, never a broken one.

## Signature

```ts
function resolveOpenApiSchemas(project: Project, endpoints: EndpointInput[]): OpenApiFragment
```

## Parameters

| Name | Type |
|---|---|
| `project` | `Project` |
| `endpoints` | `EndpointInput[]` |

**Returns:** `OpenApiFragment`

<!-- source: interface-rollbacktooloptions.md -->

# RollbackToolOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/rollback.tool.ts` (line 11)

## Properties

| Property | Type |
|---|---|
| `checkpointManager` | `CheckpointManager` |

<!-- source: component-sectionlabel.md -->

# SectionLabel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/DeskCopilot.tsx` (line 46)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SectionLabel_52d0fa74["SectionLabel"]
    class component_SectionLabel_52d0fa74 rootComponent
```

## Referenced By

- `CustomerTabBody` (RENDERS)

<!-- source: class-updateorgsettingsdto.md -->

# UpdateOrgSettingsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/organization/dto/update-org-settings.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `allowPublicDocs` | `boolean` |
| `enableAI` | `boolean` |
| `defaultProjectVisibility` | `string` |
| `enableKnowledgeGraph` | `boolean` |
| `maxProjects` | `number` |
| `maxUsers` | `number` |

<!-- source: function-voidemitter.md -->

# voidEmitter

**Kind:** Function

**Source:** `atloria-monorepo/packages/editor/src/utils/voidEmitter.ts` (line 19)

Creates a void emitter.

<!-- source: service-workflowdiscoveryservice.md -->

# WorkflowDiscoveryService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/workflow/workflow-discovery.service.ts` (line 31)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `discoverWorkflows` | `discoverWorkflows(projectId: string, workflowSignals: WorkflowSignals, options: {
      model?: string;
      force?: boolean;
      businessContext?: BusinessContext;
    })` | `Promise<WorkflowDiscoveryResult>` |
| `estimateCost` | `estimateCost(workflowSignals: WorkflowSignals, model: string)` | `{
    inputTokens: number;
    outputTokens: number;
    costUSD: number;
  }` |
| `clearCache` | `clearCache(projectId: string)` | `void` |

## Relationships

- DEPENDS_ON → `configservice`
- DEPENDS_ON → `azureclaudeprovider`

<!-- source: interface-detecteddjangomodel.md -->

# DetectedDjangoModel

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/django-detector.ts` (line 70)

Detected Django model

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `tableName` | `string` |
| `fields` | `DjangoModelField[]` |
| `relationships` | `DjangoRelationship[]` |
| `meta` | `DjangoModelMeta` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getasset.md -->

# getAsset

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/assets/assets.controller.ts` (line 51)

## Endpoint

`GET /assets/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `AssetsController` (MODULE_DECLARES)

<!-- source: component-insertcodeblock.md -->

# InsertCodeBlock

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/InsertCodeBlock.tsx` (line 14)

## Diagram

```mermaid
graph TD
    component_InsertCodeBlock_533e1d5f["InsertCodeBlock"]
    class component_InsertCodeBlock_533e1d5f rootComponent
```

## Relationships

- RENDERS → `ButtonWithTooltip`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useCellValue`
- USES_HOOK → `useTranslation`

<!-- source: constant-insertimage.md -->

# insertImage$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 134)

A signal that inserts a new image node with the published payload.

<!-- source: interface-reduxselectorpattern.md -->

# ReduxSelectorPattern

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/redux-pattern-detector.ts` (line 92)

Redux selector pattern

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `line` | `number` |
| `isMemoized` | `boolean` |
| `statePath` | `string[]` |
| `dependsOn` | `string[]` |

<!-- source: interface-regeneratedpage.md -->

# RegeneratedPage

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-pr/page-regen.service.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `slug` | `string` |
| `kgEntityId` | `string` |
| `entityFile` | `string` |
| `before` | `string | null` |
| `after` | `string` |
| `enriched` | `boolean` |

<!-- source: function-resolveopenapischemasfromdir.md -->

# resolveOpenApiSchemasFromDir

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/schema-resolver.ts` (line 306)

Resolve schemas for endpoints against a repo directory. Scopes the ts-morph project to the
endpoints' controller files + their imports (memory-bounded); falls back to a whole-dir glob
only when no file paths are available.

## Signature

```ts
function resolveOpenApiSchemasFromDir(rootDir: string, endpoints: EndpointInput[]): OpenApiFragment
```

## Parameters

| Name | Type |
|---|---|
| `rootDir` | `string` |
| `endpoints` | `EndpointInput[]` |

**Returns:** `OpenApiFragment`

<!-- source: interface-runcontext.md -->

# RunContext

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 106)

Run context passed to tools and instruction functions.

## Properties

| Property | Type |
|---|---|
| `data` | `TContext` |
| `signal` | `AbortSignal` |
| `nestingDepth` | `number` |

<!-- source: component-select.md -->

# Select

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Documents/FilterBar.tsx` (line 77)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `label` | `string` | ✓ | - |
| `value` | `string` | ✓ | - |
| `onChange` | `Function` | ✓ | - |
| `options` | `Array` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Select_2eea87b4["Select"]
    class component_Select_2eea87b4 rootComponent
```

## Referenced By

- `FilterBar` (RENDERS)

<!-- source: class-updateprojectdto.md -->

# UpdateProjectDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/update-project.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `slug` | `string` |
| `repoUrl` | `string` |
| `repoBranch` | `string` |
| `themeId` | `string` |
| `settings` | `Record<string, unknown>` |

<!-- source: function-waitfor.md -->

# waitFor

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-core/src/test-helpers.ts` (line 17)

Helper to wait for a specific amount of time

## Signature

```ts
function waitFor(ms: number): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `ms` | `number` |

**Returns:** `Promise<void>`

<!-- source: service-workflowstorageservice.md -->

# WorkflowStorageService

**Kind:** Service

**Source:** `atloria-monorepo/apps/api/src/workflow/workflow-storage.service.ts` (line 11)

## Methods

| Method | Signature | Returns |
|---|---|---|
| `storeWorkflows` | `storeWorkflows(projectId: string, workflows: DiscoveredWorkflow[])` | `Promise<void>` |
| `getWorkflows` | `getWorkflows(projectId: string)` | `Promise<DiscoveredWorkflow[]>` |
| `deleteWorkflows` | `deleteWorkflows(projectId: string)` | `Promise<void>` |

## Relationships

- DEPENDS_ON → `neo4jservice`

<!-- source: interface-detecteddjangoserializer.md -->

# DetectedDjangoSerializer

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/django-detector.ts` (line 41)

Detected Django serializer

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `model` | `string` |
| `fields` | `DjangoField[]` |
| `readOnly` | `string[]` |
| `nestedSerializers` | `string[]` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getaudiencedocuments.md -->

# getAudienceDocuments

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 451)

## Endpoint

`GET /public/p/:slugWithId/audiences/:audienceSlug/documents`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |
| `audienceSlug` | query | `string` | ✓ |
| `version` | query | `string` | - |
| `lang` | query | `string` | - |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: component-insertfrontmatter.md -->

# InsertFrontmatter

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/InsertFrontmatter.tsx` (line 14)

## Diagram

```mermaid
graph TD
    component_InsertFrontmatter_3a44ff1f["InsertFrontmatter"]
    class component_InsertFrontmatter_3a44ff1f rootComponent
```

## Relationships

- RENDERS → `ButtonWithTooltip`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useCellValues`
- USES_HOOK → `useTranslation`

<!-- source: constant-insertjsx.md -->

# insertJsx$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/index.ts` (line 143)

A signal that inserts a new JSX node with the published payload.

<!-- source: interface-relationdefinition-2.md -->

# RelationDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 780)

Relation definition between models

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `'one-to-one' | 'one-to-many' | 'many-to-one' | 'many-to-many'` |
| `targetModel` | `string` |
| `foreignKey` | `string` |
| `onDelete` | `'CASCADE' | 'SET NULL' | 'RESTRICT' | 'NO ACTION'` |
| `onUpdate` | `'CASCADE' | 'SET NULL' | 'RESTRICT' | 'NO ACTION'` |
| `relationTable` | `string` |

<!-- source: interface-repofile.md -->

# RepoFile

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/docs-repo.service.ts` (line 52)

## Properties

| Property | Type |
|---|---|
| `path` | `string` |
| `content` | `string` |

<!-- source: interface-runoptions.md -->

# RunOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 312)

Options for running an agent.

## Properties

| Property | Type |
|---|---|
| `context` | `TContext` |
| `maxTurns` | `number` |
| `signal` | `AbortSignal` |
| `stream` | `boolean` |
| `onProgress` | `ProgressCallback` |
| `turnHook` | `TurnHook<TContext>` |
| `guardrailRetries` | `number` |
| `onAgentStart` | `(agentName: string) => void` |
| `onAgentEnd` | `(agentName: string, output: string) => void` |
| `maxOutputRecoveries` | `number` |
| `toolVerificationHook` | `ToolVerificationHook` |
| `toolPreExecutionHook` | `ToolPreExecutionHook` |
| `previousResponseId` | `string` |
| `nestingDepth` | `number` |

<!-- source: function-sanitizeenrichmentexample.md -->

# sanitizeEnrichmentExample

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/example-grounding.ts` (line 68)

If the enrichment markdown's `### Usage Example` section calls ungrounded methods on the
entity, drop that section (keeping description/diagram/instructions) and return the offending
method names. A single hallucinated call makes the whole example untrustworthy — better no
example than a lying one. Returns the possibly-rewritten content + what was dropped.

## Signature

```ts
function sanitizeEnrichmentExample(content: string, entity: Pick<Entity, 'name'> & Record<string, any>): { content: string; dropped: string[] }
```

## Parameters

| Name | Type |
|---|---|
| `content` | `string` |
| `entity` | `Pick<Entity, 'name'> & Record<string, any>` |

**Returns:** `{ content: string; dropped: string[] }`

<!-- source: component-sharerow.md -->

# ShareRow

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/AgentTrafficCockpit.tsx` (line 71)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `label` | `string` | ✓ | - |
| `count` | `number` | ✓ | - |
| `total` | `number` | ✓ | - |
| `color` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ShareRow_3a0e0e0b["ShareRow"]
    class component_ShareRow_3a0e0e0b rootComponent
```

## Referenced By

- `AgentTrafficCockpit` (RENDERS)

<!-- source: class-updatesettingsdto.md -->

# UpdateSettingsDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/project/dto/update-settings.dto.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `allowComments` | `boolean` |
| `allowSuggestions` | `boolean` |
| `autoPublish` | `boolean` |
| `defaultAudience` | `string` |
| `themeId` | `string` |

<!-- source: function-waitforelement-2.md -->

# waitForElement

**Kind:** Function

**Source:** `atloria-monorepo/packages/ui-core/src/test-helpers.ts` (line 23)

Helper to wait for an element to be updated

## Signature

```ts
async function waitForElement(element: HTMLElement): Promise<void>
```

## Parameters

| Name | Type |
|---|---|
| `element` | `HTMLElement` |

**Returns:** `Promise<void>`

<!-- source: interface-detecteddjangoview.md -->

# DetectedDjangoView

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/django-detector.ts` (line 16)

Detected Django view

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `type` | `'function' | 'class' | 'viewset' | 'apiview'` |
| `methods` | `('GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE')[]` |
| `urlPath` | `string` |
| `permissions` | `string[]` |
| `serializer` | `string` |
| `model` | `string` |
| `actions` | `string[]` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getaudiencesbyurl.md -->

# getAudiencesByUrl

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 403)

## Endpoint

`GET /public/p/:slugWithId/audiences`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |
| `version` | query | `string` | - |
| `lang` | query | `string` | - |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: component-insertimagesignal.md -->

# InsertImageSignal

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/images.tsx` (line 137)

## Diagram

```mermaid
graph TD
    component_InsertImageSignal_19edc6cd["InsertImageSignal"]
    class component_InsertImageSignal_19edc6cd rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `InsertCustomImage`

<!-- source: constant-insertmarkdown.md -->

# insertMarkdown$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 415)

Inserts new markdown value into the current cursor position of the active editor.

<!-- source: interface-relationship-2.md -->

# Relationship

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/relationship.interface.ts` (line 202)

Relationship between two entities

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `type` | `RelationshipType` |
| `sourceId` | `string` |
| `targetId` | `string` |
| `metadata` | `RelationshipMetadata` |

<!-- source: interface-reshootresult.md -->

# ReshootResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/freshness.service.ts` (line 53)

Result of the one-click screenshot re-shoot trigger.

## Properties

| Property | Type |
|---|---|
| `enqueued` | `boolean` |
| `reason` | `'no-stale-pages' | 'no-provenance'` |
| `jobId` | `string` |
| `screenSlugs` | `string[]` |
| `pagesWithoutProvenance` | `number` |

<!-- source: interface-runresult.md -->

# RunResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 123)

Result of running an agent.

## Properties

| Property | Type |
|---|---|
| `output` | `string` |
| `outputJson` | `unknown` |
| `history` | `AgentHistoryItem[]` |
| `usage` | `TokenUsage` |
| `handedOff` | `boolean` |
| `finalAgentName` | `string` |
| `raw` | `unknown` |
| `responseId` | `string` |

<!-- source: function-schematotstype.md -->

# schemaToTsType

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/sdk-generator.ts` (line 37)

JSON Schema (our pipeline's subset) → TypeScript type expression.

## Signature

```ts
function schemaToTsType(schema: JsonSchema | undefined, indent): string
```

## Parameters

| Name | Type |
|---|---|
| `schema` | `JsonSchema | undefined` |
| `indent` | `any` |

**Returns:** `string`

<!-- source: component-shimmer.md -->

# Shimmer

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/[ticketId]/page.tsx` (line 456)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `className` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Shimmer_610afd86["Shimmer"]
    class component_Shimmer_610afd86 rootComponent
```

## Referenced By

- `IssueDetailPageInner` (RENDERS)

<!-- source: class-updateuseraudiencesdto.md -->

# UpdateUserAudiencesDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/organization/dto/update-user-audiences.dto.ts` (line 7)

DTO for updating a user's audience memberships

## Properties

| Property | Type |
|---|---|
| `audienceIds` | `string[]` |

<!-- source: function-withretry.md -->

# withRetry

**Kind:** Function

**Source:** `atloria-monorepo/packages/api-client/src/utils/retry.ts` (line 77)

Retry a function with exponential backoff

## Signature

```ts
async function withRetry(fn: () => Promise<T>, options: RetryOptions): Promise<T>
```

## Parameters

| Name | Type |
|---|---|
| `fn` | `() => Promise<T>` |
| `options` | `RetryOptions` |

**Returns:** `Promise<T>`

<!-- source: interface-detecteddotnetcontroller.md -->

# DetectedDotNetController

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/dotnet-detector.ts` (line 16)

Detected .NET controller

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `route` | `string` |
| `apiVersion` | `string` |
| `endpoints` | `DotNetEndpoint[]` |
| `dependencies` | `string[]` |
| `authorization` | `string[]` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getauthurl.md -->

# getAuthUrl

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/bitbucket/bitbucket.controller.ts` (line 17)

## Endpoint

`GET /bitbucket/auth-url`

## Referenced By

- `BitbucketController` (MODULE_DECLARES)

<!-- source: component-insertmarkdowntonestededitor.md -->

# InsertMarkdownToNestedEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/insert-markdown.tsx` (line 168)

## Diagram

```mermaid
graph TD
    component_InsertMarkdownToNestedEditor_d729e25["InsertMarkdownToNestedEditor"]
    class component_InsertMarkdownToNestedEditor_d729e25 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useRef`

<!-- source: constant-inserttable.md -->

# insertTable$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/table/index.ts` (line 57)

A signal that will insert a table with the published amount of rows and columns into the active editor.

<!-- source: interface-relationshipmetadata-2.md -->

# RelationshipMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/relationship.interface.ts` (line 233)

Metadata for relationships

## Properties

| Property | Type |
|---|---|
| `props` | `string[]` |
| `httpMethod` | `string` |
| `importType` | `'named' | 'default' | 'namespace' | 'side-effect'` |
| `foreignKey` | `string` |
| `line` | `number` |
| `optional` | `boolean` |
| `lazy` | `boolean` |
| `cascade` | `string[]` |

<!-- source: interface-resolvedlanguage.md -->

# ResolvedLanguage

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/project/language.util.ts` (line 14)

Language metadata for the public viewer's i18n (RTL layout + locale switcher).

Mirrors the doc generator's `_resolve_language` (atlorix tools) so a
DocVersion.language code resolves to the same {code, base, name, dir} the
docs were written for. `dir` drives the viewer's RTL/LTR layout; `name`
(native) labels the locale switcher.

Codes are BCP-47-ish: a base language ("ar", "pt") optionally with a script
or region subtag ("pt-BR", "zh-Hant"). Resolution is base-driven so any
region variant of Arabic is still RTL and still labelled "العربية".

## Properties

| Property | Type |
|---|---|
| `code` | `string` |
| `base` | `string` |
| `name` | `string` |
| `dir` | `'ltr' | 'rtl'` |

<!-- source: interface-runtimeconfig.md -->

# RuntimeConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/runtime-config.ts` (line 55)

## Properties

| Property | Type |
|---|---|
| `loop` | `LoopConfig` |
| `model` | `ModelProviderConfig` |
| `options` | `{
    tracingDisabled?: boolean;
    handoffInputFilter?: (data: unknown) => unknown;
  }` |

<!-- source: component-sidebysidediff.md -->

# SideBySideDiff

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/documents/[id]/compare/page.tsx` (line 630)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `diffLines` | `DiffLine[]` | ✓ | - |
| `fromRevision` | `DocumentRevision | null` | ✓ | - |
| `toRevision` | `DocumentRevision | null` | ✓ | - |
| `formatDate` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SideBySideDiff_c189fe1["SideBySideDiff"]
    class component_SideBySideDiff_c189fe1 rootComponent
```

## Relationships

- RENDERS → `MarkdownRenderer`
- RENDERS → `DiffChunkBlock`

## Referenced By

- `CompareDocumentsPage` (RENDERS)

<!-- source: function-snapshothashes.md -->

# snapshotHashes

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/staleness.ts` (line 47)

Map of entityId → signature hash for a whole snapshot.

## Signature

```ts
function snapshotHashes(entities: Entity[]): Record<string, string>
```

## Parameters

| Name | Type |
|---|---|
| `entities` | `Entity[]` |

**Returns:** `Record<string, string>`

<!-- source: class-updateversionmetadatadto.md -->

# UpdateVersionMetadataDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/document/dto/update-version-metadata.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `comment` | `string` |

<!-- source: function-withretry-2.md -->

# withRetry

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/retry.ts` (line 87)

Execute an async operation with retry logic

## Signature

```ts
async function withRetry(operation: () => Promise<T>, config: RetryConfig): Promise<T>
```

## Parameters

| Name | Type |
|---|---|
| `operation` | `() => Promise<T>` |
| `config` | `RetryConfig` |

**Returns:** `Promise<T>`

<!-- source: interface-detecteddotnetservice.md -->

# DetectedDotNetService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/dotnet-detector.ts` (line 59)

Detected .NET service

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `interface` | `string` |
| `methods` | `DotNetMethod[]` |
| `dependencies` | `string[]` |
| `usesEF` | `boolean` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getauthurl-2.md -->

# getAuthUrl

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/github/github.controller.ts` (line 20)

Get the GitHub OAuth authorization URL

## Endpoint

`GET /github/auth-url`

## Referenced By

- `GitHubController` (MODULE_DECLARES)

<!-- source: component-insertmarkdownwithtableandlist.md -->

# InsertMarkdownWithTableAndList

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/insert-markdown.tsx` (line 115)

## Diagram

```mermaid
graph TD
    component_InsertMarkdownWithTableAndList_d306937["InsertMarkdownWithTableAndList"]
    class component_InsertMarkdownWithTableAndList_d306937 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `InsertComplexMarkdownButton`

<!-- source: constant-insertthematicbreak.md -->

# insertThematicBreak$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/thematic-break/index.ts` (line 13)

Inserts a thematic break at the current selection.

<!-- source: interface-relationshipwithentities-2.md -->

# RelationshipWithEntities

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/relationship.interface.ts` (line 283)

Relationship with full entity information (for graph queries)

## Properties

| Property | Type |
|---|---|
| `relationship` | `Relationship` |
| `source` | `TSource` |
| `target` | `TTarget` |

<!-- source: interface-resourceownershipspec.md -->

# ResourceOwnershipSpec

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/auth/guards/resource-org.guard.ts` (line 56)

## Properties

| Property | Type |
|---|---|
| `param` | `string` |
| `kind` | `ResourceKind` |
| `source` | `'params' | 'body' | 'query'` |
| `optional` | `boolean` |

<!-- source: interface-scoredissue.md -->

# ScoredIssue

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/confidence-filter.ts` (line 18)

Confidence-Based Code Review Filter

Parses, filters, deduplicates, and formats scored issues from multiple
review agents. Each issue has a confidence score (0-100) that determines
whether it should surface to the user.

Supports two output formats from agents:
1. Line format: `[confidence: 85] (critical/bug) file.ts:42 — Description. Suggestion: fix`
2. JSON array format: `[{"confidence": 85, "file": "...", ...}]`

## Properties

| Property | Type |
|---|---|
| `description` | `string` |
| `file` | `string` |
| `line` | `number` |
| `confidence` | `number` |
| `severity` | `'critical' | 'important' | 'minor'` |
| `category` | `string` |
| `source` | `string` |
| `suggestion` | `string` |

<!-- source: component-siteurlfield.md -->

# SiteUrlField

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/page.tsx` (line 1779)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SiteUrlField_5eb3fb03["SiteUrlField"]
    class component_SiteUrlField_5eb3fb03 rootComponent
```

## Relationships

- USES_HOOK → `useSession`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

## Referenced By

- `ProjectPage` (RENDERS)

<!-- source: function-sweepframeworkfilesforsymbols.md -->

# sweepFrameworkFilesForSymbols

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/symbol-sweep.ts` (line 18)

## Signature

```ts
async function sweepFrameworkFilesForSymbols(results: ParseResult[]): Promise<ParseResult[]>
```

## Parameters

| Name | Type |
|---|---|
| `results` | `ParseResult[]` |

**Returns:** `Promise<ParseResult[]>`

<!-- source: class-uploadassetdto.md -->

# UploadAssetDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/assets/dto/upload-asset.dto.ts` (line 5)

## Properties

| Property | Type |
|---|---|
| `audiences` | `string[]` |
| `altText` | `string` |
| `caption` | `string` |
| `tags` | `string[]` |

<!-- source: function-withretrywrapper.md -->

# withRetryWrapper

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/retry.ts` (line 142)

Create a retryable version of an async function

## Signature

```ts
function withRetryWrapper(fn: (...args: TArgs) => Promise<TResult>, config: RetryConfig): (...args: TArgs) => Promise<TResult>
```

## Parameters

| Name | Type |
|---|---|
| `fn` | `(...args: TArgs) => Promise<TResult>` |
| `config` | `RetryConfig` |

**Returns:** `(...args: TArgs) => Promise<TResult>`

<!-- source: interface-detectedendpoint.md -->

# DetectedEndpoint

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/api-call-mapper.ts` (line 40)

A detected backend endpoint

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `method` | `'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'` |
| `path` | `string` |
| `entityId` | `string` |
| `filePath` | `string` |
| `handlerName` | `string` |
| `requestType` | `string` |
| `responseType` | `string` |
| `requiredRoles` | `string[]` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getauthurl-3.md -->

# getAuthUrl

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/gitlab/gitlab.controller.ts` (line 20)

Get the GitLab OAuth authorization URL

## Endpoint

`GET /gitlab/auth-url`

## Referenced By

- `GitLabController` (MODULE_DECLARES)

<!-- source: component-insertsandpack.md -->

# InsertSandpack

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/InsertSandpack.tsx` (line 12)

## Diagram

```mermaid
graph TD
    component_InsertSandpack_6acaa0e1["InsertSandpack"]
    class component_InsertSandpack_6acaa0e1 rootComponent
```

## Relationships

- RENDERS → `ButtonOrDropdownButton`
- USES_HOOK → `useCellValues`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useMemo`
- USES_HOOK → `useTranslation`

<!-- source: constant-is-apple.md -->

# IS_APPLE

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/utils/detectMac.ts` (line 8)

Used to detect if the current platform is Apple based, mostly for keyboard shortcuts.

## Definition

```ts
boolean
```

<!-- source: interface-resolvedoperation.md -->

# ResolvedOperation

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/schema-resolver.ts` (line 28)

## Properties

| Property | Type |
|---|---|
| `requestBody` | `OpenApiRef` |
| `responses` | `Record<string, ResolvedResponse>` |

<!-- source: interface-revisionsnapshot.md -->

# RevisionSnapshot

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/services/document-revision.service.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `content` | `string` |
| `title` | `string` |
| `type` | `string` |
| `state` | `string` |
| `audienceIds` | `string[]` |
| `contentHtml` | `string` |
| `canRegenerate` | `boolean` |

<!-- source: interface-searchmodeldeployment.md -->

# SearchModelDeployment

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/web-search.tool.ts` (line 28)

Azure OpenAI model deployment for web search grounding.
Each deployment has its own rate limit bucket.

## Properties

| Property | Type |
|---|---|
| `endpoint` | `string` |
| `apiKey` | `string` |
| `model` | `string` |
| `apiVersion` | `string` |
| `useV1Endpoint` | `boolean` |

<!-- source: component-sortabledocumentitem.md -->

# SortableDocumentItem

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/PublishingSidebar/SortableDocumentList.tsx` (line 72)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `document` | `Document` | ✓ | - |
| `isSelected` | `boolean` | ✓ | - |
| `editMode` | `boolean` | ✓ | - |
| `onSelect` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SortableDocumentItem_6869a021["SortableDocumentItem"]
    class component_SortableDocumentItem_6869a021 rootComponent
```

## Relationships

- RENDERS → `GripVertical`
- RENDERS → `FileText`
- USES_HOOK → `useSortable`

## Referenced By

- `SortableDocumentList` (RENDERS)

<!-- source: class-userresponsedto.md -->

# UserResponseDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/auth/dto/auth-response.dto.ts` (line 5)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `email` | `string` |
| `name` | `string` |
| `role` | `UserRole` |
| `organizationId` | `string` |
| `createdAt` | `Date` |
| `updatedAt` | `Date` |

<!-- source: function-validatecitations.md -->

# validateCitations

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/grounded-ask.ts` (line 45)

Keep only citations that correspond to a retrieved source path (drop hallucinated ones).

## Signature

```ts
function validateCitations(answer: string, context: DocSearchHit[]): string[]
```

## Parameters

| Name | Type |
|---|---|
| `answer` | `string` |
| `context` | `DocSearchHit[]` |

**Returns:** `string[]`

<!-- source: function-wraperror.md -->

# wrapError

**Kind:** Function

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/errors.ts` (line 260)

Utility to wrap unknown errors in PipelineError

## Signature

```ts
function wrapError(error: unknown, stage: JobStage, message: string): PipelineError
```

## Parameters

| Name | Type |
|---|---|
| `error` | `unknown` |
| `stage` | `JobStage` |
| `message` | `string` |

**Returns:** `PipelineError`

<!-- source: interface-detectedexpressmiddleware.md -->

# DetectedExpressMiddleware

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/express-detector.ts` (line 40)

Detected Express middleware

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `type` | `'error' | 'auth' | 'validation' | 'logging' | 'custom'` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getboardsforissue.md -->

# getBoardsForIssue

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 189)

## Endpoint

`GET /projects/:projectId/issues/:issueId/boards`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `issueId` | query | `string` | ✓ |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: component-insertsimplemarkdown.md -->

# InsertSimpleMarkdown

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/insert-markdown.tsx` (line 75)

## Diagram

```mermaid
graph TD
    component_InsertSimpleMarkdown_4059f692["InsertSimpleMarkdown"]
    class component_InsertSimpleMarkdown_4059f692 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `InsertSimpleMarkdownButton`

<!-- source: constant-is-bold.md -->

# IS_BOLD

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/FormatConstants.ts` (line 3)

<!-- source: interface-resolvedresponse.md -->

# ResolvedResponse

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/openapi/schema-resolver.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `description` | `string` |
| `schema` | `Record<string, unknown>` |

<!-- source: interface-savedocumentresult.md -->

# SaveDocumentResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/collaboration/interfaces/collaboration.interfaces.ts` (line 91)

Result of saving document state

## Properties

| Property | Type |
|---|---|
| `success` | `boolean` |
| `version` | `number` |
| `savedAt` | `Date` |

<!-- source: interface-searchresult-3.md -->

# SearchResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/types.ts` (line 36)

A search hit.

## Properties

| Property | Type |
|---|---|
| `chunk` | `CodeChunk` |
| `score` | `number` |
| `vectorScore` | `number` |
| `bm25Score` | `number` |

<!-- source: component-sparkline.md -->

# Sparkline

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/DeflectionCockpit.tsx` (line 40)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `values` | `number[]` | ✓ | - |
| `color` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Sparkline_640a15d8["Sparkline"]
    class component_Sparkline_640a15d8 rootComponent
```

## Referenced By

- `KpiCard` (RENDERS)

<!-- source: function-validatecoverage.md -->

# validateCoverage

**Kind:** Function

**Source:** `atloria-monorepo/libs/parser-core/src/utils/coverage-validator.ts` (line 182)

Validate coverage against thresholds

## Signature

```ts
function validateCoverage(entities: Entity[], screenshots: EnhancedScreenshotMetadata[], interactions: UIInteraction[], thresholds: CoverageThresholds): ValidationReport
```

## Parameters

| Name | Type |
|---|---|
| `entities` | `Entity[]` |
| `screenshots` | `EnhancedScreenshotMetadata[]` |
| `interactions` | `UIInteraction[]` |
| `thresholds` | `CoverageThresholds` |

**Returns:** `ValidationReport`

<!-- source: class-verifyemaildto.md -->

# VerifyEmailDto

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/auth/dto/password.dto.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `token` | `string` |

<!-- source: interface-detectedexpressroute.md -->

# DetectedExpressRoute

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/express-detector.ts` (line 16)

Detected Express route

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `filePath` | `string` |
| `method` | `'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'ALL'` |
| `path` | `string` |
| `handlerName` | `string` |
| `middleware` | `string[]` |
| `queryParams` | `string[]` |
| `routeParams` | `string[]` |
| `bodyType` | `string` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getbranding.md -->

# getBranding

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/branding/branding.controller.ts` (line 13)

## Endpoint

`GET /projects/:projectId/branding`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `BrandingController` (MODULE_DECLARES)

<!-- source: component-inserttable.md -->

# InsertTable

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/InsertTable.tsx` (line 22)

## Diagram

```mermaid
graph TD
    component_InsertTable_ede8c9f["InsertTable"]
    class component_InsertTable_ede8c9f rootComponent
```

## Relationships

- RENDERS → `ButtonWithTooltip`
- USES_HOOK → `useCellValue`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useTranslation`

<!-- source: constant-is-code.md -->

# IS_CODE

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/FormatConstants.ts` (line 7)

<!-- source: interface-responsedefinition-2.md -->

# ResponseDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 636)

Response definition

## Properties

| Property | Type |
|---|---|
| `statusCode` | `number` |
| `description` | `string` |
| `schema` | `SchemaDefinition` |
| `examples` | `Record<string, unknown>` |

<!-- source: interface-screenshotstatus.md -->

# ScreenshotStatus

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/doc-version/screenshot-staleness.service.ts` (line 5)

## Properties

| Property | Type |
|---|---|
| `routePath` | `string` |
| `status` | `StalenessLevel` |
| `assetUrl` | `string` |
| `capturedAt` | `string` |
| `fromVersionNumber` | `number` |
| `age` | `number` |
| `reason` | `string` |

<!-- source: interface-sectioncontext.md -->

# SectionContext

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/prompt-sections.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `mode` | `TaskMode` |
| `modelProfile` | `ModelCapabilityProfile` |

<!-- source: component-stat.md -->

# Stat

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/ops/page.tsx` (line 29)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `label` | `string` | ✓ | - |
| `value` | `unknown` | ✓ | - |
| `sub` | `string` | - | - |
| `tone` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_Stat_72419b77["Stat"]
    class component_Stat_72419b77 rootComponent
```

## Referenced By

- `OpsPage` (RENDERS)

<!-- source: class-writenotpermittederror.md -->

# WriteNotPermittedError

**Kind:** Class

**Source:** `atloria-monorepo/apps/api/src/docs-pr/git-write/git-write.adapter.ts` (line 38)

Thrown when the repo cannot be written — the GitHub App lacks contents:write /
pull_requests:write (the installation hasn't re-consented), or no installation/token
is available. The orchestrator records this as status:'error' and NEVER touches the
repo, so the feature degrades gracefully instead of breaking anything.

**Extends:** `Error`

<!-- source: interface-detectedfastapiroute.md -->

# DetectedFastAPIRoute

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/fastapi-detector.ts` (line 16)

Detected FastAPI route

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `filePath` | `string` |
| `method` | `'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'` |
| `path` | `string` |
| `functionName` | `string` |
| `requestModel` | `string` |
| `responseModel` | `string` |
| `dependencies` | `string[]` |
| `tags` | `string[]` |
| `deprecated` | `boolean` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getbycustomdomain.md -->

# getByCustomDomain

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 136)

## Endpoint

`GET /public/domain/:host`

| Parameter | In | Type | Required |
|---|---|---|---|
| `host` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: component-insertthematicbreak.md -->

# InsertThematicBreak

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/InsertThematicBreak.tsx` (line 12)

## Diagram

```mermaid
graph TD
    component_InsertThematicBreak_1b8faf9f["InsertThematicBreak"]
    class component_InsertThematicBreak_1b8faf9f rootComponent
```

## Relationships

- RENDERS → `ButtonWithTooltip`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useCellValue`
- USES_HOOK → `useTranslation`

<!-- source: constant-is-highlight.md -->

# IS_HIGHLIGHT

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/FormatConstants.ts` (line 10)

<!-- source: interface-route.md -->

# Route

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 124)

## Properties

| Property | Type |
|---|---|
| `path` | `string` |
| `component` | `string` |
| `method` | `string` |
| `parameters` | `string[]` |
| `guards` | `string[]` |
| `filePath` | `string` |
| `lineNumber` | `number` |

<!-- source: interface-searchdocument.md -->

# SearchDocument

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/azure-search.service.ts` (line 14)

Document to be indexed in Azure AI Search

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `documentType` | `'workflow' | 'feature' | 'tutorial' | 'user_manual' | 'technical_ref'` |
| `title` | `string` |
| `description` | `string` |
| `content` | `string` |
| `keywords` | `string[]` |
| `category` | `string` |
| `categoryId` | `string` |
| `categoryPath` | `string` |
| `collectionId` | `string` |
| `collectionName` | `string` |
| `parentDocumentId` | `string` |
| `parentDocumentTitle` | `string` |
| `breadcrumbs` | `string[]` |
| `difficulty` | `string` |
| `estimatedTime` | `string` |
| `audiences` | `string[]` |
| `createdAt` | `Date` |
| `updatedAt` | `Date` |
| `docVersionId` | `string` |
| `versionNumber` | `number` |

<!-- source: interface-semanticindexconfig.md -->

# SemanticIndexConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/types.ts` (line 44)

Configuration for the semantic index.

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `embeddingEndpoint` | `string` |
| `embeddingApiKey` | `string` |
| `embeddingModel` | `string` |
| `storageDir` | `string` |
| `targetChunkTokens` | `number` |
| `maxFiles` | `number` |
| `includeExtensions` | `string[]` |
| `excludeDirs` | `string[]` |

<!-- source: component-statcard-2.md -->

# StatCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/page.tsx` (line 239)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `icon` | `unknown` | ✓ | - |
| `label` | `string` | ✓ | - |
| `value` | `number` | ✓ | - |
| `color` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StatCard_4d0fd575["StatCard"]
    class component_StatCard_4d0fd575 rootComponent
```

## Referenced By

- `ProjectsPage` (RENDERS)

<!-- source: interface-detectedjpaentity.md -->

# DetectedJPAEntity

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/spring-detector.ts` (line 92)

Detected JPA entity

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `tableName` | `string` |
| `fields` | `JPAField[]` |
| `relationships` | `JPARelationship[]` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getbyid-3.md -->

# getById

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/comment/comment.controller.ts` (line 113)

Get a single comment by ID

## Endpoint

`GET /documents/:documentId/comments/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `CommentController` (MODULE_DECLARES)

<!-- source: constant-is-italic.md -->

# IS_ITALIC

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/FormatConstants.ts` (line 4)

<!-- source: component-jsxeditorcontainer.md -->

# JsxEditorContainer

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/LexicalJsxNode.tsx` (line 105)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `parentEditor` | `LexicalEditor` | ✓ | - |
| `lexicalJsxNode` | `LexicalJsxNode` | ✓ | - |
| `mdastNode` | `MdastJsx` | ✓ | - |
| `config` | `EditorConfig` | ✓ | - |
| `focusEmitter` | `VoidEmitter` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_JsxEditorContainer_7000f178["JsxEditorContainer"]
    class component_JsxEditorContainer_7000f178 rootComponent
```

## Relationships

- RENDERS → `NestedEditorsContext-Provider`
- RENDERS → `Editor`
- USES_HOOK → `useCellValue`

<!-- source: interface-routerlinkelement.md -->

# RouterLinkElement

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/template-analysis.interface.ts` (line 140)

Router link element (routerLink, router-link)

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `path` | `string` |
| `isDynamic` | `boolean` |
| `line` | `number` |
| `conditionalOn` | `string` |
| `params` | `Record<string, string>` |

<!-- source: interface-searchdocumentsresult.md -->

# SearchDocumentsResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/dto/search-document.dto.ts` (line 115)

Search result response

## Properties

| Property | Type |
|---|---|
| `results` | `any[]` |
| `total` | `number` |
| `facets` | `SearchFacets` |
| `query` | `string` |
| `took` | `number` |

<!-- source: interface-semanticsearchtooloptions.md -->

# SemanticSearchToolOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/semantic-search.tool.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `embeddingEndpoint` | `string` |
| `embeddingApiKey` | `string` |
| `embeddingModel` | `string` |
| `storageDir` | `string` |
| `includeExtensions` | `string[]` |
| `excludeDirs` | `string[]` |
| `maxFiles` | `number` |

<!-- source: component-statcard-3.md -->

# StatCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/UsageDashboard.tsx` (line 135)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `label` | `string` | ✓ | - |
| `value` | `string` | ✓ | - |
| `icon` | `string` | ✓ | - |
| `bgColor` | `string` | ✓ | - |
| `textColor` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StatCard_6eca61b2["StatCard"]
    class component_StatCard_6eca61b2 rootComponent
```

## Referenced By

- `UsageDashboard` (RENDERS)

<!-- source: interface-detectednestjscontroller.md -->

# DetectedNestJSController

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/nestjs-detector.ts` (line 16)

Detected NestJS controller

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `path` | `string` |
| `version` | `string` |
| `endpoints` | `NestJSEndpoint[]` |
| `dependencies` | `string[]` |
| `guards` | `string[]` |
| `interceptors` | `string[]` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getbyid-4.md -->

# getById

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/template/template.controller.ts` (line 60)

Get a single template by ID.

## Endpoint

`GET /templates/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `TemplateController` (MODULE_DECLARES)

<!-- source: constant-is-strikethrough.md -->

# IS_STRIKETHROUGH

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/FormatConstants.ts` (line 5)

<!-- source: component-jsxexpression.md -->

# JsxExpression

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/jsx.tsx` (line 136)

## Diagram

```mermaid
graph TD
    component_JsxExpression_23fa3ae7["JsxExpression"]
    class component_JsxExpression_23fa3ae7 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: interface-scannedfile.md -->

# ScannedFile

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/file-scanner.ts` (line 19)

Scanned file information

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `relativePath` | `string` |
| `size` | `number` |
| `extension` | `string` |
| `fileName` | `string` |
| `modifiedAt` | `Date` |
| `content` | `string` |

<!-- source: interface-searchfacets.md -->

# SearchFacets

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/dto/search-document.dto.ts` (line 105)

Search facets for filtering

## Properties

| Property | Type |
|---|---|
| `byState` | `Record<string, number>` |
| `byType` | `Record<string, number>` |
| `byAuthor` | `Record<string, number>` |
| `byCategory` | `Record<string, number>` |

<!-- source: interface-sendmessageoptions.md -->

# SendMessageOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/send-message.tool.ts` (line 59)

## Properties

| Property | Type |
|---|---|
| `bus` | `MessageBus` |

<!-- source: component-statusbadge.md -->

# StatusBadge

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/enterprise/screenshots/page.tsx` (line 22)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `status` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StatusBadge_3a39041b["StatusBadge"]
    class component_StatusBadge_3a39041b rootComponent
```

## Referenced By

- `ScreenshotsPage` (RENDERS)

<!-- source: interface-detectednestjsservice.md -->

# DetectedNestJSService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/nestjs-detector.ts` (line 69)

Detected NestJS service

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `methods` | `NestJSMethod[]` |
| `dependencies` | `string[]` |
| `usesPrisma` | `boolean` |
| `usesTypeORM` | `boolean` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getbysubdomain.md -->

# getBySubdomain

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 106)

## Endpoint

`GET /public/subdomain/:slug`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slug` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-is-subscript.md -->

# IS_SUBSCRIPT

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/FormatConstants.ts` (line 8)

<!-- source: component-jsxfragment.md -->

# JsxFragment

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/jsx.tsx` (line 150)

## Diagram

```mermaid
graph TD
    component_JsxFragment_4682ada1["JsxFragment"]
    class component_JsxFragment_4682ada1 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: interface-schemadefinition-2.md -->

# SchemaDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 599)

Schema definition for request/response bodies

## Properties

| Property | Type |
|---|---|
| `type` | `string` |
| `properties` | `Record<string, PropertyDefinition>` |
| `required` | `string[]` |
| `$ref` | `string` |

<!-- source: interface-searchoptions.md -->

# SearchOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/azure-search.service.ts` (line 54)

Search query options

## Properties

| Property | Type |
|---|---|
| `organizationId` | `string` |
| `projectId` | `string` |
| `documentType` | `'workflow' | 'feature' | 'tutorial' | 'user_manual' | 'technical_ref'` |
| `category` | `string` |
| `difficulty` | `'beginner' | 'intermediate' | 'advanced'` |
| `audience` | `string` |
| `docVersionId` | `string` |
| `limit` | `number` |
| `offset` | `number` |
| `includeFacets` | `boolean` |

<!-- source: interface-sessioncontext.md -->

# SessionContext

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/session-memory.ts` (line 41)

Input for memory extraction.

## Properties

| Property | Type |
|---|---|
| `task` | `string` |
| `history` | `AgentHistoryItem[]` |
| `notes` | `AgentNote[]` |
| `qualityGates` | `{ id: string; description: string; passed: boolean }[]` |
| `durationSeconds` | `number` |
| `turnCount` | `number` |

<!-- source: component-statusbadge-2.md -->

# StatusBadge

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/ProviderConfig.tsx` (line 114)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `available` | `boolean` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StatusBadge_429048bd["StatusBadge"]
    class component_StatusBadge_429048bd rootComponent
```

## Referenced By

- `ProviderConfig` (RENDERS)

<!-- source: interface-detectednextjsapiroute.md -->

# DetectedNextJSAPIRoute

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/nextjs-detector.ts` (line 44)

Detected Next.js API route

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `filePath` | `string` |
| `routePath` | `string` |
| `methods` | `('GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE')[]` |
| `isAppRouter` | `boolean` |
| `requestType` | `string` |
| `responseType` | `string` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getbyurl.md -->

# getByUrl

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/public-document.controller.ts` (line 64)

## Endpoint

`GET /public/doc/:slugWithId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |

## Referenced By

- `PublicDocumentController` (MODULE_DECLARES)

<!-- source: constant-is-superscript.md -->

# IS_SUPERSCRIPT

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/FormatConstants.ts` (line 9)

<!-- source: component-jsximage.md -->

# JsxImage

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/images.tsx` (line 195)

## Diagram

```mermaid
graph TD
    component_JsxImage_3f1fc077["JsxImage"]
    class component_JsxImage_3f1fc077 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`

<!-- source: interface-screenshotinstruction.md -->

# ScreenshotInstruction

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/screenshot-instruction-generator.ts` (line 29)

Single screenshot instruction

## Properties

| Property | Type |
|---|---|
| `priority` | `'critical' | 'high' | 'medium' | 'low'` |
| `stateMachine` | `string` |
| `state` | `string` |
| `component` | `string` |
| `componentPath` | `string` |
| `url` | `string` |
| `queryParams` | `Record<string, string>` |
| `setupSteps` | `string[]` |
| `filename` | `string` |
| `notes` | `string[]` |
| `availableTransitions` | `string[]` |
| `requiresApproval` | `boolean` |
| `isTerminal` | `boolean` |

<!-- source: interface-searchquery.md -->

# SearchQuery

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/web-search/interfaces/search.interfaces.ts` (line 17)

## Properties

| Property | Type |
|---|---|
| `query` | `string` |
| `categories` | `string[]` |
| `limit` | `number` |
| `minScore` | `number` |

<!-- source: interface-sessioneventmap.md -->

# SessionEventMap

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/types.ts` (line 44)

Typed event map for AgentSession.
Consumers call `session.on('tool_start', (e) => ...)` with full type safety.

## Properties

| Property | Type |
|---|---|
| `agent_thinking` | `{ agentName: string }` |
| `tool_start` | `{ toolName: string; input: string }` |
| `tool_end` | `{ toolName: string; outputPreview: string; durationMs: number }` |
| `agent_message` | `{ text: string; agentName: string; delta?: boolean }` |
| `turn_complete` | `{ turnNumber: number; usage: TokenUsage }` |
| `session_complete` | `{ totalUsage: TokenUsage; turnCount: number }` |
| `error` | `{ error: Error; recoverable: boolean }` |
| `status` | `{ code: string; message: string }` |
| `user_input_queued` | `{ message: string; position: number }` |
| `plan_ready` | `{ plan: string }` |
| `plan_approved` | `{}` |
| `model_switched` | `{ from: string; to: string; reason: string }` |
| `verbose` | `{ category: string; message: string; data?: Record<string, unknown>; timestamp: number }` |
| `session_start` | `{ model: string; workspace?: string }` |
| `session_end` | `{ totalUsage: TokenUsage; turnCount: number; reason: 'completed' | 'error' | 'cancelled' }` |
| `pre_compact` | `{ turnNumber: number; tokenCount: number; recentFiles: string[] }` |
| `post_compact` | `{ turnNumber: number; summaryInjected: boolean }` |
| `subagent_start` | `{ agentName: string; task: string }` |
| `subagent_end` | `{ agentName: string; output: string; durationMs: number }` |
| `user_prompt_submit` | `{ message: string }` |

<!-- source: component-statusbadge-3.md -->

# StatusBadge

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/RequestHistory.tsx` (line 152)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `status` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StatusBadge_2b1de691["StatusBadge"]
    class component_StatusBadge_2b1de691 rootComponent
```

## Referenced By

- `RequestHistory` (RENDERS)

<!-- source: interface-detectednextjspage.md -->

# DetectedNextJSPage

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/nextjs-detector.ts` (line 17)

Detected Next.js page/component

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `routerType` | `'app' | 'pages'` |
| `routePath` | `string` |
| `renderingType` | `'server' | 'client' | 'unknown'` |
| `isStaticRoute` | `boolean` |
| `hasLoadingState` | `boolean` |
| `hasErrorBoundary` | `boolean` |
| `hasMetadata` | `boolean` |
| `dataFetching` | `('fetch' | 'getServerSideProps' | 'getStaticProps' | 'use')[]` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getbyurl-2.md -->

# getByUrl

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 151)

## Endpoint

`GET /public/p/:slugWithId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-is-underline.md -->

# IS_UNDERLINE

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/FormatConstants.ts` (line 6)

<!-- source: component-kitchensinktoolbar.md -->

# KitchenSinkToolbar

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/KitchenSinkToolbar.tsx` (line 40)

## Diagram

```mermaid
graph TD
    component_KitchenSinkToolbar_2b1e513d["KitchenSinkToolbar"]
    class component_KitchenSinkToolbar_2b1e513d rootComponent
```

## Relationships

- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `ConditionalContents`
- RENDERS → `ChangeCodeMirrorLanguage`
- RENDERS → `ShowSandpackInfo`
- RENDERS → `UndoRedo`
- RENDERS → `Separator`
- RENDERS → `BoldItalicUnderlineToggles`
- RENDERS → `CodeToggle`
- RENDERS → `HighlightToggle`
- RENDERS → `StrikeThroughSupSubToggles`
- RENDERS → `ListsToggle`
- RENDERS → `ChangeAdmonitionType`
- RENDERS → `BlockTypeSelect`
- RENDERS → `CreateLink`
- RENDERS → `InsertImage`
- RENDERS → `InsertTable`
- RENDERS → `InsertThematicBreak`
- RENDERS → `InsertCodeBlock`
- RENDERS → `InsertSandpack`
- RENDERS → `InsertAdmonition`
- RENDERS → `InsertFrontmatter`

<!-- source: interface-screenshotmetadata-2.md -->

# ScreenshotMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/storage.interface.ts` (line 20)

Screenshot metadata for intelligent regeneration

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `url` | `string` |
| `viewport` | `{
    width: number;
    height: number;
  }` |
| `stateType` | `'default' | 'hover' | 'modal' | 'error' | 'success' | 'loading'` |
| `flowStepId` | `string` |
| `browser` | `'chromium' | 'firefox' | 'webkit'` |
| `fullPage` | `boolean` |
| `contentHash` | `string` |
| `capturedAt` | `Date` |
| `customMetadata` | `Record<string, string>` |

<!-- source: interface-searchresponse.md -->

# SearchResponse

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/azure-search.service.ts` (line 84)

Search response with facets

## Properties

| Property | Type |
|---|---|
| `results` | `SearchResult[]` |
| `total` | `number` |
| `facets` | `{
    documentType?: Record<string, number>;
    category?: Record<string, number>;
    difficulty?: Record<string, number>;
  }` |

<!-- source: interface-sessionjournalconfig.md -->

# SessionJournalConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/session-journal.ts` (line 40)

## Properties

| Property | Type |
|---|---|
| `workDir` | `string` |
| `filename` | `string` |
| `maxEntries` | `number` |

<!-- source: component-statusbadge-4.md -->

# StatusBadge

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Suggestions/SuggestionCard.tsx` (line 140)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `status` | `unknown | unknown | unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StatusBadge_4325f69b["StatusBadge"]
    class component_StatusBadge_4325f69b rootComponent
```

## Referenced By

- `SuggestionCard` (RENDERS)

<!-- source: interface-detectedpydanticmodel.md -->

# DetectedPydanticModel

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/fastapi-detector.ts` (line 42)

Detected Pydantic model

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `baseClass` | `string` |
| `fields` | `PydanticField[]` |
| `validators` | `string[]` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getbyurlwithaudience.md -->

# getByUrlWithAudience

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/public-document.controller.ts` (line 21)

## Endpoint

`GET /public/doc/:audience/:slugWithId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `audience` | query | `string` | ✓ |
| `slugWithId` | query | `string` | ✓ |

## Referenced By

- `PublicDocumentController` (MODULE_DECLARES)

<!-- source: constant-jsxcomponentdescriptors.md -->

# jsxComponentDescriptors$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 307)

Contains the currently registered JSX component descriptors.

<!-- source: component-landingpage.md -->

# LandingPage

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/pages/LandingPage.tsx` (line 10)

## Diagram

```mermaid
graph TD
    component_LandingPage_6446a245["LandingPage"]
    class component_LandingPage_6446a245 rootComponent
```

## Relationships

- RENDERS → `SEO`

<!-- source: interface-screenshotplan.md -->

# ScreenshotPlan

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/screenshot-instruction-generator.ts` (line 136)

Complete screenshot plan

## Properties

| Property | Type |
|---|---|
| `coverageReport` | `CoverageReport` |
| `instructions` | `ScreenshotInstruction[]` |
| `workflows` | `WorkflowSequence[]` |
| `totalScreenshots` | `number` |
| `estimatedMinutes` | `number` |
| `summary` | `{
    critical: number;
    high: number;
    medium: number;
    low: number;
  }` |

<!-- source: interface-searchresult.md -->

# SearchResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/web-search/interfaces/search.interfaces.ts` (line 5)

Search-related interfaces for web search and competitor docs

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `url` | `string` |
| `content` | `string` |
| `snippet` | `string` |
| `category` | `string[]` |
| `source` | `string` |
| `lastCrawled` | `Date` |
| `score` | `number` |

<!-- source: interface-sessionmanagerconfig.md -->

# SessionManagerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/session-manager.ts` (line 24)

<!-- source: component-statusicon.md -->

# StatusIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/BatchFileProcessor.tsx` (line 232)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `status` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StatusIcon_47b9dfd5["StatusIcon"]
    class component_StatusIcon_47b9dfd5 rootComponent
```

## Referenced By

- `BatchFileProcessor` (RENDERS)

<!-- source: interface-detectedreactcomponent.md -->

# DetectedReactComponent

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/react-detector.ts` (line 13)

Detected React component

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `type` | `'functional' | 'class'` |
| `filePath` | `string` |
| `propsType` | `string` |
| `stateManagement` | `string[]` |
| `hooks` | `string[]` |
| `childComponents` | `string[]` |
| `eventHandlers` | `string[]` |
| `formElements` | `string[]` |
| `apiCalls` | `string[]` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getcapabilities.md -->

# getCapabilities

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 606)

## Endpoint

`GET /public/p/:slugWithId/capabilities`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |
| `version` | query | `string` | - |
| `lang` | query | `string` | - |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-jsxisavailable.md -->

# jsxIsAvailable$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 301)

This JSX plugin will fill this value.

<!-- source: component-languageswitcher-2.md -->

# LanguageSwitcher

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/language-switcher.tsx` (line 13)

## Diagram

```mermaid
graph TD
    component_LanguageSwitcher_2ec54755["LanguageSwitcher"]
    class component_LanguageSwitcher_2ec54755 rootComponent
```

## Relationships

- RENDERS → `Globe`
- USES_HOOK → `useTranslation`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-screenshotsaveresult.md -->

# ScreenshotSaveResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/storage.interface.ts` (line 78)

Screenshot save result

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `url` | `string` |
| `filePath` | `string` |
| `version` | `number` |
| `isNew` | `boolean` |

<!-- source: interface-searchresult-2.md -->

# SearchResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/azure-search.service.ts` (line 70)

Search result item

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `description` | `string` |
| `snippet` | `string` |
| `documentType` | `string` |
| `category` | `string` |
| `difficulty` | `string` |
| `score` | `number` |

<!-- source: interface-sessionmemory.md -->

# SessionMemory

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/session-memory.ts` (line 27)

A memory extracted from a session.

## Properties

| Property | Type |
|---|---|
| `category` | `'pattern' | 'pitfall' | 'environment' | 'optimization'` |
| `title` | `string` |
| `content` | `string` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: component-statusjourney.md -->

# StatusJourney

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/[ticketId]/page.tsx` (line 181)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `current` | `string` | ✓ | - |
| `size` | `unknown | unknown` | - | "sm" |

## Diagram

```mermaid
graph TD
    component_StatusJourney_91ed227["StatusJourney"]
    class component_StatusJourney_91ed227 rootComponent
```

## Relationships

- RENDERS → `React-Fragment`
- RENDERS → `motion-div`
- RENDERS → `opt-icon`

## Referenced By

- `IssueDetailPageInner` (RENDERS)

<!-- source: interface-detectedspringcontroller.md -->

# DetectedSpringController

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/spring-detector.ts` (line 16)

Detected Spring controller

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `basePath` | `string` |
| `isRestController` | `boolean` |
| `endpoints` | `SpringEndpoint[]` |
| `dependencies` | `string[]` |
| `security` | `string[]` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getchangelog.md -->

# getChangelog

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 469)

## Endpoint

`GET /doc-versions/:projectId/:versionId/changelog`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: constant-jsxplugin.md -->

# jsxPlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/index.ts` (line 224)

a plugin that adds support for JSX elements (MDX).

<!-- source: component-lexicalautolinkplugin.md -->

# LexicalAutoLinkPlugin

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/link/AutoLinkPlugin.tsx` (line 26)

## Diagram

```mermaid
graph TD
    component_LexicalAutoLinkPlugin_5f60c401["LexicalAutoLinkPlugin"]
    class component_LexicalAutoLinkPlugin_5f60c401 rootComponent
```

## Relationships

- RENDERS → `AutoLinkPlugin`

<!-- source: interface-screenshotstatecontext.md -->

# ScreenshotStateContext

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/screenshot.interface.ts` (line 126)

Screenshot with state context
Used internally to associate screenshots with parsed component data

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `componentId` | `string` |
| `componentName` | `string` |
| `detectedState` | `string` |
| `confidence` | `number` |
| `detectionMethod` | `string` |

<!-- source: interface-sectiondiff.md -->

# SectionDiff

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/change-request/diff.types.ts` (line 3)

## Properties

| Property | Type |
|---|---|
| `heading` | `string` |
| `level` | `number` |
| `changed` | `boolean` |

<!-- source: interface-sessionmeta.md -->

# SessionMeta

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/session-store.ts` (line 23)

Metadata stored per session — used for listing without loading full history

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `workspace` | `string` |
| `model` | `string` |
| `createdAt` | `number` |
| `updatedAt` | `number` |
| `status` | `'active' | 'completed' | 'error'` |
| `sendCount` | `number` |
| `turnCount` | `number` |
| `totalUsage` | `TokenUsage` |
| `title` | `string` |

<!-- source: component-statusjourney-2.md -->

# StatusJourney

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/issues/[ticketNumber]/page.tsx` (line 205)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `current` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StatusJourney_53ae911d["StatusJourney"]
    class component_StatusJourney_53ae911d rootComponent
```

## Referenced By

- `PublicTicketPage` (RENDERS)

<!-- source: interface-detectedspringservice.md -->

# DetectedSpringService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/spring-detector.ts` (line 56)

Detected Spring service

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `methods` | `SpringMethod[]` |
| `dependencies` | `string[]` |
| `isTransactional` | `boolean` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getchathistory.md -->

# getChatHistory

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.controller.ts` (line 168)

## Endpoint

`GET /support-agent/:projectId/agents/:agentId/history`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `agentId` | query | `string` | ✓ |
| `limit` | query | `string` | - |

## Referenced By

- `SupportAgentController` (MODULE_DECLARES)

<!-- source: constant-lexicalfrontmattervisitor.md -->

# LexicalFrontmatterVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/frontmatter/LexicalFrontmatterVisitor.ts` (line 5)

## Definition

```ts
LexicalExportVisitor<FrontmatterNode, Mdast.YAML>
```

<!-- source: component-lexicalprovider.md -->

# LexicalProvider

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/MDXEditor.tsx` (line 47)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_LexicalProvider_68752f28["LexicalProvider"]
    class component_LexicalProvider_68752f28 rootComponent
```

## Relationships

- RENDERS → `LexicalComposerContext-Provider`
- USES_HOOK → `useCellValue`
- USES_HOOK → `useMemo`

<!-- source: interface-searchindex.md -->

# SearchIndex

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/search-index.generator.ts` (line 41)

Search index

## Properties

| Property | Type |
|---|---|
| `entries` | `SearchIndexEntry[]` |
| `metadata` | `SearchIndexMetadata` |

<!-- source: interface-selectionrange-2.md -->

# SelectionRange

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/collaboration/interfaces/collaboration.interfaces.ts` (line 38)

Selection range in the document

## Properties

| Property | Type |
|---|---|
| `anchor` | `number` |
| `head` | `number` |

<!-- source: interface-sessionoptions.md -->

# SessionOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/types.ts` (line 107)

## Properties

| Property | Type |
|---|---|
| `maxTurns` | `number` |
| `context` | `TContext` |
| `turnHook` | `TurnHook<TContext>` |
| `stream` | `boolean` |
| `toolVerificationHook` | `ToolVerificationHook` |
| `toolPreExecutionHook` | `ToolPreExecutionHook` |
| `guardrailRetries` | `number` |
| `maxOutputRecoveries` | `number` |
| `enableInjection` | `boolean` |
| `postCompactionHook` | `PostCompactionHook` |
| `planMode` | `boolean` |
| `hardPlanMode` | `boolean` |
| `architectModel` | `string` |
| `implementModel` | `string` |
| `verbose` | `boolean` |
| `onUserPromptSubmit` | `(message: string) => Promise<{ blocked: boolean; blockReason?: string }>` |
| `workspace` | `string` |

<!-- source: component-statusjourney-3.md -->

# StatusJourney

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/IssueSidePanel.tsx` (line 46)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `current` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StatusJourney_94f693c["StatusJourney"]
    class component_StatusJourney_94f693c rootComponent
```

## Referenced By

- `IssueSidePanel` (RENDERS)

<!-- source: interface-detectedstatemachine.md -->

# DetectedStateMachine

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/state-machine-detector.ts` (line 14)

Detected state machine or workflow

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `type` | `'enum' | 'xstate' | 'custom' | 'status_field'` |
| `states` | `StateDefinition[]` |
| `transitions` | `StateTransition[]` |
| `entityId` | `string` |
| `filePath` | `string` |
| `confidence` | `'high' | 'medium' | 'low'` |
| `reason` | `string` |

<!-- source: api-endpoint-getconfig.md -->

# getConfig

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/saml/saml.controller.ts` (line 83)

Get SAML configuration

## Endpoint

`GET /auth/saml/:orgId/config`

| Parameter | In | Type | Required |
|---|---|---|---|
| `orgId` | query | `string` | ✓ |

## Referenced By

- `SamlController` (MODULE_DECLARES)

<!-- source: constant-lexicalgenerichtmlvisitor.md -->

# LexicalGenericHTMLVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/LexicalGenericHTMLNodeVisitor.ts` (line 7)

## Definition

```ts
LexicalExportVisitor<
  GenericHTMLNode,
  MdxJsxFlowElement | MdxJsxTextElement
>
```

<!-- source: component-link.md -->

# Link

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 240)

## Diagram

```mermaid
graph TD
    component_Link_13f244["Link"]
    class component_Link_13f244 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: interface-searchindexentry.md -->

# SearchIndexEntry

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/search-index.generator.ts` (line 15)

Search index entry

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `type` | `string` |
| `description` | `string` |
| `filePath` | `string` |
| `url` | `string` |
| `keywords` | `string[]` |
| `content` | `string` |
| `tags` | `string[]` |
| `weight` | `number` |

<!-- source: interface-sendemailoptions.md -->

# SendEmailOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/email/email.service.ts` (line 11)

## Properties

| Property | Type |
|---|---|
| `to` | `string | string[]` |
| `subject` | `string` |
| `html` | `string` |
| `text` | `string` |
| `attachments` | `EmailAttachment[]` |

<!-- source: interface-sessionsavecontext.md -->

# SessionSaveContext

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/session-manager.ts` (line 34)

Caller-supplied context needed to build/update session metadata

## Properties

| Property | Type |
|---|---|
| `workspace` | `string` |
| `model` | `string` |
| `sendCount` | `number` |
| `turnCount` | `number` |
| `totalUsage` | `TokenUsage` |
| `conversationHistory` | `AgentHistoryItem[]` |
| `sdkHistory` | `unknown[]` |
| `status` | `'active' | 'completed' | 'error'` |

<!-- source: component-statusoverview.md -->

# StatusOverview

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/page.tsx` (line 438)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `counts` | `Record` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StatusOverview_7fba48c["StatusOverview"]
    class component_StatusOverview_7fba48c rootComponent
```

## Referenced By

- `IssuesListPage` (RENDERS)

<!-- source: interface-detectedsveltecomponent.md -->

# DetectedSvelteComponent

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/svelte-detector.ts` (line 16)

Detected Svelte component

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `props` | `SvelteProp[]` |
| `events` | `string[]` |
| `slots` | `string[]` |
| `reactiveStatements` | `number` |
| `stores` | `string[]` |
| `actions` | `string[]` |
| `childComponents` | `string[]` |
| `svelteKit` | `{
    isPage: boolean;
    isLayout: boolean;
    hasLoad: boolean;
    hasActions: boolean;
  }` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getconfig-2.md -->

# getConfig

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr.controller.ts` (line 34)

## Endpoint

`GET /docs-pr/:projectId/config`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocsPrController` (MODULE_DECLARES)

<!-- source: constant-lexicalheadingvisitor.md -->

# LexicalHeadingVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/headings/LexicalHeadingVisitor.ts` (line 5)

## Definition

```ts
LexicalExportVisitor<HeadingNode, Mdast.Heading>
```

<!-- source: component-linkdialog.md -->

# LinkDialog

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/LinkDialog.tsx` (line 137)

## Diagram

```mermaid
graph TD
    component_LinkDialog_65d0031e["LinkDialog"]
    class component_LinkDialog_65d0031e rootComponent
```

## Relationships

- RENDERS → `Popover-Root`
- RENDERS → `Popover-Anchor`
- RENDERS → `Popover-Portal`
- RENDERS → `Popover-Content`
- RENDERS → `LinkEditForm`
- RENDERS → `ActionButton`
- RENDERS → `Tooltip-Provider`
- RENDERS → `Tooltip-Root`
- RENDERS → `Tooltip-Trigger`
- RENDERS → `Tooltip-Portal`
- RENDERS → `Tooltip-Content`
- RENDERS → `Tooltip-Arrow`
- RENDERS → `Popover-Arrow`
- USES_HOOK → `useCellValues`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useEffect`
- USES_HOOK → `useState`
- USES_HOOK → `useTranslation`

<!-- source: interface-searchindexmetadata.md -->

# SearchIndexMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/search-index.generator.ts` (line 51)

Search index metadata

## Properties

| Property | Type |
|---|---|
| `version` | `string` |
| `totalEntries` | `number` |
| `generatedAt` | `string` |
| `entityTypes` | `string[]` |

<!-- source: interface-sessionsnapshot.md -->

# SessionSnapshot

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/session-store.ts` (line 46)

Full session snapshot written to {id}.json

## Properties

| Property | Type |
|---|---|
| `meta` | `SessionMeta` |
| `conversationHistory` | `AgentHistoryItem[]` |
| `sdkHistory` | `unknown[]` |

<!-- source: interface-slugregistry.md -->

# SlugRegistry

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/sidecar.ts` (line 76)

## Properties

| Property | Type |
|---|---|
| `entries` | `Record<string, SlugRegistryEntry>` |

<!-- source: component-stepssection.md -->

# StepsSection

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/page.tsx` (line 420)

## Diagram

```mermaid
graph TD
    component_StepsSection_bf13b88["StepsSection"]
    class component_StepsSection_bf13b88 rootComponent
```

## Relationships

- USES_HOOK → `useRef`
- USES_HOOK → `useInView`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

## Referenced By

- `HomePage` (RENDERS)

<!-- source: interface-detectedtechstack.md -->

# DetectedTechStack

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/framework.types.ts` (line 80)

Complete detected tech stack for a project

## Properties

| Property | Type |
|---|---|
| `frontend` | `{
    framework: FrontendFramework;
    version?: string;
    language: 'typescript' | 'javascript';
    uiLibrary: UILibrary;
    stateManagement: StateManagement;
    router?: string; // react-router, vue-router, etc.
    formLibrary?: string; // react-hook-form, formik, vee-validate
    validationLibrary?: string; // yup, zod, joi
  }` |
| `backend` | `{
    framework: BackendFramework;
    version?: string;
    language:
      | 'typescript'
      | 'javascript'
      | 'python'
      | 'csharp'
      | 'java'
      | 'ruby'
      | 'php';
    orm?: string; // prisma, typeorm, ef-core, sqlalchemy
    validationLibrary?: string; // class-validator, pydantic, data-annotations
  }` |
| `database` | `{
    type: 'postgresql' | 'mysql' | 'mongodb' | 'sqlite' | 'mssql' | 'unknown';
    orm?: string;
  }` |
| `isMonorepo` | `boolean` |
| `isFullStack` | `boolean` |
| `confidence` | `'high' | 'medium' | 'low'` |
| `detectionSource` | `string[]` |

<!-- source: api-endpoint-getconfig-3.md -->

# getConfig

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 63)

## Endpoint

`GET /doc-automation/config/:projectId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: constant-lexicalimagevisitor.md -->

# LexicalImageVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/LexicalImageVisitor.ts` (line 5)

## Definition

```ts
LexicalExportVisitor<ImageNode, Mdast.Image>
```

<!-- source: component-lists.md -->

# Lists

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 202)

## Diagram

```mermaid
graph TD
    component_Lists_26a6a8b["Lists"]
    class component_Lists_26a6a8b rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `UndoRedo`

<!-- source: interface-searchindexoptions.md -->

# SearchIndexOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/search-index.generator.ts` (line 65)

Search index options

## Properties

| Property | Type |
|---|---|
| `baseUrl` | `string` |
| `includeCode` | `boolean` |
| `minWeight` | `number` |
| `keywordExtractor` | `(entity: Entity) => string[]` |
| `weightCalculator` | `(entity: Entity) => number` |

<!-- source: interface-sessionstoreconfig.md -->

# SessionStoreConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/session-store.ts` (line 62)

## Properties

| Property | Type |
|---|---|
| `dir` | `string` |
| `maxSessions` | `number` |

<!-- source: interface-slugregistryentry.md -->

# SlugRegistryEntry

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/docs-repo/sidecar.ts` (line 67)

## Properties

| Property | Type |
|---|---|
| `slug` | `string` |
| `scope` | `string` |
| `lang` | `string` |
| `kgEntityId` | `string | null` |
| `previousSlugs` | `string[]` |

<!-- source: component-streamingdots.md -->

# StreamingDots

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/SupportChatWidget.tsx` (line 682)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_StreamingDots_4a538795["StreamingDots"]
    class component_StreamingDots_4a538795 rootComponent
```

## Referenced By

- `SupportChatWidget` (RENDERS)

<!-- source: interface-detecteduicomponent.md -->

# DetectedUIComponent

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/ui-library-detector.ts` (line 17)

Detected UI component usage

## Properties

| Property | Type |
|---|---|
| `library` | `UILibrary` |
| `componentName` | `string` |
| `entityId` | `string` |
| `filePath` | `string` |
| `propsUsed` | `string[]` |
| `eventsHandled` | `string[]` |
| `isFormElement` | `boolean` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getconfig-4.md -->

# getConfig

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.controller.ts` (line 41)

GET /support-agent/:projectId/config
Returns the support agent config for a project, or null if not configured.

## Endpoint

`GET /support-agent/:projectId/config`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `SupportAgentController` (MODULE_DECLARES)

<!-- source: constant-lexicaljsxvisitor.md -->

# LexicalJsxVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/LexicalJsxVisitor.ts` (line 8)

## Definition

```ts
LexicalExportVisitor<LexicalJsxNode, MdxJsxFlowElement | MdxJsxTextElement>
```

<!-- source: component-liststoggle.md -->

# ListsToggle

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/ListsToggle.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `options` | `any` | - | [] |

## Diagram

```mermaid
graph TD
    component_ListsToggle_e13b1e1["ListsToggle"]
    class component_ListsToggle_e13b1e1 rootComponent
```

## Relationships

- RENDERS → `SingleChoiceToggleGroup`
- USES_HOOK → `useCellValues`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useTranslation`

<!-- source: interface-semanticmetadata.md -->

# SemanticMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 309)

Semantic metadata for components with business logic patterns

Detects state machines, workflows, modals, and approval processes
to enable comprehensive documentation and screenshot capture.

## Properties

| Property | Type |
|---|---|
| `hasStateMachine` | `boolean` |
| `stateEnums` | `string[]` |
| `transitionMethods` | `string[]` |
| `modalTriggers` | `string[]` |
| `approvalStates` | `string[]` |

<!-- source: interface-setupagentoptions.md -->

# SetupAgentOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/setup-agent.ts` (line 42)

Options accepted by the setup agent entry-point.

## Properties

| Property | Type |
|---|---|
| `workDir` | `string` |
| `timeout` | `number` |

<!-- source: interface-snapshotdiff.md -->

# SnapshotDiff

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-materializer.service.ts` (line 82)

S4 (code→docs delta): bucket the NEW snapshot's page-backed entities against the stored
per-entity signature baseline (`technicalSnapshot.signatureHashes`, stamped at the last
materialize — preserved across a re-parse because `upsertSnapshot` never writes it). This is
the techdocs analog of the screenshot pipeline's `screen_diff`: only entities whose PUBLIC
contract moved need their page regenerated. Description/comment-only edits don't change
`signatureHashOf`, so they don't churn a page. `pageEntities` must already be the junk-filtered
set that actually produces a document (derive it from the rendered docSet), so the diff aligns
exactly with what gets materialized.

## Properties

| Property | Type |
|---|---|
| `added` | `Set<string>` |
| `changed` | `Set<string>` |
| `removed` | `Set<string>` |
| `unchanged` | `Set<string>` |

<!-- source: component-streamingindicator.md -->

# StreamingIndicator

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/ChatMessage.tsx` (line 158)

Animated streaming indicator (three dots)

## Diagram

```mermaid
graph TD
    component_StreamingIndicator_6f1ac849["StreamingIndicator"]
    class component_StreamingIndicator_6f1ac849 rootComponent
```

## Referenced By

- `ChatMessage` (RENDERS)

<!-- source: interface-detectedvalidation.md -->

# DetectedValidation

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/validation-detector.ts` (line 17)

Detected validation schema/rule

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `framework` | `| 'yup'
    | 'zod'
    | 'joi'
    | 'class-validator'
    | 'pydantic'
    | 'data-annotations'
    | 'fluent-validation'
    | 'bean-validation'
    | 'custom'` |
| `fields` | `ValidationField[]` |
| `entityId` | `string` |
| `filePath` | `string` |
| `confidence` | `'high' | 'medium' | 'low'` |
| `schemaCode` | `string` |

<!-- source: api-endpoint-getcustomdomain.md -->

# getCustomDomain

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 362)

## Endpoint

`GET /projects/:id/custom-domain`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: constant-lexicallinebreakvisitor.md -->

# LexicalLinebreakVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/LexicalLinebreakVisitor.ts` (line 7)

## Definition

```ts
LexicalExportVisitor<LineBreakNode, Mdast.Text>
```

<!-- source: component-markdownshortcuts.md -->

# MarkdownShortcuts

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 356)

## Diagram

```mermaid
graph TD
    component_MarkdownShortcuts_87dcd4c["MarkdownShortcuts"]
    class component_MarkdownShortcuts_87dcd4c rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: interface-semanticmetadata-2.md -->

# SemanticMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/semantic-detector.ts` (line 19)

Semantic Pattern Detector

Detects semantic patterns in code to understand business logic:
- State machines (enums with Stage/Status/State)
- State transitions (methods that change state)
- Modal/dialog triggers
- Approval workflows

This enables comprehensive documentation and screenshot capture.

## Properties

| Property | Type |
|---|---|
| `hasStateMachine` | `boolean` |
| `stateEnums` | `string[]` |
| `transitionMethods` | `string[]` |
| `modalTriggers` | `string[]` |
| `approvalStates` | `string[]` |

<!-- source: interface-setupresult.md -->

# SetupResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/setup-agent.ts` (line 16)

Setup Agent — Environment discovery and configuration sub-agent.

Runs in parallel with the main agent's initial investigation phase to
detect the project language, runtime, package manager, and test command,
then installs dependencies and runs a smoke test.

This module is fully self-contained — no local project imports.

## Properties

| Property | Type |
|---|---|
| `os` | `string` |
| `shell` | `string` |
| `language` | `string` |
| `runtimeVersion` | `string` |
| `packageManager` | `string` |
| `activateCommand` | `string` |
| `depsInstalled` | `boolean` |
| `smokeTestPassed` | `boolean` |
| `warnings` | `string[]` |
| `projectDocs` | `string[]` |
| `testCommand` | `string` |

<!-- source: interface-stalepage.md -->

# StalePage

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/freshness.service.ts` (line 30)

One stale, redraftable page for the cockpit list.

## Properties

| Property | Type |
|---|---|
| `slug` | `string` |
| `title` | `string` |
| `scope` | `'manual'` |

<!-- source: component-styleselector.md -->

# StyleSelector

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/ApiReferenceReader.tsx` (line 135)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `compact` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_StyleSelector_5b56974b["StyleSelector"]
    class component_StyleSelector_5b56974b rootComponent
```

## Relationships

- RENDERS → `CheckIcon`

## Referenced By

- `ApiReferenceReader` (RENDERS)

<!-- source: interface-detectedvuecomponent.md -->

# DetectedVueComponent

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/vue-detector.ts` (line 16)

Detected Vue component

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `filePath` | `string` |
| `apiStyle` | `'composition' | 'options' | 'setup-script'` |
| `props` | `VueProp[]` |
| `emits` | `string[]` |
| `reactiveState` | `string[]` |
| `computed` | `string[]` |
| `methods` | `string[]` |
| `composables` | `string[]` |
| `childComponents` | `string[]` |
| `watchers` | `string[]` |
| `confidence` | `'high' | 'medium' | 'low'` |

<!-- source: api-endpoint-getdailytraffic.md -->

# getDailyTraffic

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 78)

## Endpoint

`GET /analytics/:projectId/daily-traffic`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: constant-lexicallinkvisitor.md -->

# LexicalLinkVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link/LexicalLinkVisitor.ts` (line 5)

## Definition

```ts
LexicalExportVisitor<LinkNode, Mdast.Link>
```

<!-- source: component-mermaidpreview.md -->

# MermaidPreview

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/mermaid.tsx` (line 11)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `code` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_MermaidPreview_4d19a319["MermaidPreview"]
    class component_MermaidPreview_4d19a319 rootComponent
```

## Relationships

- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-sequencediagramoptions.md -->

# SequenceDiagramOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/sequence-diagram.generator.ts` (line 55)

Options for sequence diagram generation

## Properties

| Property | Type |
|---|---|
| `showMiddleware` | `boolean` |
| `showDatabase` | `boolean` |
| `showReturns` | `boolean` |
| `showActivation` | `boolean` |
| `maxDepth` | `number` |
| `includeNotes` | `boolean` |
| `includeParticipantTypes` | `Array<'client' | 'middleware' | 'controller' | 'service' | 'database' | 'external'>` |

<!-- source: interface-skilldefinition.md -->

# SkillDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/plugins/plugin-types.ts` (line 86)

A knowledge module (skill) contributed by a plugin.

Each subdirectory in a plugin's `skills/` directory that contains a
`SKILL.md` file produces one SkillDefinition. Skills are loaded on-demand
and injected into the system prompt when activated.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `version` | `string` |
| `body` | `string` |
| `referencePaths` | `string[]` |

<!-- source: interface-staleresult.md -->

# StaleResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/freshness.service.ts` (line 36)

## Properties

| Property | Type |
|---|---|
| `checkedAt` | `string | null` |
| `staleCount` | `number` |
| `commitHash` | `string | null` |
| `changedFiles` | `string[]` |
| `changedFileCount` | `number` |
| `technicalStaleCount` | `number` |
| `sampleNames` | `string[]` |
| `pages` | `StalePage[]` |

<!-- source: component-subdomaincard.md -->

# SubdomainCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Domains/DomainTab.tsx` (line 155)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `publishedSlug` | `string | null` | ✓ | - |
| `onToast` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SubdomainCard_3456e791["SubdomainCard"]
    class component_SubdomainCard_3456e791 rootComponent
```

## Relationships

- RENDERS → `CopyButton`
- RENDERS → `ArrowTopRightOnSquareIcon`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

## Referenced By

- `DomainTab` (RENDERS)

<!-- source: interface-directivedescriptor.md -->

# DirectiveDescriptor

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/directives/index.ts` (line 26)

Implement this interface to create a custom editor for markdown directives.
Pass the object in the `directivesPlugin` parameters.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `attributes` | `string[]` |
| `hasChildren` | `boolean` |
| `type` | `'leafDirective' | 'containerDirective' | 'textDirective'` |
| `Editor` | `React.ComponentType<DirectiveEditorProps<T>>` |

<!-- source: api-endpoint-getdata.md -->

# getData

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/app/app.controller.ts` (line 9)

## Endpoint

`GET /`

## Referenced By

- `AppController` (MODULE_DECLARES)

<!-- source: constant-lexicallistitemvisitor.md -->

# LexicalListItemVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/lists/LexicalListItemVisitor.ts` (line 6)

## Definition

```ts
LexicalExportVisitor<ListItemNode, Mdast.ListItem>
```

<!-- source: component-mermaidpreview-2.md -->

# MermaidPreview

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/mermaid/index.tsx` (line 24)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `code` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_MermaidPreview_7553a5a5["MermaidPreview"]
    class component_MermaidPreview_7553a5a5 rootComponent
```

## Relationships

- USES_HOOK → `useRef`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-sequencediagramresult.md -->

# SequenceDiagramResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/sequence-diagram.generator.ts` (line 102)

Result of sequence diagram generation

## Properties

| Property | Type |
|---|---|
| `mermaidCode` | `string` |
| `participants` | `SequenceParticipant[]` |
| `messages` | `SequenceMessage[]` |
| `stats` | `{
    /** Number of participants */
    participantCount: number;
    /** Number of messages */
    messageCount: number;
    /** Maximum depth reached */
    maxDepthReached: number;
    /** Number of async calls */
    asyncCallCount: number;
    /** Number of database interactions */
    databaseInteractionCount: number;
  }` |

<!-- source: interface-snapshot.md -->

# Snapshot

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/checkpoint-manager.ts` (line 32)

## Properties

| Property | Type |
|---|---|
| `file` | `string` |
| `content` | `string` |
| `timestamp` | `number` |
| `label` | `string` |

<!-- source: interface-staletransitioninfo.md -->

# StaleTransitionInfo

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/stale-alert.service.ts` (line 27)

## Properties

| Property | Type |
|---|---|
| `staleCount` | `number` |
| `manualStaleCount` | `number` |
| `sampleNames` | `Array<string | undefined>` |
| `commit` | `string | null` |
| `branch` | `string | null` |

<!-- source: component-summarycard.md -->

# SummaryCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/versions/[versionId]/review/page.tsx` (line 25)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `icon` | `string` | ✓ | - |
| `count` | `number` | ✓ | - |
| `label` | `string` | ✓ | - |
| `color` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SummaryCard_733d09f2["SummaryCard"]
    class component_SummaryCard_733d09f2 rootComponent
```

## Referenced By

- `ReviewPage` (RENDERS)

<!-- source: interface-directiveeditorprops.md -->

# DirectiveEditorProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/directives/index.ts` (line 58)

## Properties

| Property | Type |
|---|---|
| `mdastNode` | `T` |
| `parentEditor` | `LexicalEditor` |
| `lexicalNode` | `DirectiveNode` |
| `descriptor` | `DirectiveDescriptor` |

<!-- source: api-endpoint-getdeliveries.md -->

# getDeliveries

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 326)

## Endpoint

`GET /doc-automation/config/:projectId/deliveries`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: constant-lexicallistvisitor.md -->

# LexicalListVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/lists/LexicalListVisitor.ts` (line 5)

## Definition

```ts
LexicalExportVisitor<ListNode, Mdast.List>
```

<!-- source: component-missingplugins.md -->

# MissingPlugins

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/error-handling.tsx` (line 38)

## Diagram

```mermaid
graph TD
    component_MissingPlugins_3ba3f4e9["MissingPlugins"]
    class component_MissingPlugins_3ba3f4e9 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `ConditionalContents`
- RENDERS → `ChangeCodeMirrorLanguage`
- RENDERS → `ShowSandpackInfo`
- RENDERS → `UndoRedo`
- RENDERS → `BoldItalicUnderlineToggles`

<!-- source: interface-sequencemessage.md -->

# SequenceMessage

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/sequence-diagram.generator.ts` (line 35)

Represents a message/interaction in the sequence

## Properties

| Property | Type |
|---|---|
| `from` | `string` |
| `to` | `string` |
| `label` | `string` |
| `type` | `'sync' | 'async' | 'return'` |
| `note` | `string` |
| `activates` | `boolean` |
| `deactivates` | `boolean` |

<!-- source: interface-socketlike.md -->

# SocketLike

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/protocol/websocket-transport.ts` (line 37)

Minimal interface for a Socket.IO-compatible socket.
Using a structural type instead of importing from socket.io keeps
agent-core free of the socket.io peer dependency.

<!-- source: interface-startstitchparams.md -->

# StartStitchParams

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/capture/flow-draft-stitcher.service.ts` (line 16)

## Properties

| Property | Type |
|---|---|
| `jobId` | `string` |
| `documentId` | `string` |
| `organizationId` | `string` |
| `workerApiBase` | `string` |

<!-- source: component-supportpanel.md -->

# SupportPanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/page.tsx` (line 345)

## Diagram

```mermaid
graph TD
    component_SupportPanel_dea53f["SupportPanel"]
    class component_SupportPanel_dea53f rootComponent
```

## Relationships

- RENDERS → `PreviewShell`

## Referenced By

- `HomePage` (RENDERS)

<!-- source: interface-directivematch.md -->

# DirectiveMatch

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 206)

Directive match result

## Properties

| Property | Type |
|---|---|
| `type` | `| 'audience'
    | 'variant'
    | 'block'
    | 'include'
    | 'closing'
    | 'variant_child'
    | 'variant_child_close'` |
| `raw` | `string` |
| `content` | `string` |
| `line` | `number` |
| `offset` | `number` |
| `closing` | `boolean` |

<!-- source: api-endpoint-getdevicebreakdown.md -->

# getDeviceBreakdown

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 90)

## Endpoint

`GET /analytics/:projectId/devices`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: constant-lexicalmdxexpressionvisitor.md -->

# LexicalMdxExpressionVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/LexicalMdxExpressionVisitor.ts` (line 5)

## Definition

```ts
LexicalExportVisitor<LexicalMdxExpressionNode, MdxTextExpression>
```

<!-- source: component-moreformatting.md -->

# MoreFormatting

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 73)

## Diagram

```mermaid
graph TD
    component_MoreFormatting_596b699c["MoreFormatting"]
    class component_MoreFormatting_596b699c rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useRef`

<!-- source: interface-sequenceparticipant.md -->

# SequenceParticipant

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/sequence-diagram.generator.ts` (line 21)

Represents a participant in the sequence diagram

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `type` | `'client' | 'middleware' | 'controller' | 'service' | 'database' | 'external'` |
| `entity` | `Entity` |

<!-- source: interface-spawnagentoptions.md -->

# SpawnAgentOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/spawn-agent.tool.ts` (line 40)

## Properties

| Property | Type |
|---|---|
| `runtime` | `IAgentLoop` |
| `agentFactory` | `AgentFactory<TContext>` |
| `timeout` | `number` |
| `onBackgroundComplete` | `(event: BackgroundCompleteEvent) => void` |
| `worktreeManager` | `WorktreeManager` |
| `router` | `ModelRouter` |
| `onSubagentStart` | `(event: { agentName: string; task: string }) => void` |
| `onSubagentEnd` | `(event: { agentName: string; output: string; durationMs: number }) => void` |

<!-- source: interface-staticsearchdoc-2.md -->

# StaticSearchDoc

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/search-index.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `url` | `string` |
| `documentType` | `SearchDocType` |
| `headings` | `string[]` |
| `excerpt` | `string` |
| `tokens` | `string[]` |
| `boost` | `number` |

<!-- source: component-symbolicon.md -->

# SymbolIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/SymbolList.tsx` (line 138)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `type` | `SymbolType` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SymbolIcon_40b4134b["SymbolIcon"]
    class component_SymbolIcon_40b4134b rootComponent
```

## Referenced By

- `SymbolList` (RENDERS)

<!-- source: interface-discoveredroute.md -->

# DiscoveredRoute

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/site-map.types.ts` (line 65)

## Properties

| Property | Type |
|---|---|
| `path` | `string` |
| `fullUrl` | `string` |
| `menuLabel` | `string` |
| `menuSelector` | `string` |
| `pageType` | `PageType` |
| `profile` | `PageElementProfile` |
| `routeSegments` | `string[]` |
| `profileTimeMs` | `number` |

<!-- source: api-endpoint-getdocument.md -->

# getDocument

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 500)

## Endpoint

`GET /public/p/:slugWithId/audiences/:audienceSlug/documents/:documentSlug`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |
| `audienceSlug` | query | `string` | ✓ |
| `documentSlug` | query | `string` | ✓ |
| `version` | query | `string` | - |
| `lang` | query | `string` | - |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-lexicalparagraphvisitor.md -->

# LexicalParagraphVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/LexicalParagraphVisitor.ts` (line 7)

## Definition

```ts
LexicalExportVisitor<ParagraphNode, Mdast.Paragraph>
```

<!-- source: component-multiplechoicetogglegroup.md -->

# MultipleChoiceToggleGroup

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/toolbar.tsx` (line 108)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `items` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_MultipleChoiceToggleGroup_50de21a8["MultipleChoiceToggleGroup"]
    class component_MultipleChoiceToggleGroup_50de21a8 rootComponent
```

## Relationships

- RENDERS → `ToggleSingleGroupWithItem`

<!-- source: interface-serviceentity-2.md -->

# ServiceEntity

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 817)

Service entity (NestJS, Express, etc.)

## Properties

| Property | Type |
|---|---|
| `type` | `EntityType.SERVICE` |
| `dependencies` | `DependencyInfo[]` |
| `methods` | `MethodDefinition[]` |
| `isSingleton` | `boolean` |

<!-- source: interface-staticsearchindex-2.md -->

# StaticSearchIndex

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/search-index.ts` (line 39)

## Properties

| Property | Type |
|---|---|
| `v` | `1` |
| `slugWithId` | `string` |
| `generatedAt` | `string` |
| `count` | `number` |
| `docs` | `StaticSearchDoc[]` |

<!-- source: interface-streamedrunhandle.md -->

# StreamedRunHandle

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/types.ts` (line 180)

Wrapper around the SDK's StreamedRunResult.
Provides a clean interface for AgentSession to consume streaming events
without importing SDK types directly.

## Properties

| Property | Type |
|---|---|
| `events` | `AsyncIterable<StreamEvent>` |
| `completed` | `Promise<void>` |
| `getNewItems` | `() => unknown[]` |
| `getRawResponses` | `() => unknown[]` |
| `getFinalOutput` | `() => string` |
| `getLastAgentName` | `() => string` |
| `getHistory` | `() => unknown[]` |

<!-- source: component-syncstatusindicator.md -->

# SyncStatusIndicator

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/CollaborationStatusBar.tsx` (line 175)

Sync status indicator showing connection and sync state

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `synced` | `boolean` | ✓ | - |
| `connectionStatus` | `ConnectionStatus` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SyncStatusIndicator_5bbce5d0["SyncStatusIndicator"]
    class component_SyncStatusIndicator_5bbce5d0 rootComponent
```

## Relationships

- USES_HOOK → `useMemo`

## Referenced By

- `CollaborationStatusBar` (RENDERS)

<!-- source: interface-discoveryclientconfig.md -->

# DiscoveryClientConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/discovery.client.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `baseUrl` | `string` |
| `timeoutMs` | `number` |

<!-- source: api-endpoint-getdocumentactivities.md -->

# getDocumentActivities

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/activity/activity.controller.ts` (line 25)

## Endpoint

`GET /activities/documents/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ActivityController` (MODULE_DECLARES)

<!-- source: constant-lexicalquotevisitor.md -->

# LexicalQuoteVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/quote/LexicalQuoteVisitor.ts` (line 5)

## Definition

```ts
LexicalExportVisitor<QuoteNode, Mdast.Blockquote>
```

<!-- source: component-nav.md -->

# Nav

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/layout/nav.tsx` (line 32)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `logoText` | `string` | - | - |
| `logoSrc` | `string` | - | - |
| `links` | `NavLink[]` | ✓ | - |
| `defaultTheme` | `ThemeMode` | - | "dark" |
| `primaryColor` | `string` | - | - |
| `ctaKey` | `string` | - | - |
| `ctaHref` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_Nav_12ab4064["Nav"]
    class component_Nav_12ab4064 rootComponent
```

## Relationships

- RENDERS → `LanguageSwitcher`
- RENDERS → `ThemeToggle`
- RENDERS → `X`
- RENDERS → `Menu`
- RENDERS → `AnimatePresence`
- RENDERS → `motion-div`
- USES_HOOK → `useTranslation`
- USES_HOOK → `useState`

<!-- source: interface-servicemethod.md -->

# ServiceMethod

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 58)

## Properties

| Property | Type |
|---|---|
| `service` | `string` |
| `method` | `string` |
| `filePath` | `string` |
| `lineNumber` | `number` |
| `calls` | `MethodCall[]` |
| `calledBy` | `MethodCaller[]` |

<!-- source: interface-stepdocumentation.md -->

# StepDocumentation

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/user-docs-generator.service.ts` (line 41)

Documentation for a single step

## Properties

| Property | Type |
|---|---|
| `stepNumber` | `number` |
| `title` | `string` |
| `content` | `string` |
| `screenshots` | `string[]` |
| `tips` | `string[]` |
| `warnings` | `string[]` |

<!-- source: interface-subsetentry.md -->

# SubsetEntry

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/swebench-subset.ts` (line 21)

SWE-bench Verified — Curated Starter Subset

30 hand-picked tasks from the actual SWE-bench Verified dataset (500 tasks).
Balanced 10/10/10 across difficulty for clean comparison.
Selected for: well-defined test targets (FAIL_TO_PASS), pure Python,
and coverage across 9 repos.

Difficulty based on gold patch line count:
  easy   = < 20 lines
  medium = 20-80 lines
  hard   = > 80 lines

IDs verified against princeton-nlp/SWE-bench_Verified (2026-03-25).

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `repo` | `string` |
| `difficulty` | `'easy' | 'medium' | 'hard'` |
| `description` | `string` |

<!-- source: component-tab.md -->

# Tab

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/entity/[entityId]/page.tsx` (line 60)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `label` | `string` | ✓ | - |
| `count` | `number` | - | - |
| `active` | `boolean` | - | - |
| `aiTag` | `boolean` | - | - |
| `onClick` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Tab_d987b97["Tab"]
    class component_Tab_d987b97 rootComponent
```

## Referenced By

- `EntityDetailPage` (RENDERS)

<!-- source: interface-discoveryscanrequest.md -->

# DiscoveryScanRequest

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/discovery.client.ts` (line 9)

## Properties

| Property | Type |
|---|---|
| `siteUrl` | `string` |
| `auth` | `{
    loginUrl: string;
    username: string;
    password: string;
    usernameSelector?: string;
    passwordSelector?: string;
    submitSelector?: string;
    successSelector?: string;
  }` |
| `exploreGridDepth` | `boolean` |
| `timeoutMs` | `number` |
| `pageProfileTimeoutMs` | `number` |

<!-- source: api-endpoint-getduplicates.md -->

# getDuplicates

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/issues.controller.ts` (line 107)

## Endpoint

`GET /projects/:projectId/issues/:issueId/duplicates`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `issueId` | query | `string` | ✓ |

## Referenced By

- `IssuesController` (MODULE_DECLARES)

<!-- source: constant-lexicalrootvisitor.md -->

# LexicalRootVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/LexicalRootVisitor.ts` (line 7)

## Definition

```ts
LexicalExportVisitor<LexicalRootNode, Mdast.Root>
```

<!-- source: component-navigationtree.md -->

# NavigationTree

**Kind:** Component

**Source:** `atloria-monorepo/packages/ui-react/src/components/NavigationTree.tsx` (line 167)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `items` | `DocumentTreeNode[]` | ✓ | - |
| `activeId` | `string` | - | - |
| `defaultExpanded` | `string[]` | - | [] |
| `expanded` | `string[]` | - | - |
| `onExpandedChange` | `Function` | - | - |
| `onItemClick` | `Function` | - | - |
| `showStateIndicator` | `boolean` | - | false |
| `loading` | `boolean` | - | false |
| `emptyMessage` | `string` | - | - |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_NavigationTree_7b35908b["NavigationTree"]
    class component_NavigationTree_7b35908b rootComponent
```

## Relationships

- RENDERS → `TreeItem`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-significancecheckable.md -->

# SignificanceCheckable

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/significance.ts` (line 12)

Significance gate for technical reference docs (audit FIX 1).

The published corpus was 28% junk: entities mined from generated/minified/vendored code
(literal `Bn` pages from a checked-in Prisma client) plus test scaffolding. This is the ONE
shared predicate both the parse pipeline (navMap + snapshot) and the materializer
(transformSnapshotToDocSet) apply, so pages, nav, llms.txt and search all agree on what exists.

Pure + dependency-free so it is trivially unit-testable and usable from any surface.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `filePath` | `string` |

<!-- source: interface-streamchunk.md -->

# StreamChunk

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/ai/interfaces/ai-types.ts` (line 8)

## Properties

| Property | Type |
|---|---|
| `type` | `'text' | 'error' | 'done'` |
| `content` | `string` |
| `metadata` | `Record<string, any>` |

<!-- source: interface-swebenchprediction.md -->

# SWEBenchPrediction

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/swebench-evaluator.ts` (line 26)

SWE-bench prediction format (one per line in JSONL)

## Properties

| Property | Type |
|---|---|
| `instance_id` | `string` |
| `model_name_or_path` | `string` |
| `model_patch` | `string` |

<!-- source: component-tab-2.md -->

# Tab

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/technical/entity/[entityId]/page.tsx` (line 41)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `label` | `string` | ✓ | - |
| `count` | `number` | - | - |
| `active` | `boolean` | - | - |
| `aiTag` | `boolean` | - | - |
| `onClick` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Tab_69883e86["Tab"]
    class component_Tab_69883e86 rootComponent
```

## Referenced By

- `PublicEntityDetailPage` (RENDERS)

<!-- source: interface-djangofield.md -->

# DjangoField

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/django-detector.ts` (line 60)

Django field

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `required` | `boolean` |
| `source` | `string` |

<!-- source: api-endpoint-getentities.md -->

# getEntities

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/kg-sync.controller.ts` (line 54)

Get all entities for a project

## Endpoint

`GET /projects/:projectId/entities`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `type` | query | `string` | - |

## Referenced By

- `KgSyncController` (MODULE_DECLARES)

<!-- source: constant-lexicaltablevisitor.md -->

# LexicalTableVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/table/LexicalTableVisitor.ts` (line 5)

## Definition

```ts
LexicalExportVisitor<TableNode, Mdast.Table>
```

<!-- source: component-nestedlexicaleditor.md -->

# NestedLexicalEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/NestedLexicalEditor.tsx` (line 158)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `getContent` | `Function` | ✓ | - |
| `getUpdatedMdastNode` | `Function` | ✓ | - |
| `contentEditableProps` | `unknown` | - | - |
| `block` | `boolean` | - | - |

## Diagram

```mermaid
graph TD
    component_NestedLexicalEditor_4667bcd6["NestedLexicalEditor"]
    class component_NestedLexicalEditor_4667bcd6 rootComponent
```

## Relationships

- RENDERS → `LexicalNestedComposer`
- RENDERS → `RichTextPlugin`
- RENDERS → `ContentEditable`
- RENDERS → `SharedHistoryPlugin`
- RENDERS → `Child`
- USES_HOOK → `useNestedEditorContext`
- USES_HOOK → `useMdastNodeUpdater`
- USES_HOOK → `useLexicalNodeRemove`
- USES_HOOK → `useRealm`
- USES_HOOK → `useCellValues`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-slotdefinition-2.md -->

# SlotDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 470)

Slot definition (Vue)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `props` | `PropDefinition[]` |

<!-- source: interface-submitfeedbackdto.md -->

# SubmitFeedbackDto

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/analytics/feedback.service.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `documentId` | `string` |
| `documentSlug` | `string` |
| `sessionId` | `string` |
| `rating` | `'HELPFUL' | 'NOT_HELPFUL'` |
| `comment` | `string` |
| `userAgent` | `string` |
| `country` | `string` |

<!-- source: component-tabbutton.md -->

# TabButton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/ParsingResults.tsx` (line 107)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |
| `active` | `boolean` | ✓ | - |
| `onClick` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TabButton_23277783["TabButton"]
    class component_TabButton_23277783 rootComponent
```

## Referenced By

- `ParsingResults` (RENDERS)

<!-- source: interface-taskresult-2.md -->

# TaskResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/types.ts` (line 79)

Result of running the agent on a single task.

## Properties

| Property | Type |
|---|---|
| `taskId` | `string` |
| `suite` | `BenchmarkTask['suite']` |
| `passed` | `boolean` |
| `hasChanges` | `boolean` |
| `agentPatch` | `string` |
| `durationMs` | `number` |
| `turns` | `number` |
| `tokens` | `{ input: number; output: number; total: number }` |
| `costUsd` | `number` |
| `toolCalls` | `ToolCallRecord[]` |
| `error` | `string` |
| `timedOut` | `boolean` |
| `failureCategory` | `FailureCategory` |
| `attemptIndex` | `number` |
| `difficulty` | `'easy' | 'medium' | 'hard'` |
| `language` | `string` |
| `repo` | `string` |
| `fileLocalization` | `FileLocalization` |
| `terminationReason` | `'success' | 'max_turns_hit' | 'timeout_hit' | 'harness_error' | 'no_progress' | 'duplicate_patch'` |
| `setupDurationMs` | `number` |
| `agentDurationMs` | `number` |
| `patchSaved` | `boolean` |

<!-- source: interface-djangomodelfield.md -->

# DjangoModelField

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/django-detector.ts` (line 89)

Django model field

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `nullable` | `boolean` |
| `unique` | `boolean` |
| `choices` | `string[]` |

<!-- source: api-endpoint-getentity.md -->

# getEntity

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/graph.controller.ts` (line 59)

## Endpoint

`GET /knowledge-graph/entities/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `projectId` | query | `string` | ✓ |

## Referenced By

- `GraphController` (MODULE_DECLARES)

<!-- source: constant-lexicaltextvisitor.md -->

# LexicalTextVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/LexicalTextVisitor.ts` (line 24)

## Definition

```ts
LexicalExportVisitor<
  TextNode,
  Mdast.Text | Mdast.Html | MdxJsxTextElement
>
```

<!-- source: component-nestedlists.md -->

# NestedLists

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/nested-lists.tsx` (line 25)

## Diagram

```mermaid
graph TD
    component_NestedLists_508f825a["NestedLists"]
    class component_NestedLists_508f825a rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `UndoRedo`

<!-- source: interface-stateactionmetadata.md -->

# StateActionMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-management.interface.ts` (line 83)

State action metadata (Redux, NgRx, Pinia)

## Properties

| Property | Type |
|---|---|
| `actionType` | `string` |
| `payloadShape` | `Record<string, string>` |
| `isAsync` | `boolean` |
| `relatedActions` | `{
    start?: string;
    success?: string;
    failure?: string;
  }` |
| `dispatchedBy` | `string[]` |
| `handledBy` | `string[]` |
| `triggersEffects` | `string[]` |

<!-- source: interface-symbol.md -->

# Symbol

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/parser/interfaces/code-parser.interface.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `SymbolType` |
| `startLine` | `number` |
| `endLine` | `number` |
| `startColumn` | `number` |
| `endColumn` | `number` |
| `signature` | `string` |
| `docstring` | `string` |
| `modifiers` | `string[]` |
| `parameters` | `Parameter[]` |
| `returnType` | `string` |

<!-- source: component-tableofcontents.md -->

# TableOfContents

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/DocumentViewer.tsx` (line 220)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `items` | `TocItem[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TableOfContents_6ec138bf["TableOfContents"]
    class component_TableOfContents_6ec138bf rootComponent
```

## Relationships

- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

## Referenced By

- `DocumentViewer` (RENDERS)

<!-- source: interface-testgateconfig.md -->

# TestGateConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/test-watcher.ts` (line 213)

## Properties

| Property | Type |
|---|---|
| `testCommand` | `string` |
| `cwd` | `string` |
| `timeoutMs` | `number` |

<!-- source: interface-djangomodelmeta.md -->

# DjangoModelMeta

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/django-detector.ts` (line 110)

Django model meta

## Properties

| Property | Type |
|---|---|
| `ordering` | `string[]` |
| `verboseName` | `string` |
| `permissions` | `string[]` |

<!-- source: api-endpoint-getentity-2.md -->

# getEntity

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 165)

## Endpoint

`GET /technical-docs/:projectId/entity/:entityId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `entityId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: constant-lexicalthematicbreakvisitor.md -->

# LexicalThematicBreakVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/thematic-break/LexicalThematicBreakVisitor.ts` (line 5)

## Definition

```ts
LexicalExportVisitor<HorizontalRuleNode, Mdast.ThematicBreak>
```

<!-- source: component-optimizedimage.md -->

# OptimizedImage

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/layout/optimized-image.tsx` (line 22)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `src` | `string` | ✓ | - |
| `alt` | `string` | ✓ | - |
| `width` | `number` | - | - |
| `height` | `number` | - | - |
| `srcSet` | `string` | - | - |
| `sizes` | `string` | - | - |
| `className` | `string` | - | "" |
| `loading` | `unknown | unknown` | - | "lazy" |
| `priority` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_OptimizedImage_1529e593["OptimizedImage"]
    class component_OptimizedImage_1529e593 rootComponent
```

## Relationships

- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-stateeffectmetadata.md -->

# StateEffectMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-management.interface.ts` (line 192)

State effect metadata (NgRx Effects, Redux Saga)

## Properties

| Property | Type |
|---|---|
| `effectName` | `string` |
| `triggerAction` | `string` |
| `successAction` | `string` |
| `errorAction` | `string` |
| `isLegacy` | `boolean` |
| `dependencies` | `string[]` |

<!-- source: interface-tableofcontentsitem.md -->

# TableOfContentsItem

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/user-docs-generator.service.ts` (line 53)

Table of contents item

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `slug` | `string` |
| `level` | `number` |
| `children` | `TableOfContentsItem[]` |

<!-- source: component-technicaldocssection.md -->

# TechnicalDocsSection

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/page.tsx` (line 880)

Technical Docs Section — links to the technical docs viewer and shows snapshot status.

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TechnicalDocsSection_7581d2a8["TechnicalDocsSection"]
    class component_TechnicalDocsSection_7581d2a8 rootComponent
```

## Relationships

- RENDERS → `ChevronUp`
- RENDERS → `ChevronDown`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

## Referenced By

- `ProjectPage` (RENDERS)

<!-- source: interface-testrunresult.md -->

# TestRunResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/test-watcher.ts` (line 36)

## Properties

| Property | Type |
|---|---|
| `passed` | `boolean` |
| `stdout` | `string` |
| `stderr` | `string` |
| `durationMs` | `number` |
| `timedOut` | `boolean` |

<!-- source: interface-djangorelationship.md -->

# DjangoRelationship

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/django-detector.ts` (line 100)

Django model relationship

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `'ForeignKey' | 'ManyToManyField' | 'OneToOneField'` |
| `relatedModel` | `string` |
| `relatedName` | `string` |

<!-- source: api-endpoint-getentitybyid.md -->

# getEntityById

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/kg-sync.controller.ts` (line 93)

Get a single entity by ID

## Endpoint

`GET /projects/:projectId/entities/:entityId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `entityId` | query | `string` | ✓ |

## Referenced By

- `KgSyncController` (MODULE_DECLARES)

<!-- source: constant-lexicaltheme.md -->

# lexicalTheme

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/styles/lexicalTheme.ts` (line 5)

## Definition

```ts
EditorThemeClasses
```

<!-- source: component-parentoffsetofanchor.md -->

# ParentOffsetOfAnchor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/link-dialog.tsx` (line 104)

## Diagram

```mermaid
graph TD
    component_ParentOffsetOfAnchor_a4dae0b["ParentOffsetOfAnchor"]
    class component_ParentOffsetOfAnchor_a4dae0b rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: interface-stateflow.md -->

# StateFlow

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-management.interface.ts` (line 351)

Complete state flow for documentation

## Properties

| Property | Type |
|---|---|
| `flowName` | `string` |
| `library` | `StateManagementLibrary` |
| `states` | `string[]` |
| `transitions` | `StateTransition[]` |
| `conditionalUI` | `ConditionalUIPattern[]` |
| `components` | `string[]` |
| `actions` | `string[]` |
| `selectors` | `string[]` |
| `asyncPattern` | `AsyncStatePattern` |

<!-- source: interface-techdocscuration.md -->

# TechdocsCuration

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/curation.ts` (line 8)

Curation (Phase 2.2): maintainers pin the entities readers should find first and hide
internal noise (generated helpers, migration scaffolding). Stored per-project in
project.settings.techdocsCuration and applied SERVER-SIDE when the snapshot is served,
so the sidebar tree, the Cmd+K palette and any future consumer inherit it for free.

## Properties

| Property | Type |
|---|---|
| `pinned` | `string[]` |
| `hidden` | `string[]` |

<!-- source: component-testresultbadge.md -->

# TestResultBadge

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/ProviderConfig.tsx` (line 128)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `success` | `boolean` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TestResultBadge_157732fa["TestResultBadge"]
    class component_TestResultBadge_157732fa rootComponent
```

## Referenced By

- `ProviderConfig` (RENDERS)

<!-- source: interface-testsnapshot.md -->

# TestSnapshot

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/circle-detector.ts` (line 44)

## Properties

| Property | Type |
|---|---|
| `passed` | `number` |
| `failed` | `number` |
| `failingTests` | `string[]` |

<!-- source: interface-docclassificationmeta.md -->

# DocClassificationMeta

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/knowledge-reference.types.ts` (line 91)

## Properties

| Property | Type |
|---|---|
| `categoryName` | `string` |
| `targetPersonas` | `string[]` |
| `featureIds` | `string[]` |
| `difficulty` | `string` |

<!-- source: api-endpoint-getescalation.md -->

# getEscalation

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 349)

## Endpoint

`GET /technical-docs/:projectId/escalation`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: constant-lexicaltheme-2.md -->

# lexicalTheme$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 929)

<!-- source: component-placeholder.md -->

# Placeholder

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 100)

## Diagram

```mermaid
graph TD
    component_Placeholder_36b00417["Placeholder"]
    class component_Placeholder_36b00417 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: interface-statemachine.md -->

# StateMachine

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-machine.interface.ts` (line 144)

Complete state machine definition

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `enumName` | `string` |
| `states` | `StateNode[]` |
| `transitions` | `StateTransition[]` |
| `validationRules` | `string[]` |
| `initialState` | `string` |
| `filePath` | `string` |
| `metadata` | `Record<string, unknown>` |

<!-- source: interface-technicaldoccategory.md -->

# TechnicalDocCategory

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-materializer.service.ts` (line 112)

## Properties

| Property | Type |
|---|---|
| `slug` | `string` |
| `name` | `string` |
| `parentSlug` | `string | null` |
| `order` | `number` |

<!-- source: interface-testwatcherconfig.md -->

# TestWatcherConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/test-watcher.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `testCommand` | `string` |
| `cwd` | `string` |
| `debounceMs` | `number` |
| `timeoutMs` | `number` |
| `enabled` | `boolean` |
| `reportPassingTests` | `boolean` |

<!-- source: component-ticker.md -->

# Ticker

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/page.tsx` (line 474)

## Diagram

```mermaid
graph TD
    component_Ticker_67be73ac["Ticker"]
    class component_Ticker_67be73ac rootComponent
```

## Referenced By

- `HomePage` (RENDERS)

<!-- source: interface-docsconfig-2.md -->

# DocsConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/docs-config.ts` (line 8)

Per-project docs configuration — the S2 review gate. When `requireReview` is true, saving
edits to a published public page opens a change request for review instead of writing the
live page directly.

## Properties

| Property | Type |
|---|---|
| `requireReview` | `boolean` |

<!-- source: api-endpoint-getfeedbacksummary.md -->

# getFeedbackSummary

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 190)

## Endpoint

`GET /analytics/:projectId/feedback-summary`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: constant-linkautocompletesuggestions.md -->

# linkAutocompleteSuggestions$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 343)

<!-- source: component-popoverportal.md -->

# PopoverPortal

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/ui/PopoverUtils.tsx` (line 7)

## Diagram

```mermaid
graph TD
    component_PopoverPortal_5c262bd4["PopoverPortal"]
    class component_PopoverPortal_5c262bd4 rootComponent
```

## Relationships

- RENDERS → `RadixPopover-Portal`
- USES_HOOK → `useCellValue`

<!-- source: interface-statemachineanalysisresult.md -->

# StateMachineAnalysisResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-machine.interface.ts` (line 190)

Result of state machine analysis

## Properties

| Property | Type |
|---|---|
| `stateMachines` | `StateMachine[]` |
| `totalStates` | `number` |
| `totalTransitions` | `number` |
| `filePath` | `string` |
| `analyzedAt` | `Date` |

<!-- source: interface-technicaldocpage.md -->

# TechnicalDocPage

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-materializer.service.ts` (line 119)

## Properties

| Property | Type |
|---|---|
| `slug` | `string` |
| `title` | `string` |
| `content` | `string` |
| `pageType` | `'reference' | 'concept'` |
| `categorySlug` | `string` |
| `order` | `number` |
| `entityId` | `string` |

<!-- source: component-timelinecard.md -->

# TimelineCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/documents/[id]/compare/page.tsx` (line 838)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `change` | `VersionChange` | ✓ | - |
| `formatDate` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TimelineCard_2e54a068["TimelineCard"]
    class component_TimelineCard_2e54a068 rootComponent
```

## Relationships

- RENDERS → `ChangePairBlock`

## Referenced By

- `TimelineView` (RENDERS)

<!-- source: interface-todoitem.md -->

# TodoItem

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/todo-manager.ts` (line 10)

Todo Manager

Structured task list re-injected after every tool call.
Prevents objective drift after 3-4 steps in the agent loop.

Zero SDK imports — operates on our own interfaces.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `description` | `string` |
| `status` | `'pending' | 'in_progress' | 'completed' | 'skipped'` |
| `result` | `string` |
| `createdAt` | `number` |
| `completedAt` | `number` |

<!-- source: interface-docscreenshotrequest.md -->

# DocScreenshotRequest

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/agent-screenshot-mapper.ts` (line 107)

Input: a doc's screenshot placeholders to be mapped

## Properties

| Property | Type |
|---|---|
| `docPath` | `string` |
| `docTitle` | `string` |
| `category` | `string` |
| `placeholders` | `Array<{
    id: string;
    description: string;
    sectionHeading: string;
  }>` |

<!-- source: api-endpoint-getflow.md -->

# getFlow

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/capture/public-capture.controller.ts` (line 17)

## Endpoint

`GET /public/capture/flows/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `PublicCaptureController` (MODULE_DECLARES)

<!-- source: constant-linkdialogplugin.md -->

# linkDialogPlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 387)

<!-- source: component-pricingcolumns-2.md -->

# PricingColumns

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/pricing/pricing-columns.tsx` (line 27)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `labelKey` | `string` | - | - |
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `tiers` | `PricingTier[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PricingColumns_445ce9f7["PricingColumns"]
    class component_PricingColumns_445ce9f7 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-span`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `PricingTierCard`
- USES_HOOK → `useTranslation`

<!-- source: interface-statemachinecoverage.md -->

# StateMachineCoverage

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/coverage-calculator.ts` (line 23)

Coverage metrics for a single state machine

## Properties

| Property | Type |
|---|---|
| `stateMachineName` | `string` |
| `enumName` | `string` |
| `totalStates` | `number` |
| `coveredStates` | `number` |
| `stateCoveragePercent` | `number` |
| `totalTransitions` | `number` |
| `coveredTransitions` | `number` |
| `transitionCoveragePercent` | `number` |
| `uncoveredStates` | `string[]` |
| `uncoveredTransitions` | `string[]` |
| `terminalStatesCovered` | `string[]` |
| `terminalStatesUncovered` | `string[]` |
| `approvalStatesCovered` | `string[]` |
| `approvalStatesUncovered` | `string[]` |

<!-- source: interface-technicaldocset.md -->

# TechnicalDocSet

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-materializer.service.ts` (line 138)

## Properties

| Property | Type |
|---|---|
| `categories` | `TechnicalDocCategory[]` |
| `documents` | `TechnicalDocPage[]` |

<!-- source: component-timelineview.md -->

# TimelineView

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/documents/[id]/compare/page.tsx` (line 791)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `changes` | `VersionChange[]` | ✓ | - |
| `loading` | `boolean` | ✓ | - |
| `formatDate` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TimelineView_2e5d5ffd["TimelineView"]
    class component_TimelineView_2e5d5ffd rootComponent
```

## Relationships

- RENDERS → `ClockIcon`
- RENDERS → `TimelineCard`

## Referenced By

- `CompareDocumentsPage` (RENDERS)

<!-- source: interface-todostats.md -->

# TodoStats

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/protocol/agent-protocol.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `total` | `number` |
| `completed` | `number` |
| `pending` | `number` |
| `inProgress` | `number` |
| `skipped` | `number` |

<!-- source: interface-doctypeclassification.md -->

# DocTypeClassification

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/doc-type-classifier.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `type` | `DocType` |
| `secondaryType` | `DocType` |
| `confidence` | `number` |
| `signals` | `string[]` |

<!-- source: api-endpoint-getgeobreakdown.md -->

# getGeoBreakdown

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 116)

## Endpoint

`GET /analytics/:projectId/geo`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: constant-linkdialogstate.md -->

# linkDialogState$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 91)

The current state of the link dialog.

<!-- source: component-pricingcomparisontable-2.md -->

# PricingComparisonTable

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/pricing/pricing-comparison-table.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `plans` | `unknown[]` | ✓ | - |
| `features` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PricingComparisonTable_762df8ca["PricingComparisonTable"]
    class component_PricingComparisonTable_762df8ca rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `motion-table`
- RENDERS → `ComparisonRow`
- USES_HOOK → `useTranslation`

<!-- source: interface-statemachinediagramoptions.md -->

# StateMachineDiagramOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/diagrams/state-machine-diagram.generator.ts` (line 34)

Options for state machine diagram generation

## Properties

| Property | Type |
|---|---|
| `showCoverage` | `boolean` |
| `colorScheme` | `CoverageColorScheme` |
| `annotations` | `boolean` |
| `showMethods` | `boolean` |
| `showApprovalRequirements` | `boolean` |
| `showModalTriggers` | `boolean` |
| `direction` | `'TB' | 'LR'` |
| `includeTheme` | `boolean` |

<!-- source: interface-technicaldocsjoboptions.md -->

# TechnicalDocsJobOptions

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-parser.service.ts` (line 23)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `organizationId` | `string` |
| `repoUrl` | `string` |
| `branch` | `string` |
| `credentials` | `{ username?: string; password?: string }` |
| `userId` | `string` |

<!-- source: component-toastview.md -->

# ToastView

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/Toast.tsx` (line 75)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `toast` | `ToastItem` | ✓ | - |
| `onDismiss` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ToastView_64df5a3b["ToastView"]
    class component_ToastView_64df5a3b rootComponent
```

## Relationships

- RENDERS → `Icon`
- RENDERS → `XMarkIcon`

## Referenced By

- `BoardsToastProvider` (RENDERS)

<!-- source: interface-tokenusage-2.md -->

# TokenUsage

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 142)

## Properties

| Property | Type |
|---|---|
| `inputTokens` | `number` |
| `outputTokens` | `number` |
| `totalTokens` | `number` |

<!-- source: interface-document.md -->

# Document

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/documents.ts` (line 11)

Document model for API responses

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `slug` | `string` |
| `content` | `string` |
| `contentHtml` | `string` |
| `type` | `string` |
| `source` | `string` |
| `audiences` | `string[]` |
| `projectId` | `string` |
| `createdById` | `string` |
| `updatedById` | `string` |
| `state` | `string` |
| `isPublic` | `boolean` |
| `canRegenerate` | `boolean` |
| `kgEntityId` | `string` |
| `kgEntityType` | `string` |
| `createdAt` | `string` |
| `updatedAt` | `string` |

<!-- source: api-endpoint-getghostdocs.md -->

# getGhostDocs

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 143)

## Endpoint

`GET /analytics/:projectId/ghost-docs`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: constant-linkplugin.md -->

# linkPlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link/index.tsx` (line 21)

A plugin that adds support for links in the editor.

<!-- source: component-pricingherocard-2.md -->

# PricingHeroCard

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/pricing/pricing-hero-card.tsx` (line 34)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `heroPlan` | `PricingPlan` | ✓ | - |
| `secondaryPlans` | `PricingPlan[]` | - | - |

## Diagram

```mermaid
graph TD
    component_PricingHeroCard_3836d2e8["PricingHeroCard"]
    class component_PricingHeroCard_3836d2e8 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `Check`
- RENDERS → `ArrowRight`
- USES_HOOK → `useTranslation`

<!-- source: interface-statemanagementinfo-2.md -->

# StateManagementInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 481)

State management information

## Properties

| Property | Type |
|---|---|
| `type` | `| 'useState'
    | 'useReducer'
    | 'context'
    | 'redux'
    | 'zustand'
    | 'pinia'
    | 'other'` |
| `stores` | `string[]` |
| `actions` | `string[]` |
| `selectors` | `string[]` |

<!-- source: interface-technicaldocsjobpayload.md -->

# TechnicalDocsJobPayload

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-generation.service.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `organizationId` | `string` |
| `repoUrl` | `string` |
| `branch` | `string` |
| `credentials` | `{ username?: string; password?: string }` |
| `userId` | `string` |

<!-- source: component-toolbarbutton.md -->

# ToolbarButton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/EditorToolbar.tsx` (line 10)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onClick` | `Function` | ✓ | - |
| `active` | `boolean` | - | - |
| `disabled` | `boolean` | - | - |
| `children` | `unknown` | ✓ | - |
| `title` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ToolbarButton_1f84a7ff["ToolbarButton"]
    class component_ToolbarButton_1f84a7ff rootComponent
```

## Referenced By

- `EditorToolbar` (RENDERS)

<!-- source: interface-toolcallrecord.md -->

# ToolCallRecord

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/benchmark/types.ts` (line 141)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `durationMs` | `number` |
| `inputPreview` | `string` |
| `outputPreview` | `string` |

<!-- source: interface-documentast.md -->

# DocumentAST

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 87)

Document AST root

## Properties

| Property | Type |
|---|---|
| `nodes` | `ASTNode[]` |
| `blocks` | `Map<string, BlockDefinitionNode>` |
| `errors` | `ParseError[]` |
| `warnings` | `ParseWarning[]` |

<!-- source: api-endpoint-gethealth-2.md -->

# getHealth

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/search.controller.ts` (line 189)

Health check for search service

GET /search/health

Returns search service status:
- enabled: true/false (from AZURE_SEARCH_ENABLED)
- configured: true/false (credentials present)
- indexName: The index being used

## Endpoint

`GET /search/health`

## Referenced By

- `SearchController` (MODULE_DECLARES)

<!-- source: constant-listsplugin.md -->

# listsPlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/lists/index.ts` (line 101)

A plugin that adds support for markdown lists.

<!-- source: component-pricingtiercard-2.md -->

# PricingTierCard

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/pricing-tier-card.tsx` (line 30)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `nameKey` | `string` | ✓ | - |
| `priceKey` | `string` | ✓ | - |
| `intervalKey` | `string` | - | - |
| `descriptionKey` | `string` | - | - |
| `features` | `PricingFeature[]` | ✓ | - |
| `ctaKey` | `string` | ✓ | - |
| `ctaUrl` | `string` | ✓ | - |
| `highlighted` | `boolean` | - | false |
| `badgeKey` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_PricingTierCard_74505afb["PricingTierCard"]
    class component_PricingTierCard_74505afb rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `Check`
- USES_HOOK → `useTranslation`

<!-- source: interface-statenode.md -->

# StateNode

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-machine.interface.ts` (line 25)

State Machine Interfaces

Defines types for representing state machines extracted from code.
Used to model business workflows like job approval, order processing, etc.

## Properties

| Property | Type |
|---|---|
| `value` | `number | string` |
| `name` | `string` |
| `isTerminal` | `boolean` |
| `requiresApproval` | `boolean` |
| `metadata` | `Record<string, unknown>` |

<!-- source: interface-technicaldocsjobresult.md -->

# TechnicalDocsJobResult

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-parser.service.ts` (line 41)

## Properties

| Property | Type |
|---|---|
| `entityCount` | `number` |
| `relationshipCount` | `number` |
| `hasApiSpec` | `boolean` |
| `durationMs` | `number` |

<!-- source: interface-tooldefinition.md -->

# ToolDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 60)

Tool definition — domain layers define these as plain objects.
agent-runtime.ts converts them to SDK FunctionTool instances.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `parameters` | `Record<string, unknown>` |
| `execute` | `(context: RunContext<TContext>, input: string) => Promise<string>` |
| `timeoutMs` | `number` |
| `isConcurrencySafe` | `boolean` |
| `deferLoading` | `boolean` |
| `strict` | `boolean` |

<!-- source: component-topbar.md -->

# TopBar

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/issues/[ticketNumber]/page.tsx` (line 316)

## Diagram

```mermaid
graph TD
    component_TopBar_92a4a9["TopBar"]
    class component_TopBar_92a4a9 rootComponent
```

## Relationships

- RENDERS → `Link`

## Referenced By

- `PublicTicketPage` (RENDERS)

<!-- source: interface-documentationplan.md -->

# DocumentationPlan

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-05.types.ts` (line 65)

## Properties

| Property | Type |
|---|---|
| `totalDocuments` | `number` |
| `categories` | `DocumentCategory[]` |
| `readingOrder` | `string[]` |
| `estimatedSections` | `number` |

<!-- source: api-endpoint-getjob.md -->

# getJob

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 153)

## Endpoint

`GET /doc-automation/jobs/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: constant-logger.md -->

# logger

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/logger.ts` (line 247)

<!-- source: component-privacypolicy.md -->

# PrivacyPolicy

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/pages/PrivacyPolicy.tsx` (line 11)

## Diagram

```mermaid
graph TD
    component_PrivacyPolicy_2efdb285["PrivacyPolicy"]
    class component_PrivacyPolicy_2efdb285 rootComponent
```

## Relationships

- RENDERS → `SEO`
- USES_HOOK → `useTranslation`

<!-- source: interface-statereducermetadata.md -->

# StateReducerMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-management.interface.ts` (line 127)

State reducer metadata (Redux, NgRx)

## Properties

| Property | Type |
|---|---|
| `sliceName` | `string` |
| `initialState` | `Record<string, unknown>` |
| `handlesActions` | `string[]` |
| `stateShape` | `Record<string, string>` |
| `stateTransitions` | `StateTransition[]` |

<!-- source: interface-technicaldocsqueuejob.md -->

# TechnicalDocsQueueJob

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-queue.service.ts` (line 13)

## Properties

| Property | Type |
|---|---|
| `jobId` | `string | null` |
| `options` | `TechnicalDocsJobPayload & { limit?: number }` |
| `kind` | `'generate' | 'index' | 'enrich'` |

<!-- source: interface-toolguideoptions.md -->

# ToolGuideOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/tool-usage-guide.ts` (line 16)

Tool Usage Guide

Generates instruction text that teaches agents how to use filesystem tools
effectively. Modeled after Claude Code's system prompt approach:
- Read before Edit (mandatory)
- Glob to find, Read to understand, Edit to modify
- Uniqueness discipline for surgical edits
- Verification after changes

Inject this into agent instructions when the agent has access to
edit/write tools. Without this guidance, agents will attempt to
regenerate entire files instead of making targeted edits.

## Properties

| Property | Type |
|---|---|
| `tools` | `('read' | 'edit' | 'write' | 'glob' | 'grep' | 'list_directory' | 'bash' | 'todo' | 'spawn_agent' | 'code_analysis' | 'quality_gate' | 'note' | 'web_search' | 'web_fetch' | 'rollback_file' | 'memory' | 'semantic_search' | 'tool_search' | 'apply_patch' | 'journal' | 'multi_edit' | 'notebook_read' | 'notebook_edit' | 'send_message' | 'cron_create' | 'cron_delete' | 'cron_list' | 'enter_worktree' | 'exit_worktree')[]` |
| `includeWorkflow` | `boolean` |

<!-- source: component-typeicon.md -->

# TypeIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/RelationsPanel.tsx` (line 46)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `type` | `string` | ✓ | - |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_TypeIcon_28cc00b1["TypeIcon"]
    class component_TypeIcon_28cc00b1 rootComponent
```

## Relationships

- RENDERS → `CogIcon`
- RENDERS → `CommandLineIcon`
- RENDERS → `CircleStackIcon`
- RENDERS → `CubeIcon`
- RENDERS → `ShieldCheckIcon`
- RENDERS → `PuzzlePieceIcon`
- RENDERS → `CodeBracketIcon`
- RENDERS → `DocumentTextIcon`

## Referenced By

- `RelItem` (RENDERS)

<!-- source: interface-documentationrelevantdeps.md -->

# DocumentationRelevantDeps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 256)

DocumentationRelevantDeps - What to load when extracting an entity

When we extract OrderForm.tsx, we should also load:
- orderValidationSchema.ts (FULLY - contains validation rules)
- OrderService.create() (signature + JSDoc)
- useOrderState hook (state shape)
- ORDER_STATUS enum (ALL values)

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `required` | `Array<{
    entityId: string;
    reason: 'validation' | 'state' | 'constants' | 'error_handling';
    loadStrategy: 'full' | 'signature_only' | 'values_only';
  }>` |
| `helpful` | `Array<{
    entityId: string;
    reason: string;
    loadStrategy: 'full' | 'signature_only';
  }>` |
| `estimatedTokens` | `{
    required: number;
    helpful: number;
    total: number;
  }` |

<!-- source: api-endpoint-getjob-2.md -->

# getJob

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/pme/pme.controller.ts` (line 49)

## Endpoint

`GET /pme/jobs/:jobId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `jobId` | query | `string` | ✓ |

## Referenced By

- `PmeController` (MODULE_DECLARES)

<!-- source: constant-markdown-export-css.md -->

# MARKDOWN_EXPORT_CSS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/markdown-engine/src/lib/render.ts` (line 67)

A compact github-flavoured highlight.js theme plus base prose styles, meant to
be inlined into a <style> tag of a self-contained export document (PDF/HTML).
Kept here so the renderer's highlight output and the CSS that styles it stay
in one place.

<!-- source: component-problemcentered-2.md -->

# ProblemCentered

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/problem/problem-centered.tsx` (line 21)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `problems` | `Problem[]` | ✓ | - |
| `solutionKey` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_ProblemCentered_582b2e70["ProblemCentered"]
    class component_ProblemCentered_582b2e70 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: interface-stateselectormetadata.md -->

# StateSelectorMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-management.interface.ts` (line 157)

State selector metadata (Redux, NgRx, Pinia)

## Properties

| Property | Type |
|---|---|
| `selectorName` | `string` |
| `statePath` | `string[]` |
| `isMemoized` | `boolean` |
| `dependsOn` | `string[]` |
| `usedBy` | `string[]` |
| `returnType` | `string` |

<!-- source: interface-technicalnavmap.md -->

# TechnicalNavMap

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-materializer.service.ts` (line 52)

## Properties

| Property | Type |
|---|---|
| `apps` | `NavSection[]` |
| `libs` | `NavSection[]` |
| `other` | `NavTypeGroup[]` |

<!-- source: interface-toolregistryconfig.md -->

# ToolRegistryConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/tool-registry.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `tools` | `ToolDefinition<any>[]` |

<!-- source: component-unifieddiff.md -->

# UnifiedDiff

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/documents/[id]/compare/page.tsx` (line 438)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `diffLines` | `DiffLine[]` | ✓ | - |
| `fromRevision` | `DocumentRevision | null` | ✓ | - |
| `toRevision` | `DocumentRevision | null` | ✓ | - |
| `formatDate` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_UnifiedDiff_27573860["UnifiedDiff"]
    class component_UnifiedDiff_27573860 rootComponent
```

## Relationships

- RENDERS → `DiffLineRow`

## Referenced By

- `CompareDocumentsPage` (RENDERS)

<!-- source: interface-documentationtopic.md -->

# DocumentationTopic

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-04.types.ts` (line 42)

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `description` | `string` |
| `type` | `DocumentType` |
| `priority` | `1 | 2 | 3 | 4 | 5` |
| `estimatedSections` | `number` |

<!-- source: api-endpoint-getjob-3.md -->

# getJob

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/screenshot/screenshot.controller.ts` (line 69)

## Endpoint

`GET /screenshots/jobs/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ScreenshotController` (MODULE_DECLARES)

<!-- source: constant-markdown.md -->

# markdown$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 242)

Holds the current markdown value.

<!-- source: component-problemsplitvisual-2.md -->

# ProblemSplitVisual

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/problem/problem-split-visual.tsx` (line 28)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `problems` | `Problem[]` | ✓ | - |
| `imageSrc` | `string` | ✓ | - |
| `imageAlt` | `string` | ✓ | - |
| `imagePosition` | `unknown | unknown` | - | "start" |

## Diagram

```mermaid
graph TD
    component_ProblemSplitVisual_2e71c2e3["ProblemSplitVisual"]
    class component_ProblemSplitVisual_2e71c2e3 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: interface-statesideeffect.md -->

# StateSideEffect

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-management.interface.ts` (line 63)

Side effect during state transition

## Properties

| Property | Type |
|---|---|
| `type` | `'api-call' | 'navigation' | 'notification' | 'cache-update' | 'analytics'` |
| `description` | `string` |
| `metadata` | `Record<string, unknown>` |

<!-- source: interface-threewaysection.md -->

# ThreeWaySection

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/change-request/diff.types.ts` (line 6)

## Properties

| Property | Type |
|---|---|
| `heading` | `string` |
| `level` | `number` |
| `base` | `string` |
| `mine` | `string` |
| `theirs` | `string` |
| `state` | `'unchanged'|'take-theirs'|'keep-mine'|'conflict'` |

<!-- source: interface-toolresult.md -->

# ToolResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/tool-result-manager.ts` (line 12)

Tool Result Manager

Manages tool call results in the context window:
- Truncates results exceeding a token budget
- Clears results older than N turns
- Large outputs can be stored as files instead

Zero SDK imports — operates on our own interfaces.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `toolName` | `string` |
| `result` | `string` |
| `turn` | `number` |
| `tokenEstimate` | `number` |
| `truncated` | `boolean` |

<!-- source: component-usagepanel.md -->

# UsagePanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/ai/page.tsx` (line 227)

Usage panel — renders REAL current-billing-month AI usage from /billing/summary. Only surfaces figures the API actually provides (this-month totals + per-provider breakdown). No fabricated daily/weekly buckets; honest-empty when there is no usage.

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `usage` | `RealUsage | null` | ✓ | - |
| `loading` | `boolean` | - | - |

## Diagram

```mermaid
graph TD
    component_UsagePanel_9b1dcca["UsagePanel"]
    class component_UsagePanel_9b1dcca rootComponent
```

## Referenced By

- `AISettingsPage` (RENDERS)

<!-- source: interface-documentcategory.md -->

# DocumentCategory

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-05.types.ts` (line 72)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `documentCount` | `number` |
| `priority` | `number` |

<!-- source: api-endpoint-getjobsbyproject.md -->

# getJobsByProject

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/pme/pme.controller.ts` (line 61)

## Endpoint

`GET /pme/projects/:projectId/jobs`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `PmeController` (MODULE_DECLARES)

<!-- source: constant-markdownerrorsignal.md -->

# markdownErrorSignal$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 180)

<!-- source: component-projectcard.md -->

# ProjectCard

**Kind:** Component

**Source:** `atloria-monorepo/packages/ui-react/src/components/ProjectCard.tsx` (line 46)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `project` | `Project` | ✓ | - |
| `onClick` | `Function` | - | - |
| `showDescription` | `boolean` | - | true |
| `showMenu` | `boolean` | - | false |
| `onDelete` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_ProjectCard_778a6dfb["ProjectCard"]
    class component_ProjectCard_778a6dfb rootComponent
```

## Relationships

- RENDERS → `FolderIcon`
- RENDERS → `EllipsisVerticalIcon`
- RENDERS → `TrashIcon`
- RENDERS → `CalendarIcon`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-statestoremetadata.md -->

# StateStoreMetadata

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-management.interface.ts` (line 227)

State store metadata (Zustand, MobX, Pinia)

## Properties

| Property | Type |
|---|---|
| `storeName` | `string` |
| `stateShape` | `Record<string, string>` |
| `actions` | `Array<{
    name: string;
    parameters?: Array<{ name: string; type: string }>;
    isAsync: boolean;
    sideEffects?: StateSideEffect[];
  }>` |
| `getters` | `Array<{
    name: string;
    dependsOn: string[];
    returnType?: string;
  }>` |
| `usedBy` | `string[]` |

<!-- source: interface-ticketitem.md -->

# TicketItem

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/technical-docs/techdocs-sources.service.ts` (line 15)

A pulled ticket/conversation with the `updatedAt` used to advance a connector's sync cursor.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `subject` | `string` |
| `body` | `string` |
| `updatedAt` | `string` |

<!-- source: interface-toolresultmanagerconfig.md -->

# ToolResultManagerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/context/tool-result-manager.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `maxTokensPerResult` | `number` |
| `maxAgeTurns` | `number` |
| `maxTotalTokens` | `number` |

<!-- source: component-useravatar.md -->

# UserAvatar

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/CollaborationStatusBar.tsx` (line 39)

User avatar component with color-coded border

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `user` | `CollaborationUser` | ✓ | - |
| `size` | `unknown | unknown | unknown` | - | "default" |
| `showTooltip` | `boolean` | - | true |

## Diagram

```mermaid
graph TD
    component_UserAvatar_100ae536["UserAvatar"]
    class component_UserAvatar_100ae536 rootComponent
```

## Relationships

- USES_HOOK → `useState`

## Referenced By

- `CollaborationStatusBar` (RENDERS)

<!-- source: interface-documentcategorystructure.md -->

# DocumentCategoryStructure

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-06.types.ts` (line 50)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `icon` | `string` |
| `order` | `number` |
| `documentIds` | `string[]` |
| `parentId` | `string` |
| `level` | `1 | 2 | 3` |
| `subcategoryIds` | `string[]` |

<!-- source: api-endpoint-getjobstatus-3.md -->

# getJobStatus

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/sync.controller.ts` (line 132)

## Endpoint

`GET /projects/sync/jobs/:jobId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `jobId` | query | `string` | ✓ |

## Referenced By

- `SyncController` (MODULE_DECLARES)

<!-- source: constant-markdownprocessingerror.md -->

# markdownProcessingError$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 177)

Emits a processing error when such happens

<!-- source: component-propertypopover.md -->

# PropertyPopover

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/PropertyPopover.tsx` (line 16)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `title` | `any` | ✓ | - |
| `properties` | `any` | ✓ | - |
| `onChange` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PropertyPopover_7bdce1ea["PropertyPopover"]
    class component_PropertyPopover_7bdce1ea rootComponent
```

## Relationships

- RENDERS → `RadixPopover-Root`
- RENDERS → `RadixPopover-Trigger`
- RENDERS → `PopoverPortal`
- RENDERS → `PopoverContent`
- USES_HOOK → `useState`
- USES_HOOK → `useCellValue`
- USES_HOOK → `useForm`

<!-- source: interface-statetransition.md -->

# StateTransition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-machine.interface.ts` (line 67)

A transition between two states

## Properties

| Property | Type |
|---|---|
| `from` | `string` |
| `to` | `string` |
| `method` | `string` |
| `requiresModal` | `boolean` |
| `approvalRequired` | `boolean` |
| `trigger` | `'user-action' | 'system-event' | 'time-based' | 'automatic'` |
| `conditions` | `string[]` |
| `metadata` | `Record<string, unknown>` |

<!-- source: interface-tickettopicproposal-2.md -->

# TicketTopicProposal

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/manuals-insights/manuals-insights.service.ts` (line 80)

One redacted, human-facing content-loop proposal (what the cockpit/GET returns).

## Properties

| Property | Type |
|---|---|
| `topicKey` | `string` |
| `title` | `string` |
| `ticketCount` | `number` |
| `exampleQuestions` | `string[]` |
| `suggestedAnswerSourcePages` | `Array<{ slug: string; title: string }>` |
| `alreadyDocumented` | `false` |

<!-- source: interface-toolschema.md -->

# ToolSchema

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/model-provider-interface.ts` (line 26)

Tool schema sent to the model.
Matches the OpenAI function-calling format (industry standard).

## Properties

| Property | Type |
|---|---|
| `type` | `'function'` |
| `name` | `string` |
| `description` | `string` |
| `parameters` | `Record<string, unknown>` |
| `strict` | `boolean` |

<!-- source: component-verdictdot.md -->

# VerdictDot

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/compare/gitbook/page.tsx` (line 101)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `verdict` | `unknown | unknown | unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_VerdictDot_4ed120dc["VerdictDot"]
    class component_VerdictDot_4ed120dc rootComponent
```

## Referenced By

- `CompareGitBookPage` (RENDERS)

<!-- source: interface-documentcompareresult.md -->

# DocumentCompareResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/types/api-client.ts` (line 45)

Result of comparing two document versions or revisions

## Properties

| Property | Type |
|---|---|
| `from` | `{
    id: string;
    version?: number;
    title: string;
    content: string;
    createdAt: string;
    createdBy?: { id: string; name: string; email: string };
  }` |
| `to` | `{
    id: string;
    version?: number;
    title: string;
    content: string;
    createdAt: string;
    createdBy?: { id: string; name: string; email: string };
  }` |
| `diff` | `{
    title?: { changed: boolean; from: string; to: string };
    content?: Array<{ type: string; value: string; lineNumber?: number }>;
    metadata?: Array<{ field: string; changed: boolean; from: any; to: any }>;
    stats?: {
      additions: number;
      deletions: number;
      modifications: number;
    };
  }` |

<!-- source: api-endpoint-getllmsfulltxt.md -->

# getLlmsFullTxt

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-mcp.controller.ts` (line 226)

## Endpoint

`GET /technical-docs/:projectId/llms-full.txt`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsMcpController` (MODULE_DECLARES)

<!-- source: constant-markdownsourceeditorvalue.md -->

# markdownSourceEditorValue$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 898)

The current value of the source/diff editors.

<!-- source: component-readonly.md -->

# ReadOnly

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/link-dialog.tsx` (line 50)

## Diagram

```mermaid
graph TD
    component_ReadOnly_41143212["ReadOnly"]
    class component_ReadOnly_41143212 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useState`

<!-- source: interface-statetransition-2.md -->

# StateTransition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/state-management.interface.ts` (line 33)

State transition for async operations

## Properties

| Property | Type |
|---|---|
| `from` | `string` |
| `to` | `string` |
| `trigger` | `string` |
| `condition` | `string` |
| `sideEffects` | `StateSideEffect[]` |

<!-- source: interface-timelinestats.md -->

# TimelineStats

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/dto/document-stats.dto.ts` (line 15)

Timeline statistics

## Properties

| Property | Type |
|---|---|
| `date` | `string` |
| `revisions` | `number` |
| `versions` | `number` |

<!-- source: interface-toolsearchresult.md -->

# ToolSearchResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/tool-registry.ts` (line 29)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `parameters` | `Record<string, unknown>` |

<!-- source: component-verdictdot-2.md -->

# VerdictDot

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/compare/mintlify/page.tsx` (line 100)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `verdict` | `unknown | unknown | unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_VerdictDot_4f0f8b09["VerdictDot"]
    class component_VerdictDot_4f0f8b09 rootComponent
```

## Referenced By

- `CompareMintlifyPage` (RENDERS)

<!-- source: interface-documentfilters.md -->

# DocumentFilters

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/document.dto.ts` (line 57)

DTO for filtering/searching documents

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `categoryId` | `string` |
| `docVersionId` | `string` |
| `type` | `DocumentType` |
| `state` | `DocumentState` |
| `audiences` | `Audience[]` |
| `search` | `string` |
| `sortBy` | `string` |
| `sortOrder` | `'asc' | 'desc'` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: api-endpoint-getllmsfulltxtbyurl.md -->

# getLlmsFullTxtByUrl

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 254)

## Endpoint

`GET /public/p/:slugWithId/llms-full.txt`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-maxlengthplugin.md -->

# maxLengthPlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/maxlength/index.ts` (line 16)

A plugin that limits the maximum length of the text content of the editor.
Adapted from the Lexical plugin. https://github.com/facebook/lexical/blob/main/packages/lexical-playground/src/plugins/MaxLengthPlugin/index.tsx

<!-- source: component-readonly-2.md -->

# ReadOnly

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/toolbar.tsx` (line 48)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `readOnly` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ReadOnly_27e2e1ee["ReadOnly"]
    class component_ReadOnly_27e2e1ee rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: interface-storyentry.md -->

# StoryEntry

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/storybook/types.ts` (line 49)

Individual story entry

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `exportName` | `string` |
| `parameters` | `Record<string, unknown>` |
| `args` | `Record<string, unknown>` |
| `argTypes` | `Record<string, ArgType>` |
| `locStart` | `number` |
| `locEnd` | `number` |
| `meta` | `{
    /** Custom story name */
    storyName?: string;
    /** Width hint */
    width?: number;
    /** Height hint */
    height?: number;
    /** Additional metadata */
    [key: string]: unknown;
  }` |
| `render` | `string` |

<!-- source: interface-tocentry.md -->

# TocEntry

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/services/toc-builder.service.ts` (line 3)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `text` | `string` |
| `level` | `number` |
| `children` | `TocEntry[]` |

<!-- source: interface-toolsearchtooloptions.md -->

# ToolSearchToolOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/tool-search.tool.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `registry` | `ToolRegistry` |
| `maxResults` | `number` |

<!-- source: component-verifyemailcontent.md -->

# VerifyEmailContent

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(auth)/verify-email/page.tsx` (line 9)

## Diagram

```mermaid
graph TD
    component_VerifyEmailContent_b432c11["VerifyEmailContent"]
    class component_VerifyEmailContent_b432c11 rootComponent
```

## Relationships

- RENDERS → `Link`
- USES_HOOK → `useSearchParams`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

## Referenced By

- `VerifyEmailPage` (RENDERS)

<!-- source: interface-documentfrontmatter.md -->

# DocumentFrontmatter

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-10.types.ts` (line 55)

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `description` | `string` |
| `keywords` | `string[]` |
| `category` | `string` |
| `difficulty` | `string` |
| `estimatedReadTime` | `number` |
| `lastUpdated` | `string` |

<!-- source: api-endpoint-getllmstxt.md -->

# getLlmsTxt

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-mcp.controller.ts` (line 212)

## Endpoint

`GET /technical-docs/:projectId/llms.txt`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsMcpController` (MODULE_DECLARES)

<!-- source: constant-mdastblockquotevisitor.md -->

# MdastBlockQuoteVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/quote/MdastBlockQuoteVisitor.ts` (line 5)

## Definition

```ts
MdastImportVisitor<Mdast.Blockquote>
```

<!-- source: component-readonlydiffmode.md -->

# ReadOnlyDiffMode

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/diff-source.tsx` (line 93)

## Diagram

```mermaid
graph TD
    component_ReadOnlyDiffMode_24ae3442["ReadOnlyDiffMode"]
    class component_ReadOnlyDiffMode_24ae3442 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- USES_HOOK → `useRef`

<!-- source: interface-storyfile.md -->

# StoryFile

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/storybook/types.ts` (line 110)

Parsed story file result

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `fileId` | `string` |
| `stories` | `StoryEntry[]` |
| `defaultExport` | `DefaultExport` |
| `source` | `string` |
| `version` | `CSFVersion` |

<!-- source: interface-tokenusage.md -->

# TokenUsage

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/ai/interfaces/ai-provider.interface.ts` (line 8)

## Properties

| Property | Type |
|---|---|
| `inputTokens` | `number` |
| `outputTokens` | `number` |
| `totalTokens` | `number` |

<!-- source: interface-traceevent.md -->

# TraceEvent

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tracing/otlp-exporter.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `timestamp` | `number` |
| `attributes` | `Record<string, string | number | boolean>` |

<!-- source: component-versionproviderwrapper.md -->

# VersionProviderWrapper

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/PublicLayoutShell.tsx` (line 255)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_VersionProviderWrapper_245f773d["VersionProviderWrapper"]
    class component_VersionProviderWrapper_245f773d rootComponent
```

## Relationships

- RENDERS → `VersionProvider`
- USES_HOOK → `usePathname`

## Referenced By

- `PublicLayoutShell` (RENDERS)

<!-- source: interface-documentlistparams.md -->

# DocumentListParams

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/documents.ts` (line 52)

Document list query parameters

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `categoryId` | `string` |
| `type` | `string` |
| `state` | `string` |
| `audience` | `string` |
| `search` | `string` |
| `sortBy` | `string` |
| `sortOrder` | `'asc' | 'desc'` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: api-endpoint-getllmstxtbyurl.md -->

# getLlmsTxtByUrl

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 238)

## Endpoint

`GET /public/p/:slugWithId/llms.txt`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-mdastbreakvisitor.md -->

# MdastBreakVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/MdastBreakVisitor.ts` (line 7)

## Definition

```ts
MdastImportVisitor<Mdast.Paragraph>
```

<!-- source: component-realmwithplugins.md -->

# RealmWithPlugins

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/RealmWithPlugins.tsx` (line 45)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |
| `plugins` | `RealmPlugin[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_RealmWithPlugins_6f3f6733["RealmWithPlugins"]
    class component_RealmWithPlugins_6f3f6733 rootComponent
```

## Relationships

- RENDERS → `RealmContext-Provider`
- USES_HOOK → `useMemo`
- USES_HOOK → `useEffect`

<!-- source: interface-systemoverviewinput.md -->

# SystemOverviewInput

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/techdocs/system-overview.ts` (line 11)

## Properties

| Property | Type |
|---|---|
| `projectName` | `string` |
| `entities` | `Entity[]` |
| `relationships` | `Relationship[]` |
| `readme` | `string` |

<!-- source: interface-tracespan.md -->

# TraceSpan

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tracing/otlp-exporter.ts` (line 11)

OTLP Tracing Exporter

Generic: SDK TracingExporter → OpenTelemetry → Grafana.
Reusable by any agent (doc-automation, support AI, etc.)

Phase 6: Collects spans from the agent runtime and exports
them in OpenTelemetry format.

## Properties

| Property | Type |
|---|---|
| `traceId` | `string` |
| `spanId` | `string` |
| `parentSpanId` | `string` |
| `operationName` | `string` |
| `serviceName` | `string` |
| `startTime` | `number` |
| `endTime` | `number` |
| `duration` | `number` |
| `status` | `'ok' | 'error' | 'unset'` |
| `attributes` | `Record<string, string | number | boolean>` |
| `events` | `TraceEvent[]` |

<!-- source: interface-trackusageparams.md -->

# TrackUsageParams

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/ai/ai-usage.service.ts` (line 84)

## Properties

| Property | Type |
|---|---|
| `organizationId` | `string` |
| `projectId` | `string` |
| `userId` | `string` |
| `provider` | `string` |
| `model` | `string` |
| `operationType` | `string` |
| `entityType` | `string` |
| `entityId` | `string` |
| `usage` | `TokenUsage` |
| `metadata` | `Record<string, any>` |
| `skipCreditDeduction` | `boolean` |

<!-- source: component-versionseohead.md -->

# VersionSeoHead

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/PublicLayoutShell.tsx` (line 281)

Phase 3: SEO meta tags for versioned docs. - Active version: canonical = self (no version prefix) - Other versions: canonical points to active version - Deprecated: noindex

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `slugId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_VersionSeoHead_6c24ab48["VersionSeoHead"]
    class component_VersionSeoHead_6c24ab48 rootComponent
```

## Relationships

- USES_HOOK → `useVersionContext`
- USES_HOOK → `usePathname`

## Referenced By

- `PublicProjectLayoutInner` (RENDERS)

<!-- source: interface-documentlistprops.md -->

# DocumentListProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/components/DocumentList.tsx` (line 8)

Props for DocumentList component

## Properties

| Property | Type |
|---|---|
| `documents` | `Document[]` |
| `onDocumentClick` | `(document: Document) => void` |
| `loading` | `boolean` |
| `emptyMessage` | `string` |

<!-- source: api-endpoint-getme.md -->

# getMe

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/auth.controller.ts` (line 143)

## Endpoint

`GET /auth/me`

## Referenced By

- `AuthController` (MODULE_DECLARES)

<!-- source: constant-mdastcodevisitor.md -->

# MdastCodeVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/codeblock/MdastCodeVisitor.ts` (line 5)

## Definition

```ts
MdastImportVisitor<Mdast.Code>
```

<!-- source: component-remotemdxeditorrealmprovider.md -->

# RemoteMDXEditorRealmProvider

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/remote/index.tsx` (line 22)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_RemoteMDXEditorRealmProvider_73d336b9["RemoteMDXEditorRealmProvider"]
    class component_RemoteMDXEditorRealmProvider_73d336b9 rootComponent
```

## Relationships

- RENDERS → `RemoteMDXEditorRealmContext-Provider`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`
- USES_HOOK → `useMemo`

<!-- source: interface-tabdefinition.md -->

# TabDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/tab-extractor.ts` (line 21)

A tab definition extracted from template source code.

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `index` | `number` |
| `selector` | `string` |
| `tabSystem` | `string` |
| `conditionalOn` | `string` |
| `hostComponent` | `string` |
| `sourceFile` | `string` |

<!-- source: interface-trajectoryentry.md -->

# TrajectoryEntry

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tracing/trajectory-logger.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `timestamp` | `string` |
| `turn` | `number` |
| `event` | `string` |
| `data` | `Record<string, unknown>` |

<!-- source: interface-troubleshootingitem.md -->

# TroubleshootingItem

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/tutorial-generator.service.ts` (line 52)

## Properties

| Property | Type |
|---|---|
| `issue` | `string` |
| `solution` | `string` |

<!-- source: component-videoplayer.md -->

# VideoPlayer

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 493)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `src` | `string` | ✓ | - |
| `alt` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_VideoPlayer_100b4de7["VideoPlayer"]
    class component_VideoPlayer_100b4de7 rootComponent
```

## Referenced By

- `CustomImage` (RENDERS)

<!-- source: interface-documentlistresponse.md -->

# DocumentListResponse

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/documents.ts` (line 68)

Document list response with pagination

## Properties

| Property | Type |
|---|---|
| `documents` | `Document[]` |
| `totalCount` | `number` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: api-endpoint-getmembers.md -->

# getMembers

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/organization/organization.controller.ts` (line 99)

## Endpoint

`GET /organizations/:id/members`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `OrganizationController` (MODULE_DECLARES)

<!-- source: constant-mdastextensions.md -->

# mdastExtensions$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 282)

<!-- source: component-richtexteditor.md -->

# RichTextEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/MDXEditor.tsx` (line 58)

## Diagram

```mermaid
graph TD
    component_RichTextEditor_167e68e3["RichTextEditor"]
    class component_RichTextEditor_167e68e3 rootComponent
```

## Relationships

- RENDERS → `Child`
- RENDERS → `RenderRecursiveWrappers`
- RENDERS → `RichTextPlugin`
- RENDERS → `ContentEditable`
- USES_HOOK → `useTranslation`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useCellValues`

<!-- source: interface-templateanalysis.md -->

# TemplateAnalysis

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/template-analysis.interface.ts` (line 216)

Complete template analysis result

## Properties

| Property | Type |
|---|---|
| `framework` | `'angular' | 'vue' | 'react'` |
| `buttons` | `ButtonElement[]` |
| `links` | `LinkElement[]` |
| `forms` | `FormElement[]` |
| `conditionals` | `ConditionalBlock[]` |
| `loops` | `LoopBlock[]` |
| `routerLinks` | `RouterLinkElement[]` |
| `childComponents` | `ComponentUsage[]` |
| `modalTriggers` | `ModalTrigger[]` |
| `errors` | `string[]` |

<!-- source: interface-trajectoryloggerconfig.md -->

# TrajectoryLoggerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tracing/trajectory-logger.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `onEntry` | `(line: string) => void` |
| `outputPath` | `string` |
| `includeTokenUsage` | `boolean` |

<!-- source: interface-tutorialcontent.md -->

# TutorialContent

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/tutorial-generator.service.ts` (line 9)

Generated tutorial content

## Properties

| Property | Type |
|---|---|
| `tutorialId` | `string` |
| `title` | `string` |
| `description` | `string` |
| `difficulty` | `string` |
| `estimatedTime` | `string` |
| `category` | `string` |
| `tags` | `string[]` |
| `prerequisites` | `{
    requirements: string[];
    requiredRole?: string;
    beforeYouBegin?: string;
  }` |
| `overview` | `string` |
| `steps` | `TutorialStep[]` |
| `whatYouLearned` | `string` |
| `nextSteps` | `string[]` |
| `tips` | `string[]` |
| `commonMistakes` | `string[]` |
| `troubleshooting` | `TroubleshootingItem[]` |
| `generatedAt` | `Date` |
| `tokensUsed` | `number` |

<!-- source: component-viewbutton.md -->

# ViewButton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/CodeParser.tsx` (line 184)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |
| `active` | `boolean` | ✓ | - |
| `onClick` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ViewButton_2e580519["ViewButton"]
    class component_ViewButton_2e580519 rootComponent
```

## Referenced By

- `CodeParser` (RENDERS)

<!-- source: interface-documentlistresponse-2.md -->

# DocumentListResponse

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/document.dto.ts` (line 74)

Response for list documents with pagination

## Properties

| Property | Type |
|---|---|
| `documents` | `Document[]` |
| `totalCount` | `number` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: api-endpoint-getmembers-2.md -->

# getMembers

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 173)

## Endpoint

`GET /projects/:id/members`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: constant-mdastfrontmattervisitor.md -->

# MdastFrontmatterVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/frontmatter/MdastFrontmatterVisitor.ts` (line 5)

## Definition

```ts
MdastImportVisitor<Mdast.YAML>
```

<!-- source: component-root.md -->

# Root

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/toolbar.tsx` (line 43)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `readOnly` | `any` | ✓ | - |
| `children` | `any` | ✓ | - |
| `className` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Root_7914ca8c["Root"]
    class component_Root_7914ca8c rootComponent
```

## Relationships

- RENDERS → `RadixToolbar-Root`

<!-- source: interface-turnhook.md -->

# TurnHook

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 274)

Hook invoked before each model call within the agent loop.
Allows domain layers to:
- Inject runtime state into instructions (turn budget, progress, tool result summaries)
- Monitor context pressure and warn the agent
- Track turn progression

Implemented by domain layers (e.g., PmeTurnHook), wired in agent-runtime.ts
via the SDK's callModelInputFilter.

<!-- source: interface-tutorialstep.md -->

# TutorialStep

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/tutorial-generator.service.ts` (line 43)

## Properties

| Property | Type |
|---|---|
| `stepNumber` | `number` |
| `title` | `string` |
| `instructions` | `string` |
| `screenshot` | `string` |
| `expectedResult` | `string` |
| `tips` | `string[]` |

<!-- source: interface-uiinteraction.md -->

# UIInteraction

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/ui-interaction.interface.ts` (line 27)

UI Interaction Interface

Represents an interactive element on a page that can trigger state transitions.
Used to link buttons, forms, and other UI elements to their corresponding
state machine transitions.

## Properties

| Property | Type |
|---|---|
| `element` | `string` |
| `action` | `string` |
| `transition` | `string` |
| `targetState` | `string` |
| `requiresModal` | `boolean` |
| `selector` | `string` |
| `componentSource` | `string` |

<!-- source: component-viewerfooter.md -->

# ViewerFooter

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/DocumentViewer.tsx` (line 295)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `document` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ViewerFooter_33064d35["ViewerFooter"]
    class component_ViewerFooter_33064d35 rootComponent
```

## Referenced By

- `DocumentViewer` (RENDERS)

<!-- source: interface-documentlistresponse-3.md -->

# DocumentListResponse

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/types/api-client.ts` (line 35)

Document list response

## Properties

| Property | Type |
|---|---|
| `documents` | `Document[]` |
| `totalCount` | `number` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: api-endpoint-getmetadata.md -->

# getMetadata

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/saml/saml.controller.ts` (line 126)

Get SAML metadata for IdP configuration

## Endpoint

`GET /auth/saml/:orgId/metadata`

| Parameter | In | Type | Required |
|---|---|---|---|
| `orgId` | query | `string` | ✓ |

## Referenced By

- `SamlController` (MODULE_DECLARES)

<!-- source: constant-mdastheadingvisitor.md -->

# MdastHeadingVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/headings/MdastHeadingVisitor.ts` (line 5)

## Definition

```ts
MdastImportVisitor<Mdast.Heading>
```

<!-- source: component-sandpackeditor.md -->

# SandpackEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/sandpack/SandpackEditor.tsx` (line 26)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `nodeKey` | `any` | ✓ | - |
| `code` | `any` | ✓ | - |
| `focusEmitter` | `any` | ✓ | - |
| `preset` | `SandpackPreset` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SandpackEditor_725231f6["SandpackEditor"]
    class component_SandpackEditor_725231f6 rootComponent
```

## Relationships

- RENDERS → `SandpackProvider`
- RENDERS → `SandpackLayout`
- RENDERS → `SandpackCodeEditor`
- RENDERS → `SandpackPreview`
- RENDERS → `CodeUpdateEmitter`
- USES_HOOK → `useCodeMirrorRef`
- USES_HOOK → `useCellValues`
- USES_HOOK → `useCodeBlockEditorContext`
- USES_HOOK → `useTranslation`

<!-- source: interface-turnhookargs.md -->

# TurnHookArgs

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/types.ts` (line 251)

Arguments passed to TurnHook.beforeModelCall() before each model invocation.

## Properties

| Property | Type |
|---|---|
| `instructions` | `string | undefined` |
| `input` | `AgentInputItem[]` |
| `agentName` | `string` |
| `turnNumber` | `number` |
| `context` | `TContext | undefined` |

<!-- source: interface-uniqueconstraint-2.md -->

# UniqueConstraint

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/entity.interface.ts` (line 806)

Unique constraint definition

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `fields` | `string[]` |

<!-- source: interface-updatebrandingdto.md -->

# UpdateBrandingDto

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/branding/branding.service.ts` (line 12)

## Properties

| Property | Type |
|---|---|
| `siteName` | `string | null` |
| `tagline` | `string | null` |
| `logoLightUrl` | `string | null` |
| `faviconUrl` | `string | null` |
| `primaryColor` | `string | null` |
| `accentColor` | `string | null` |
| `supportEmail` | `string | null` |
| `menuStyle` | `string | null` |
| `menuConfig` | `Record<string, any> | null` |
| `theme` | `string | null` |

<!-- source: component-viewerheader.md -->

# ViewerHeader

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/DocumentViewer.tsx` (line 72)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `document` | `unknown` | ✓ | - |
| `readingTime` | `number` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ViewerHeader_30302043["ViewerHeader"]
    class component_ViewerHeader_30302043 rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `ChevronRightIcon`
- RENDERS → `CheckIcon`
- RENDERS → `LinkIcon`
- RENDERS → `PrinterIcon`
- RENDERS → `PencilIcon`
- RENDERS → `ClockIcon`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`

## Referenced By

- `DocumentViewer` (RENDERS)

<!-- source: interface-documentnode.md -->

# DocumentNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 150)

Document node in category

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `slug` | `string` |
| `type` | `string` |
| `description` | `string` |
| `priority` | `number` |
| `metadata` | `{
    sourceScreenSlugs?: string[];
    /** screen-slug → relative screenshot ref paths within the output dir */
    screenImages?: Record<string, string[]>;
    [key: string]: unknown;
  }` |

<!-- source: api-endpoint-getnamedversion.md -->

# getNamedVersion

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 653)

## Endpoint

`GET /documents/:id/versions/:versionNumber`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `versionNumber` | query | `number` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: constant-mdasthtmlimagevisitor.md -->

# MdastHtmlImageVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/MdastImageVisitor.ts` (line 20)

## Definition

```ts
MdastImportVisitor<Mdast.Html>
```

<!-- source: component-select-2.md -->

# Select

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/select.tsx` (line 89)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `value` | `T` | ✓ | - |
| `onChange` | `Function` | ✓ | - |
| `triggerTitle` | `string` | ✓ | - |
| `placeholder` | `string` | ✓ | - |
| `disabled` | `boolean` | - | - |
| `items` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Select_1a72f749["Select"]
    class component_Select_1a72f749 rootComponent
```

## Relationships

- RENDERS → `RadixSelect-Root`
- RENDERS → `SelectTrigger`
- RENDERS → `SelectContent`
- RENDERS → `RadixSelect-Separator`
- RENDERS → `SelectItem`

<!-- source: interface-turnrecord.md -->

# TurnRecord

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/autonomous/circle-detector.ts` (line 29)

## Properties

| Property | Type |
|---|---|
| `turn` | `number` |
| `actionSignature` | `string` |
| `filesEdited` | `string[]` |
| `bashCommands` | `string[]` |
| `testResult` | `TestSnapshot | null` |
| `errorSignatures` | `string[]` |

<!-- source: interface-updateversionmetadatadto.md -->

# UpdateVersionMetadataDto

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/document/services/document-version.service.ts` (line 11)

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `comment` | `string` |

<!-- source: interface-userjourneyanalysisoptions.md -->

# UserJourneyAnalysisOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/user-journey.interface.ts` (line 218)

Options for user journey analysis

## Properties

| Property | Type |
|---|---|
| `criticalOnly` | `boolean` |
| `maxDepth` | `number` |
| `includeSubflows` | `boolean` |
| `includeTemplateFlows` | `boolean` |
| `includeStateMachineFlows` | `boolean` |
| `minNodes` | `number` |

<!-- source: component-warningicon.md -->

# WarningIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/ParsingResults.tsx` (line 128)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_WarningIcon_60b0ae0b["WarningIcon"]
    class component_WarningIcon_60b0ae0b rootComponent
```

## Referenced By

- `ParsingResults` (RENDERS)

<!-- source: interface-documentplan.md -->

# DocumentPlan

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-09.types.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `title` | `string` |
| `sections` | `SectionPlan[]` |
| `frontmatter` | `{
    description: string;
    keywords: string[];
    difficulty: 'beginner' | 'intermediate' | 'advanced';
    estimatedReadTime: number; // minutes
  }` |
| `requiredEntities` | `{
    primary: string[]; // Entity IDs that MUST be included fully
    secondary: string[]; // Entity IDs for context (can be summarized)
    crossChunk: string[]; // Entity IDs from OTHER chunks (need fetching)
  }` |
| `criticalCode` | `Array<{
    entityId: string;
    reason: 'validation' | 'state_machine' | 'error_messages' | 'permissions';
    minCharacters: number; // Minimum chars to include (default: 2000)
  }>` |
| `sourceChunkId` | `string` |
| `relatedChunkIds` | `string[]` |

<!-- source: api-endpoint-getnamedversions.md -->

# getNamedVersions

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 636)

## Endpoint

`GET /documents/:id/versions`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: constant-mdasthtmlvisitor.md -->

# MdastHTMLVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/MdastHTMLVisitor.ts` (line 8)

## Definition

```ts
MdastImportVisitor<MdastHTMLNode>
```

<!-- source: component-selectbuttontrigger.md -->

# SelectButtonTrigger

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/select.tsx` (line 69)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |
| `title` | `any` | ✓ | - |
| `className` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SelectButtonTrigger_193b0d51["SelectButtonTrigger"]
    class component_SelectButtonTrigger_193b0d51 rootComponent
```

## Relationships

- RENDERS → `TooltipWrap`
- RENDERS → `RadixSelect-Trigger`
- RENDERS → `RadixSelect-Icon`
- USES_HOOK → `useCellValues`

<!-- source: interface-upsertsupportagentconfigdto.md -->

# UpsertSupportAgentConfigDto

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.service.ts` (line 12)

## Properties

| Property | Type |
|---|---|
| `includeUserDocs` | `boolean` |
| `includeTechnicalDocs` | `boolean` |
| `includeApiDocs` | `boolean` |
| `scopedCategoryIds` | `string[] | null` |
| `scopedCollectionIds` | `string[] | null` |
| `agentName` | `string` |
| `welcomeMessage` | `string | null` |
| `systemPrompt` | `string | null` |
| `isEnabled` | `boolean` |

<!-- source: interface-userjourneyanalysisresult.md -->

# UserJourneyAnalysisResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/user-journey.interface.ts` (line 181)

Result of analyzing a component for user journeys

## Properties

| Property | Type |
|---|---|
| `source` | `string` |
| `framework` | `'angular' | 'react' | 'vue'` |
| `flows` | `UserJourneyFlow[]` |
| `errors` | `string[]` |
| `warnings` | `string[]` |
| `metadata` | `{
    /** Duration in milliseconds */
    duration: number;

    /** Number of flows found */
    flowCount: number;

    /** Number of nodes across all flows */
    totalNodeCount: number;

    /** Number of edges across all flows */
    totalEdgeCount: number;

    [key: string]: any;
  }` |

<!-- source: interface-vectorstoreconfig.md -->

# VectorStoreConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/semantic/vector-store.ts` (line 53)

## Properties

| Property | Type |
|---|---|
| `storageDir` | `string` |
| `projectRoot` | `string` |

<!-- source: component-webhookscontent.md -->

# WebhooksContent

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/settings/webhooks/page.tsx` (line 37)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_WebhooksContent_4eefa935["WebhooksContent"]
    class component_WebhooksContent_4eefa935 rootComponent
```

## Relationships

- USES_HOOK → `useSession`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useEffect`

## Referenced By

- `WebhooksPage` (RENDERS)

<!-- source: component-acceptinvitepage.md -->

# AcceptInvitePage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/invite/[token]/page.tsx` (line 17)

## Diagram

```mermaid
graph TD
    component_AcceptInvitePage_171c1d80["AcceptInvitePage"]
    class component_AcceptInvitePage_171c1d80 rootComponent
```

## Relationships

- RENDERS → `Link`
- USES_HOOK → `useParams`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-documentrevision.md -->

# DocumentRevision

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/documents.ts` (line 35)

Document revision — snapshot of a document's state at a point in time

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `documentId` | `string` |
| `version` | `number` |
| `content` | `string` |
| `title` | `string` |
| `createdAt` | `string` |
| `createdBy` | `{
    id: string;
    name: string;
    email: string;
  } | null` |

<!-- source: api-endpoint-getone.md -->

# getOne

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 48)

## Endpoint

`GET /projects/:projectId/boards/:boardId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `boardId` | query | `string` | ✓ |
| `includeCards` | query | `string` | - |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: constant-mdastimagevisitor.md -->

# MdastImageVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/MdastImageVisitor.ts` (line 7)

## Definition

```ts
MdastImportVisitor<Mdast.Image>
```

<!-- source: component-seo.md -->

# SEO

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/seo.tsx` (line 31)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `titleKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | ✓ | - |
| `canonicalUrl` | `string` | - | - |
| `ogImage` | `string` | - | - |
| `ogType` | `string` | - | "website" |
| `twitterCard` | `unknown | unknown` | - | "summary_large_image" |
| `structuredData` | `StructuredData` | - | - |
| `noIndex` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_SEO_5fae89e6["SEO"]
    class component_SEO_5fae89e6 rootComponent
```

## Relationships

- RENDERS → `Helmet`
- USES_HOOK → `useTranslation`

<!-- source: interface-usagecost.md -->

# UsageCost

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/ai/ai-usage.service.ts` (line 103)

## Properties

| Property | Type |
|---|---|
| `inputCost` | `number` |
| `outputCost` | `number` |
| `totalCost` | `number` |
| `inputTokens` | `number` |
| `outputTokens` | `number` |
| `totalTokens` | `number` |

<!-- source: interface-userjourneybuildcontext.md -->

# UserJourneyBuildContext

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/user-journey.interface.ts` (line 246)

Context for building user journey nodes

Tracks state while traversing code to build journey flows

## Properties

| Property | Type |
|---|---|
| `componentName` | `string` |
| `currentRoute` | `string` |
| `nodes` | `Map<string, UserJourneyNode>` |
| `edges` | `UserJourneyEdge[]` |
| `visitedNodeIds` | `Set<string>` |
| `depth` | `number` |
| `options` | `UserJourneyAnalysisOptions` |

<!-- source: interface-verboseevent.md -->

# VerboseEvent

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/verbose-logger.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `category` | `string` |
| `message` | `string` |
| `data` | `Record<string, unknown>` |
| `timestamp` | `number` |

<!-- source: component-accordion.md -->

# Accordion

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MDXRenderer.tsx` (line 317)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Accordion_2806ab21["Accordion"]
    class component_Accordion_2806ab21 rootComponent
```

<!-- source: interface-documentrevision-2.md -->

# DocumentRevision

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/types/api-client.ts` (line 77)

Document revision — snapshot of a document at a point in time

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `documentId` | `string` |
| `version` | `number` |
| `content` | `string` |
| `title` | `string` |
| `createdAt` | `string` |
| `createdBy` | `{
    id: string;
    name: string;
    email: string;
  } | null` |

<!-- source: api-endpoint-getone-2.md -->

# getOne

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/issues.controller.ts` (line 65)

## Endpoint

`GET /projects/:projectId/issues/:issueId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `issueId` | query | `string` | ✓ |

## Referenced By

- `IssuesController` (MODULE_DECLARES)

<!-- source: constant-mdastinlinecodevisitor.md -->

# MdastInlineCodeVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/MdastInlineCodeVisitor.ts` (line 26)

## Definition

```ts
MdastImportVisitor<Mdast.InlineCode>
```

<!-- source: component-sharedhistoryplugin.md -->

# SharedHistoryPlugin

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/SharedHistoryPlugin.tsx` (line 6)

## Diagram

```mermaid
graph TD
    component_SharedHistoryPlugin_8198dd6["SharedHistoryPlugin"]
    class component_SharedHistoryPlugin_8198dd6 rootComponent
```

## Relationships

- RENDERS → `HistoryPlugin`
- USES_HOOK → `useCellValue`

<!-- source: interface-userjourneydiagramresult.md -->

# UserJourneyDiagramResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/user-journey-diagram.generator.ts` (line 51)

Result of user journey diagram generation

## Properties

| Property | Type |
|---|---|
| `flows` | `UserJourneyFlow[]` |
| `diagrams` | `Map<string, string>` |
| `errors` | `string[]` |
| `warnings` | `string[]` |
| `stats` | `{
    totalFlows: number;
    totalNodes: number;
    totalEdges: number;
    byFramework: Record<string, number>;
  }` |

<!-- source: interface-verboseloggeroptions.md -->

# VerboseLoggerOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/session/verbose-logger.ts` (line 33)

## Properties

| Property | Type |
|---|---|
| `previewLimit` | `number` |

<!-- source: interface-versiondiff.md -->

# VersionDiff

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/doc-version/version-diff.service.ts` (line 30)

## Properties

| Property | Type |
|---|---|
| `versionA` | `string` |
| `versionB` | `string` |
| `summary` | `{
    added: number;
    removed: number;
    modified: number;
    unchanged: number;
    totalA: number;
    totalB: number;
  }` |
| `documents` | `{
    added: DocDiffEntry[];
    removed: DocDiffEntry[];
    modified: DocDiffEntry[];
    unchanged: DocDiffEntry[];
  }` |
| `categories` | `{
    added: CategoryDiffEntry[];
    removed: CategoryDiffEntry[];
    unchanged: CategoryDiffEntry[];
  }` |

<!-- source: component-accordionitem.md -->

# AccordionItem

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MDXRenderer.tsx` (line 325)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `title` | `any` | ✓ | - |
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_AccordionItem_2067436e["AccordionItem"]
    class component_AccordionItem_2067436e rootComponent
```

## Relationships

- USES_HOOK → `useState`

<!-- source: interface-documentsummary.md -->

# DocumentSummary

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-11.types.ts` (line 81)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `category` | `string` |
| `type` | `string` |
| `keyTerms` | `string[]` |
| `referencedScreens` | `string[]` |
| `referencedRoles` | `string[]` |
| `navigationPaths` | `string[]` |

<!-- source: api-endpoint-getorganizationjobs.md -->

# getOrganizationJobs

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/sync.controller.ts` (line 158)

## Endpoint

`GET /projects/sync/jobs`

## Referenced By

- `SyncController` (MODULE_DECLARES)

<!-- source: constant-mdastjsximagevisitor.md -->

# MdastJsxImageVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/MdastImageVisitor.ts` (line 65)

## Definition

```ts
MdastImportVisitor<MdxJsxTextElement | MdxJsxFlowElement>
```

<!-- source: component-showsandpackinfo.md -->

# ShowSandpackInfo

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/ShowSandpackInfo.tsx` (line 15)

## Diagram

```mermaid
graph TD
    component_ShowSandpackInfo_27202d3b["ShowSandpackInfo"]
    class component_ShowSandpackInfo_27202d3b rootComponent
```

## Relationships

- RENDERS → `ButtonWithTooltip`
- USES_HOOK → `useCellValues`
- USES_HOOK → `useTranslation`

<!-- source: interface-userjourneyedge.md -->

# UserJourneyEdge

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/user-journey.interface.ts` (line 94)

Connection between two nodes in a user journey

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `from` | `string` |
| `to` | `string` |
| `label` | `string` |
| `condition` | `string` |
| `isDefault` | `boolean` |
| `metadata` | `Record<string, any>` |

<!-- source: interface-vercelaiproviderconfig.md -->

# VercelAIProviderConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/runtime/runtime-config.ts` (line 40)

Vercel AI SDK provider configuration.
Uses the `ai` package to call any supported LLM provider.

## Properties

| Property | Type |
|---|---|
| `provider` | `string` |
| `model` | `string` |
| `apiKey` | `string` |
| `baseUrl` | `string` |

<!-- source: interface-webhookverification.md -->

# WebhookVerification

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/webhooks/webhook.service.ts` (line 18)

Per-request material used to authenticate an incoming webhook.

## Properties

| Property | Type |
|---|---|
| `signature` | `string` |
| `token` | `string` |
| `authHeader` | `string` |
| `rawBody` | `string | Buffer` |

<!-- source: component-activefilterchips.md -->

# ActiveFilterChips

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 219)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `filters` | `BoardFiltersState` | ✓ | - |
| `onChange` | `Function` | ✓ | - |
| `options` | `ReturnType` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ActiveFilterChips_f30d1c2["ActiveFilterChips"]
    class component_ActiveFilterChips_f30d1c2 rootComponent
```

## Relationships

- RENDERS → `Chip`

<!-- source: interface-documenttreenode-2.md -->

# DocumentTreeNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/components/NavigationTree.tsx` (line 10)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `slug` | `string` |
| `urlId` | `string` |
| `url` | `string` |
| `state` | `'DRAFT' | 'PUBLISHED' | 'ARCHIVED'` |
| `children` | `DocumentTreeNode[]` |

<!-- source: api-endpoint-getoverview.md -->

# getOverview

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 30)

## Endpoint

`GET /analytics/:projectId/overview`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: constant-mdastlinkvisitor.md -->

# MdastLinkVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link/MdastLinkVisitor.ts` (line 5)

## Definition

```ts
MdastImportVisitor<Mdast.Link>
```

<!-- source: component-simpletoolbar.md -->

# SimpleToolbar

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/toolbar.tsx` (line 157)

## Diagram

```mermaid
graph TD
    component_SimpleToolbar_622ad2a3["SimpleToolbar"]
    class component_SimpleToolbar_622ad2a3 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `UndoRedo`
- RENDERS → `Separator`

<!-- source: interface-userjourneyflow.md -->

# UserJourneyFlow

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/user-journey.interface.ts` (line 123)

A complete user journey flow

Represents an end-to-end user interaction flow through the application,
including screens, actions, decisions, and navigation.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `framework` | `'angular' | 'react' | 'vue'` |
| `component` | `string` |
| `nodes` | `UserJourneyNode[]` |
| `edges` | `UserJourneyEdge[]` |
| `startNodeId` | `string` |
| `endNodeIds` | `string[]` |
| `tags` | `string[]` |
| `metadata` | `{
    /** Estimated complexity (1-10) */
    complexity?: number;

    /** Number of user actions required */
    actionCount?: number;

    /** Number of decision points */
    decisionCount?: number;

    /** Number of screens involved */
    screenCount?: number;

    /** Is this a critical user flow? */
    isCritical?: boolean;

    /** Related state machine IDs */
    relatedStateMachines?: string[];

    [key: string]: any;
  }` |

<!-- source: interface-watchmodeconfig.md -->

# WatchModeConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/watch-mode.ts` (line 4)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `includePatterns` | `string[]` |
| `excludeDirs` | `string[]` |
| `markers` | `string[]` |
| `onMarkerFound` | `(marker: MarkerResult) => void` |
| `debounceMs` | `number` |

<!-- source: interface-workflowaction.md -->

# WorkflowAction

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/workflow-detector.service.ts` (line 36)

An action within a workflow step

## Properties

| Property | Type |
|---|---|
| `type` | `'navigate' | 'fill-form' | 'click' | 'select' | 'upload' | 'verify'` |
| `target` | `string` |
| `value` | `string` |
| `description` | `string` |

<!-- source: component-addissuestoboarddialog.md -->

# AddIssuesToBoardDialog

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/AddIssuesToBoardDialog.tsx` (line 43)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `open` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `boardId` | `string` | ✓ | - |
| `columns` | `BoardColumnLite[]` | ✓ | - |
| `alreadyOnBoardIds` | `string[]` | ✓ | - |
| `onAdded` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_AddIssuesToBoardDialog_ad211fa["AddIssuesToBoardDialog"]
    class component_AddIssuesToBoardDialog_ad211fa rootComponent
```

## Relationships

- RENDERS → `Modal`
- RENDERS → `MagnifyingGlassIcon`
- RENDERS → `ExclamationTriangleIcon`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useBoardsToast`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`
- USES_HOOK → `useMemo`

<!-- source: interface-documentupdateresult.md -->

# DocumentUpdateResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 313)

Result of replacing placeholders in a document

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `documentPath` | `string` |
| `replacementsCount` | `number` |
| `failedReplacements` | `{ placeholder: string; reason: string }[]` |
| `updatedContent` | `string` |

<!-- source: api-endpoint-getpagemarkdown.md -->

# getPageMarkdown

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-mcp.controller.ts` (line 240)

## Endpoint

`GET /technical-docs/:projectId/pages/:slug.md`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `slug` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsMcpController` (MODULE_DECLARES)

<!-- source: constant-mdastlistitemvisitor.md -->

# MdastListItemVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/lists/MdastListItemVisitor.ts` (line 5)

## Definition

```ts
MdastImportVisitor<Mdast.ListItem>
```

<!-- source: component-singlechoicetogglegroup.md -->

# SingleChoiceToggleGroup

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/toolbar.tsx` (line 140)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `value` | `T | unknown` | ✓ | - |
| `onChange` | `Function` | ✓ | - |
| `className` | `string` | - | - |
| `ggClassName` | `string` | - | - |
| `items` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SingleChoiceToggleGroup_79ca4df0["SingleChoiceToggleGroup"]
    class component_SingleChoiceToggleGroup_79ca4df0 rootComponent
```

## Relationships

- RENDERS → `RadixToolbar-ToggleGroup`
- RENDERS → `ToolbarToggleItem`
- RENDERS → `TooltipWrap`
- USES_HOOK → `useTranslation`

<!-- source: interface-userjourneygenerationoptions.md -->

# UserJourneyGenerationOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/user-journey-diagram.generator.ts` (line 31)

Options for generating user journey diagrams

## Properties

| Property | Type |
|---|---|
| `includeRouteFlows` | `boolean` |
| `includeComponentFlows` | `boolean` |
| `componentFilter` | `string[]` |
| `routeFilter` | `string[]` |
| `frameworkFilter` | `Array<'angular' | 'react' | 'vue'>` |

<!-- source: interface-webfetchoptions.md -->

# WebFetchOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/web-fetch.tool.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `maxContentLength` | `number` |
| `timeout` | `number` |

<!-- source: interface-workflowdocumentation.md -->

# WorkflowDocumentation

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/user-docs-generator.service.ts` (line 27)

Documentation for a single workflow

## Properties

| Property | Type |
|---|---|
| `workflowId` | `string` |
| `workflowName` | `string` |
| `category` | `string` |
| `overview` | `string` |
| `prerequisites` | `string` |
| `steps` | `StepDocumentation[]` |
| `troubleshooting` | `string` |
| `relatedWorkflows` | `string[]` |

<!-- source: component-adminpage.md -->

# AdminPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/admin/page.tsx` (line 34)

## Diagram

```mermaid
graph TD
    component_AdminPage_2c35d3ba["AdminPage"]
    class component_AdminPage_2c35d3ba rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `ShieldCheckIcon`
- RENDERS → `Link`
- RENDERS → `Icon`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-documentuploadresult.md -->

# DocumentUploadResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 209)

Result of document upload operation

## Properties

| Property | Type |
|---|---|
| `success` | `boolean` |
| `uploaded` | `UploadedItem[]` |
| `failed` | `FailedUpload[]` |
| `stats` | `UploadStats` |
| `error` | `string` |

<!-- source: api-endpoint-getpagemarkdownbyurl.md -->

# getPageMarkdownByUrl

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 270)

## Endpoint

`GET /public/p/:slugWithId/pages/:slug.md`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |
| `slug` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-mdastlistvisitor.md -->

# MdastListVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/lists/MdastListVisitor.ts` (line 6)

## Definition

```ts
MdastImportVisitor<Mdast.List>
```

<!-- source: component-socialproofstatsgrid-2.md -->

# SocialProofStatsGrid

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/social-proof/social-proof-stats-grid.tsx` (line 14)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | - | - |
| `descriptionKey` | `string` | - | - |
| `stats` | `unknown[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SocialProofStatsGrid_54fd95ef["SocialProofStatsGrid"]
    class component_SocialProofStatsGrid_54fd95ef rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `StatCard`
- USES_HOOK → `useTranslation`

<!-- source: interface-userjourneynode.md -->

# UserJourneyNode

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/user-journey.interface.ts` (line 53)

A single node in a user journey

Represents a step in the user's interaction with the application.
Could be a screen they see, an action they take, or a decision point.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `type` | `UserJourneyNodeType` |
| `label` | `string` |
| `description` | `string` |
| `componentName` | `string` |
| `routePath` | `string` |
| `userAction` | `string` |
| `handlerMethod` | `string` |
| `condition` | `string` |
| `sourceLine` | `number` |
| `sourceFile` | `string` |
| `metadata` | `Record<string, any>` |

<!-- source: interface-websearchoptions.md -->

# WebSearchOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/web-search.tool.ts` (line 41)

## Properties

| Property | Type |
|---|---|
| `braveApiKey` | `string` |
| `models` | `SearchModelDeployment[]` |
| `maxResults` | `number` |
| `timeout` | `number` |
| `perModelCooldownMs` | `number` |

<!-- source: interface-workflowhint.md -->

# WorkflowHint

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/ai/services/business-context-parser.service.ts` (line 29)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `steps` | `string[]` |
| `module` | `string` |

<!-- source: component-agentactionsconfig.md -->

# AgentActionsConfig

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/AgentActionsConfig.tsx` (line 15)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_AgentActionsConfig_1173e685["AgentActionsConfig"]
    class component_AgentActionsConfig_1173e685 rootComponent
```

## Relationships

- RENDERS → `BoltIcon`
- RENDERS → `XMarkIcon`
- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `CheckCircleIcon`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-documentuploadresult-2.md -->

# DocumentUploadResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-13.types.ts` (line 20)

## Properties

| Property | Type |
|---|---|
| `uploaded` | `UploadedDocument[]` |
| `failed` | `UploadFailure[]` |
| `stats` | `{
    totalDocuments: number;
    successful: number;
    failed: number;
    totalScreenshots: number;
  }` |

<!-- source: api-endpoint-getprojectactivities.md -->

# getProjectActivities

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/activity/activity.controller.ts` (line 32)

## Endpoint

`GET /activities/projects/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ActivityController` (MODULE_DECLARES)

<!-- source: constant-mdastmdxexpressionvisitor.md -->

# MdastMdxExpressionVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/MdastMdxExpressionVisitor.ts` (line 6)

## Definition

```ts
MdastImportVisitor<MdxTextExpression | MdxFlowExpression>
```

<!-- source: component-socialprooftestimonials-2.md -->

# SocialProofTestimonials

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/social-proof/social-proof-testimonials.tsx` (line 22)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | - | - |
| `descriptionKey` | `string` | - | - |
| `testimonials` | `Testimonial[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SocialProofTestimonials_413593a8["SocialProofTestimonials"]
    class component_SocialProofTestimonials_413593a8 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `TestimonialCard`
- USES_HOOK → `useTranslation`

<!-- source: interface-validationcheck.md -->

# ValidationCheck

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/coverage-validator.ts` (line 61)

Validation result for a single check

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `passed` | `boolean` |
| `severity` | `'critical' | 'error' | 'warning' | 'info'` |
| `message` | `string` |
| `actual` | `number | string` |
| `expected` | `number | string` |
| `recommendation` | `string` |

<!-- source: interface-workflowstep.md -->

# WorkflowStep

**Kind:** Interface

**Source:** `atloria-monorepo/apps/api/src/documentation/services/workflow-detector.service.ts` (line 21)

A single step in a workflow

## Properties

| Property | Type |
|---|---|
| `stepNumber` | `number` |
| `title` | `string` |
| `description` | `string` |
| `pageId` | `string` |
| `route` | `string` |
| `actions` | `WorkflowAction[]` |
| `expectedOutcome` | `string` |
| `errorHandling` | `string` |
| `screenshots` | `string[]` |

<!-- source: interface-worktreecontroloptions.md -->

# WorktreeControlOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/worktree-control.tool.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `worktreeManager` | `WorktreeManager` |

<!-- source: component-agentactionspage.md -->

# AgentActionsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/product/agent-actions/page.tsx` (line 69)

## Diagram

```mermaid
graph TD
    component_AgentActionsPage_7ebb270f["AgentActionsPage"]
    class component_AgentActionsPage_7ebb270f rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `McpInstallBlock`

<!-- source: interface-documentupsertresult.md -->

# DocumentUpsertResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 281)

Document upsert result

## Properties

| Property | Type |
|---|---|
| `operation` | `UpsertOperation` |
| `document` | `{
    id: string; // Database ID
    slug: string;
    title: string;
    version: number;
  }` |

<!-- source: api-endpoint-getprojectaudiences.md -->

# getProjectAudiences

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 431)

## Endpoint

`GET /projects/:id/audiences`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: constant-mdastmdxjsesmvisitor.md -->

# MdastMdxJsEsmVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/MdastMdxJsEsmVisitor.ts` (line 4)

## Definition

```ts
MdastImportVisitor<MdxjsEsm>
```

<!-- source: component-socialprooftimeline-2.md -->

# SocialProofTimeline

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/social-proof/social-proof-timeline.tsx` (line 78)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | - | - |
| `milestones` | `Milestone[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SocialProofTimeline_2c004d08["SocialProofTimeline"]
    class component_SocialProofTimeline_2c004d08 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `TimelineDot`
- RENDERS → `MilestoneCard`
- USES_HOOK → `useTranslation`

<!-- source: interface-validationreport.md -->

# ValidationReport

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/coverage-validator.ts` (line 101)

Complete validation report

## Properties

| Property | Type |
|---|---|
| `isValid` | `boolean` |
| `coverageReport` | `CoverageReport` |
| `checks` | `ValidationCheck[]` |
| `criticalCount` | `number` |
| `errorCount` | `number` |
| `warningCount` | `number` |
| `summary` | `string` |
| `topPriorityActions` | `string[]` |
| `effortEstimate` | `{
    /**
     * Number of additional screenshots needed
     */
    screenshotsNeeded: number;

    /**
     * Number of uncovered states
     */
    uncoveredStatesCount: number;

    /**
     * Number of uncovered transitions
     */
    uncoveredTransitionsCount: number;

    /**
     * Estimated time in hours (rough estimate)
     */
    estimatedHours: number;
  }` |

<!-- source: interface-worktreecontroltools.md -->

# WorktreeControlTools

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/worktree-control.tool.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `enterWorktreeTool` | `ToolDefinition<TContext>` |
| `exitWorktreeTool` | `ToolDefinition<TContext>` |
| `activeWorktree` | `WorktreeInfo | undefined` |

<!-- source: component-agenttrafficcockpit.md -->

# AgentTrafficCockpit

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/AgentTrafficCockpit.tsx` (line 86)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_AgentTrafficCockpit_4ea8a435["AgentTrafficCockpit"]
    class component_AgentTrafficCockpit_4ea8a435 rootComponent
```

## Relationships

- RENDERS → `AreaChart`
- RENDERS → `ShareRow`
- USES_HOOK → `useSession`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-dotnetendpoint.md -->

# DotNetEndpoint

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/dotnet-detector.ts` (line 37)

.NET API endpoint

## Properties

| Property | Type |
|---|---|
| `method` | `'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'` |
| `route` | `string` |
| `actionName` | `string` |
| `parameters` | `DotNetParameter[]` |
| `returnType` | `string` |
| `authorization` | `string` |

<!-- source: api-endpoint-getprojectjobs.md -->

# getProjectJobs

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/parsing/parsing.controller.ts` (line 103)

## Endpoint

`GET /projects/:projectId/parse`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `limit` | query | `number` | - |

## Referenced By

- `ParsingController` (MODULE_DECLARES)

<!-- source: constant-mdastmdxjsxelementvisitor.md -->

# MdastMdxJsxElementVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/MdastMdxJsxElementVisitor.ts` (line 7)

## Definition

```ts
MdastImportVisitor<MdxJsxTextElement | MdxJsxFlowElement>
```

<!-- source: component-socialprooftrustbadges-2.md -->

# SocialProofTrustBadges

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/social-proof/social-proof-trust-badges.tsx` (line 36)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `headlineKey` | `string` | - | - |
| `descriptionKey` | `string` | - | - |
| `badges` | `TrustBadge[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SocialProofTrustBadges_4f1aae85["SocialProofTrustBadges"]
    class component_SocialProofTrustBadges_4f1aae85 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h2`
- RENDERS → `motion-p`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: interface-versionconfig.md -->

# VersionConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/version-config.ts` (line 41)

Version configuration

## Properties

| Property | Type |
|---|---|
| `currentVersion` | `string` |
| `latestVersion` | `string` |
| `versions` | `VersionInfo[]` |
| `defaultVersion` | `string` |

<!-- source: interface-worktreeinfo.md -->

# WorktreeInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/worktree-manager.ts` (line 32)

## Properties

| Property | Type |
|---|---|
| `branch` | `string` |
| `path` | `string` |
| `createdAt` | `number` |

<!-- source: component-aiassistant.md -->

# AIAssistant

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/AIAssistant.tsx` (line 28)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `_documentId` | `string` | - | - |
| `documentContent` | `string` | - | - |
| `onClose` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_AIAssistant_b06d1fb["AIAssistant"]
    class component_AIAssistant_b06d1fb rootComponent
```

## Relationships

- RENDERS → `ProviderSelector`
- RENDERS → `Settings`
- RENDERS → `Trash2`
- RENDERS → `X`
- RENDERS → `MessageList`
- RENDERS → `PromptInput`
- USES_HOOK → `useState`
- USES_HOOK → `useAI`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-dotnetmethod.md -->

# DotNetMethod

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/dotnet-detector.ts` (line 78)

.NET method

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `returnType` | `string` |
| `isAsync` | `boolean` |
| `parameters` | `DotNetParameter[]` |

<!-- source: api-endpoint-getprojectstats.md -->

# getProjectStats

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/dashboard/dashboard.controller.ts` (line 28)

## Endpoint

`GET /dashboard/projects`

## Referenced By

- `DashboardController` (MODULE_DECLARES)

<!-- source: constant-mdastparagraphvisitor.md -->

# MdastParagraphVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/MdastParagraphVisitor.ts` (line 8)

## Definition

```ts
MdastImportVisitor<Mdast.Paragraph>
```

<!-- source: component-sourceeditor.md -->

# SourceEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/diff-source/SourceEditor.tsx` (line 19)

## Diagram

```mermaid
graph TD
    component_SourceEditor_676a5c02["SourceEditor"]
    class component_SourceEditor_676a5c02 rootComponent
```

## Relationships

- USES_HOOK → `useCellValues`
- USES_HOOK → `usePublisher`
- USES_HOOK → `useRef`
- USES_HOOK → `useCallback`

<!-- source: interface-versiondiff-2.md -->

# VersionDiff

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/version-diff.ts` (line 55)

Version diff result

## Properties

| Property | Type |
|---|---|
| `fromVersion` | `string` |
| `toVersion` | `string` |
| `changes` | `EntityChange[]` |
| `added` | `EntityChange[]` |
| `removed` | `EntityChange[]` |
| `modified` | `EntityChange[]` |
| `statistics` | `DiffStatistics` |
| `generatedAt` | `Date` |

<!-- source: interface-worktreemanagerconfig.md -->

# WorktreeManagerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/worktree-manager.ts` (line 23)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `maxWorktrees` | `number` |
| `staleThresholdMs` | `number` |

<!-- source: component-aipage.md -->

# AIPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/ai/page.tsx` (line 11)

## Diagram

```mermaid
graph TD
    component_AIPage_6c973cfa["AIPage"]
    class component_AIPage_6c973cfa rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `SparklesIcon`
- RENDERS → `Card`
- RENDERS → `CardHeader`
- RENDERS → `CardContent`

<!-- source: interface-dotnetparameter.md -->

# DotNetParameter

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/dotnet-detector.ts` (line 49)

.NET parameter

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `source` | `'body' | 'query' | 'route' | 'header' | 'form'` |
| `required` | `boolean` |

<!-- source: api-endpoint-getpublicapispec.md -->

# getPublicApiSpec

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 719)

## Endpoint

`GET /public/p/:slugWithId/api-spec`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |
| `version` | query | `string` | - |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-mdastrootvisitor.md -->

# MdastRootVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/MdastRootVisitor.ts` (line 4)

## Definition

```ts
MdastImportVisitor<Mdast.Root>
```

<!-- source: component-spanwithcolor.md -->

# SpanWithColor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/colors.tsx` (line 77)

## Diagram

```mermaid
graph TD
    component_SpanWithColor_32d45efe["SpanWithColor"]
    class component_SpanWithColor_32d45efe rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `ColorsToolbar`

<!-- source: interface-versiondiffoptions.md -->

# VersionDiffOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/version-diff.generator.ts` (line 22)

Version diff options

## Properties

| Property | Type |
|---|---|
| `includeDescriptions` | `boolean` |
| `detectBreaking` | `boolean` |
| `includeSourceDiff` | `boolean` |

<!-- source: interface-writefileoptions.md -->

# WriteFileOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/agent-core/src/tools/write-file.tool.ts` (line 16)

## Properties

| Property | Type |
|---|---|
| `rootDir` | `string` |
| `maxFileSize` | `number` |
| `checkpointManager` | `CheckpointManager` |

<!-- source: component-aisettingspage.md -->

# AISettingsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/ai/page.tsx` (line 36)

## Diagram

```mermaid
graph TD
    component_AISettingsPage_2013264d["AISettingsPage"]
    class component_AISettingsPage_2013264d rootComponent
```

## Relationships

- RENDERS → `ProviderConfig`
- RENDERS → `UsagePanel`
- RENDERS → `RequestHistory`
- RENDERS → `SettingsManager`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useAIProviders`
- USES_HOOK → `useAISettings`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-editimagetoolbarprops.md -->

# EditImageToolbarProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/EditImageToolbar.tsx` (line 10)

## Properties

| Property | Type |
|---|---|
| `nodeKey` | `string` |
| `imageSource` | `string` |
| `initialImagePath` | `string | null` |
| `title` | `string` |
| `alt` | `string` |
| `width` | `number | 'inherit'` |
| `height` | `number | 'inherit'` |

<!-- source: api-endpoint-getpublicchatconfig.md -->

# getPublicChatConfig

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 775)

## Endpoint

`GET /public/p/:slugWithId/chat/config`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-mdasttablevisitor.md -->

# MdastTableVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/table/MdastTableVisitor.ts` (line 6)

## Definition

```ts
MdastImportVisitor<Mdast.Table>
```

<!-- source: component-spanwithcolor-2.md -->

# SpanWithColor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/html.tsx` (line 51)

## Diagram

```mermaid
graph TD
    component_SpanWithColor_29241ba3["SpanWithColor"]
    class component_SpanWithColor_29241ba3 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `HTMLToolbarComponent`

<!-- source: interface-versioninfo.md -->

# VersionInfo

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/version-config.ts` (line 11)

Version Configuration and Utilities

## Properties

| Property | Type |
|---|---|
| `version` | `string` |
| `label` | `string` |
| `releaseDate` | `Date` |
| `isLatest` | `boolean` |
| `isPrerelease` | `boolean` |
| `isDeprecated` | `boolean` |
| `deprecationMessage` | `string` |
| `docsPath` | `string` |
| `gitRef` | `string` |
| `changelogUrl` | `string` |
| `supportStatus` | `'active' | 'maintenance' | 'eol'` |
| `eolDate` | `Date` |

<!-- source: component-alert.md -->

# Alert

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MDXRenderer.tsx` (line 188)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `type` | `any` | - | "info" |
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Alert_217a838d["Alert"]
    class component_Alert_217a838d rootComponent
```

<!-- source: interface-editingimagedialogstate.md -->

# EditingImageDialogState

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 106)

The state of the image dialog when it is in editing an existing node.

## Properties

| Property | Type |
|---|---|
| `type` | `'editing'` |
| `nodeKey` | `string` |
| `initialValues` | `Omit<SaveImageParameters, 'file'>` |

<!-- source: api-endpoint-getpublicdocument.md -->

# getPublicDocument

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/public-document.controller.ts` (line 102)

## Endpoint

`GET /public/documents/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `PublicDocumentController` (MODULE_DECLARES)

<!-- source: constant-mdasttextvisitor.md -->

# MdastTextVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/MdastTextVisitor.ts` (line 6)

## Definition

```ts
MdastImportVisitor<Mdast.Text>
```

<!-- source: component-statcard-5.md -->

# StatCard

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/stat-card.tsx` (line 19)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `valueKey` | `string` | ✓ | - |
| `labelKey` | `string` | ✓ | - |
| `className` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_StatCard_3978ba54["StatCard"]
    class component_StatCard_3978ba54 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- USES_HOOK → `useTranslation`

<!-- source: interface-versionselectoroptions.md -->

# VersionSelectorOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/version-selector.generator.ts` (line 10)

## Properties

| Property | Type |
|---|---|
| `className` | `string` |
| `showBanner` | `boolean` |
| `showLabels` | `boolean` |
| `showSupportStatus` | `boolean` |

<!-- source: component-analyticsredirectpage.md -->

# AnalyticsRedirectPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/analytics/page.tsx` (line 14)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_AnalyticsRedirectPage_5eae63c3["AnalyticsRedirectPage"]
    class component_AnalyticsRedirectPage_5eae63c3 rootComponent
```

## Relationships

- USES_HOOK → `useRouter`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useProjectContext`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-editlinkdialog.md -->

# EditLinkDialog

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 54)

The state of the link dialog when it is in edit mode.

## Properties

| Property | Type |
|---|---|
| `type` | `'edit'` |
| `initialUrl` | `string` |
| `hasInitialText` | `boolean` |
| `url` | `string` |
| `title` | `string` |
| `linkNodeKey` | `string` |
| `rectangle` | `RectData` |

<!-- source: api-endpoint-getpublicentity.md -->

# getPublicEntity

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 678)

## Endpoint

`GET /public/p/:slugWithId/entity/:entityId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |
| `entityId` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-mdastthematicbreakvisitor.md -->

# MdastThematicBreakVisitor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/thematic-break/MdastThematicBreakVisitor.ts` (line 5)

## Definition

```ts
MdastImportVisitor<Mdast.ThematicBreak>
```

<!-- source: component-stepindicator-3.md -->

# StepIndicator

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/step-indicator.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `step` | `number` | ✓ | - |
| `icon` | `LucideIcon` | ✓ | - |
| `titleKey` | `string` | ✓ | - |
| `descriptionKey` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StepIndicator_36a41b62["StepIndicator"]
    class component_StepIndicator_36a41b62 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `Icon`
- USES_HOOK → `useTranslation`

<!-- source: interface-visibilityfilterconfig.md -->

# VisibilityFilterConfig

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/generators/versioning/visibility-filter.ts` (line 10)

## Properties

| Property | Type |
|---|---|
| `showPrivate` | `boolean` |
| `showProtected` | `boolean` |
| `showInternal` | `boolean` |
| `showAlpha` | `boolean` |
| `showBeta` | `boolean` |
| `showDeprecated` | `boolean` |
| `showExperimental` | `boolean` |
| `customFilter` | `(entity: Entity) => boolean` |

<!-- source: component-apiplaygroundpage.md -->

# ApiPlaygroundPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/api/page.tsx` (line 30)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ApiPlaygroundPage_63398d9e["ApiPlaygroundPage"]
    class component_ApiPlaygroundPage_63398d9e rootComponent
```

## Relationships

- RENDERS → `KeyIcon`
- RENDERS → `AgentActionsConfig`
- RENDERS → `CommandLineIcon`
- RENDERS → `Link`
- RENDERS → `ArrowLeftIcon`
- RENDERS → `XMarkIcon`
- RENDERS → `McpInstallBlock`
- RENDERS → `ApiReferenceReader`
- RENDERS → `ArrowPathIcon`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useEffect`

<!-- source: interface-editorinfocus.md -->

# EditorInFocus

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 109)

The type of the editor being edited currently. Custom editors can override this, so that the toolbar can change its contents.

## Properties

| Property | Type |
|---|---|
| `editorType` | `string` |
| `rootNode` | `LexicalNode | null` |
| `editorRef` | `unknown` |

<!-- source: api-endpoint-getpublicstats.md -->

# getPublicStats

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/app/app.controller.ts` (line 14)

## Endpoint

`GET /stats`

## Referenced By

- `AppController` (MODULE_DECLARES)

<!-- source: constant-mdxeditor.md -->

# MDXEditor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/MDXEditor.tsx` (line 407)

The MDXEditor React component.

<!-- source: component-strikethroughsupsubtoggles.md -->

# StrikeThroughSupSubToggles

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/BoldItalicUnderlineToggles.tsx` (line 89)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `options` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StrikeThroughSupSubToggles_77078597["StrikeThroughSupSubToggles"]
    class component_StrikeThroughSupSubToggles_77078597 rootComponent
```

## Relationships

- RENDERS → `FormatButton`
- USES_HOOK → `useTranslation`

<!-- source: interface-workflowactiondocumentation.md -->

# WorkflowActionDocumentation

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-documentation.interface.ts` (line 148)

Documentation for a workflow action/transition

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `label` | `string` |
| `description` | `string` |
| `targetState` | `string` |
| `requiresModal` | `boolean` |
| `triggers` | `UIInteraction[]` |
| `type` | `'primary' | 'secondary' | 'destructive'` |

<!-- source: component-apireferencereader.md -->

# ApiReferenceReader

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/ApiReferenceReader.tsx` (line 68)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ApiReferenceReader_6feed347["ApiReferenceReader"]
    class component_ApiReferenceReader_6feed347 rootComponent
```

## Relationships

- RENDERS → `CheckIcon`
- RENDERS → `ArrowPathIcon`
- RENDERS → `StyleSelector`
- RENDERS → `GenerateButton`
- RENDERS → `MarkdownRenderer`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useMemo`

<!-- source: interface-entity-3.md -->

# Entity

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 179)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `type` | `EntityType` |
| `filePath` | `string` |
| `tier` | `EntityTier` |
| `sourceCode` | `string` |
| `signature` | `string` |
| `summary` | `string` |
| `startLine` | `number` |
| `endLine` | `number` |
| `exports` | `boolean` |
| `isUserFacing` | `boolean` |
| `dependencies` | `string[]` |
| `dependents` | `string[]` |

<!-- source: api-endpoint-getpublicsupportagents.md -->

# getPublicSupportAgents

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 750)

## Endpoint

`GET /public/p/:slugWithId/support-agents`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-mega-file-default-phases.md -->

# MEGA_FILE_DEFAULT_PHASES

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/mega-file.types.ts` (line 49)

Default mega-file extraction strategy

For a 12,560 line Angular component:
Phase 1: Extract class signature and all method names (overview)
Phase 2: Extract all state-related code (stage/status handling)
Phase 3: Extract all validation code
Phase 4: Extract all user-action handlers
Phase 5: Extract DevExtreme configurations from template

## Definition

```ts
MegaFilePhase[]
```

<!-- source: component-table.md -->

# Table

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 221)

## Diagram

```mermaid
graph TD
    component_Table_2d742c4["Table"]
    class component_Table_2d742c4 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `DiffSourceToggleWrapper`
- RENDERS → `UndoRedo`

<!-- source: interface-workflowdocgenerationoptions.md -->

# WorkflowDocGenerationOptions

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-documentation.interface.ts` (line 191)

Options for workflow documentation generation

## Properties

| Property | Type |
|---|---|
| `includeDiagrams` | `boolean` |
| `includeScreenshots` | `boolean` |
| `includeInteractions` | `boolean` |
| `format` | `'mdx' | 'markdown' | 'json'` |
| `screenshotBaseUrl` | `string` |
| `groupByCategory` | `boolean` |

<!-- source: component-audienceblock.md -->

# AudienceBlock

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/AudienceBlock.tsx` (line 46)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `audience` | `Audience` | - | - |
| `audienceLogic` | `string` | - | - |
| `children` | `unknown` | ✓ | - |
| `onEdit` | `Function` | - | - |
| `onDelete` | `Function` | - | - |
| `isNested` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_AudienceBlock_1eec9820["AudienceBlock"]
    class component_AudienceBlock_1eec9820 rootComponent
```

## Relationships

- USES_HOOK → `useState`

<!-- source: interface-entitydependencygraph.md -->

# EntityDependencyGraph

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 216)

EntityDependencyGraph - Tracks what code depends on what

Used to ensure we don't just extract a form, but also its
validation schema, services, and state management.

## Properties

| Property | Type |
|---|---|
| `nodes` | `Map<string, EntityNode>` |
| `edges` | `DependencyEdge[]` |

<!-- source: api-endpoint-getpublictechnicalsnapshot.md -->

# getPublicTechnicalSnapshot

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 645)

## Endpoint

`GET /public/p/:slugWithId/technical-snapshot`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |
| `version` | query | `string` | - |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-mermaidcodeeditordescriptor.md -->

# MermaidCodeEditorDescriptor

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/mermaid/index.tsx` (line 68)

Code block editor descriptor for Mermaid diagrams
This provides read-only visualization of Mermaid diagrams

## Definition

```ts
CodeBlockEditorDescriptor
```

<!-- source: component-tableeditor.md -->

# TableEditor

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/table/TableEditor.tsx` (line 76)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `mdastNode` | `any` | ✓ | - |
| `parentEditor` | `any` | ✓ | - |
| `lexicalTable` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TableEditor_6c312391["TableEditor"]
    class component_TableEditor_6c312391 rootComponent
```

## Relationships

- RENDERS → `ColumnEditor`
- RENDERS → `CellElement`
- RENDERS → `RowEditor`
- RENDERS → `Cell`
- USES_HOOK → `useState`
- USES_HOOK → `useCellValues`
- USES_HOOK → `useMemo`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`
- USES_HOOK → `useTranslation`

<!-- source: interface-workflowdocgenerationresult.md -->

# WorkflowDocGenerationResult

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-documentation.interface.ts` (line 231)

Result of workflow documentation generation

## Properties

| Property | Type |
|---|---|
| `documentation` | `WorkflowDocumentation` |
| `content` | `string` |
| `outputPath` | `string` |
| `warnings` | `string[]` |

<!-- source: component-audiencelist.md -->

# AudienceList

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/PublishingSidebar/AudienceList.tsx` (line 32)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `audiences` | `Audience[]` | ✓ | - |
| `selectedAudience` | `string | null` | ✓ | - |
| `onSelectAudience` | `Function` | ✓ | - |
| `loading` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_AudienceList_451cca0c["AudienceList"]
    class component_AudienceList_451cca0c rootComponent
```

## Relationships

- RENDERS → `Users`
- RENDERS → `ChevronRight`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-entitynode.md -->

# EntityNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 221)

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `name` | `string` |
| `type` | `EntityType` |
| `tier` | `EntityTier` |
| `isDocumentationRelevant` | `boolean` |

<!-- source: api-endpoint-getpublictree.md -->

# getPublicTree

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/public-document.controller.ts` (line 146)

## Endpoint

`GET /public/documents/tree/:organizationId/:projectId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `organizationId` | query | `string` | ✓ |
| `projectId` | query | `string` | ✓ |

## Referenced By

- `PublicDocumentController` (MODULE_DECLARES)

<!-- source: constant-meta-category-ids.md -->

# META_CATEGORY_IDS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 74)

<!-- source: component-tableofcontents-2.md -->

# TableOfContents

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/table-of-contents.tsx` (line 79)

## Diagram

```mermaid
graph TD
    component_TableOfContents_77233c23["TableOfContents"]
    class component_TableOfContents_77233c23 rootComponent
```

## Relationships

- RENDERS → `TableOfContentsSidebar`
- RENDERS → `MDXEditor`
- USES_HOOK → `useState`

<!-- source: interface-workflowdocumentation-2.md -->

# WorkflowDocumentation

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-documentation.interface.ts` (line 18)

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;
  }` |

<!-- source: component-audiencepreviewpanel.md -->

# AudiencePreviewPanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/AudiencePreviewPanel.tsx` (line 12)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `documentId` | `string` | ✓ | - |
| `selectedAudiences` | `string[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_AudiencePreviewPanel_511d98f6["AudiencePreviewPanel"]
    class component_AudiencePreviewPanel_511d98f6 rootComponent
```

## Relationships

- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `MarkdownRenderer`
- USES_HOOK → `useState`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useEffect`

<!-- source: interface-entityselectionconfig.md -->

# EntitySelectionConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/entity-selector.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `maxEntities` | `number` |
| `maxTokens` | `number` |
| `charsPerToken` | `number` |

<!-- source: api-endpoint-getpublishedlanguagesbyurl.md -->

# getPublishedLanguagesByUrl

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 375)

## Endpoint

`GET /public/p/:slugWithId/languages`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-meta-doc-ids.md -->

# META_DOC_IDS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 83)

<!-- source: component-tableofcontents-3.md -->

# TableOfContents

**Kind:** Component

**Source:** `atloria-monorepo/packages/ui-react/src/components/TableOfContents.tsx` (line 54)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `entries` | `TocEntry[]` | ✓ | - |
| `onNavigate` | `Function` | - | - |
| `title` | `string` | - | "On This Page" |
| `className` | `string` | - | "" |
| `scrollOffset` | `number` | - | 80 |

## Diagram

```mermaid
graph TD
    component_TableOfContents_1fddc5c5["TableOfContents"]
    class component_TableOfContents_1fddc5c5 rootComponent
```

## Relationships

- RENDERS → `ChevronDown`
- RENDERS → `ChevronRight`
- RENDERS → `X`
- RENDERS → `List`
- USES_HOOK → `useState`
- USES_HOOK → `useMemo`
- USES_HOOK → `useActiveSection`
- USES_HOOK → `useCallback`

<!-- source: interface-workflowenum.md -->

# WorkflowEnum

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 78)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `filePath` | `string` |
| `lineNumber` | `number` |
| `values` | `EnumValue[]` |
| `usageLocations` | `string[]` |

<!-- source: component-audienceselector.md -->

# AudienceSelector

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/AudienceSelector.tsx` (line 16)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `audiences` | `Audience[]` | ✓ | - |
| `selected` | `Audience` | ✓ | - |
| `onChange` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_AudienceSelector_350e59f7["AudienceSelector"]
    class component_AudienceSelector_350e59f7 rootComponent
```

<!-- source: interface-environment.md -->

# Environment

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/APIExplorer.ts` (line 55)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `variables` | `Record<string, string>` |

<!-- source: api-endpoint-getpublishedprojects.md -->

# getPublishedProjects

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 64)

## Endpoint

`GET /public/projects`

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-mui-component-patterns.md -->

# MUI_COMPONENT_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/material-ui.patterns.ts` (line 11)

Material-UI (MUI) Pattern Detection

Patterns for detecting MUI components, theming, and styling.

<!-- source: component-termsofservice.md -->

# TermsOfService

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/pages/TermsOfService.tsx` (line 11)

## Diagram

```mermaid
graph TD
    component_TermsOfService_4f0b681f["TermsOfService"]
    class component_TermsOfService_4f0b681f rootComponent
```

## Relationships

- RENDERS → `SEO`
- USES_HOOK → `useTranslation`

<!-- source: interface-workflowsequence.md -->

# WorkflowSequence

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/utils/screenshot-instruction-generator.ts` (line 101)

Workflow sequence of screenshots

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `stateMachine` | `string` |
| `description` | `string` |
| `states` | `string[]` |
| `instructions` | `ScreenshotInstruction[]` |
| `estimatedMinutes` | `number` |

<!-- source: component-audienceselectormodal.md -->

# AudienceSelectorModal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/AudienceSelectorModal.tsx` (line 43)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `open` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `onApply` | `Function` | ✓ | - |
| `audiences` | `Audience[]` | ✓ | - |
| `initialSelection` | `string[]` | - | [] |

## Diagram

```mermaid
graph TD
    component_AudienceSelectorModal_14481940["AudienceSelectorModal"]
    class component_AudienceSelectorModal_14481940 rootComponent
```

## Relationships

- RENDERS → `Transition`
- RENDERS → `Dialog`
- RENDERS → `Transition-Child`
- RENDERS → `Dialog-Panel`
- RENDERS → `Dialog-Title`
- USES_HOOK → `useState`
- USES_HOOK → `useMemo`

<!-- source: interface-environment-2.md -->

# Environment

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/EndpointDetail.ts` (line 56)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `variables` | `Record<string, string>` |

<!-- source: api-endpoint-getpublishedversions.md -->

# getPublishedVersions

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 363)

## Endpoint

`GET /public/p/:slugWithId/versions`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-mui-data-grid-patterns.md -->

# MUI_DATA_GRID_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/material-ui.patterns.ts` (line 227)

<!-- source: component-testimonialcard-2.md -->

# TestimonialCard

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/testimonial-card.tsx` (line 21)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `quoteKey` | `string` | ✓ | - |
| `authorNameKey` | `string` | ✓ | - |
| `authorRoleKey` | `string` | - | - |
| `avatarSrc` | `string` | - | - |
| `rating` | `number` | - | - |

## Diagram

```mermaid
graph TD
    component_TestimonialCard_17264b5a["TestimonialCard"]
    class component_TestimonialCard_17264b5a rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `Star`
- USES_HOOK → `useTranslation`

<!-- source: interface-workflowsignals.md -->

# WorkflowSignals

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 39)

Workflow Signals - Raw entities and relationships for AI analysis
Uses reverse-engineering approach: AI determines what it needs from the data

## Properties

| Property | Type |
|---|---|
| `entities` | `CodeEntity[]` |
| `relationships` | `CodeRelationship[]` |
| `projectStats` | `ProjectStats` |

<!-- source: component-audiencesettingspage.md -->

# AudienceSettingsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/audiences/page.tsx` (line 15)

## Diagram

```mermaid
graph TD
    component_AudienceSettingsPage_4ff5807e["AudienceSettingsPage"]
    class component_AudienceSettingsPage_4ff5807e rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `UsersIcon`
- RENDERS → `Button`
- RENDERS → `PlusIcon`
- RENDERS → `Card`
- RENDERS → `CardHeader`
- RENDERS → `CardContent`
- RENDERS → `PencilIcon`
- RENDERS → `TrashIcon`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-environment-3.md -->

# Environment

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/EnvironmentSelector.ts` (line 8)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `variables` | `Record<string, string>` |

<!-- source: api-endpoint-getrecentdocuments.md -->

# getRecentDocuments

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/activity/activity.controller.ts` (line 48)

## Endpoint

`GET /activities/recent/documents`

| Parameter | In | Type | Required |
|---|---|---|---|
| `limit` | query | `number` | - |
| `projectId` | query | `string` | - |

## Referenced By

- `ActivityController` (MODULE_DECLARES)

<!-- source: constant-mui-detection-config.md -->

# MUI_DETECTION_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/material-ui.patterns.ts` (line 276)

## Definition

```ts
MuiDetectionConfig
```

<!-- source: component-thematicbreaks.md -->

# ThematicBreaks

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/basics.tsx` (line 177)

## Diagram

```mermaid
graph TD
    component_ThematicBreaks_4d52f727["ThematicBreaks"]
    class component_ThematicBreaks_4d52f727 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: interface-workflowstage.md -->

# WorkflowStage

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 147)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `stageValue` | `number` |
| `entity` | `string` |
| `routes` | `string[]` |
| `components` | `string[]` |
| `uiElements` | `string[]` |

<!-- source: component-audiencespage.md -->

# AudiencesPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/audiences/page.tsx` (line 16)

## Diagram

```mermaid
graph TD
    component_AudiencesPage_3ab997a["AudiencesPage"]
    class component_AudiencesPage_3ab997a rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `Button`
- RENDERS → `PlusIcon`
- RENDERS → `UsersIcon`
- RENDERS → `PencilIcon`
- RENDERS → `TrashIcon`
- RENDERS → `AnimatePresence`
- RENDERS → `XMarkIcon`
- USES_HOOK → `useSession`
- USES_HOOK → `useAudiences`
- USES_HOOK → `useState`

<!-- source: interface-environment-4.md -->

# Environment

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/RequestPanel.ts` (line 29)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `variables` | `Record<string, string>` |

<!-- source: api-endpoint-getrecentprojects.md -->

# getRecentProjects

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/activity/activity.controller.ts` (line 40)

## Endpoint

`GET /activities/recent/projects`

| Parameter | In | Type | Required |
|---|---|---|---|
| `limit` | query | `number` | - |

## Referenced By

- `ActivityController` (MODULE_DECLARES)

<!-- source: constant-mui-hooks-patterns.md -->

# MUI_HOOKS_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/material-ui.patterns.ts` (line 213)

<!-- source: component-themetoggle-2.md -->

# ThemeToggle

**Kind:** Component

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/theme-toggle.tsx` (line 31)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `defaultTheme` | `ThemeMode` | - | "dark" |
| `primaryColor` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_ThemeToggle_7a27254b["ThemeToggle"]
    class component_ThemeToggle_7a27254b rootComponent
```

## Relationships

- RENDERS → `Icon`
- USES_HOOK → `useState`

<!-- source: interface-workflowstatedocumentation.md -->

# WorkflowStateDocumentation

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-documentation.interface.ts` (line 86)

Documentation for a specific workflow state

## Properties

| Property | Type |
|---|---|
| `state` | `string` |
| `title` | `string` |
| `description` | `string` |
| `screenshots` | `EnhancedScreenshotMetadata[]` |
| `actions` | `WorkflowActionDocumentation[]` |
| `isTerminal` | `boolean` |
| `requiresApproval` | `boolean` |
| `flags` | `{
    /**
     * State is the initial/starting state
     */
    isInitial?: boolean;

    /**
     * State has approval sub-states
     */
    hasApproval?: boolean;

    /**
     * State has modal interactions
     */
    hasModals?: boolean;
  }` |

<!-- source: component-audittrailpage.md -->

# AuditTrailPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/audit/page.tsx` (line 7)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_AuditTrailPage_62503ee7["AuditTrailPage"]
    class component_AuditTrailPage_62503ee7 rootComponent
```

## Relationships

- USES_HOOK → `useSession`
- USES_HOOK → `useState`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useEffect`

<!-- source: interface-evidencedclaim.md -->

# EvidencedClaim

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-10.types.ts` (line 72)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `claim` | `string` |
| `entityIds` | `string[]` |
| `confidence` | `number` |

<!-- source: api-endpoint-getrelated.md -->

# getRelated

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/graph.controller.ts` (line 70)

## Endpoint

`GET /knowledge-graph/entities/:id/related`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `projectId` | query | `string` | ✓ |
| `depth` | query | `number` | - |
| `type` | query | `string` | - |

## Referenced By

- `GraphController` (MODULE_DECLARES)

<!-- source: constant-mui-props-patterns.md -->

# MUI_PROPS_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/material-ui.patterns.ts` (line 131)

<!-- source: component-undoredo.md -->

# UndoRedo

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/UndoRedo.tsx` (line 13)

## Diagram

```mermaid
graph TD
    component_UndoRedo_6ea7afb9["UndoRedo"]
    class component_UndoRedo_6ea7afb9 rootComponent
```

## Relationships

- RENDERS → `MultipleChoiceToggleGroup`
- USES_HOOK → `useCellValues`
- USES_HOOK → `useState`
- USES_HOOK → `useTranslation`
- USES_HOOK → `useEffect`

<!-- source: interface-workflowtransition.md -->

# WorkflowTransition

**Kind:** Interface

**Source:** `atloria-monorepo/libs/parser-core/src/interfaces/workflow-signals.interface.ts` (line 158)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `action` | `string` |
| `fromStage` | `string` |
| `toStage` | `string` |
| `method` | `string` |
| `service` | `string` |
| `endpoint` | `string` |
| `httpMethod` | `string` |
| `uiTrigger` | `string` |
| `permissions` | `string[]` |
| `isBackward` | `boolean` |
| `isTerminal` | `boolean` |

<!-- source: component-authlayout.md -->

# AuthLayout

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(auth)/layout.tsx` (line 7)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_AuthLayout_22549ad3["AuthLayout"]
    class component_AuthLayout_22549ad3 rootComponent
```

<!-- source: interface-executionbatch.md -->

# ExecutionBatch

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-08.types.ts` (line 48)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `sessionIds` | `string[]` |
| `order` | `number` |

<!-- source: api-endpoint-getrelateddocuments.md -->

# getRelatedDocuments

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 560)

## Endpoint

`GET /public/p/:slugWithId/related`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |
| `doc` | query | `string` | ✓ |
| `audience` | query | `string` | ✓ |
| `version` | query | `string` | - |
| `lang` | query | `string` | - |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-mui-theming-patterns.md -->

# MUI_THEMING_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/material-ui.patterns.ts` (line 177)

<!-- source: component-withindialog.md -->

# WithinDialog

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/within-dialog.tsx` (line 13)

## Diagram

```mermaid
graph TD
    component_WithinDialog_58f15a0e["WithinDialog"]
    class component_WithinDialog_58f15a0e rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `BoldItalicUnderlineToggles`
- RENDERS → `BlockTypeSelect`
- RENDERS → `CreateLink`
- USES_HOOK → `useRef`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`

<!-- source: component-backbutton.md -->

# BackButton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/BackButton.tsx` (line 9)

## Diagram

```mermaid
graph TD
    component_BackButton_24bc4112["BackButton"]
    class component_BackButton_24bc4112 rootComponent
```

## Relationships

- RENDERS → `ChevronRightIcon`
- USES_HOOK → `useRouter`
- USES_HOOK → `useParams`
- USES_HOOK → `usePublicProjectContext`
- USES_HOOK → `useLanguageContext`

<!-- source: interface-exportlexicaltreeoptions.md -->

# ExportLexicalTreeOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/exportMarkdownFromLexical.ts` (line 101)

## Properties

| Property | Type |
|---|---|
| `root` | `LexicalRootNode` |
| `visitors` | `LexicalVisitor[]` |
| `jsxComponentDescriptors` | `JsxComponentDescriptor[]` |
| `jsxIsAvailable` | `boolean` |
| `addImportStatements` | `boolean` |

<!-- source: api-endpoint-getrelationships.md -->

# getRelationships

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/graph.controller.ts` (line 97)

## Endpoint

`GET /knowledge-graph/entities/:id/relationships`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `projectId` | query | `string` | ✓ |

## Referenced By

- `GraphController` (MODULE_DECLARES)

<!-- source: constant-mutechange.md -->

# muteChange$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 374)

<!-- source: component-withnestededitors.md -->

# WithNestedEditors

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/link-dialog.tsx` (line 85)

## Diagram

```mermaid
graph TD
    component_WithNestedEditors_3060a27d["WithNestedEditors"]
    class component_WithNestedEditors_3060a27d rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: component-batchfileprocessor.md -->

# BatchFileProcessor

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/BatchFileProcessor.tsx` (line 24)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onComplete` | `Function` | - | - |
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_BatchFileProcessor_67991fc["BatchFileProcessor"]
    class component_BatchFileProcessor_67991fc rootComponent
```

## Relationships

- RENDERS → `StatusIcon`
- USES_HOOK → `useState`
- USES_HOOK → `useParser`
- USES_HOOK → `useCallback`

<!-- source: interface-exportmarkdownfromlexicaloptions.md -->

# ExportMarkdownFromLexicalOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/exportMarkdownFromLexical.ts` (line 392)

## Properties

| Property | Type |
|---|---|
| `visitors` | `LexicalVisitor[]` |
| `toMarkdownExtensions` | `ToMarkdownExtension[]` |
| `toMarkdownOptions` | `ToMarkdownOptions` |

<!-- source: api-endpoint-getrelationships-2.md -->

# getRelationships

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/kg-sync.controller.ts` (line 226)

Get all relationships for a project

## Endpoint

`GET /projects/:projectId/relationships`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `KgSyncController` (MODULE_DECLARES)

<!-- source: constant-nested-editor-updated-command.md -->

# NESTED_EDITOR_UPDATED_COMMAND

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 115)

<!-- source: component-withoutlinktitlefield.md -->

# WithoutLinkTitleField

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/link-dialog.tsx` (line 32)

## Diagram

```mermaid
graph TD
    component_WithoutLinkTitleField_5a7a0808["WithoutLinkTitleField"]
    class component_WithoutLinkTitleField_5a7a0808 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`

<!-- source: component-billingsettingspage.md -->

# BillingSettingsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/billing/page.tsx` (line 59)

## Diagram

```mermaid
graph TD
    component_BillingSettingsPage_419d7571["BillingSettingsPage"]
    class component_BillingSettingsPage_419d7571 rootComponent
```

## Relationships

- RENDERS → `CreditCardIcon`
- RENDERS → `CheckIcon`
- RENDERS → `ArrowTopRightOnSquareIcon`
- RENDERS → `BoltIcon`
- USES_HOOK → `useSession`
- USES_HOOK → `useSearchParams`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-expressionvalue.md -->

# ExpressionValue

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/index.ts` (line 114)

## Properties

| Property | Type |
|---|---|
| `type` | `'expression'` |
| `value` | `string` |

<!-- source: api-endpoint-getrelationshipsforentity.md -->

# getRelationshipsForEntity

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/kg-sync.controller.ts` (line 256)

Get relationships for a specific entity

## Endpoint

`GET /projects/:projectId/entities/:entityId/relationships`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `entityId` | query | `string` | ✓ |

## Referenced By

- `KgSyncController` (MODULE_DECLARES)

<!-- source: constant-nestededitorchildren.md -->

# nestedEditorChildren$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 770)

React Components registered to be rendered inside `LexicalNestedComposer`. Useful if you're using lexical editor plugins that are wrapped as react components.

<!-- source: component-youtube.md -->

# Youtube

**Kind:** Component

**Source:** `atloria-monorepo/packages/editor/src/examples/directives.tsx` (line 91)

## Diagram

```mermaid
graph TD
    component_Youtube_37711bc6["Youtube"]
    class component_Youtube_37711bc6 rootComponent
```

## Relationships

- RENDERS → `MDXEditor`
- RENDERS → `YouTubeButton`

<!-- source: component-bitbucketicon-2.md -->

# BitbucketIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/integrations/page.tsx` (line 24)

## Diagram

```mermaid
graph TD
    component_BitbucketIcon_2bcd6354["BitbucketIcon"]
    class component_BitbucketIcon_2bcd6354 rootComponent
```

<!-- source: interface-extractedselectors.md -->

# ExtractedSelectors

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 63)

Collection of extracted selectors by type

## Properties

| Property | Type |
|---|---|
| `buttons` | `SelectorInfo[]` |
| `inputs` | `SelectorInfo[]` |
| `links` | `SelectorInfo[]` |
| `modals` | `SelectorInfo[]` |
| `tables` | `SelectorInfo[]` |
| `forms` | `SelectorInfo[]` |

<!-- source: api-endpoint-getreview.md -->

# getReview

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 248)

## Endpoint

`GET /doc-versions/:projectId/:versionId/review`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: constant-nestededitorscontext.md -->

# NestedEditorsContext

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/NestedLexicalEditor.tsx` (line 89)

<!-- source: component-boardcard.md -->

# BoardCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardCard.tsx` (line 26)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `card` | `BoardCardData` | ✓ | - |
| `asOverlay` | `boolean` | - | false |
| `onCardClick` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_BoardCard_1a154160["BoardCard"]
    class component_BoardCard_1a154160 rootComponent
```

## Relationships

- RENDERS → `ChatBubbleLeftEllipsisIcon`
- USES_HOOK → `useSortable`

<!-- source: interface-extractedtroubleshootingsection.md -->

# ExtractedTroubleshootingSection

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 132)

## Properties

| Property | Type |
|---|---|
| `heading` | `string` |
| `content` | `string` |
| `sourceTitle` | `string` |
| `sourceSlug` | `string` |

<!-- source: api-endpoint-getrevision.md -->

# getRevision

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 538)

## Endpoint

`GET /documents/:id/revisions/:revisionId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `revisionId` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: constant-never-truncate-patterns.md -->

# NEVER_TRUNCATE_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 434)

<!-- source: component-boardcolumn.md -->

# BoardColumn

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardColumn.tsx` (line 18)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `column` | `BoardColumnData` | ✓ | - |
| `onAddCard` | `Function` | - | - |
| `onEditColumn` | `Function` | - | - |
| `onCardClick` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_BoardColumn_4c47b60["BoardColumn"]
    class component_BoardColumn_4c47b60 rootComponent
```

## Relationships

- RENDERS → `EllipsisHorizontalIcon`
- RENDERS → `SortableContext`
- RENDERS → `BoardCard`
- RENDERS → `PlusIcon`
- USES_HOOK → `useDroppable`

<!-- source: interface-failedupload.md -->

# FailedUpload

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 233)

Failed upload record

## Properties

| Property | Type |
|---|---|
| `type` | `'category' | 'document' | 'screenshot'` |
| `id` | `string` |
| `title` | `string` |
| `error` | `string` |
| `retryCount` | `number` |

<!-- source: api-endpoint-getrevisions.md -->

# getRevisions

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 514)

## Endpoint

`GET /documents/:id/revisions`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `limit` | query | `number` | - |
| `offset` | query | `number` | - |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: constant-normalizer-version.md -->

# NORMALIZER_VERSION

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-normalizer/src/lib/normalize.ts` (line 25)

Bump whenever the pre-pass, extension set, or serializer options change — every stored
document fingerprint is (content, NORMALIZER_VERSION)-keyed, so a change here is a corpus
re-normalization event, not a silent tweak. v2: CRLF/NFC pre-pass + YAML front-matter.

<!-- source: component-boardfiltersbutton.md -->

# BoardFiltersButton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardFilters.tsx` (line 170)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `filters` | `BoardFiltersState` | ✓ | - |
| `onChange` | `Function` | ✓ | - |
| `options` | `ReturnType` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_BoardFiltersButton_6a5627ae["BoardFiltersButton"]
    class component_BoardFiltersButton_6a5627ae rootComponent
```

## Relationships

- RENDERS → `FunnelIcon`
- RENDERS → `FilterPopover`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`

<!-- source: interface-fallbackoption.md -->

# FallbackOption

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/toolbar.tsx` (line 262)

## Properties

| Property | Type |
|---|---|
| `fallback` | `() => React.ReactNode` |

<!-- source: api-endpoint-getscreenbaseline.md -->

# getScreenBaseline

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 76)

## Endpoint

`GET /doc-automation/config/:projectId/screen-baseline`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: constant-onblur.md -->

# onBlur$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 485)

Emits when the editor loses focus

<!-- source: component-boardloadingskeleton.md -->

# BoardLoadingSkeleton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardLoadingSkeleton.tsx` (line 3)

## Diagram

```mermaid
graph TD
    component_BoardLoadingSkeleton_73832c5c["BoardLoadingSkeleton"]
    class component_BoardLoadingSkeleton_73832c5c rootComponent
```

<!-- source: interface-featurearea.md -->

# FeatureArea

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-05.types.ts` (line 57)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `features` | `string[]` |
| `priority` | `number` |

<!-- source: api-endpoint-getscreenshot.md -->

# getScreenshot

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/screenshot/screenshot.controller.ts` (line 78)

## Endpoint

`GET /screenshots/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ScreenshotController` (MODULE_DECLARES)

<!-- source: constant-onclicklinkcallback.md -->

# onClickLinkCallback$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 350)

<!-- source: component-boardpage.md -->

# BoardPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/boards/[boardId]/page.tsx` (line 53)

## Diagram

```mermaid
graph TD
    component_BoardPage_4443a1f8["BoardPage"]
    class component_BoardPage_4443a1f8 rootComponent
```

## Relationships

- RENDERS → `BoardsToastProvider`
- RENDERS → `BoardPageContent`

<!-- source: interface-featureevidence.md -->

# FeatureEvidence

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-03.types.ts` (line 54)

## Properties

| Property | Type |
|---|---|
| `entityId` | `string` |
| `type` | `'route' | 'controller' | 'component' | 'service' | 'model'` |
| `snippet` | `string` |
| `reasoning` | `string` |

<!-- source: api-endpoint-getscreenshotplaceholders.md -->

# getScreenshotPlaceholders

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 1146)

## Endpoint

`GET /public/p/:slugWithId/screenshots`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |
| `documentId` | query | `string` | - |
| `status` | query | `string` | - |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-onreadonlyclicklinkcallback.md -->

# onReadOnlyClickLinkCallback$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 353)

<!-- source: component-boardpicker.md -->

# BoardPicker

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardPicker.tsx` (line 50)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `issueId` | `string` | ✓ | - |
| `issueStatus` | `string` | ✓ | - |
| `bulkIssueIds` | `string[]` | - | - |
| `open` | `boolean` | ✓ | - |
| `anchorRect` | `DOMRect | null` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `onChanged` | `Function` | - | - |
| `onCreateBoard` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_BoardPicker_68dc6460["BoardPicker"]
    class component_BoardPicker_68dc6460 rootComponent
```

## Relationships

- RENDERS → `MagnifyingGlassIcon`
- RENDERS → `CheckIcon`
- RENDERS → `PlusIcon`
- RENDERS → `ViewColumnsIcon`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useBoardsToast`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-featureiconprops-2.md -->

# FeatureIconProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/feature-icon.tsx` (line 11)

## Properties

| Property | Type |
|---|---|
| `icon` | `LucideIcon` |
| `size` | `number` |
| `className` | `string` |

<!-- source: api-endpoint-getscreenshots.md -->

# getScreenshots

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 300)

## Endpoint

`GET /doc-versions/:projectId/:versionId/screenshots`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: constant-onwindowchange.md -->

# onWindowChange$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 85)

Emits when the window is resized.

<!-- source: component-boardsettingsdialog.md -->

# BoardSettingsDialog

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardSettingsDialog.tsx` (line 47)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `open` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `board` | `BoardLite | null` | ✓ | - |
| `onChanged` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_BoardSettingsDialog_3821d8c0["BoardSettingsDialog"]
    class component_BoardSettingsDialog_3821d8c0 rootComponent
```

## Relationships

- RENDERS → `Modal`
- RENDERS → `ColumnsList`
- RENDERS → `PlusIcon`
- RENDERS → `ColumnEditor`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useBoardsToast`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-featureinput.md -->

# FeatureInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-03.types.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `chunks` | `Chunk[]` |

<!-- source: api-endpoint-getscrollhistogram.md -->

# getScrollHistogram

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 167)

## Endpoint

`GET /analytics/:projectId/scroll-histogram`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: constant-open-link-dialog.md -->

# OPEN_LINK_DIALOG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/LinkDialog.tsx` (line 27)

## Definition

```ts
LexicalCommand<undefined>
```

<!-- source: component-boardsindexpage.md -->

# BoardsIndexPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/boards/page.tsx` (line 62)

## Diagram

```mermaid
graph TD
    component_BoardsIndexPage_3ab59701["BoardsIndexPage"]
    class component_BoardsIndexPage_3ab59701 rootComponent
```

## Relationships

- RENDERS → `BoardsToastProvider`
- RENDERS → `BoardsIndexContent`

<!-- source: interface-featureresult.md -->

# FeatureResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-03.types.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `features` | `UserFeature[]` |
| `chunkFeatureMap` | `Record<string, string[]>` |
| `stats` | `{
    totalFeatures: number;
    totalActions: number;
    avgConfidence: number;
  }` |

<!-- source: api-endpoint-getsearchindexbyurl.md -->

# getSearchIndexByUrl

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 294)

## Endpoint

`GET /public/p/:slugWithId/search-index.json`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: constant-openeditimagedialog.md -->

# openEditImageDialog$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 322)

Opens the edit image dialog with the published parameters.

<!-- source: component-boardstoastprovider.md -->

# BoardsToastProvider

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/Toast.tsx` (line 43)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_BoardsToastProvider_74b88104["BoardsToastProvider"]
    class component_BoardsToastProvider_74b88104 rootComponent
```

## Relationships

- RENDERS → `ToastContext-Provider`
- RENDERS → `ToastView`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`

<!-- source: interface-featureshorizontalflowprops-2.md -->

# FeaturesHorizontalFlowProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/features/features-horizontal-flow.tsx` (line 19)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `features` | `Feature[]` |

<!-- source: api-endpoint-getsettings.md -->

# getSettings

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/organization/organization.controller.ts` (line 140)

## Endpoint

`GET /organizations/:id/settings`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `OrganizationController` (MODULE_DECLARES)

<!-- source: constant-openlinkeditdialog.md -->

# openLinkEditDialog$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 300)

An action that opens the link dialog.

<!-- source: component-boardview.md -->

# BoardView

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/BoardView.tsx` (line 54)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `boardId` | `string` | ✓ | - |
| `onEditColumn` | `Function` | - | - |
| `onAddColumn` | `Function` | - | - |
| `refreshKey` | `number` | - | 0 |
| `filters` | `BoardFiltersState` | - | unknown |
| `onBoardLoaded` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_BoardView_5699fb80["BoardView"]
    class component_BoardView_5699fb80 rootComponent
```

## Relationships

- RENDERS → `BoardLoadingSkeleton`
- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `DndContext`
- RENDERS → `BoardColumn`
- RENDERS → `PlusIcon`
- RENDERS → `DragOverlay`
- RENDERS → `BoardCard`
- RENDERS → `IssueSidePanel`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`
- USES_HOOK → `useSensors`
- USES_HOOK → `useSensor`

<!-- source: interface-featuresinteractivetabsprops-2.md -->

# FeaturesInteractiveTabsProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/features/features-interactive-tabs.tsx` (line 23)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `tabs` | `Tab[]` |

<!-- source: api-endpoint-getsettings-2.md -->

# getSettings

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 269)

## Endpoint

`GET /projects/:id/settings`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: constant-opennewimagedialog.md -->

# openNewImageDialog$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 314)

Opens the new image dialog.

<!-- source: component-brandedheader.md -->

# BrandedHeader

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/BrandedHeader.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `slugId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_BrandedHeader_6c50e2f6["BrandedHeader"]
    class component_BrandedHeader_6c50e2f6 rootComponent
```

## Relationships

- RENDERS → `Link`
- USES_HOOK → `useBranding`

<!-- source: interface-fileimageparameters.md -->

# FileImageParameters

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 63)

## Properties

| Property | Type |
|---|---|
| `file` | `File` |

<!-- source: api-endpoint-getsnapshot.md -->

# getSnapshot

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 142)

## Endpoint

`GET /technical-docs/:projectId/snapshot`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: constant-placeholder.md -->

# placeholder$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 154)

<!-- source: component-brandingprovider.md -->

# BrandingProvider

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/BrandingContext.tsx` (line 59)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `slugId` | `string` | ✓ | - |
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_BrandingProvider_369ca96a["BrandingProvider"]
    class component_BrandingProvider_369ca96a rootComponent
```

## Relationships

- RENDERS → `BrandingContext-Provider`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-fixeddoctemplate.md -->

# FixedDocTemplate

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 225)

Type for a fixed doc template.
The `referenceNeeds` field tells the KnowledgeCollector what snippet types to prioritize.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `categoryId` | `string` |
| `title` | `string` |
| `slug` | `string` |
| `order` | `number` |
| `referenceNeeds` | `SnippetType[]` |
| `promptGuidance` | `string` |
| `maxTokens` | `number` |
| `subcategory` | `string` |

<!-- source: api-endpoint-getsourcebreakdown.md -->

# getSourceBreakdown

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 102)

## Endpoint

`GET /analytics/:projectId/sources`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: constant-popovercontent.md -->

# PopoverContent

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/ui/PopoverUtils.tsx` (line 12)

<!-- source: component-brandingsettingspage.md -->

# BrandingSettingsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/branding/page.tsx` (line 119)

## Diagram

```mermaid
graph TD
    component_BrandingSettingsPage_687aa0f3["BrandingSettingsPage"]
    class component_BrandingSettingsPage_687aa0f3 rootComponent
```

## Relationships

- RENDERS → `PaintBrushIcon`
- RENDERS → `ArrowTopRightOnSquareIcon`
- RENDERS → `PhotoIcon`
- RENDERS → `SwatchIcon`
- RENDERS → `GlobeAltIcon`
- RENDERS → `ArrowUpTrayIcon`
- RENDERS → `SparklesIcon`
- RENDERS → `CheckIcon`
- RENDERS → `ContrastWarning`
- RENDERS → `DomainTab`
- RENDERS → `ComputerDesktopIcon`
- RENDERS → `DevicePhoneMobileIcon`
- RENDERS → `PreviewPane`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`
- USES_HOOK → `useMemo`

<!-- source: interface-flaskdetectionconfig.md -->

# FlaskDetectionConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/flask.patterns.ts` (line 240)

## Properties

| Property | Type |
|---|---|
| `name` | `'flask'` |
| `filePatterns` | `string[]` |
| `identifiers` | `RegExp[]` |
| `configFiles` | `string[]` |

<!-- source: api-endpoint-getstatistics.md -->

# getStatistics

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/graph.controller.ts` (line 186)

## Endpoint

`GET /knowledge-graph/statistics`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `GraphController` (MODULE_DECLARES)

<!-- source: constant-quoteplugin.md -->

# quotePlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/quote/index.ts` (line 11)

A plugin that adds support for block quotes to the editor.

<!-- source: component-breadcrumb.md -->

# Breadcrumb

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MDXRenderer.tsx` (line 180)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Breadcrumb_61456cb4["Breadcrumb"]
    class component_Breadcrumb_61456cb4 rootComponent
```

<!-- source: interface-flatcategory.md -->

# FlatCategory

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 175)

Flat category entry (for quick lookups)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `slug` | `string` |
| `level` | `number` |
| `parentId` | `string | null` |
| `path` | `string` |

<!-- source: api-endpoint-getstats.md -->

# getStats

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/dashboard/dashboard.controller.ts` (line 17)

## Endpoint

`GET /dashboard/stats`

## Referenced By

- `DashboardController` (MODULE_DECLARES)

<!-- source: constant-readonly.md -->

# readOnly$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 147)

Holds the readOnly state of the editor.

<!-- source: component-breadcrumbs.md -->

# Breadcrumbs

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/Breadcrumbs.tsx` (line 22)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `items` | `BreadcrumbItem[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Breadcrumbs_3e3fee6a["Breadcrumbs"]
    class component_Breadcrumbs_3e3fee6a rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `ChevronRightIcon`
- USES_HOOK → `useLanguageContext`

<!-- source: interface-fontconfig.md -->

# FontConfig

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/fonts.ts` (line 11)

Dynamic Font Loading

Loads Google Fonts at runtime based on site configuration.
AI picks fonts matching the brand voice during assembly.

Fonts are loaded via the Google Fonts CSS API with display=swap
for optimal loading performance (no FOIT).

## Properties

| Property | Type |
|---|---|
| `heading` | `string` |
| `body` | `string` |
| `mono` | `string` |
| `weights` | `number[]` |

<!-- source: api-endpoint-getstats-2.md -->

# getStats

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 147)

## Endpoint

`GET /documents/:id/stats`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: constant-remoterealmplugin.md -->

# remoteRealmPlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/remote/index.tsx` (line 63)

A plugin that allows you to access the editor's realm outside of the editor's component tree.
Requires wrapping your application in the `RemoteMDXEditorRealmProvider` component.

<!-- source: component-breadcrumbs-2.md -->

# Breadcrumbs

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Layout/Breadcrumbs.tsx` (line 28)

## Diagram

```mermaid
graph TD
    component_Breadcrumbs_7e8905e3["Breadcrumbs"]
    class component_Breadcrumbs_7e8905e3 rootComponent
```

## Relationships

- RENDERS → `ChevronRightIcon`
- RENDERS → `Link`
- USES_HOOK → `usePathname`
- USES_HOOK → `useSearchParams`
- USES_HOOK → `useProjectContext`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-fontfamily.md -->

# FontFamily

**Kind:** Interface

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 34)

## Properties

| Property | Type |
|---|---|
| `sans` | `string` |
| `serif` | `string` |
| `mono` | `string` |

<!-- source: api-endpoint-getstats-3.md -->

# getStats

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/issues.controller.ts` (line 56)

## Endpoint

`GET /projects/:projectId/issues/stats`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `IssuesController` (MODULE_DECLARES)

<!-- source: constant-removefrontmatter.md -->

# removeFrontmatter$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/frontmatter/index.ts` (line 61)

Removes the frontmatter node from the markdown document.

<!-- source: component-browsecollectionspage.md -->

# BrowseCollectionsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/browse/page.tsx` (line 15)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_BrowseCollectionsPage_1a6e1de1["BrowseCollectionsPage"]
    class component_BrowseCollectionsPage_1a6e1de1 rootComponent
```

## Relationships

- RENDERS → `CollectionsBrowse`
- USES_HOOK → `useSearchParams`
- USES_HOOK → `useLanguageContext`

<!-- source: interface-fontsize.md -->

# FontSize

**Kind:** Interface

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 40)

## Properties

| Property | Type |
|---|---|
| `xs` | `string` |
| `sm` | `string` |
| `base` | `string` |
| `lg` | `string` |
| `xl` | `string` |
| `'2xl'` | `string` |
| `'3xl'` | `string` |
| `'4xl'` | `string` |
| `'5xl'` | `string` |

<!-- source: api-endpoint-getstats-4.md -->

# getStats

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 302)

## Endpoint

`GET /projects/:id/stats`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: constant-removelink.md -->

# removeLink$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 290)

A signal that removes the current link.

<!-- source: component-capturedflows.md -->

# CapturedFlows

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/CapturedFlows.tsx` (line 47)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CapturedFlows_1e080fdd["CapturedFlows"]
    class component_CapturedFlows_1e080fdd rootComponent
```

## Relationships

- RENDERS → `Clapperboard`
- RENDERS → `Code2`
- RENDERS → `RefreshCw`
- RENDERS → `Check`
- RENDERS → `Copy`
- RENDERS → `ExternalLink`
- RENDERS → `ListChecks`
- RENDERS → `Route`
- RENDERS → `FileText`
- RENDERS → `Trash2`
- RENDERS → `StepEditor`
- RENDERS → `TourEmbed`
- USES_HOOK → `useSession`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-fontweight.md -->

# FontWeight

**Kind:** Interface

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 52)

## Properties

| Property | Type |
|---|---|
| `light` | `number` |
| `normal` | `number` |
| `medium` | `number` |
| `semibold` | `number` |
| `bold` | `number` |

<!-- source: api-endpoint-getstatus.md -->

# getStatus

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/agent/agent.controller.ts` (line 20)

Health check / session stats for monitoring.

## Endpoint

`GET /agent/status`

## Referenced By

- `AgentController` (MODULE_DECLARES)

<!-- source: constant-resetbutton.md -->

# resetButton

**Kind:** Constant

**Source:** `atloria-monorepo/packages/ui-core/src/utils/styles.ts` (line 15)

<!-- source: component-capturemodal.md -->

# CaptureModal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/enterprise/screenshots/CaptureModal.tsx` (line 17)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `siteUrl` | `string` | ✓ | - |
| `routePath` | `string` | ✓ | - |
| `description` | `string` | - | - |
| `documentId` | `string` | ✓ | - |
| `projectId` | `string` | ✓ | - |
| `versionId` | `string` | ✓ | - |
| `apiClient` | `any` | ✓ | - |
| `onCapture` | `Function` | ✓ | - |
| `onClose` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CaptureModal_7825c8f5["CaptureModal"]
    class component_CaptureModal_7825c8f5 rootComponent
```

## Relationships

- USES_HOOK → `useState`

<!-- source: interface-footerlinkgroup.md -->

# FooterLinkGroup

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/layout/footer.tsx` (line 10)

## Properties

| Property | Type |
|---|---|
| `titleKey` | `string` |
| `links` | `{ labelKey: string; href: string }[]` |

<!-- source: api-endpoint-getstatus-2.md -->

# getStatus

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/bitbucket/bitbucket.controller.ts` (line 70)

## Endpoint

`GET /bitbucket/status`

## Referenced By

- `BitbucketController` (MODULE_DECLARES)

<!-- source: constant-rooteditor.md -->

# rootEditor$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 123)

Holds a reference to the root Lexical editor instance.

<!-- source: component-categorydocumentlist.md -->

# CategoryDocumentList

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/PublishingSidebar/CategoryDocumentList.tsx` (line 53)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `categories` | `CategoryNode[]` | ✓ | - |
| `selectedDocument` | `string | null` | ✓ | - |
| `onSelectDocument` | `Function` | ✓ | - |
| `onHoverDocument` | `Function` | - | - |
| `loading` | `boolean` | - | false |
| `lang` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_CategoryDocumentList_61ceec8a["CategoryDocumentList"]
    class component_CategoryDocumentList_61ceec8a rootComponent
```

## Relationships

- RENDERS → `FileText`
- RENDERS → `ChevronDown`
- RENDERS → `ChevronRight`
- RENDERS → `CategoryIcon`
- RENDERS → `FolderOpen`
- RENDERS → `Folder`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useMemo`
- USES_HOOK → `useEffect`

<!-- source: interface-formcapturespec.md -->

# FormCaptureSpec

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/screenshot-spec.types.ts` (line 122)

Form state capture specification

## Properties

| Property | Type |
|---|---|
| `formState` | `'empty' | 'validation-errors' | 'filled' | 'partial'` |
| `fieldsToFill` | `{ selector: string; value: string }[]` |
| `submitSelector` | `string` |

<!-- source: api-endpoint-getstatus-3.md -->

# getStatus

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/github/github.controller.ts` (line 81)

Check GitHub connection status

## Endpoint

`GET /github/status`

## Referenced By

- `GitHubController` (MODULE_DECLARES)

<!-- source: constant-rooteditorsubscriptions.md -->

# rootEditorSubscriptions$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 469)

<!-- source: component-categoryicon.md -->

# CategoryIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Categories/CategoryIcon.tsx` (line 9)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `icon` | `string | null | undefined` | ✓ | - |
| `fallback` | `unknown` | - | - |
| `className` | `string` | - | "w-4 h-4" |
| `emojiClassName` | `string` | - | "text-base" |

## Diagram

```mermaid
graph TD
    component_CategoryIcon_37f8cc2b["CategoryIcon"]
    class component_CategoryIcon_37f8cc2b rootComponent
```

## Relationships

- RENDERS → `LucideComponent`

<!-- source: interface-formdefinition-2.md -->

# FormDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 111)

A form discovered in source code

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `submitMethod` | `string` |
| `fields` | `FormFieldDefinition[]` |
| `route` | `string` |
| `hostComponent` | `string` |
| `sourceFile` | `string` |

<!-- source: api-endpoint-getstatus-4.md -->

# getStatus

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/gitlab/gitlab.controller.ts` (line 81)

Check GitLab connection status

## Endpoint

`GET /gitlab/status`

## Referenced By

- `GitLabController` (MODULE_DECLARES)

<!-- source: constant-saveimage.md -->

# saveImage$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 353)

Saves the data from the image dialog

<!-- source: component-categorymodal.md -->

# CategoryModal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Categories/CategoryModal.tsx` (line 48)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `isOpen` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `onSuccess` | `Function` | ✓ | - |
| `projectId` | `string` | ✓ | - |
| `category` | `Category | null` | - | - |
| `parentId` | `string | null` | - | - |
| `mode` | `unknown | unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CategoryModal_1150262f["CategoryModal"]
    class component_CategoryModal_1150262f rootComponent
```

## Relationships

- RENDERS → `XMarkIcon`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-formfield-2.md -->

# FormField

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/layout/contact-form.tsx` (line 16)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `'text' | 'email' | 'tel' | 'textarea' | 'select'` |
| `labelKey` | `string` |
| `placeholderKey` | `string` |
| `required` | `boolean` |
| `options` | `{ labelKey: string; value: string }[]` |

<!-- source: api-endpoint-getstatus-5.md -->

# getStatus

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/parsing/parsing.controller.ts` (line 44)

## Endpoint

`GET /projects/:projectId/parse/:jobId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `jobId` | query | `string` | ✓ |

## Referenced By

- `ParsingController` (MODULE_DECLARES)

<!-- source: constant-scalein.md -->

# scaleIn

**Kind:** Constant

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/animations.ts` (line 30)

Scale in from slightly smaller

## Definition

```ts
Variants
```

<!-- source: component-categorytreesidebar.md -->

# CategoryTreeSidebar

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Categories/CategoryTreeSidebar.tsx` (line 145)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `selectedCategoryId` | `string | null` | - | - |
| `onSelectCategory` | `Function` | ✓ | - |
| `onCreateCategory` | `Function` | - | - |
| `onEditCategory` | `Function` | - | - |
| `onDeleteCategory` | `Function` | - | - |
| `editMode` | `boolean` | - | false |
| `onReorderCategories` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_CategoryTreeSidebar_40c8abcf["CategoryTreeSidebar"]
    class component_CategoryTreeSidebar_40c8abcf rootComponent
```

## Relationships

- RENDERS → `ErrorState`
- RENDERS → `MagnifyingGlassIcon`
- RENDERS → `XMarkIcon`
- RENDERS → `DocumentTextIcon`
- RENDERS → `DndContext`
- RENDERS → `SortableContext`
- RENDERS → `CategoryNode`
- RENDERS → `PlusIcon`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useSensors`
- USES_HOOK → `useSensor`
- USES_HOOK → `useCallback`
- USES_HOOK → `useMemo`
- USES_HOOK → `useEffect`

<!-- source: interface-formfielddefinition-2.md -->

# FormFieldDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 91)

A form field discovered in source code

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `required` | `boolean` |
| `model` | `string` |
| `validationRules` | `FormValidationRule[]` |
| `selector` | `string` |
| `conditionalOn` | `string` |

<!-- source: api-endpoint-getstatus-6.md -->

# getStatus

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 399)

## Endpoint

`GET /technical-docs/:projectId/status`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: constant-sectionviewport.md -->

# sectionViewport

**Kind:** Constant

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/animations.ts` (line 115)

Section viewport trigger defaults.
Use with whileInView on section containers.

<!-- source: component-changerequestdetailpage.md -->

# ChangeRequestDetailPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/changes/[crId]/page.tsx` (line 266)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ChangeRequestDetailPage_117d8e55["ChangeRequestDetailPage"]
    class component_ChangeRequestDetailPage_117d8e55 rootComponent
```

## Relationships

- RENDERS → `Spinner`
- RENDERS → `ActivityStrip`
- RENDERS → `ConflictFileCard`
- RENDERS → `CrDiffView`
- USES_HOOK → `useSession`
- USES_HOOK → `useRouter`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-formprofile.md -->

# FormProfile

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/site-map.types.ts` (line 41)

## Properties

| Property | Type |
|---|---|
| `selector` | `string` |
| `fieldCount` | `number` |
| `hasSubmitButton` | `boolean` |

<!-- source: api-endpoint-getsuggestions.md -->

# getSuggestions

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/search.controller.ts` (line 125)

Get autocomplete suggestions

GET /search/suggestions?q=partial

Query Parameters:
- q (required): Partial search query
- projectId: Filter to specific project (default: all projects in user's organization)
- limit: Max suggestions (default: 5)

## Endpoint

`GET /search/suggestions`

| Parameter | In | Type | Required |
|---|---|---|---|
| `q` | query | `string` | ✓ |
| `projectId` | query | `string` | - |
| `limit` | query | `string` | - |

## Referenced By

- `SearchController` (MODULE_DECLARES)

<!-- source: constant-selectitem.md -->

# SelectItem

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/select.tsx` (line 12)

<!-- source: component-changescontent.md -->

# ChangesContent

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/ChangesContent.tsx` (line 29)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ChangesContent_2be838fc["ChangesContent"]
    class component_ChangesContent_2be838fc rootComponent
```

## Relationships

- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-formvalidationrule-2.md -->

# FormValidationRule

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 79)

A validation rule on a form field

## Properties

| Property | Type |
|---|---|
| `type` | `string` |
| `param` | `string` |
| `message` | `string` |

<!-- source: api-endpoint-getsupportedlanguages.md -->

# getSupportedLanguages

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/parser/parser.controller.ts` (line 28)

## Endpoint

`GET /parser/languages`

## Referenced By

- `ParserController` (MODULE_DECLARES)

<!-- source: constant-selector-types.md -->

# SELECTOR_TYPES

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 13)

Route Mapping Types

Type definitions for linking routes to components, templates, and extracted selectors.
Used to provide accurate selector information to the screenshot-worker.

<!-- source: component-changespage.md -->

# ChangesPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/changes/page.tsx` (line 7)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ChangesPage_2cd26585["ChangesPage"]
    class component_ChangesPage_2cd26585 rootComponent
```

## Relationships

- USES_HOOK → `useRouter`
- USES_HOOK → `useEffect`

<!-- source: interface-frameworkdetectionconfig.md -->

# FrameworkDetectionConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/framework.types.ts` (line 150)

Framework detection configuration

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `'frontend' | 'backend' | 'fullstack'` |
| `indicatorFiles` | `string[]` |
| `dependencies` | `string[]` |
| `filePatterns` | `RegExp[]` |
| `codePatterns` | `RegExp[]` |
| `priority` | `number` |

<!-- source: api-endpoint-getthread.md -->

# getThread

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/desk.controller.ts` (line 60)

## Endpoint

`GET /desk/:projectId/threads/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `DeskController` (MODULE_DECLARES)

<!-- source: constant-separator.md -->

# Separator

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/toolbar.tsx` (line 326)

A toolbar primitive that allows you to show a separator between toolbar items.
By default, the separator is styled as vertical line.

<!-- source: component-chatmessage.md -->

# ChatMessage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/ChatMessage.tsx` (line 27)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `message` | `Message` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ChatMessage_2eec20e5["ChatMessage"]
    class component_ChatMessage_2eec20e5 rootComponent
```

## Relationships

- RENDERS → `StreamingIndicator`
- RENDERS → `ReactMarkdown`

<!-- source: interface-frameworkdetectionresult.md -->

# FrameworkDetectionResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/framework.types.ts` (line 127)

Framework detection result with patterns to apply

## Properties

| Property | Type |
|---|---|
| `techStack` | `DetectedTechStack` |
| `patternsToApply` | `string[]` |
| `detectorsToRun` | `string[]` |
| `fileExtensions` | `string[]` |
| `priorityPaths` | `string[]` |

<!-- source: api-endpoint-getticket.md -->

# getTicket

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/public-issues.controller.ts` (line 19)

## Endpoint

`GET /public/issues/:projectSlugId/:ticketNumber`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectSlugId` | query | `string` | ✓ |
| `ticketNumber` | query | `number` | ✓ |
| `reporterSessionId` | query | `string` | ✓ |

## Referenced By

- `PublicIssuesController` (MODULE_DECLARES)

<!-- source: constant-setmarkdown.md -->

# setMarkdown$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 379)

Sets a new markdown value for the editor, replacing the current one.

<!-- source: component-claimtrialpage.md -->

# ClaimTrialPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/claim/[projectId]/page.tsx` (line 15)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ClaimTrialPage_735f88e1["ClaimTrialPage"]
    class component_ClaimTrialPage_735f88e1 rootComponent
```

## Relationships

- USES_HOOK → `useRouter`
- USES_HOOK → `useSession`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-frontmattereditorprops.md -->

# FrontmatterEditorProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/frontmatter/FrontmatterEditor.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `yaml` | `string` |
| `onChange` | `(yaml: string) => void` |

<!-- source: api-endpoint-gettopdocuments.md -->

# getTopDocuments

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 54)

## Endpoint

`GET /analytics/:projectId/documents`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: constant-shadcn-component-patterns.md -->

# SHADCN_COMPONENT_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/shadcn.patterns.ts` (line 12)

shadcn/ui Pattern Detection

Patterns for detecting shadcn/ui components (built on Radix UI primitives).
shadcn/ui copies component code into your project rather than being a package.

<!-- source: component-codebasechat.md -->

# CodebaseChat

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/CodebaseChat.tsx` (line 23)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CodebaseChat_2e0d7f59["CodebaseChat"]
    class component_CodebaseChat_2e0d7f59 rootComponent
```

## Relationships

- USES_HOOK → `useSession`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-generateddocument.md -->

# GeneratedDocument

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-10.types.ts` (line 40)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `slug` | `string` |
| `content` | `string` |
| `frontmatter` | `DocumentFrontmatter` |
| `sections` | `GeneratedSection[]` |
| `claims` | `EvidencedClaim[]` |
| `screenshotPlaceholders` | `string[]` |
| `metadata` | `{
    groundingScore?: number;       // 0-1, % of entity mentions verified against source code
    ungroundedEntities?: string[]; // entities mentioned but not found in code
  }` |

<!-- source: api-endpoint-gettopsearchqueries.md -->

# getTopSearchQueries

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 66)

## Endpoint

`GET /analytics/:projectId/search-queries`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: constant-shadcn-data-table-patterns.md -->

# SHADCN_DATA_TABLE_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/shadcn.patterns.ts` (line 216)

<!-- source: component-codeparser.md -->

# CodeParser

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/CodeParser.tsx` (line 22)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `initialCode` | `string` | - | "" |
| `initialLanguage` | `string` | - | "typescript" |
| `onParseComplete` | `Function` | - | - |
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_CodeParser_2086ed1c["CodeParser"]
    class component_CodeParser_2086ed1c rootComponent
```

## Relationships

- RENDERS → `ViewButton`
- RENDERS → `FileUpload`
- RENDERS → `BatchFileProcessor`
- RENDERS → `ParsingResults`
- USES_HOOK → `useState`
- USES_HOOK → `useParser`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-generatedsection.md -->

# GeneratedSection

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-10.types.ts` (line 65)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `content` | `string` |
| `order` | `number` |

<!-- source: api-endpoint-gettree.md -->

# getTree

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/category.controller.ts` (line 55)

Get category tree for a project

## Endpoint

`GET /categories/tree/:projectId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `docVersionId` | query | `string | undefined` | ✓ |

## Referenced By

- `CategoryController` (MODULE_DECLARES)

<!-- source: constant-shadcn-detection-config.md -->

# SHADCN_DETECTION_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/shadcn.patterns.ts` (line 287)

## Definition

```ts
ShadcnDetectionConfig
```

<!-- source: component-codeviewer.md -->

# CodeViewer

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/CodeViewer.tsx` (line 19)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `code` | `string` | ✓ | - |
| `language` | `string` | ✓ | - |
| `symbols` | `Symbol[]` | - | [] |
| `highlightedSymbol` | `Symbol` | - | - |
| `onSymbolClick` | `Function` | - | - |
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_CodeViewer_4d8bf3c2["CodeViewer"]
    class component_CodeViewer_4d8bf3c2 rootComponent
```

## Relationships

- RENDERS → `CheckIcon`
- RENDERS → `CopyIcon`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`

<!-- source: interface-generationcontext.md -->

# GenerationContext

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-10.types.ts` (line 112)

GenerationContext - Extended context for AI generation

Includes mechanisms for the AI to request more context.

## Properties

| Property | Type |
|---|---|
| `chunkSummary` | `string` |
| `relevantEntities` | `Entity[]` |
| `deepLoadedEntities` | `Map<string, DeepLoadResponse>` |
| `deepLoadIterations` | `number` |
| `maxDeepLoadIterations` | `number` |
| `uncertainties` | `Uncertainty[]` |

<!-- source: api-endpoint-gettree-2.md -->

# getTree

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 479)

## Endpoint

`GET /documents/tree/:projectId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: constant-shadcn-form-patterns.md -->

# SHADCN_FORM_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/shadcn.patterns.ts` (line 178)

<!-- source: component-collaborationstatusbar.md -->

# CollaborationStatusBar

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/CollaborationStatusBar.tsx` (line 342)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `synced` | `boolean` | ✓ | - |
| `activeUsers` | `CollaborationUser[]` | ✓ | - |
| `connectionStatus` | `ConnectionStatus` | ✓ | - |
| `maxVisibleUsers` | `number` | - | 5 |
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_CollaborationStatusBar_20048f2e["CollaborationStatusBar"]
    class component_CollaborationStatusBar_20048f2e rootComponent
```

## Relationships

- RENDERS → `SyncStatusIndicator`
- RENDERS → `UserAvatar`
- RENDERS → `OverflowIndicator`

<!-- source: interface-generationinput.md -->

# GenerationInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-10.types.ts` (line 26)

## Properties

| Property | Type |
|---|---|
| `plans` | `DocumentPlan[]` |
| `entities` | `Entity[]` |
| `sharedContext` | `string` |
| `retrievedContexts` | `Map<string, RetrievedContext>` |
| `appName` | `string` |
| `categoryMap` | `Map<string, { categoryId: string; categorySlug: string; categoryName: string }>` |

<!-- source: api-endpoint-gettrendingdocs.md -->

# getTrendingDocs

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 155)

## Endpoint

`GET /analytics/:projectId/trending-docs`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: constant-shadcn-utility-patterns.md -->

# SHADCN_UTILITY_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/shadcn.patterns.ts` (line 252)

<!-- source: component-collaborativedocumenteditor.md -->

# CollaborativeDocumentEditor

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/CollaborativeDocumentEditor.tsx` (line 277)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `documentId` | `string` | ✓ | - |
| `initialContent` | `string` | - | "" |
| `userId` | `string` | ✓ | - |
| `userName` | `string` | ✓ | - |
| `onChange` | `Function` | - | - |
| `editable` | `boolean` | - | true |
| `serverUrl` | `string` | - | - |
| `className` | `string` | - | "" |
| `showStatusBar` | `boolean` | - | true |
| `showCursors` | `boolean` | - | true |

## Diagram

```mermaid
graph TD
    component_CollaborativeDocumentEditor_61abc9e0["CollaborativeDocumentEditor"]
    class component_CollaborativeDocumentEditor_61abc9e0 rootComponent
```

## Relationships

- RENDERS → `EditorSkeleton`
- RENDERS → `EditorError`
- RENDERS → `CollaborationStatusBar`
- RENDERS → `UserCursors`
- RENDERS → `MDXEditor`
- RENDERS → `KitchenSinkToolbar`
- RENDERS → `Separator`
- RENDERS → `InsertAudienceButton`
- USES_HOOK → `useRef`
- USES_HOOK → `useState`
- USES_HOOK → `useCollaboration`
- USES_HOOK → `useSession`
- USES_HOOK → `useAudiences`
- USES_HOOK → `useMemo`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-generationresult.md -->

# GenerationResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-10.types.ts` (line 35)

## Properties

| Property | Type |
|---|---|
| `documents` | `GeneratedDocument[]` |
| `tokenUsage` | `TokenUsage[]` |

<!-- source: api-endpoint-gettriggerconfig.md -->

# getTriggerConfig

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 274)

## Endpoint

`GET /doc-automation/config/:projectId/triggers`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: constant-showlinktitlefield.md -->

# showLinkTitleField$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 382)

<!-- source: component-collectionsbrowse.md -->

# CollectionsBrowse

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/CollectionsBrowse.tsx` (line 63)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `slugId` | `string` | ✓ | - |
| `audienceSlug` | `string` | - | - |
| `version` | `string` | - | - |
| `lang` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_CollectionsBrowse_1c13d76["CollectionsBrowse"]
    class component_CollectionsBrowse_1c13d76 rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `FolderIcon`
- RENDERS → `ArrowRightIcon`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-generatorserviceconfig.md -->

# GeneratorServiceConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/generator.service.ts` (line 41)

## Properties

| Property | Type |
|---|---|
| `maxOutputTokens` | `number` |
| `temperature` | `number` |
| `batchSize` | `number` |
| `onDocumentGenerated` | `(doc: GeneratedDocument) => Promise<void>` |
| `useTemplatePrefill` | `boolean` |

<!-- source: api-endpoint-getuseractivity.md -->

# getUserActivity

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/dashboard/dashboard.controller.ts` (line 38)

## Endpoint

`GET /dashboard/activity`

## Referenced By

- `DashboardController` (MODULE_DECLARES)

<!-- source: constant-singletogglegroup.md -->

# SingleToggleGroup

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/toolbar.tsx` (line 77)

<!-- source: component-colorfield.md -->

# ColorField

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/branding/page.tsx` (line 1073)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `value` | `string` | ✓ | - |
| `onChange` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ColorField_2d432677["ColorField"]
    class component_ColorField_2d432677 rootComponent
```

## Relationships

- RENDERS → `CheckIcon`
- RENDERS → `ClipboardDocumentIcon`
- USES_HOOK → `useState`

<!-- source: interface-genericjsxeditorprops.md -->

# GenericJsxEditorProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/jsx-editors/GenericJsxEditor.tsx` (line 55)

Properties for the Generic Jsx Editor

## Properties

| Property | Type |
|---|---|
| `PropertyEditor` | `PropertyEditorType` |

<!-- source: api-endpoint-getuseraudiences.md -->

# getUserAudiences

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/organization/organization.controller.ts` (line 176)

## Endpoint

`GET /organizations/:id/members/:userId/audiences`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `userId` | query | `string` | ✓ |

## Referenced By

- `OrganizationController` (MODULE_DECLARES)

<!-- source: constant-slidefromend.md -->

# slideFromEnd

**Kind:** Constant

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/animations.ts` (line 72)

Slide from inline-end (LTR: right, RTL: left)

## Definition

```ts
Variants
```

<!-- source: component-columneditor.md -->

# ColumnEditor

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/ColumnEditor.tsx` (line 56)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `open` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `boardId` | `string` | ✓ | - |
| `column` | `unknown | null` | ✓ | - |
| `afterColumnId` | `string` | - | - |
| `onSaved` | `Function` | - | - |
| `onDeleted` | `Function` | - | - |
| `otherColumns` | `Array` | - | [] |

## Diagram

```mermaid
graph TD
    component_ColumnEditor_5e59bd5c["ColumnEditor"]
    class component_ColumnEditor_5e59bd5c rootComponent
```

## Relationships

- RENDERS → `Modal`
- RENDERS → `TrashIcon`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useBoardsToast`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: api-endpoint-getvariants.md -->

# getVariants

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/pme/pme.controller.ts` (line 75)

## Endpoint

`GET /pme/jobs/:jobId/variants`

| Parameter | In | Type | Required |
|---|---|---|---|
| `jobId` | query | `string` | ✓ |

## Referenced By

- `PmeController` (MODULE_DECLARES)

<!-- source: interface-gridprofile.md -->

# GridProfile

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/site-map.types.ts` (line 10)

SiteMap Types — Browser-discovered route and page profile data.

Generated by the DiscoveryService in screenshot-worker via Playwright.
Feeds HybridMapper Tier 2 (confidence 0.95) for screenshot placeholder matching.

## Properties

| Property | Type |
|---|---|
| `framework` | `'devextreme' | 'ag-grid' | 'aria' | 'html-table'` |
| `selector` | `string` |
| `rowCount` | `number` |
| `columns` | `string[]` |
| `hasDetailNavigation` | `boolean` |
| `detailUrl` | `string` |
| `detailProfile` | `PageElementProfile` |

<!-- source: constant-slidefromstart.md -->

# slideFromStart

**Kind:** Constant

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/animations.ts` (line 62)

Slide from inline-start (LTR: left, RTL: right)

## Definition

```ts
Variants
```

<!-- source: component-commandpalette.md -->

# CommandPalette

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/CommandPalette.tsx` (line 40)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `navMap` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CommandPalette_320cc491["CommandPalette"]
    class component_CommandPalette_320cc491 rootComponent
```

## Relationships

- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useMemo`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: api-endpoint-getversion.md -->

# getVersion

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 309)

## Endpoint

`GET /documents/:id/versions/:version`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `version` | query | `number` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: interface-groundingresult.md -->

# GroundingResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/grounding-checker.ts` (line 13)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `title` | `string` |
| `score` | `number` |
| `matched` | `string[]` |
| `unmatched` | `string[]` |

<!-- source: constant-spellcheck.md -->

# spellCheck$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 141)

Holds the spellcheck value of the content editable element.

<!-- source: component-commentformskeleton.md -->

# CommentFormSkeleton

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Comments/CommentSkeleton.tsx` (line 53)

## Diagram

```mermaid
graph TD
    component_CommentFormSkeleton_698dd283["CommentFormSkeleton"]
    class component_CommentFormSkeleton_698dd283 rootComponent
```

<!-- source: api-endpoint-getversions.md -->

# getVersions

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 286)

## Endpoint

`GET /documents/:id/versions`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: interface-groundingscoreresult.md -->

# GroundingScoreResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/grounding-checker.ts` (line 21)

## Properties

| Property | Type |
|---|---|
| `score` | `number` |
| `matched` | `string[]` |
| `unmatched` | `string[]` |

<!-- source: constant-spring-async-patterns.md -->

# SPRING_ASYNC_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/spring.patterns.ts` (line 233)

<!-- source: component-commenthighlight.md -->

# CommentHighlight

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/CommentMarkers.tsx` (line 224)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |
| `isActive` | `boolean` | - | - |
| `onClick` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_CommentHighlight_482205e5["CommentHighlight"]
    class component_CommentHighlight_482205e5 rootComponent
```

<!-- source: api-endpoint-getversiontraffic.md -->

# getVersionTraffic

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 42)

## Endpoint

`GET /analytics/:projectId/versions`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: interface-herobentogridprops-2.md -->

# HeroBentoGridProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/hero/hero-bento-grid.tsx` (line 15)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `subheadlineKey` | `string` |
| `primaryCtaKey` | `string` |
| `primaryCtaUrl` | `string` |
| `secondaryCtaKey` | `string` |
| `secondaryCtaUrl` | `string` |
| `badgeKey` | `string` |
| `gridItems` | `{ titleKey: string; descriptionKey?: string; icon?: LucideIcon }[]` |
| `className` | `string` |

<!-- source: constant-spring-controller-patterns.md -->

# SPRING_CONTROLLER_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/spring.patterns.ts` (line 11)

Spring Boot Pattern Detection

Patterns for detecting Spring Boot controllers, services, and annotations.

<!-- source: component-commentmarkers.md -->

# CommentMarkers

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/CommentMarkers.tsx` (line 38)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `comments` | `CommentWithUser[]` | ✓ | - |
| `onMarkerClick` | `Function` | - | - |
| `editorContent` | `string` | - | "" |
| `containerHeight` | `number` | - | 800 |

## Diagram

```mermaid
graph TD
    component_CommentMarkers_7abefb16["CommentMarkers"]
    class component_CommentMarkers_7abefb16 rootComponent
```

## Relationships

- RENDERS → `MessageCircle`
- RENDERS → `CommentPreview`
- USES_HOOK → `useState`
- USES_HOOK → `useMemo`
- USES_HOOK → `useCallback`

<!-- source: api-endpoint-getwebhookurl.md -->

# getWebhookUrl

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 340)

## Endpoint

`GET /doc-automation/config/:projectId/webhook-url`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: interface-herodarkcenteredprops-2.md -->

# HeroDarkCenteredProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/hero/hero-dark-centered.tsx` (line 14)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `subheadlineKey` | `string` |
| `primaryCtaKey` | `string` |
| `primaryCtaUrl` | `string` |
| `secondaryCtaKey` | `string` |
| `secondaryCtaUrl` | `string` |
| `badgeKey` | `string` |
| `floatingStats` | `{ valueKey: string; labelKey: string }[]` |
| `imageSrc` | `string` |
| `imageAlt` | `string` |

<!-- source: constant-spring-data-patterns.md -->

# SPRING_DATA_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/spring.patterns.ts` (line 89)

<!-- source: component-commentsidebar.md -->

# CommentSidebar

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Comments/CommentSidebar.tsx` (line 42)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `documentId` | `string` | ✓ | - |
| `isOpen` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `enableRealtime` | `boolean` | - | true |
| `projectId` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_CommentSidebar_cc3c3f7["CommentSidebar"]
    class component_CommentSidebar_cc3c3f7 rootComponent
```

## Relationships

- RENDERS → `MessageCircle`
- RENDERS → `X`
- RENDERS → `FilterPill`
- RENDERS → `CommentSkeletonList`
- RENDERS → `CommentThread`
- RENDERS → `CommentForm`
- USES_HOOK → `useComments`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useMemo`
- USES_HOOK → `useEffect`

<!-- source: api-endpoint-getzeroresultsearches.md -->

# getZeroResultSearches

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 128)

## Endpoint

`GET /analytics/:projectId/zero-result-searches`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: interface-herogradientsplitprops-2.md -->

# HeroGradientSplitProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/hero/hero-gradient-split.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `subheadlineKey` | `string` |
| `primaryCtaKey` | `string` |
| `primaryCtaUrl` | `string` |
| `secondaryCtaKey` | `string` |
| `secondaryCtaUrl` | `string` |
| `imageSrc` | `string` |
| `imageAlt` | `string` |
| `badges` | `{ textKey: string; icon?: LucideIcon }[]` |
| `className` | `string` |

<!-- source: constant-spring-detection-config.md -->

# SPRING_DETECTION_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/spring.patterns.ts` (line 259)

## Definition

```ts
SpringDetectionConfig
```

<!-- source: component-commentskeletonlist.md -->

# CommentSkeletonList

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Comments/CommentSkeleton.tsx` (line 40)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `count` | `number` | - | 3 |

## Diagram

```mermaid
graph TD
    component_CommentSkeletonList_1a0c0929["CommentSkeletonList"]
    class component_CommentSkeletonList_1a0c0929 rootComponent
```

## Relationships

- RENDERS → `CommentSkeleton`

<!-- source: api-endpoint-handle.md -->

# handle

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/github-app/github-app.controller.ts` (line 25)

## Endpoint

`POST /webhooks/github-app`

## Referenced By

- `GithubAppController` (MODULE_DECLARES)

<!-- source: interface-herominimalcenteredprops-2.md -->

# HeroMinimalCenteredProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/hero/hero-minimal-centered.tsx` (line 14)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `subheadlineKey` | `string` |
| `primaryCtaKey` | `string` |
| `primaryCtaUrl` | `string` |
| `secondaryCtaKey` | `string` |
| `secondaryCtaUrl` | `string` |
| `badgeKey` | `string` |
| `badgeIcon` | `LucideIcon` |
| `dividerIcons` | `LucideIcon[]` |
| `imageSrc` | `string` |
| `imageAlt` | `string` |

<!-- source: constant-spring-error-patterns.md -->

# SPRING_ERROR_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/spring.patterns.ts` (line 218)

<!-- source: component-commentthread.md -->

# CommentThread

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Comments/CommentThread.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `comment` | `CommentWithUser` | ✓ | - |
| `onResolve` | `Function` | ✓ | - |
| `onUnresolve` | `Function` | ✓ | - |
| `onReply` | `Function` | ✓ | - |
| `onDelete` | `Function` | - | - |
| `projectId` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_CommentThread_20643079["CommentThread"]
    class component_CommentThread_20643079 rootComponent
```

## Relationships

- RENDERS → `Check`
- RENDERS → `Avatar`
- RENDERS → `MessageSquare`
- RENDERS → `RotateCcw`
- RENDERS → `Trash2`
- RENDERS → `CommentReply`
- RENDERS → `ReplyForm`
- USES_HOOK → `useState`

<!-- source: api-endpoint-handle-2.md -->

# handle

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-mcp.controller.ts` (line 164)

## Endpoint

`POST /technical-docs/:projectId/mcp`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsMcpController` (MODULE_DECLARES)

<!-- source: interface-howitworkscardsgridprops-2.md -->

# HowItWorksCardsGridProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/how-it-works/how-it-works-cards-grid.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `labelKey` | `string` |
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `steps` | `{ icon: LucideIcon; titleKey: string; descriptionKey: string }[]` |

<!-- source: constant-spring-security-patterns.md -->

# SPRING_SECURITY_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/spring.patterns.ts` (line 172)

<!-- source: component-compactupload.md -->

# CompactUpload

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/branding/page.tsx` (line 1250)

Compact upload — preview + upload + clear all in one interactive zone. Click the zone to pick a file, hover to see the replace/clear overlay.

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `url` | `string` | ✓ | - |
| `uploading` | `boolean` | ✓ | - |
| `inputRef` | `unknown` | ✓ | - |
| `onUpload` | `Function` | ✓ | - |
| `onClear` | `Function` | ✓ | - |
| `size` | `unknown | unknown` | - | "lg" |

## Diagram

```mermaid
graph TD
    component_CompactUpload_26ad441c["CompactUpload"]
    class component_CompactUpload_26ad441c rootComponent
```

## Relationships

- RENDERS → `ArrowUpTrayIcon`
- USES_HOOK → `useState`

<!-- source: api-endpoint-handleazuredevops.md -->

# handleAzureDevOps

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/webhooks/webhook.controller.ts` (line 94)

## Endpoint

`POST /webhooks/azure-devops`

## Referenced By

- `WebhookController` (MODULE_DECLARES)

<!-- source: interface-hybridmappingoptions.md -->

# HybridMappingOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/hybrid-mapper.service.ts` (line 50)

## Properties

| Property | Type |
|---|---|
| `interactionMap` | `InteractionMap` |
| `siteMap` | `SiteMap` |
| `siteUrl` | `string` |
| `appName` | `string` |

<!-- source: constant-spring-service-patterns.md -->

# SPRING_SERVICE_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/spring.patterns.ts` (line 57)

<!-- source: component-comparedocumentspage.md -->

# CompareDocumentsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/documents/[id]/compare/page.tsx` (line 35)

## Diagram

```mermaid
graph TD
    component_CompareDocumentsPage_5d965af9["CompareDocumentsPage"]
    class component_CompareDocumentsPage_5d965af9 rootComponent
```

## Relationships

- RENDERS → `ArrowLeftIcon`
- RENDERS → `ChartBarIcon`
- RENDERS → `Squares2X2Icon`
- RENDERS → `ViewColumnsIcon`
- RENDERS → `ClockIcon`
- RENDERS → `TimelineView`
- RENDERS → `ArrowsRightLeftIcon`
- RENDERS → `UnifiedDiff`
- RENDERS → `SideBySideDiff`
- USES_HOOK → `useParams`
- USES_HOOK → `useRouter`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: api-endpoint-handlecallback.md -->

# handleCallback

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/bitbucket/bitbucket.controller.ts` (line 23)

## Endpoint

`GET /bitbucket/callback`

| Parameter | In | Type | Required |
|---|---|---|---|
| `code` | query | `string` | ✓ |
| `state` | query | `string` | ✓ |

## Referenced By

- `BitbucketController` (MODULE_DECLARES)

<!-- source: interface-hybridmappingresult.md -->

# HybridMappingResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/hybrid-mapper.service.ts` (line 61)

## Properties

| Property | Type |
|---|---|
| `mapped` | `ScreenshotSpec[]` |
| `unmapped` | `ScreenshotPlaceholder[]` |
| `stats` | `HybridMappingStats` |

<!-- source: constant-spring-validation-patterns.md -->

# SPRING_VALIDATION_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/spring.patterns.ts` (line 136)

<!-- source: component-comparegitbookpage.md -->

# CompareGitBookPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/compare/gitbook/page.tsx` (line 109)

## Diagram

```mermaid
graph TD
    component_CompareGitBookPage_3c5fbd11["CompareGitBookPage"]
    class component_CompareGitBookPage_3c5fbd11 rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `VerdictDot`

<!-- source: api-endpoint-handlecallback-2.md -->

# handleCallback

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/github/github.controller.ts` (line 31)

GitHub OAuth callback - exchanges code for token
This is called by GitHub after the user authorizes.
Returns HTML that sends a message to the opener window and closes itself.

## Endpoint

`GET /github/callback`

| Parameter | In | Type | Required |
|---|---|---|---|
| `code` | query | `string` | ✓ |
| `state` | query | `string` | ✓ |

## Referenced By

- `GitHubController` (MODULE_DECLARES)

<!-- source: interface-hybridmappingstats.md -->

# HybridMappingStats

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/hybrid-mapper.service.ts` (line 70)

## Properties

| Property | Type |
|---|---|
| `total` | `number` |
| `interactionMapMatches` | `number` |
| `siteMapMatches` | `number` |
| `unmatchedCount` | `number` |
| `averageConfidence` | `number` |

<!-- source: constant-sronly.md -->

# srOnly

**Kind:** Constant

**Source:** `atloria-monorepo/packages/ui-core/src/utils/styles.ts` (line 25)

<!-- source: component-comparehubpage.md -->

# CompareHubPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/compare/page.tsx` (line 39)

## Diagram

```mermaid
graph TD
    component_CompareHubPage_4f78e629["CompareHubPage"]
    class component_CompareHubPage_4f78e629 rootComponent
```

## Relationships

- RENDERS → `Link`

<!-- source: api-endpoint-handlecallback-3.md -->

# handleCallback

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/gitlab/gitlab.controller.ts` (line 31)

GitLab OAuth callback - exchanges code for token
This is called by GitLab after the user authorizes.
Returns HTML that sends a message to the opener window and closes itself.

## Endpoint

`GET /gitlab/callback`

| Parameter | In | Type | Required |
|---|---|---|---|
| `code` | query | `string` | ✓ |
| `state` | query | `string` | ✓ |

## Referenced By

- `GitLabController` (MODULE_DECLARES)

<!-- source: interface-ianalyzerservice.md -->

# IAnalyzerService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-04-analysis/analyzer.service.ts` (line 35)

<!-- source: constant-staggerchildren.md -->

# staggerChildren

**Kind:** Constant

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/animations.ts` (line 40)

Stagger children — use on parent container

## Definition

```ts
Variants
```

<!-- source: component-comparemintlifypage.md -->

# CompareMintlifyPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/compare/mintlify/page.tsx` (line 108)

## Diagram

```mermaid
graph TD
    component_CompareMintlifyPage_2aeac93["CompareMintlifyPage"]
    class component_CompareMintlifyPage_2aeac93 rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `VerdictDot`

<!-- source: api-endpoint-handlegithub.md -->

# handleGitHub

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/webhooks/webhook.controller.ts` (line 19)

## Endpoint

`POST /webhooks/github`

## Referenced By

- `WebhookController` (MODULE_DECLARES)

<!-- source: interface-ichunkerservice.md -->

# IChunkerService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-02-chunking/chunker.service.ts` (line 28)

Chunker service interface for dependency injection

<!-- source: constant-staggerfast.md -->

# staggerFast

**Kind:** Constant

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/animations.ts` (line 51)

Faster stagger for grids with many items

## Definition

```ts
Variants
```

<!-- source: component-compareversionspage.md -->

# CompareVersionsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/versions/compare/page.tsx` (line 15)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CompareVersionsPage_ac18b08["CompareVersionsPage"]
    class component_CompareVersionsPage_ac18b08 rootComponent
```

## Relationships

- USES_HOOK → `useSession`
- USES_HOOK → `useRouter`
- USES_HOOK → `useSearchParams`
- USES_HOOK → `useState`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useEffect`

<!-- source: api-endpoint-handlegitlab.md -->

# handleGitLab

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/webhooks/webhook.controller.ts` (line 64)

## Endpoint

`POST /webhooks/gitlab`

## Referenced By

- `WebhookController` (MODULE_DECLARES)

<!-- source: interface-icrossstackmapper.md -->

# ICrossStackMapper

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-03-features/cross-stack-mapper.ts` (line 63)

Cross-Stack Mapper Service Interface

<!-- source: constant-state-management-detection-configs.md -->

# STATE_MANAGEMENT_DETECTION_CONFIGS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/framework.types.ts` (line 403)

State management detection configurations

<!-- source: component-completionsummary.md -->

# CompletionSummary

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/DocAutomation/CompletionSummary.tsx` (line 51)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `result` | `JobResult` | ✓ | - |
| `projectSlug` | `string` | - | - |
| `projectId` | `string` | - | - |
| `onGenerateAgain` | `Function` | - | - |
| `onViewDocs` | `Function` | - | - |
| `screenshotProgress` | `unknown | null` | - | - |
| `onCancelScreenshots` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_CompletionSummary_7657cbf4["CompletionSummary"]
    class component_CompletionSummary_7657cbf4 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `CheckCircle2`
- RENDERS → `Icon`
- RENDERS → `Globe`
- RENDERS → `Camera`
- RENDERS → `Button`
- RENDERS → `ExternalLink`
- RENDERS → `Check`
- RENDERS → `Copy`
- RENDERS → `RefreshCw`
- USES_HOOK → `useState`

<!-- source: api-endpoint-handlemcp.md -->

# handleMcp

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 310)

## Endpoint

`POST /public/p/:slugWithId/mcp`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: interface-idocplannerservice.md -->

# IDocPlannerService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-09-planning/doc-planner.service.ts` (line 29)

<!-- source: constant-streaming-config.md -->

# STREAMING_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 388)

<!-- source: component-configeditor.md -->

# ConfigEditor

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/DocAutomation/ConfigEditor.tsx` (line 65)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `config` | `DocumentationConfig | null` | ✓ | - |
| `loading` | `boolean` | - | false |
| `error` | `Error | null` | - | - |
| `onSave` | `Function` | ✓ | - |
| `onCancel` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_ConfigEditor_5e2992a0["ConfigEditor"]
    class component_ConfigEditor_5e2992a0 rootComponent
```

## Relationships

- RENDERS → `GitBranch`
- RENDERS → `Lock`
- RENDERS → `EyeOff`
- RENDERS → `Eye`
- RENDERS → `FolderCode`
- RENDERS → `Globe`
- RENDERS → `Users`
- RENDERS → `AlertCircle`
- RENDERS → `Button`
- RENDERS → `Loader2`
- RENDERS → `Save`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: api-endpoint-healthcheck-2.md -->

# healthCheck

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/app/app.controller.ts` (line 19)

## Endpoint

`GET /health`

## Referenced By

- `AppController` (MODULE_DECLARES)

<!-- source: interface-ifeatureextractorservice.md -->

# IFeatureExtractorService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-03-features/extractor.service.ts` (line 24)

<!-- source: constant-subtle.md -->

# subtle

**Kind:** Constant

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/animations.ts` (line 103)

Subtle entrance — minimal animation

## Definition

```ts
Variants
```

<!-- source: component-connectaimenu.md -->

# ConnectAiMenu

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/ConnectAiMenu.tsx` (line 16)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `slugId` | `string` | ✓ | - |
| `audienceSlug` | `string` | ✓ | - |
| `documentSlug` | `string` | ✓ | - |
| `title` | `string` | ✓ | - |
| `content` | `string` | ✓ | - |
| `lang` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ConnectAiMenu_1e6ecca["ConnectAiMenu"]
    class component_ConnectAiMenu_1e6ecca rootComponent
```

## Relationships

- RENDERS → `McpInstallBlock`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-igeneratorservice.md -->

# IGeneratorService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/generator.service.ts` (line 37)

<!-- source: api-endpoint-importintercom.md -->

# importIntercom

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 229)

## Endpoint

`POST /technical-docs/:projectId/sources/intercom`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: constant-supported-locales.md -->

# SUPPORTED_LOCALES

**Kind:** Constant

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/i18n.tsx` (line 46)

Supported locales — assembler populates this during generation.
Each generated site has its own set of locales.

## Definition

```ts
LocaleInfo[]
```

<!-- source: component-connectorspanel.md -->

# ConnectorsPanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/ConnectorsPanel.tsx` (line 30)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ConnectorsPanel_755ea9db["ConnectorsPanel"]
    class component_ConnectorsPanel_755ea9db rootComponent
```

## Relationships

- RENDERS → `BoltIcon`
- RENDERS → `PlusIcon`
- RENDERS → `ArrowPathIcon`
- RENDERS → `TrashIcon`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-imageeditorprops.md -->

# ImageEditorProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/ImageEditor.tsx` (line 46)

## Properties

| Property | Type |
|---|---|
| `nodeKey` | `string` |
| `src` | `string` |
| `alt` | `string` |
| `title` | `string` |
| `width` | `number | 'inherit'` |
| `height` | `number | 'inherit'` |
| `rest` | `(MdxJsxAttribute | MdxJsxExpressionAttribute)[]` |

<!-- source: api-endpoint-importpdfsource.md -->

# importPdfSource

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 205)

## Endpoint

`POST /technical-docs/:projectId/sources/pdf`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: constant-svelte-component-patterns.md -->

# SVELTE_COMPONENT_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/svelte.patterns.ts` (line 11)

Svelte Pattern Detection

Patterns for detecting Svelte components, stores, and reactivity.

<!-- source: component-crdiffview.md -->

# CrDiffView

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/CrDiffView.tsx` (line 112)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `diff` | `CrDiff` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CrDiffView_65218f7e["CrDiffView"]
    class component_CrDiffView_65218f7e rootComponent
```

## Relationships

- RENDERS → `FileDiff`

<!-- source: interface-importpoint.md -->

# ImportPoint

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/importMarkdownToLexical.ts` (line 124)

<!-- source: api-endpoint-importurlsource.md -->

# importUrlSource

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 193)

## Endpoint

`POST /technical-docs/:projectId/sources/url`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: constant-svelte-detection-config.md -->

# SVELTE_DETECTION_CONFIG

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/svelte.patterns.ts` (line 250)

## Definition

```ts
SvelteDetectionConfig
```

<!-- source: component-createboarddialog.md -->

# CreateBoardDialog

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/CreateBoardDialog.tsx` (line 44)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `open` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `onCreated` | `Function` | - | - |
| `duplicateFrom` | `unknown | null` | - | - |

## Diagram

```mermaid
graph TD
    component_CreateBoardDialog_786a7a20["CreateBoardDialog"]
    class component_CreateBoardDialog_786a7a20 rootComponent
```

## Relationships

- RENDERS → `Modal`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useRouter`
- USES_HOOK → `useBoardsToast`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-importstatement.md -->

# ImportStatement

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/importMarkdownToLexical.ts` (line 13)

## Properties

| Property | Type |
|---|---|
| `source` | `string` |
| `defaultExport` | `boolean` |

<!-- source: api-endpoint-importzendesk.md -->

# importZendesk

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 218)

## Endpoint

`POST /technical-docs/:projectId/sources/zendesk`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: constant-svelte-store-patterns.md -->

# SVELTE_STORE_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/svelte.patterns.ts` (line 148)

<!-- source: component-customaccordion.md -->

# CustomAccordion

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 738)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |
| `...props` | `object` | - | - |

## Diagram

```mermaid
graph TD
    component_CustomAccordion_15ea9134["CustomAccordion"]
    class component_CustomAccordion_15ea9134 rootComponent
```

<!-- source: api-endpoint-improve.md -->

# improve

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/ai/ai.controller.ts` (line 125)

## Endpoint

`POST /ai/improve`

## Referenced By

- `AIController` (MODULE_DECLARES)

<!-- source: interface-inactiveimagedialogstate.md -->

# InactiveImageDialogState

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 90)

The state of the image dialog when it is inactive.

## Properties

| Property | Type |
|---|---|
| `type` | `'inactive'` |

<!-- source: constant-svelte-template-patterns.md -->

# SVELTE_TEMPLATE_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/svelte.patterns.ts` (line 63)

<!-- source: component-customaccordionitem.md -->

# CustomAccordionItem

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 746)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |
| `title` | `any` | ✓ | - |
| `...props` | `object` | - | - |

## Diagram

```mermaid
graph TD
    component_CustomAccordionItem_f39c667["CustomAccordionItem"]
    class component_CustomAccordionItem_f39c667 rootComponent
```

<!-- source: interface-inactivelinkdialog.md -->

# InactiveLinkDialog

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 32)

The state of the link dialog when it is inactive.

## Properties

| Property | Type |
|---|---|
| `type` | `'inactive'` |
| `rectangle` | `undefined` |
| `linkNodeKey` | `undefined` |

<!-- source: api-endpoint-insights.md -->

# insights

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/manuals-insights/manuals-insights.controller.ts` (line 17)

## Endpoint

`GET /manuals-insights/:projectId/insights`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `ManualsInsightsController` (MODULE_DECLARES)

<!-- source: constant-sveltekit-patterns.md -->

# SVELTEKIT_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/svelte.patterns.ts` (line 185)

<!-- source: component-customalert.md -->

# CustomAlert

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 729)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |
| `type` | `any` | ✓ | - |
| `...props` | `object` | - | - |

## Diagram

```mermaid
graph TD
    component_CustomAlert_4bc42b48["CustomAlert"]
    class component_CustomAlert_4bc42b48 rootComponent
```

<!-- source: interface-includenode.md -->

# IncludeNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 72)

Include reference node
Represents a reference to a reusable block

## Properties

| Property | Type |
|---|---|
| `type` | `'include_reference'` |
| `blockId` | `string` |
| `resolved` | `boolean` |
| `resolvedContent` | `ASTNode[]` |

<!-- source: api-endpoint-invitemember.md -->

# inviteMember

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/organization/organization.controller.ts` (line 114)

## Endpoint

`POST /organizations/:id/invite`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `OrganizationController` (MODULE_DECLARES)

<!-- source: constant-switchfrompreviewtolinkedit.md -->

# switchFromPreviewToLinkEdit$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 284)

An action that switches the link dialog from preview mode to edit mode.

<!-- source: component-custombreadcrumb.md -->

# CustomBreadcrumb

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 721)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |
| `...props` | `object` | - | - |

## Diagram

```mermaid
graph TD
    component_CustomBreadcrumb_1ef0e197["CustomBreadcrumb"]
    class component_CustomBreadcrumb_1ef0e197 rootComponent
```

<!-- source: interface-inputprofile.md -->

# InputProfile

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/site-map.types.ts` (line 34)

## Properties

| Property | Type |
|---|---|
| `type` | `string` |
| `placeholder` | `string` |
| `selector` | `string` |
| `label` | `string` |

<!-- source: api-endpoint-list-3.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/activity/activity.controller.ts` (line 18)

## Endpoint

`GET /activities`

| Parameter | In | Type | Required |
|---|---|---|---|
| `filters` | query | `ActivityFiltersDto` | ✓ |

## Referenced By

- `ActivityController` (MODULE_DECLARES)

<!-- source: constant-syntaxextensions.md -->

# syntaxExtensions$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 280)

<!-- source: component-customcodeblock.md -->

# CustomCodeBlock

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MDXRenderer.tsx` (line 203)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `className` | `any` | ✓ | - |
| `children` | `any` | ✓ | - |
| `...props` | `object` | - | - |

## Diagram

```mermaid
graph TD
    component_CustomCodeBlock_de2077a["CustomCodeBlock"]
    class component_CustomCodeBlock_de2077a rootComponent
```

<!-- source: interface-interactionmap.md -->

# InteractionMap

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 243)

Complete interaction map for an entire application.
Generated by source code analysis in Phase 1.

## Properties

| Property | Type |
|---|---|
| `framework` | `'angular' | 'react' | 'vue' | 'nextjs' | 'jquery' | 'unknown'` |
| `routes` | `RouteInteractionMap[]` |
| `globalPermissions` | `PermissionCheck[]` |
| `authConfig` | `AuthConfigDiscovery` |
| `stats` | `InteractionMapStats` |
| `generatedAt` | `Date` |

<!-- source: api-endpoint-list-4.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/audience/audience.controller.ts` (line 29)

## Endpoint

`GET /audiences`

## Referenced By

- `AudienceController` (MODULE_DECLARES)

<!-- source: constant-tableplugin.md -->

# tablePlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/table/index.ts` (line 82)

A plugin that adds support for tables to the editor.

<!-- source: component-customcodeblock-2.md -->

# CustomCodeBlock

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 561)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `node` | `any` | ✓ | - |
| `inline` | `any` | ✓ | - |
| `className` | `any` | ✓ | - |
| `children` | `any` | ✓ | - |
| `...props` | `object` | - | - |

## Diagram

```mermaid
graph TD
    component_CustomCodeBlock_3e369e8c["CustomCodeBlock"]
    class component_CustomCodeBlock_3e369e8c rootComponent
```

<!-- source: interface-interactionmapstats.md -->

# InteractionMapStats

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 261)

Statistics about the interaction map

## Properties

| Property | Type |
|---|---|
| `totalRoutes` | `number` |
| `routesWithModals` | `number` |
| `routesWithTabs` | `number` |
| `routesWithForms` | `number` |
| `routesWithWorkflowStates` | `number` |
| `totalModals` | `number` |
| `totalTabs` | `number` |
| `totalFormFields` | `number` |
| `totalPermissions` | `number` |
| `totalWorkflowStates` | `number` |

<!-- source: api-endpoint-list-5.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 32)

## Endpoint

`GET /projects/:projectId/boards`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: constant-thematicbreakplugin.md -->

# thematicBreakPlugin

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/thematic-break/index.ts` (line 23)

A plugin that adds support for thematic breaks.

<!-- source: component-customdiv.md -->

# CustomDiv

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 513)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |
| `className` | `any` | ✓ | - |
| `...props` | `object` | - | - |

## Diagram

```mermaid
graph TD
    component_CustomDiv_7dec4e83["CustomDiv"]
    class component_CustomDiv_7dec4e83 rootComponent
```

## Relationships

- RENDERS → `VideoEmbed`
- RENDERS → `Screenshot`

<!-- source: interface-iparserservice.md -->

# IParserService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/parser.service.ts` (line 40)

Parser service interface for dependency injection

<!-- source: api-endpoint-list-6.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/capture/capture.controller.ts` (line 46)

## Endpoint

`GET /capture/:projectId/flows`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `CaptureController` (MODULE_DECLARES)

<!-- source: constant-theme-presets-4.md -->

# THEME_PRESETS

**Kind:** Constant

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/theme.ts` (line 78)

## Definition

```ts
Record<ThemeMode, ThemeVars>
```

<!-- source: component-customem.md -->

# CustomEm

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 681)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomEm_35be923c["CustomEm"]
    class component_CustomEm_35be923c rootComponent
```

<!-- source: interface-iphaseservice.md -->

# IPhaseService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-07-phases/divider.service.ts` (line 24)

<!-- source: api-endpoint-list-7.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.controller.ts` (line 47)

## Endpoint

`GET /projects/:projectId/change-requests`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `query` | query | `ListChangeRequestsDto` | ✓ |

## Referenced By

- `ChangeRequestController` (MODULE_DECLARES)

<!-- source: constant-themeengine.md -->

# themeEngine

**Kind:** Constant

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/theme-engine.ts` (line 389)

<!-- source: component-customerspage.md -->

# CustomersPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/customers/page.tsx` (line 98)

## Diagram

```mermaid
graph TD
    component_CustomersPage_675ed49c["CustomersPage"]
    class component_CustomersPage_675ed49c rootComponent
```

## Relationships

- RENDERS → `Link`

<!-- source: interface-isessionservice.md -->

# ISessionService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-08-sessions/planner.service.ts` (line 24)

<!-- source: api-endpoint-list-8.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/comment/comment.controller.ts` (line 80)

List all comments for a document with optional filters

## Endpoint

`GET /documents/:documentId/comments`

| Parameter | In | Type | Required |
|---|---|---|---|
| `documentId` | query | `string` | ✓ |
| `filters` | query | `CommentFiltersDto` | ✓ |

## Referenced By

- `CommentController` (MODULE_DECLARES)

<!-- source: constant-tier-classification-rules.md -->

# TIER_CLASSIFICATION_RULES

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 402)

<!-- source: component-customheading1.md -->

# CustomHeading1

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MDXRenderer.tsx` (line 232)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomHeading1_302e3837["CustomHeading1"]
    class component_CustomHeading1_302e3837 rootComponent
```

<!-- source: interface-istructureservice.md -->

# IStructureService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-06-structure/structure.service.ts` (line 37)

<!-- source: api-endpoint-list-9.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 48)

## Endpoint

`GET /doc-versions/:projectId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `query` | query | `ListDocVersionsDto` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: constant-togglesinglegroupwithitem.md -->

# ToggleSingleGroupWithItem

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/toolbar.tsx` (line 85)

<!-- source: component-customheading1-2.md -->

# CustomHeading1

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 589)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomHeading1_5ea94903["CustomHeading1"]
    class component_CustomHeading1_5ea94903 rootComponent
```

<!-- source: interface-isynthesizerservice.md -->

# ISynthesizerService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-05-synthesis/synthesizer.service.ts` (line 39)

<!-- source: api-endpoint-list-10.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/category.controller.ts` (line 45)

List categories with filters

## Endpoint

`GET /categories`

| Parameter | In | Type | Required |
|---|---|---|---|
| `filters` | query | `CategoryFiltersDto` | ✓ |

## Referenced By

- `CategoryController` (MODULE_DECLARES)

<!-- source: constant-tomarkdownextensions.md -->

# toMarkdownExtensions$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 291)

<!-- source: component-customheading2.md -->

# CustomHeading2

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MDXRenderer.tsx` (line 241)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomHeading2_302e3836["CustomHeading2"]
    class component_CustomHeading2_302e3836 rootComponent
```

<!-- source: interface-iverifierservice.md -->

# IVerifierService

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/verifier.service.ts` (line 30)

<!-- source: api-endpoint-list-11.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 84)

## Endpoint

`GET /documents`

| Parameter | In | Type | Required |
|---|---|---|---|
| `filters` | query | `DocumentFiltersDto` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: constant-tomarkdownoptions.md -->

# toMarkdownOptions$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 295)

<!-- source: component-customheading2-2.md -->

# CustomHeading2

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 594)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomHeading2_5ea94904["CustomHeading2"]
    class component_CustomHeading2_5ea94904 rootComponent
```

<!-- source: interface-jobconfig.md -->

# JobConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 124)

## Properties

| Property | Type |
|---|---|
| `repositoryUrl` | `string` |
| `branch` | `string` |
| `includePaths` | `string[]` |
| `excludePaths` | `string[]` |
| `targetAudience` | `'beginner' | 'intermediate' | 'advanced'` |
| `tone` | `'formal' | 'friendly' | 'technical'` |
| `language` | `string` |
| `maxDocuments` | `number` |
| `maxTokenBudget` | `number` |
| `enableScreenshots` | `boolean` |
| `screenshotBaseUrl` | `string` |

<!-- source: api-endpoint-list-12.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/issues.controller.ts` (line 26)

## Endpoint

`GET /projects/:projectId/issues`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `status` | query | `string` | - |
| `category` | query | `string` | - |
| `ticketType` | query | `string` | - |
| `priority` | query | `string` | - |
| `assigneeId` | query | `string` | - |
| `search` | query | `string` | - |
| `sortBy` | query | `string` | - |
| `sortOrder` | query | `string` | - |
| `page` | query | `string` | - |
| `limit` | query | `string` | - |

## Referenced By

- `IssuesController` (MODULE_DECLARES)

<!-- source: constant-toolbartoggleitem.md -->

# ToolbarToggleItem

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/primitives/toolbar.tsx` (line 69)

<!-- source: component-customheading3.md -->

# CustomHeading3

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MDXRenderer.tsx` (line 250)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomHeading3_302e3835["CustomHeading3"]
    class component_CustomHeading3_302e3835 rootComponent
```

<!-- source: interface-jobstate.md -->

# JobState

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 36)

## Properties

| Property | Type |
|---|---|
| `id` | `JobId` |
| `projectId` | `string` |
| `repositoryUrl` | `string` |
| `branch` | `string` |
| `status` | `JobStatus` |
| `currentStage` | `JobStage` |
| `progress` | `number` |
| `startedAt` | `Date` |
| `updatedAt` | `Date` |
| `completedAt` | `Date` |
| `error` | `string` |
| `config` | `JobConfig` |
| `approvalCheckpoint` | `ApprovalCheckpoint` |

<!-- source: api-endpoint-list-13.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/notification/notification.controller.ts` (line 20)

## Endpoint

`GET /notifications`

| Parameter | In | Type | Required |
|---|---|---|---|
| `unreadOnly` | query | `string` | - |
| `limit` | query | `string` | - |
| `offset` | query | `string` | - |

## Referenced By

- `NotificationController` (MODULE_DECLARES)

<!-- source: constant-topareachildren.md -->

# topAreaChildren$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 740)

<!-- source: component-customheading3-2.md -->

# CustomHeading3

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 599)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomHeading3_5ea94905["CustomHeading3"]
    class component_CustomHeading3_5ea94905 rootComponent
```

<!-- source: interface-jpafield.md -->

# JPAField

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/spring-detector.ts` (line 109)

JPA field

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `column` | `string` |
| `nullable` | `boolean` |
| `unique` | `boolean` |

<!-- source: api-endpoint-list-14.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/organization/organization.controller.ts` (line 41)

## Endpoint

`GET /organizations`

## Referenced By

- `OrganizationController` (MODULE_DECLARES)

<!-- source: constant-transition.md -->

# transition

**Kind:** Constant

**Source:** `atloria-monorepo/packages/ui-core/src/utils/styles.ts` (line 37)

<!-- source: component-customheading4.md -->

# CustomHeading4

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MDXRenderer.tsx` (line 259)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomHeading4_302e3834["CustomHeading4"]
    class component_CustomHeading4_302e3834 rootComponent
```

<!-- source: interface-jparelationship.md -->

# JPARelationship

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/spring-detector.ts` (line 120)

JPA relationship

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `'OneToOne' | 'OneToMany' | 'ManyToOne' | 'ManyToMany'` |
| `targetEntity` | `string` |
| `mappedBy` | `string` |

<!-- source: api-endpoint-list-15.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 66)

## Endpoint

`GET /projects`

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: constant-translation.md -->

# translation$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 925)

<!-- source: component-customheading4-2.md -->

# CustomHeading4

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 604)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomHeading4_5ea94906["CustomHeading4"]
    class component_CustomHeading4_5ea94906 rootComponent
```

<!-- source: interface-jsxcomponentdescriptor.md -->

# JsxComponentDescriptor

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/index.ts` (line 57)

Defines the structure of a JSX component that can be used within the markdown document.

## Properties

| Property | Type |
|---|---|
| `name` | `string | null` |
| `kind` | `'flow' | 'text'` |
| `source` | `string` |
| `defaultExport` | `boolean` |
| `props` | `JsxPropertyDescriptor[]` |
| `hasChildren` | `boolean` |
| `Editor` | `React.ComponentType<JsxEditorProps>` |

<!-- source: api-endpoint-list-16.md -->

# list

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/template/template.controller.ts` (line 43)

List all available templates.
Returns public templates and organization-specific templates.

## Endpoint

`GET /templates`

| Parameter | In | Type | Required |
|---|---|---|---|
| `filters` | query | `TemplateFiltersDto` | ✓ |

## Referenced By

- `TemplateController` (MODULE_DECLARES)

<!-- source: constant-ui-library-detection-configs.md -->

# UI_LIBRARY_DETECTION_CONFIGS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/framework.types.ts` (line 352)

UI Library detection configurations

<!-- source: component-customheading5.md -->

# CustomHeading5

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MDXRenderer.tsx` (line 268)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomHeading5_302e3833["CustomHeading5"]
    class component_CustomHeading5_302e3833 rootComponent
```

<!-- source: interface-jsxeditorprops.md -->

# JsxEditorProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/index.ts` (line 96)

The properties passed to a custom JSX Editor component.

## Properties

| Property | Type |
|---|---|
| `mdastNode` | `MdastJsx` |
| `descriptor` | `JsxComponentDescriptor` |

<!-- source: api-endpoint-listagents.md -->

# listAgents

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.controller.ts` (line 108)

## Endpoint

`GET /support-agent/:projectId/agents`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `SupportAgentController` (MODULE_DECLARES)

<!-- source: constant-universal-api-call-patterns.md -->

# UNIVERSAL_API_CALL_PATTERNS

**Kind:** Constant

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/cross-language.types.ts` (line 212)

## Definition

```ts
ApiCallPattern[]
```

<!-- source: component-customheading5-2.md -->

# CustomHeading5

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 609)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomHeading5_5ea94907["CustomHeading5"]
    class component_CustomHeading5_5ea94907 rootComponent
```

<!-- source: interface-jsxpluginparams.md -->

# JsxPluginParams

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/index.ts` (line 189)

## Properties

| Property | Type |
|---|---|
| `jsxComponentDescriptors` | `JsxComponentDescriptor[]` |
| `allowFragment` | `boolean` |

<!-- source: api-endpoint-listassets.md -->

# listAssets

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/assets/assets.controller.ts` (line 43)

## Endpoint

`GET /assets`

| Parameter | In | Type | Required |
|---|---|---|---|
| `audiences` | query | `string` | - |

## Referenced By

- `AssetsController` (MODULE_DECLARES)

<!-- source: constant-updatelink.md -->

# updateLink$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 268)

A signal that updates the current link with the published payload.

<!-- source: component-customheading6.md -->

# CustomHeading6

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MDXRenderer.tsx` (line 277)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomHeading6_302e3832["CustomHeading6"]
    class component_CustomHeading6_302e3832 rootComponent
```

<!-- source: interface-jsxpropertydescriptor.md -->

# JsxPropertyDescriptor

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/jsx/index.ts` (line 38)

Defines the structure of a JSX component property.

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `'string' | 'number' | 'expression'` |
| `required` | `boolean` |

<!-- source: api-endpoint-listbranches.md -->

# listBranches

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/bitbucket/bitbucket.controller.ts` (line 80)

## Endpoint

`GET /bitbucket/repos/:owner/:repo/branches`

| Parameter | In | Type | Required |
|---|---|---|---|
| `owner` | query | `string` | ✓ |
| `repo` | query | `string` | ✓ |

## Referenced By

- `BitbucketController` (MODULE_DECLARES)

<!-- source: constant-usedlexicalnodes.md -->

# usedLexicalNodes$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 279)

Contains the currently registered lexical nodes.

<!-- source: component-customheading6-2.md -->

# CustomHeading6

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 614)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomHeading6_5ea94908["CustomHeading6"]
    class component_CustomHeading6_5ea94908 rootComponent
```

<!-- source: interface-knowledgecollectorconfig.md -->

# KnowledgeCollectorConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/knowledge-reference.types.ts` (line 79)

## Properties

| Property | Type |
|---|---|
| `maxSnippetsPerEntry` | `number` |
| `maxSnippetChars` | `number` |
| `minConfidence` | `number` |
| `maxEntriesPerCategory` | `number` |
| `enableAdminClassification` | `boolean` |

<!-- source: api-endpoint-listbranches-2.md -->

# listBranches

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/github/github.controller.ts` (line 97)

List branches for a specific repository

## Endpoint

`GET /github/repos/:owner/:repo/branches`

| Parameter | In | Type | Required |
|---|---|---|---|
| `owner` | query | `string` | ✓ |
| `repo` | query | `string` | ✓ |

## Referenced By

- `GitHubController` (MODULE_DECLARES)

<!-- source: constant-viewmode.md -->

# viewMode$

**Kind:** Constant

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/index.ts` (line 860)

<!-- source: component-customlink.md -->

# CustomLink

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MDXRenderer.tsx` (line 294)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `href` | `any` | ✓ | - |
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomLink_1870dac["CustomLink"]
    class component_CustomLink_1870dac rootComponent
```

<!-- source: interface-knowledgeentry.md -->

# KnowledgeEntry

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/knowledge-reference.types.ts` (line 42)

## Properties

| Property | Type |
|---|---|
| `sourceDocId` | `string` |
| `sourceTitle` | `string` |
| `sourceSlug` | `string` |
| `sourceCategory` | `string` |
| `targetCategory` | `MetaKnowledgeCategory` |
| `confidence` | `number` |
| `relevanceReason` | `string` |
| `snippets` | `KnowledgeSnippet[]` |

<!-- source: api-endpoint-listbranches-3.md -->

# listBranches

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/gitlab/gitlab.controller.ts` (line 97)

List branches for a specific repository

## Endpoint

`GET /gitlab/repos/:owner/:repo/branches`

| Parameter | In | Type | Required |
|---|---|---|---|
| `owner` | query | `string` | ✓ |
| `repo` | query | `string` | ✓ |

## Referenced By

- `GitLabController` (MODULE_DECLARES)

<!-- source: component-customlink-2.md -->

# CustomLink

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 648)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `href` | `any` | ✓ | - |
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomLink_3f99df72["CustomLink"]
    class component_CustomLink_3f99df72 rootComponent
```

## Relationships

- RENDERS → `VideoEmbed`

<!-- source: interface-knowledgereferencestore.md -->

# KnowledgeReferenceStore

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/knowledge-reference.types.ts` (line 64)

## Properties

| Property | Type |
|---|---|
| `references` | `Record<MetaKnowledgeCategory, MetaCategoryReference>` |
| `metadata` | `{
    buildStartedAt: Date;
    buildCompletedAt?: Date;
    totalDocsProcessed: number;
    totalDocsClassified: number;
    classificationFailures: number;
  }` |

<!-- source: api-endpoint-listbranches-4.md -->

# listBranches

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/parsing/test-connection.controller.ts` (line 53)

## Endpoint

`POST /git/branches`

## Referenced By

- `TestConnectionController` (MODULE_DECLARES)

<!-- source: component-customparagraph.md -->

# CustomParagraph

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 548)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |
| `node` | `any` | ✓ | - |
| `...props` | `object` | - | - |

## Diagram

```mermaid
graph TD
    component_CustomParagraph_8d06aa6["CustomParagraph"]
    class component_CustomParagraph_8d06aa6 rootComponent
```

<!-- source: interface-knowledgesnippet.md -->

# KnowledgeSnippet

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/knowledge-reference.types.ts` (line 36)

## Properties

| Property | Type |
|---|---|
| `type` | `SnippetType` |
| `sectionTitle` | `string` |
| `content` | `string` |

<!-- source: api-endpoint-listcards.md -->

# listCards

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 141)

## Endpoint

`GET /projects/:projectId/boards/:boardId/cards`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `boardId` | query | `string` | ✓ |
| `since` | query | `string` | - |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: component-customscreenshot.md -->

# CustomScreenshot

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 795)

## Diagram

```mermaid
graph TD
    component_CustomScreenshot_3bd8c906["CustomScreenshot"]
    class component_CustomScreenshot_3bd8c906 rootComponent
```

## Relationships

- RENDERS → `Screenshot`

<!-- source: interface-largefileindex.md -->

# LargeFileIndex

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-02.types.ts` (line 63)

LargeFileIndex - Detailed index for lazy loading from large files (>500KB)

Instead of loading full content of large files (which would overflow context),
we create an index that enables on-demand loading of specific sections.
This supports the iterative deep loading mechanism.

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `fileSize` | `number` |
| `lineCount` | `number` |
| `tokenEstimate` | `number` |
| `overview` | `{
    purpose: string; // What this file is for
    primaryExports: string[]; // Main exports
    imports: string[]; // Key imports
    isAutoGenerated: boolean; // Detected auto-generated file
  }` |
| `entities` | `Array<{
    name: string;
    type: string; // FUNCTION, CLASS, etc.
    startLine: number;
    endLine: number;
    signature: string; // Quick reference
    summary: string; // Brief description
    hasNeverTruncatePatterns: boolean; // Contains critical patterns
  }>` |
| `sections` | `Array<{
    startLine: number;
    endLine: number;
    summary: string; // What this section does
    entities: string[]; // Entity names in this section
  }>` |
| `criticalExtracts` | `Array<{
    entityName: string;
    reason: 'validation' | 'error_messages' | 'permissions' | 'state_machine';
    content: string; // Full source code
  }>` |

<!-- source: api-endpoint-listconnectors.md -->

# listConnectors

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 261)

## Endpoint

`GET /technical-docs/:projectId/connectors`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: component-customstrong.md -->

# CustomStrong

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 673)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomStrong_4bef122b["CustomStrong"]
    class component_CustomStrong_4bef122b rootComponent
```

<!-- source: interface-largefileindexerconfig.md -->

# LargeFileIndexerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/large-file-indexer.ts` (line 23)

Configuration for large file indexing

## Properties

| Property | Type |
|---|---|
| `sizeThreshold` | `number` |
| `maxOverviewLines` | `number` |
| `maxCriticalExtracts` | `number` |

<!-- source: api-endpoint-listexporthistory.md -->

# listExportHistory

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/export/analytics-export.controller.ts` (line 151)

## Endpoint

`GET /analytics/:projectId/export-history`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `AnalyticsExportController` (MODULE_DECLARES)

<!-- source: component-customtable.md -->

# CustomTable

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MDXRenderer.tsx` (line 307)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomTable_2eedbb4c["CustomTable"]
    class component_CustomTable_2eedbb4c rootComponent
```

<!-- source: interface-largefilesummary.md -->

# LargeFileSummary

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-02.types.ts` (line 44)

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `fileSize` | `number` |
| `summary` | `string` |
| `exports` | `Array<{
    name: string;
    type: string;
    signature: string;
  }>` |
| `purpose` | `string` |

<!-- source: api-endpoint-listjobs.md -->

# listJobs

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 140)

## Endpoint

`GET /doc-automation/jobs`

| Parameter | In | Type | Required |
|---|---|---|---|
| `filters` | query | `JobFiltersDto` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: component-customtable-2.md -->

# CustomTable

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 689)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomTable_4ccaddba["CustomTable"]
    class component_CustomTable_4ccaddba rootComponent
```

<!-- source: interface-learningpathdocinput.md -->

# LearningPathDocInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 99)

## Properties

| Property | Type |
|---|---|
| `appName` | `string` |
| `persona` | `{
    name: string;
    description: string;
    goals?: string[];
    relevantFeatures?: string[];
  }` |
| `matchedDocs` | `MatchedDocForPath[]` |

<!-- source: api-endpoint-listjobs-2.md -->

# listJobs

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/screenshot/screenshot.controller.ts` (line 60)

## Endpoint

`GET /screenshots/jobs`

| Parameter | In | Type | Required |
|---|---|---|---|
| `filters` | query | `ScreenshotJobFiltersDto` | ✓ |

## Referenced By

- `ScreenshotController` (MODULE_DECLARES)

<!-- source: component-customtbody.md -->

# CustomTbody

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 704)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomTbody_4ccb8202["CustomTbody"]
    class component_CustomTbody_4ccb8202 rootComponent
```

<!-- source: interface-lexicalconvertoptions.md -->

# LexicalConvertOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/exportMarkdownFromLexical.ts` (line 409)

Configures how the lexical tree is converted to a mdast tree and then to markdown.

## Properties

| Property | Type |
|---|---|
| `visitors` | `LexicalVisitor[]` |
| `toMarkdownExtensions` | `ToMarkdownExtension[]` |
| `toMarkdownOptions` | `ToMarkdownOptions` |

<!-- source: api-endpoint-listpendingapprovals.md -->

# listPendingApprovals

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 123)

## Endpoint

`GET /doc-versions/:projectId/approvals/pending`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-customtd.md -->

# CustomTd

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 716)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomTd_35be9404["CustomTd"]
    class component_CustomTd_35be9404 rootComponent
```

<!-- source: interface-lexicalexportvisitor.md -->

# LexicalExportVisitor

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/exportMarkdownFromLexical.ts` (line 17)

Implement this interface in order to process mdast node(s) into a lexical tree.
This is part of the process that converts the editor contents to markdown.

## Properties

| Property | Type |
|---|---|
| `priority` | `number` |

<!-- source: api-endpoint-listproviders.md -->

# listProviders

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/ai/ai.controller.ts` (line 211)

## Endpoint

`GET /ai/providers`

## Referenced By

- `AIController` (MODULE_DECLARES)

<!-- source: component-customth.md -->

# CustomTh

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 712)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomTh_35be9408["CustomTh"]
    class component_CustomTh_35be9408 rootComponent
```

<!-- source: interface-lineheight.md -->

# LineHeight

**Kind:** Interface

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 60)

## Properties

| Property | Type |
|---|---|
| `tight` | `number` |
| `normal` | `number` |
| `relaxed` | `number` |

<!-- source: api-endpoint-listprs.md -->

# listPrs

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr.controller.ts` (line 68)

## Endpoint

`GET /docs-pr/:projectId/prs`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocsPrController` (MODULE_DECLARES)

<!-- source: component-customthead.md -->

# CustomThead

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 700)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomThead_4cce1640["CustomThead"]
    class component_CustomThead_4cce1640 rootComponent
```

<!-- source: api-endpoint-listreports.md -->

# listReports

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/export/analytics-export.controller.ts` (line 88)

## Endpoint

`GET /analytics/:projectId/reports`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `AnalyticsExportController` (MODULE_DECLARES)

<!-- source: interface-localeinfo.md -->

# LocaleInfo

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/i18n.tsx` (line 21)

## Properties

| Property | Type |
|---|---|
| `code` | `string` |
| `name` | `string` |
| `nativeName` | `string` |
| `dir` | `'ltr' | 'rtl'` |

<!-- source: component-customtr.md -->

# CustomTr

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 708)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `any` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_CustomTr_35be9412["CustomTr"]
    class component_CustomTr_35be9412 rootComponent
```

<!-- source: api-endpoint-listrepos.md -->

# listRepos

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/bitbucket/bitbucket.controller.ts` (line 75)

## Endpoint

`GET /bitbucket/repos`

## Referenced By

- `BitbucketController` (MODULE_DECLARES)

<!-- source: interface-logentry.md -->

# LogEntry

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/logger.ts` (line 10)

## Properties

| Property | Type |
|---|---|
| `timestamp` | `Date` |
| `level` | `LogLevel` |
| `stage` | `string` |
| `message` | `string` |
| `data` | `Record<string, unknown>` |
| `error` | `Error` |

<!-- source: component-dashboardlayout.md -->

# DashboardLayout

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Layout/DashboardLayout.tsx` (line 24)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DashboardLayout_47a9a6a3["DashboardLayout"]
    class component_DashboardLayout_47a9a6a3 rootComponent
```

## Relationships

- RENDERS → `Navbar`
- RENDERS → `Sidebar`
- RENDERS → `AnimatePresence`
- RENDERS → `motion-div`
- RENDERS → `XMarkIcon`
- RENDERS → `Bars3Icon`
- USES_HOOK → `useState`

<!-- source: api-endpoint-listrepos-2.md -->

# listRepos

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/github/github.controller.ts` (line 89)

List repositories from the connected GitHub account

## Endpoint

`GET /github/repos`

## Referenced By

- `GitHubController` (MODULE_DECLARES)

<!-- source: interface-loggerconfig.md -->

# LoggerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/logger.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `level` | `LogLevel` |
| `prefix` | `string` |
| `includeTimestamp` | `boolean` |
| `includeStage` | `boolean` |
| `silent` | `boolean` |

<!-- source: component-dashboardpage.md -->

# DashboardPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/page.tsx` (line 17)

## Diagram

```mermaid
graph TD
    component_DashboardPage_736be54b["DashboardPage"]
    class component_DashboardPage_736be54b rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `NewProjectWizard`
- RENDERS → `Link`
- RENDERS → `FolderIcon`
- USES_HOOK → `useSession`
- USES_HOOK → `useProjects`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: api-endpoint-listrepos-3.md -->

# listRepos

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/gitlab/gitlab.controller.ts` (line 89)

List repositories from the connected GitLab account

## Endpoint

`GET /gitlab/repos`

## Referenced By

- `GitLabController` (MODULE_DECLARES)

<!-- source: interface-logindto.md -->

# LoginDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/auth.ts` (line 6)

Auth DTOs

## Properties

| Property | Type |
|---|---|
| `email` | `string` |
| `password` | `string` |

<!-- source: component-dashboardtabbar.md -->

# DashboardTabBar

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/dashboard/DashboardTabBar.tsx` (line 13)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `activeTab` | `string` | ✓ | - |
| `onTabChange` | `Function` | ✓ | - |
| `projectId` | `string` | - | - |
| `changesCount` | `number` | - | - |

## Diagram

```mermaid
graph TD
    component_DashboardTabBar_3fa6f1d8["DashboardTabBar"]
    class component_DashboardTabBar_3fa6f1d8 rootComponent
```

<!-- source: api-endpoint-listscreenshots.md -->

# listScreenshots

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/screenshot/screenshot.controller.ts` (line 51)

## Endpoint

`GET /screenshots`

| Parameter | In | Type | Required |
|---|---|---|---|
| `filters` | query | `ScreenshotFiltersDto` | ✓ |

## Referenced By

- `ScreenshotController` (MODULE_DECLARES)

<!-- source: interface-mappingoptions.md -->

# MappingOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-mapper.service.ts` (line 45)

Options for mapping placeholders

## Properties

| Property | Type |
|---|---|
| `siteUrl` | `string` |
| `appName` | `string` |
| `knownRoutes` | `string[]` |
| `batchSize` | `number` |
| `confidenceThreshold` | `number` |
| `routeMappings` | `RouteMappingResult` |
| `framework` | `string` |

<!-- source: component-deflectioncockpit.md -->

# DeflectionCockpit

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/DeflectionCockpit.tsx` (line 110)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DeflectionCockpit_48928715["DeflectionCockpit"]
    class component_DeflectionCockpit_48928715 rootComponent
```

## Relationships

- RENDERS → `KpiCard`
- RENDERS → `LineChart`
- USES_HOOK → `useSession`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: api-endpoint-listsources.md -->

# listSources

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 240)

## Endpoint

`GET /technical-docs/:projectId/sources`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: interface-mappingresult.md -->

# MappingResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 158)

Result of AI mapping stage

## Properties

| Property | Type |
|---|---|
| `mappings` | `ScreenshotMapping[]` |
| `unmapped` | `{ placeholderId: string; description: string; reason: string }[]` |
| `lowConfidence` | `ScreenshotMapping[]` |
| `tokenUsage` | `TokenUsage` |

<!-- source: component-deleteboarddialog.md -->

# DeleteBoardDialog

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/DeleteBoardDialog.tsx` (line 19)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `open` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `board` | `unknown | null` | ✓ | - |
| `onDeleted` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_DeleteBoardDialog_74c76980["DeleteBoardDialog"]
    class component_DeleteBoardDialog_74c76980 rootComponent
```

## Relationships

- RENDERS → `Modal`
- RENDERS → `TrashIcon`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useBoardsToast`
- USES_HOOK → `useState`

<!-- source: api-endpoint-listthreads.md -->

# listThreads

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/desk.controller.ts` (line 33)

## Endpoint

`GET /desk/:projectId/threads`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `bucket` | query | `string` | - |
| `limit` | query | `string` | - |

## Referenced By

- `DeskController` (MODULE_DECLARES)

<!-- source: interface-markdownparseoptions.md -->

# MarkdownParseOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/importMarkdownToLexical.ts` (line 140)

## Properties

| Property | Type |
|---|---|
| `markdown` | `string` |
| `syntaxExtensions` | `NonNullable<ParseOptions['extensions']>` |
| `mdastExtensions` | `MdastExtensions` |

<!-- source: component-deletecategorymodal.md -->

# DeleteCategoryModal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Categories/CategoryModal.tsx` (line 288)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `isOpen` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `onConfirm` | `Function` | ✓ | - |
| `category` | `Category | null` | ✓ | - |
| `loading` | `boolean` | - | - |

## Diagram

```mermaid
graph TD
    component_DeleteCategoryModal_7c6ea866["DeleteCategoryModal"]
    class component_DeleteCategoryModal_7c6ea866 rootComponent
```

<!-- source: api-endpoint-login-2.md -->

# login

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/auth.controller.ts` (line 48)

## Endpoint

`POST /auth/login`

## Referenced By

- `AuthController` (MODULE_DECLARES)

<!-- source: interface-matcheddocforpath.md -->

# MatchedDocForPath

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 110)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `difficulty` | `string` |
| `estimatedReadTime` | `number` |
| `prerequisites` | `string[]` |
| `featureIds` | `string[]` |
| `priority` | `number` |

<!-- source: component-deletedocumentmodal.md -->

# DeleteDocumentModal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Documents/DeleteDocumentModal.tsx` (line 14)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `isOpen` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `onConfirm` | `Function` | ✓ | - |
| `document` | `Document | null` | ✓ | - |
| `loading` | `boolean` | - | - |

## Diagram

```mermaid
graph TD
    component_DeleteDocumentModal_13b2853d["DeleteDocumentModal"]
    class component_DeleteDocumentModal_13b2853d rootComponent
```

## Relationships

- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `XMarkIcon`

<!-- source: api-endpoint-login-3.md -->

# login

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/saml/saml.controller.ts` (line 18)

Initiate SAML login
User is redirected to their IdP for authentication

## Endpoint

`GET /auth/saml/login/:orgSlug`

| Parameter | In | Type | Required |
|---|---|---|---|
| `orgSlug` | query | `string` | ✓ |

## Referenced By

- `SamlController` (MODULE_DECLARES)

<!-- source: interface-mdastblockhtmlnode.md -->

# MdastBlockHTMLNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/MdastHTMLNode.ts` (line 8)

A block-level HTML node.

## Properties

| Property | Type |
|---|---|
| `name` | `(typeof htmlTags)[number]` |

<!-- source: component-deleteprojectmodal.md -->

# DeleteProjectModal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/DeleteProjectModal.tsx` (line 14)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `project` | `Project | null` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `onConfirm` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DeleteProjectModal_4733800["DeleteProjectModal"]
    class component_DeleteProjectModal_4733800 rootComponent
```

## Relationships

- RENDERS → `AnimatePresence`
- RENDERS → `motion-div`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: api-endpoint-logout.md -->

# logout

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/auth.controller.ts` (line 127)

## Endpoint

`POST /auth/logout`

## Referenced By

- `AuthController` (MODULE_DECLARES)

<!-- source: interface-mdastimportvisitor.md -->

# MdastImportVisitor

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/importMarkdownToLexical.ts` (line 42)

Implement this interface to convert certain mdast nodes into lexical nodes.

## Properties

| Property | Type |
|---|---|
| `testNode` | `((mdastNode: Mdast.Nodes, descriptors: Descriptors) => boolean) | string` |
| `priority` | `number` |

<!-- source: component-dependencygraph.md -->

# DependencyGraph

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/DependencyGraph.tsx` (line 13)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `dependencies` | `Dependency[]` | ✓ | - |
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_DependencyGraph_552a8292["DependencyGraph"]
    class component_DependencyGraph_552a8292 rootComponent
```

## Relationships

- RENDERS → `ExternalIcon`
- RENDERS → `DependencyCard`
- RENDERS → `InternalIcon`

<!-- source: api-endpoint-markread.md -->

# markRead

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/notification/notification.controller.ts` (line 35)

## Endpoint

`PATCH /notifications/:id/read`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `NotificationController` (MODULE_DECLARES)

<!-- source: interface-mdastinlinehtmlnode.md -->

# MdastInlineHTMLNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/MdastHTMLNode.ts` (line 19)

An inline HTML node.

## Properties

| Property | Type |
|---|---|
| `name` | `(typeof htmlTags)[number]` |

<!-- source: component-deskcopilot.md -->

# DeskCopilot

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/DeskCopilot.tsx` (line 552)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `thread` | `DeskThreadDetail | null` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DeskCopilot_19c1892a["DeskCopilot"]
    class component_DeskCopilot_19c1892a rootComponent
```

## Relationships

- RENDERS → `ChatBubbleLeftEllipsisIcon`
- RENDERS → `CopilotTabBody`
- RENDERS → `CustomerTabBody`
- RENDERS → `ActivityTabBody`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: api-endpoint-mcpget.md -->

# mcpGet

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 356)

## Endpoint

`GET /public/p/:slugWithId/mcp`

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: interface-mdasttreeimportoptions.md -->

# MdastTreeImportOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/importMarkdownToLexical.ts` (line 133)

The options of the tree import utility. Not meant to be used directly.

## Properties

| Property | Type |
|---|---|
| `root` | `ImportPoint` |
| `visitors` | `MdastImportVisitor<Mdast.RootContent>[]` |
| `mdastRoot` | `Mdast.Root` |

<!-- source: component-deskpage.md -->

# DeskPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/page.tsx` (line 49)

## Diagram

```mermaid
graph TD
    component_DeskPage_6149f886["DeskPage"]
    class component_DeskPage_6149f886 rootComponent
```

## Relationships

- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `QueueRail`
- RENDERS → `ThreadList`
- RENDERS → `ThreadView`
- RENDERS → `DeskCopilot`
- RENDERS → `SnoozeMenu`
- RENDERS → `DuplicateDialog`
- RENDERS → `ShortcutOverlay`
- RENDERS → `DeskToast`
- USES_HOOK → `useSession`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useMemo`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: api-endpoint-mcpget-2.md -->

# mcpGet

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-mcp.controller.ts` (line 203)

## Endpoint

`GET /technical-docs/:projectId/mcp`

## Referenced By

- `TechnicalDocsMcpController` (MODULE_DECLARES)

<!-- source: interface-mdxeditormethods.md -->

# MDXEditorMethods

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/MDXEditor.tsx` (line 140)

## Properties

| Property | Type |
|---|---|
| `getMarkdown` | `() => string` |
| `setMarkdown` | `(value: string) => void` |
| `insertMarkdown` | `(value: string) => void` |
| `focus` | `(
    callbackFn?: (() => void) | undefined,
    opts?: {
      defaultSelection?: 'rootStart' | 'rootEnd'
      preventScroll?: boolean
    }
  ) => void` |
| `getContentEditableHTML` | `() => string` |
| `getSelectionMarkdown` | `() => string` |

<!-- source: component-desktoast.md -->

# DeskToast

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/DeskDialogs.tsx` (line 248)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `toast` | `unknown | null` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DeskToast_7c09524e["DeskToast"]
    class component_DeskToast_7c09524e rootComponent
```

<!-- source: interface-mdxeditorprops.md -->

# MDXEditorProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/MDXEditor.tsx` (line 300)

## Properties

| Property | Type |
|---|---|
| `contentEditableClassName` | `string` |
| `spellCheck` | `boolean` |
| `markdown` | `string` |
| `onChange` | `(markdown: string, initialMarkdownNormalize: boolean) => void` |
| `onError` | `(payload: { error: string; source: string }) => void` |
| `toMarkdownOptions` | `ToMarkdownOptions` |
| `plugins` | `RealmPlugin[]` |
| `className` | `string` |
| `autoFocus` | `boolean | { defaultSelection?: 'rootStart' | 'rootEnd'; preventScroll?: boolean }` |
| `onBlur` | `(e: FocusEvent) => void` |
| `placeholder` | `React.ReactNode` |
| `readOnly` | `boolean` |
| `iconComponentFor` | `(name: IconKey) => JSX.Element` |
| `suppressHtmlProcessing` | `boolean` |
| `translation` | `Translation` |
| `trim` | `boolean` |
| `lexicalTheme` | `EditorThemeClasses` |
| `overlayContainer` | `HTMLElement | null` |
| `suppressSharedHistory` | `boolean` |
| `editorState` | `EditorState | undefined | null` |
| `additionalLexicalNodes` | `AdditionalLexicalNode[]` |
| `lexicalEditorNamespace` | `string` |

<!-- source: api-endpoint-merge.md -->

# merge

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.controller.ts` (line 77)

## Endpoint

`POST /projects/:projectId/change-requests/:crId/merge`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `crId` | query | `string` | ✓ |

## Referenced By

- `ChangeRequestController` (MODULE_DECLARES)

<!-- source: component-docmeta.md -->

# DocMeta

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/DocMeta.tsx` (line 18)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `content` | `string` | ✓ | - |
| `updatedAt` | `string | Date` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DocMeta_54e453ca["DocMeta"]
    class component_DocMeta_54e453ca rootComponent
```

## Relationships

- RENDERS → `ClockIcon`
- RENDERS → `CalendarDaysIcon`
- USES_HOOK → `useLanguageContext`

<!-- source: interface-megafiledetectionresult.md -->

# MegaFileDetectionResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/mega-file.types.ts` (line 147)

Strategy for determining which phased approach to use

## Properties

| Property | Type |
|---|---|
| `isMegaFile` | `boolean` |
| `reason` | `string` |
| `fileSize` | `number` |
| `lineCount` | `number` |
| `suggestedStrategy` | `MegaFileStrategy | null` |

<!-- source: api-endpoint-movecard.md -->

# moveCard

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 164)

## Endpoint

`PATCH /projects/:projectId/boards/:boardId/cards/:cardId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `boardId` | query | `string` | ✓ |
| `cardId` | query | `string` | ✓ |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: component-docpage.md -->

# DocPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/doc/[...segments]/page.tsx` (line 134)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DocPage_2e26b721["DocPage"]
    class component_DocPage_2e26b721 rootComponent
```

## Relationships

- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `TableOfContents`
- RENDERS → `MDXEditor`
- USES_HOOK → `useSession`
- USES_HOOK → `useDocContext`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useMemo`
- USES_HOOK → `useEffect`

<!-- source: interface-megafileindex.md -->

# MegaFileIndex

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/mega-file.types.ts` (line 115)

Mega-file index - Enhanced version of LargeFileIndex for 600KB+ files

## Properties

| Property | Type |
|---|---|
| `isMegaFile` | `true` |
| `phaseExtractions` | `Array<{
    phase: number;
    name: string;
    tokenCount: number;
    content: string; // Extracted content for this phase
    entityNames: string[]; // Entities found in this phase
  }>` |
| `crossPhaseReferences` | `Array<{
    fromPhase: number;
    toPhase: number;
    reference: string; // Method/variable name
    type: 'calls' | 'uses' | 'extends';
  }>` |

<!-- source: api-endpoint-open.md -->

# open

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.controller.ts` (line 27)

## Endpoint

`POST /projects/:projectId/change-requests`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `ChangeRequestController` (MODULE_DECLARES)

<!-- source: component-docprovider.md -->

# DocProvider

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/doc/[...segments]/doc-context.tsx` (line 46)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DocProvider_3b2b1910["DocProvider"]
    class component_DocProvider_3b2b1910 rootComponent
```

## Relationships

- RENDERS → `DocContext-Provider`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-megafileindexerconfig.md -->

# MegaFileIndexerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/mega-file-indexer.ts` (line 26)

Configuration for mega file indexing

## Properties

| Property | Type |
|---|---|
| `sizeThreshold` | `number` |
| `lineThreshold` | `number` |
| `phases` | `MegaFilePhase[]` |

<!-- source: api-endpoint-overview.md -->

# overview

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/ops/ops.controller.ts` (line 15)

## Endpoint

`GET /ops/overview`

## Referenced By

- `OpsController` (MODULE_DECLARES)

<!-- source: component-docschangesbanner.md -->

# DocsChangesBanner

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/DocsChangesBanner.tsx` (line 15)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DocsChangesBanner_a8b58a6["DocsChangesBanner"]
    class component_DocsChangesBanner_a8b58a6 rootComponent
```

## Relationships

- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-megafilephase.md -->

# MegaFilePhase

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/mega-file.types.ts` (line 31)

## Properties

| Property | Type |
|---|---|
| `phase` | `number` |
| `name` | `string` |
| `description` | `string` |
| `extractPatterns` | `RegExp[]` |
| `maxTokens` | `number` |

<!-- source: api-endpoint-parse.md -->

# parse

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/parser/parser.controller.ts` (line 16)

## Endpoint

`POST /parser/parse`

## Referenced By

- `ParserController` (MODULE_DECLARES)

<!-- source: component-docsprpanel.md -->

# DocsPrPanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/DocsPrPanel.tsx` (line 36)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DocsPrPanel_2ef75fc5["DocsPrPanel"]
    class component_DocsPrPanel_2ef75fc5 rootComponent
```

## Relationships

- RENDERS → `ArrowPathIcon`
- RENDERS → `CheckCircleIcon`
- RENDERS → `ArrowTopRightOnSquareIcon`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-megafilephaseextractionresult.md -->

# MegaFilePhaseExtractionResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/mega-file.types.ts` (line 158)

Result of mega-file phase extraction

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `phases` | `Array<{
    phase: MegaFilePhase;
    extractedContent: string;
    tokenCount: number;
    entityCount: number;
    success: boolean;
    error?: string;
  }>` |
| `totalTokens` | `number` |
| `coveragePercent` | `number` |

<!-- source: api-endpoint-parsedocument.md -->

# parseDocument

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/parser/parser.controller.ts` (line 22)

## Endpoint

`POST /parser/document/:id/parse`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ParserController` (MODULE_DECLARES)

<!-- source: component-docsreviewtoggle.md -->

# DocsReviewToggle

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/change-requests/DocsReviewToggle.tsx` (line 17)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DocsReviewToggle_68d7fb62["DocsReviewToggle"]
    class component_DocsReviewToggle_68d7fb62 rootComponent
```

## Relationships

- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-megafilestrategy.md -->

# MegaFileStrategy

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/mega-file.types.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `sizeThreshold` | `number` |
| `lineThreshold` | `number` |
| `phases` | `MegaFilePhase[]` |

<!-- source: api-endpoint-parseproject-2.md -->

# parseProject

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/parsing/parsing.controller.ts` (line 16)

## Endpoint

`POST /projects/:projectId/parse`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `ParsingController` (MODULE_DECLARES)

<!-- source: component-documentcard.md -->

# DocumentCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Documents/DocumentCard.tsx` (line 18)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `document` | `unknown` | ✓ | - |
| `onDelete` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_DocumentCard_5fc3e2f["DocumentCard"]
    class component_DocumentCard_5fc3e2f rootComponent
```

## Relationships

- RENDERS → `PencilIcon`
- RENDERS → `TrashIcon`
- USES_HOOK → `useRouter`

<!-- source: interface-metacategoryreference.md -->

# MetaCategoryReference

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/knowledge-reference.types.ts` (line 53)

## Properties

| Property | Type |
|---|---|
| `category` | `MetaKnowledgeCategory` |
| `entries` | `KnowledgeEntry[]` |
| `stats` | `{
    totalEntries: number;
    totalSnippets: number;
    uniqueSourceDocs: number;
    avgConfidence: number;
  }` |

<!-- source: api-endpoint-playgroundproxy.md -->

# playgroundProxy

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-mcp.controller.ts` (line 438)

## Endpoint

`POST /technical-docs/:projectId/playground/proxy`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsMcpController` (MODULE_DECLARES)

<!-- source: component-documenteditor.md -->

# DocumentEditor

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/DocumentEditor.tsx` (line 156)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `content` | `string` | ✓ | - |
| `onChange` | `Function` | ✓ | - |
| `editable` | `boolean` | - | true |
| `originalContent` | `string` | - | - |
| `previewMode` | `boolean` | - | false |
| `selectedAudiences` | `string[]` | - | [] |
| `documentId` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_DocumentEditor_702dfdfa["DocumentEditor"]
    class component_DocumentEditor_702dfdfa rootComponent
```

## Relationships

- RENDERS → `AudiencePreviewPanel`
- RENDERS → `MDXEditor`
- RENDERS → `KitchenSinkToolbar`
- RENDERS → `Separator`
- RENDERS → `InsertAudienceButton`
- USES_HOOK → `useRef`
- USES_HOOK → `useImageUpload`
- USES_HOOK → `useSession`
- USES_HOOK → `useAudiences`
- USES_HOOK → `useMemo`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-metadocstats.md -->

# MetaDocStats

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 60)

## Properties

| Property | Type |
|---|---|
| `categoriesCreated` | `number` |
| `categoriesMoved` | `number` |
| `metaDocsGenerated` | `number` |
| `aiCallsMade` | `number` |
| `totalTokens` | `number` |
| `adminDocsFound` | `number` |
| `personaPathsGenerated` | `number` |

<!-- source: api-endpoint-portal.md -->

# portal

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/billing/billing.controller.ts` (line 41)

## Endpoint

`GET /billing/portal`

## Referenced By

- `BillingController` (MODULE_DECLARES)

<!-- source: component-documentlayout.md -->

# DocumentLayout

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/doc/[...segments]/layout.tsx` (line 207)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DocumentLayout_10c8777a["DocumentLayout"]
    class component_DocumentLayout_10c8777a rootComponent
```

## Relationships

- RENDERS → `DocProvider`
- RENDERS → `DocumentLayoutInner`

<!-- source: interface-metadocumentationconfig.md -->

# MetaDocumentationConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `skipMetaDocGeneration` | `boolean` |
| `maxConcurrency` | `number` |
| `temperature` | `number` |
| `maxOutputTokens` | `number` |

<!-- source: api-endpoint-previewscreenshot.md -->

# previewScreenshot

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 329)

## Endpoint

`POST /doc-versions/:projectId/:versionId/screenshots/preview`

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-documentlayout-2.md -->

# DocumentLayout

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Layout/DocumentLayout.tsx` (line 30)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |
| `organizationId` | `string` | ✓ | - |
| `projectId` | `string` | ✓ | - |
| `activeDocumentId` | `string` | - | - |
| `className` | `string` | - | - |
| `onNavigate` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_DocumentLayout_739b223["DocumentLayout"]
    class component_DocumentLayout_739b223 rootComponent
```

## Relationships

- RENDERS → `NavigationTree`
- RENDERS → `MobileNavigation`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-metadocumentationinput.md -->

# MetaDocumentationInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 38)

## Properties

| Property | Type |
|---|---|
| `appName` | `string` |
| `synthesis` | `{
    summary: string;
    personas: MetaDocumentationPersona[];
    featureAreas: Array<{ name: string; description: string; modules: string[] }>;
    crossModuleRelationships: Array<{ from: string; to: string; description: string }>;
  }` |
| `existingCategories` | `DocumentCategoryStructure[]` |
| `existingDocuments` | `PlannedDocument[]` |
| `generatedDocuments` | `GeneratedDocument[]` |
| `knowledgeReferences` | `KnowledgeReferenceStore` |

<!-- source: api-endpoint-publicsearch.md -->

# publicSearch

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 1051)

## Endpoint

`GET /public/p/:slugWithId/search`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |
| `q` | query | `string` | ✓ |
| `limit` | query | `string` | - |
| `version` | query | `string` | - |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: component-documentlist.md -->

# DocumentList

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Documents/DocumentList.tsx` (line 32)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | - | - |
| `categoryId` | `string | null` | - | - |
| `documents` | `any[]` | ✓ | - |
| `loading` | `boolean` | ✓ | - |
| `error` | `Error | null` | ✓ | - |
| `totalCount` | `number` | ✓ | - |
| `onFiltersChange` | `Function` | ✓ | - |
| `onCreateDocument` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_DocumentList_6733cd4b["DocumentList"]
    class component_DocumentList_6733cd4b rootComponent
```

## Relationships

- RENDERS → `SearchBar`
- RENDERS → `SortControl`
- RENDERS → `ViewToggle`
- RENDERS → `FilterChips`
- RENDERS → `LoadingGrid`
- RENDERS → `ErrorState`
- RENDERS → `EmptyState`
- RENDERS → `DocumentCard`
- RENDERS → `DocumentListItem`
- RENDERS → `Pagination`
- RENDERS → `DeleteDocumentModal`
- USES_HOOK → `useRouter`
- USES_HOOK → `useSearchParams`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useRef`
- USES_HOOK → `useCallback`

<!-- source: interface-metadocumentationpersona.md -->

# MetaDocumentationPersona

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 30)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `id` | `string` |
| `goals` | `string[]` |
| `relevantFeatures` | `string[]` |

<!-- source: api-endpoint-publish.md -->

# publish

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 197)

## Endpoint

`POST /doc-versions/:projectId/:versionId/publish`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-documentlistitem.md -->

# DocumentListItem

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Documents/DocumentListItem.tsx` (line 17)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `document` | `unknown` | ✓ | - |
| `onDelete` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_DocumentListItem_63ee54cf["DocumentListItem"]
    class component_DocumentListItem_63ee54cf rootComponent
```

## Relationships

- RENDERS → `PencilIcon`
- RENDERS → `TrashIcon`
- USES_HOOK → `useRouter`

<!-- source: interface-metadocumentationresult.md -->

# MetaDocumentationResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 52)

## Properties

| Property | Type |
|---|---|
| `restructuredCategories` | `DocumentCategoryStructure[]` |
| `restructuredDocuments` | `PlannedDocument[]` |
| `newDocuments` | `GeneratedDocument[]` |
| `tokenUsage` | `{ promptTokens: number; completionTokens: number; totalTokens: number }` |
| `stats` | `MetaDocStats` |

<!-- source: api-endpoint-publish-2.md -->

# publish

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 379)

## Endpoint

`POST /documents/:id/publish`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: component-documentpage.md -->

# DocumentPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/documents/[id]/page.tsx` (line 13)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DocumentPage_12029c29["DocumentPage"]
    class component_DocumentPage_12029c29 rootComponent
```

## Relationships

- RENDERS → `DocumentViewer`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useDocument`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-milestone-2.md -->

# Milestone

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/social-proof/social-proof-timeline.tsx` (line 11)

## Properties

| Property | Type |
|---|---|
| `dateKey` | `string` |
| `titleKey` | `string` |
| `descriptionKey` | `string` |

<!-- source: api-endpoint-publish-3.md -->

# publish

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 314)

## Endpoint

`POST /projects/:id/publish`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: component-documentsettingsdrawer.md -->

# DocumentSettingsDrawer

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Document/DocumentSettingsDrawer.tsx` (line 18)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `isOpen` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `canRegenerate` | `boolean` | ✓ | - |
| `kgEntityId` | `string` | ✓ | - |
| `kgEntityType` | `string` | ✓ | - |
| `onSave` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DocumentSettingsDrawer_15d260da["DocumentSettingsDrawer"]
    class component_DocumentSettingsDrawer_15d260da rootComponent
```

## Relationships

- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-modalcapturespec.md -->

# ModalCaptureSpec

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/screenshot-spec.types.ts` (line 92)

Modal capture specification

## Properties

| Property | Type |
|---|---|
| `modalName` | `string` |
| `triggerSelector` | `string` |
| `triggerText` | `string` |
| `closeMethod` | `'button-text' | 'data-dismiss' | 'escape'` |
| `closeButtonTexts` | `string[]` |

<!-- source: api-endpoint-query.md -->

# query

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/audit/audit.controller.ts` (line 15)

## Endpoint

`GET /audit/:projectId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `action` | query | `string` | - |
| `actorId` | query | `string` | - |
| `startDate` | query | `string` | - |
| `endDate` | query | `string` | - |
| `limit` | query | `string` | - |
| `offset` | query | `string` | - |

## Referenced By

- `AuditController` (MODULE_DECLARES)

<!-- source: component-documentspage.md -->

# DocumentsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/documents/page.tsx` (line 20)

## Diagram

```mermaid
graph TD
    component_DocumentsPage_5a3064d8["DocumentsPage"]
    class component_DocumentsPage_5a3064d8 rootComponent
```

## Relationships

- RENDERS → `CategoryTreeSidebar`
- RENDERS → `SortableDocumentList`
- RENDERS → `DocumentList`
- RENDERS → `CategoryModal`
- RENDERS → `DeleteCategoryModal`
- RENDERS → `ErrorState`
- USES_HOOK → `useRouter`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useProjectContext`
- USES_HOOK → `useState`
- USES_HOOK → `useVersionContext`
- USES_HOOK → `useEffect`
- USES_HOOK → `useDocuments`
- USES_HOOK → `useCallback`

<!-- source: interface-modaldefinition-2.md -->

# ModalDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 23)

A modal/popup/dialog discovered in source code

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `title` | `string` |
| `triggerType` | `ModalTriggerType` |
| `triggerSelector` | `string` |
| `triggerMethod` | `string` |
| `closeMethod` | `ModalCloseMethod` |
| `closeButtonTexts` | `string[]` |
| `conditionalOn` | `string` |
| `hostComponent` | `string` |
| `sourceFile` | `string` |
| `line` | `number` |

<!-- source: api-endpoint-ragindex.md -->

# ragIndex

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-mcp.controller.ts` (line 83)

## Endpoint

`POST /technical-docs/:projectId/rag/index`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsMcpController` (MODULE_DECLARES)

<!-- source: component-documenttoc.md -->

# DocumentToC

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/PublishingSidebar/DocumentToC.tsx` (line 28)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `content` | `string` | ✓ | - |
| `title` | `string` | ✓ | - |
| `loading` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_DocumentToC_725ad64e["DocumentToC"]
    class component_DocumentToC_725ad64e rootComponent
```

## Relationships

- RENDERS → `FileText`
- RENDERS → `ChevronDown`
- RENDERS → `ChevronRight`
- USES_HOOK → `useState`
- USES_HOOK → `useMemo`
- USES_HOOK → `useEffect`

<!-- source: interface-modalprofile.md -->

# ModalProfile

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/site-map.types.ts` (line 47)

## Properties

| Property | Type |
|---|---|
| `selector` | `string` |
| `title` | `string` |

<!-- source: api-endpoint-readall.md -->

# readAll

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/notification/notification.controller.ts` (line 41)

## Endpoint

`POST /notifications/read-all`

## Referenced By

- `NotificationController` (MODULE_DECLARES)

<!-- source: component-documentviewer.md -->

# DocumentViewer

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/DocumentViewer.tsx` (line 35)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `document` | `unknown` | ✓ | - |
| `capturedScreenshots` | `Record` | - | - |

## Diagram

```mermaid
graph TD
    component_DocumentViewer_24e17c0b["DocumentViewer"]
    class component_DocumentViewer_24e17c0b rootComponent
```

## Relationships

- RENDERS → `ViewerHeader`
- RENDERS → `MarkdownRenderer`
- RENDERS → `ViewerFooter`
- RENDERS → `TableOfContents`
- USES_HOOK → `useMemo`

<!-- source: interface-modeltokensummary.md -->

# ModelTokenSummary

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/pipeline/token-tracker.ts` (line 48)

## Properties

| Property | Type |
|---|---|
| `inputTokens` | `number` |
| `outputTokens` | `number` |
| `costUsd` | `number` |

<!-- source: api-endpoint-record.md -->

# record

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/events/events.controller.ts` (line 24)

## Endpoint

`POST /events`

## Referenced By

- `EventsController` (MODULE_DECLARES)

<!-- source: component-domainstatuschip.md -->

# DomainStatusChip

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Domains/DomainStatusChip.tsx` (line 57)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `status` | `DomainStatus` | ✓ | - |
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_DomainStatusChip_7eb6346["DomainStatusChip"]
    class component_DomainStatusChip_7eb6346 rootComponent
```

<!-- source: interface-muidetectionconfig.md -->

# MuiDetectionConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/material-ui.patterns.ts` (line 269)

## Properties

| Property | Type |
|---|---|
| `name` | `'material-ui'` |
| `filePatterns` | `string[]` |
| `identifiers` | `RegExp[]` |
| `configFiles` | `string[]` |

<!-- source: api-endpoint-recordpublicchatfeedback.md -->

# recordPublicChatFeedback

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 932)

## Endpoint

`POST /public/p/:slugWithId/chat/feedback`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: component-domaintab.md -->

# DomainTab

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Domains/DomainTab.tsx` (line 854)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `publishedSlug` | `string | null` | ✓ | - |
| `onToast` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DomainTab_7a023614["DomainTab"]
    class component_DomainTab_7a023614 rootComponent
```

## Relationships

- RENDERS → `SubdomainCard`
- RENDERS → `CustomDomainCard`

<!-- source: interface-navigationtreeprops.md -->

# NavigationTreeProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/components/NavigationTree.tsx` (line 20)

## Properties

| Property | Type |
|---|---|
| `items` | `DocumentTreeNode[]` |
| `activeId` | `string` |
| `defaultExpanded` | `string[]` |
| `expanded` | `string[]` |
| `onExpandedChange` | `(expandedIds: string[]) => void` |
| `onItemClick` | `(node: DocumentTreeNode) => void` |
| `showStateIndicator` | `boolean` |
| `loading` | `boolean` |
| `emptyMessage` | `string` |
| `className` | `string` |
| `'aria-label'` | `string` |

<!-- source: api-endpoint-recordpublicchatresolution.md -->

# recordPublicChatResolution

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/public-project.controller.ts` (line 972)

## Endpoint

`POST /public/p/:slugWithId/chat/resolution`

| Parameter | In | Type | Required |
|---|---|---|---|
| `slugWithId` | query | `string` | ✓ |

## Referenced By

- `PublicProjectController` (MODULE_DECLARES)

<!-- source: component-donutchart.md -->

# DonutChart

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/DonutChart.tsx` (line 54)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `data` | `DonutDatum[]` | ✓ | - |
| `loading` | `boolean` | - | false |
| `centerLabel` | `string` | - | - |
| `colors` | `string[]` | - | unknown |
| `emptyMessage` | `string` | - | "No data yet" |
| `maxSlices` | `number` | - | 6 |

## Diagram

```mermaid
graph TD
    component_DonutChart_24b992bd["DonutChart"]
    class component_DonutChart_24b992bd rootComponent
```

## Relationships

- RENDERS → `ResponsiveContainer`
- RENDERS → `PieChart`
- RENDERS → `Pie`
- RENDERS → `Cell`
- RENDERS → `Tooltip`
- RENDERS → `CustomTooltip`

<!-- source: interface-navlink.md -->

# NavLink

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/layout/nav.tsx` (line 17)

## Properties

| Property | Type |
|---|---|
| `labelKey` | `string` |
| `href` | `string` |

<!-- source: api-endpoint-refresh.md -->

# refresh

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/auth.controller.ts` (line 66)

## Endpoint

`POST /auth/refresh`

## Referenced By

- `AuthController` (MODULE_DECLARES)

<!-- source: component-duplicatedialog.md -->

# DuplicateDialog

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/DeskDialogs.tsx` (line 102)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `ticketNumber` | `number` | ✓ | - |
| `busy` | `boolean` | ✓ | - |
| `onSubmit` | `Function` | ✓ | - |
| `onClose` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_DuplicateDialog_774f45d7["DuplicateDialog"]
    class component_DuplicateDialog_774f45d7 rootComponent
```

## Relationships

- RENDERS → `Backdrop`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-nestededitorscontextvalue.md -->

# NestedEditorsContextValue

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/core/NestedLexicalEditor.tsx` (line 56)

## Properties

| Property | Type |
|---|---|
| `parentEditor` | `LexicalEditor` |
| `config` | `EditorConfig` |
| `mdastNode` | `T` |
| `lexicalNode` | `DecoratorNode<any> & {
    /**
     * Use this method to update the mdast node. This will also update the mdast tree of the parent editor.
     */
    setMdastNode: (mdastNode: any) => void
  }` |
| `focusEmitter` | `VoidEmitter` |

<!-- source: api-endpoint-refreshdiff.md -->

# refreshDiff

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.controller.ts` (line 94)

## Endpoint

`POST /projects/:projectId/change-requests/:crId/refresh-diff`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `crId` | query | `string` | ✓ |

## Referenced By

- `ChangeRequestController` (MODULE_DECLARES)

<!-- source: component-editdocumentpage.md -->

# EditDocumentPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/documents/[id]/edit/page.tsx` (line 78)

## Diagram

```mermaid
graph TD
    component_EditDocumentPage_1d1bc2e0["EditDocumentPage"]
    class component_EditDocumentPage_1d1bc2e0 rootComponent
```

## Relationships

- RENDERS → `Clock`
- RENDERS → `MessageCircle`
- RENDERS → `PublishButton`
- RENDERS → `Pencil`
- RENDERS → `CollaborativeDocumentEditor`
- RENDERS → `DocumentEditor`
- RENDERS → `CommentMarkers`
- RENDERS → `Check`
- RENDERS → `Copy`
- RENDERS → `ExternalLink`
- RENDERS → `Eye`
- RENDERS → `Users`
- RENDERS → `SaveAsTemplateButton`
- RENDERS → `DocumentSettingsDrawer`
- RENDERS → `CommentSidebar`
- RENDERS → `AnimatePresence`
- RENDERS → `VersionHistoryPanel`
- USES_HOOK → `useRouter`
- USES_HOOK → `useParams`
- USES_HOOK → `useSearchParams`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useComments`
- USES_HOOK → `useAudiences`
- USES_HOOK → `useMemo`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-nestjsendpoint.md -->

# NestJSEndpoint

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/nestjs-detector.ts` (line 39)

NestJS endpoint

## Properties

| Property | Type |
|---|---|
| `method` | `'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'` |
| `path` | `string` |
| `handlerName` | `string` |
| `requestDto` | `string` |
| `responseDto` | `string` |
| `roles` | `string[]` |
| `guard` | `string` |
| `isPublic` | `boolean` |
| `parameters` | `NestJSParameter[]` |

<!-- source: api-endpoint-register.md -->

# register

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/auth.controller.ts` (line 26)

## Endpoint

`POST /auth/register`

## Referenced By

- `AuthController` (MODULE_DECLARES)

<!-- source: component-editortoolbar.md -->

# EditorToolbar

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/EditorToolbar.tsx` (line 9)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `editor` | `Editor` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_EditorToolbar_7d08cec0["EditorToolbar"]
    class component_EditorToolbar_7d08cec0 rootComponent
```

## Relationships

- RENDERS → `ToolbarButton`

<!-- source: interface-nestjsmethod.md -->

# NestJSMethod

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/nestjs-detector.ts` (line 88)

NestJS method

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `returnType` | `string` |
| `isAsync` | `boolean` |
| `parameters` | `NestJSParameter[]` |

<!-- source: api-endpoint-reindexdocuments.md -->

# reindexDocuments

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/sync.controller.ts` (line 71)

## Endpoint

`POST /projects/:projectId/documents/reindex`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `SyncController` (MODULE_DECLARES)

<!-- source: component-emailverificationbanner.md -->

# EmailVerificationBanner

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/EmailVerificationBanner.tsx` (line 12)

## Diagram

```mermaid
graph TD
    component_EmailVerificationBanner_55803c2c["EmailVerificationBanner"]
    class component_EmailVerificationBanner_55803c2c rootComponent
```

## Relationships

- USES_HOOK → `useSession`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-nestjsparameter.md -->

# NestJSParameter

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/nestjs-detector.ts` (line 60)

NestJS parameter

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `decorator` | `'Body' | 'Query' | 'Param' | 'Headers' | 'Req' | 'Res'` |

<!-- source: api-endpoint-reject-3.md -->

# reject

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 720)

## Endpoint

`POST /doc-versions/:projectId/:versionId/approval/reject`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-embedcodegenerator.md -->

# EmbedCodeGenerator

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/EmbedCodeGenerator.tsx` (line 16)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `agentSlug` | `string` | - | "default" |
| `primaryColor` | `string` | - | "#0891B2" |
| `agentEnabled` | `boolean` | - | - |

## Diagram

```mermaid
graph TD
    component_EmbedCodeGenerator_5fb33733["EmbedCodeGenerator"]
    class component_EmbedCodeGenerator_5fb33733 rootComponent
```

## Relationships

- RENDERS → `Globe`
- RENDERS → `Link`
- RENDERS → `Icon`
- RENDERS → `AlertTriangle`
- RENDERS → `Check`
- RENDERS → `Copy`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-newimagedialogstate.md -->

# NewImageDialogState

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 98)

The state of the image dialog when it is in new mode.

## Properties

| Property | Type |
|---|---|
| `type` | `'new'` |

<!-- source: api-endpoint-remove-2.md -->

# remove

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 71)

## Endpoint

`DELETE /projects/:projectId/boards/:boardId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `boardId` | query | `string` | ✓ |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: component-emptystate-2.md -->

# EmptyState

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Templates/TemplateGallery.tsx` (line 176)

Empty state component

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `category` | `TemplateCategory | unknown` | ✓ | - |
| `searchQuery` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_EmptyState_45a47a7a["EmptyState"]
    class component_EmptyState_45a47a7a rootComponent
```

## Relationships

- RENDERS → `FileText`

<!-- source: interface-openaiconfig.md -->

# OpenAIConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/openai.provider.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `apiKey` | `string` |
| `baseUrl` | `string` |
| `model` | `string` |
| `maxTokens` | `number` |
| `temperature` | `number` |
| `timeout` | `number` |
| `azureEndpoint` | `string` |
| `azureApiKey` | `string` |
| `azureDeployment` | `string` |
| `azureApiVersion` | `string` |
| `retry` | `Partial<RetryConfig>` |

<!-- source: api-endpoint-remove-3.md -->

# remove

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/capture/capture.controller.ts` (line 99)

## Endpoint

`DELETE /capture/:projectId/flows/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `CaptureController` (MODULE_DECLARES)

<!-- source: component-emptystate-3.md -->

# EmptyState

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/common/EmptyState.tsx` (line 151)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `type` | `EmptyStateType` | ✓ | - |
| `searchQuery` | `string` | - | - |
| `onAction` | `Function` | - | - |
| `actionLabel` | `string` | - | - |
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_EmptyState_43e558a0["EmptyState"]
    class component_EmptyState_43e558a0 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `Icon`
- RENDERS → `motion-button`
- RENDERS → `PlusCircleIcon`

<!-- source: interface-openaigenerateoptions.md -->

# OpenAIGenerateOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/openai.provider.ts` (line 46)

## Properties

| Property | Type |
|---|---|
| `maxTokens` | `number` |
| `temperature` | `number` |
| `systemPrompt` | `string` |
| `messages` | `OpenAIMessage[]` |
| `responseFormat` | `'text' | 'json_object'` |
| `stopSequences` | `string[]` |

<!-- source: api-endpoint-removecard.md -->

# removeCard

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 176)

## Endpoint

`DELETE /projects/:projectId/boards/:boardId/cards/:cardId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `boardId` | query | `string` | ✓ |
| `cardId` | query | `string` | ✓ |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: component-enhancepanel.md -->

# EnhancePanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/EnhancePanel.tsx` (line 30)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `slug` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_EnhancePanel_1f5e4b27["EnhancePanel"]
    class component_EnhancePanel_1f5e4b27 rootComponent
```

## Relationships

- RENDERS → `OutOfCredits`
- USES_HOOK → `useSession`
- USES_HOOK → `useState`

<!-- source: interface-openaimessage.md -->

# OpenAIMessage

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/openai.provider.ts` (line 33)

## Properties

| Property | Type |
|---|---|
| `role` | `'system' | 'user' | 'assistant'` |
| `content` | `string` |

<!-- source: api-endpoint-removeconnector.md -->

# removeConnector

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 304)

## Endpoint

`DELETE /technical-docs/:projectId/connectors/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: component-enterpriseanalyticspage.md -->

# EnterpriseAnalyticsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/enterprise/analytics/page.tsx` (line 210)

## Diagram

```mermaid
graph TD
    component_EnterpriseAnalyticsPage_5420c7df["EnterpriseAnalyticsPage"]
    class component_EnterpriseAnalyticsPage_5420c7df rootComponent
```

## Relationships

- RENDERS → `ChartBarIcon`
- RENDERS → `ClipboardDocumentListIcon`
- RENDERS → `EyeIcon`
- RENDERS → `ArrowDownTrayIcon`
- RENDERS → `TimePeriodSelector`
- RENDERS → `MetricCard`
- RENDERS → `UsersIcon`
- RENDERS → `ClockSolidIcon`
- RENDERS → `ArrowTrendingUpIcon`
- RENDERS → `ArrowTrendingDownIcon`
- RENDERS → `MagnifyingGlassIcon`
- RENDERS → `TimeSeriesChart`
- RENDERS → `HorizontalBarChart`
- RENDERS → `DonutChart`
- RENDERS → `DeflectionCockpit`
- RENDERS → `TicketContentOpportunities`
- RENDERS → `AgentTrafficCockpit`
- RENDERS → `React-Fragment`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-openairesponse.md -->

# OpenAIResponse

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/openai.provider.ts` (line 38)

## Properties

| Property | Type |
|---|---|
| `content` | `string` |
| `inputTokens` | `number` |
| `outputTokens` | `number` |
| `model` | `string` |
| `finishReason` | `string` |

<!-- source: api-endpoint-removecustomdomain.md -->

# removeCustomDomain

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 400)

## Endpoint

`DELETE /projects/:id/custom-domain`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: component-entitydetailpage.md -->

# EntityDetailPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/entity/[entityId]/page.tsx` (line 184)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_EntityDetailPage_6f886d91["EntityDetailPage"]
    class component_EntityDetailPage_6f886d91 rootComponent
```

## Relationships

- RENDERS → `EntityTree`
- RENDERS → `RelationsPanel`
- RENDERS → `SparklesIcon`
- RENDERS → `TypeIcon`
- RENDERS → `CheckIcon`
- RENDERS → `DocumentDuplicateIcon`
- RENDERS → `ShareIcon`
- RENDERS → `EnhancePanel`
- RENDERS → `Tab`
- RENDERS → `MethodsTable`
- RENDERS → `FieldsTable`
- RENDERS → `Code`
- RENDERS → `AiEnrichmentContent`
- USES_HOOK → `useState`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useEffect`

<!-- source: interface-openapispec.md -->

# OpenAPISpec

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/APIExplorer.ts` (line 17)

## Properties

| Property | Type |
|---|---|
| `openapi` | `string` |
| `info` | `{
    title: string;
    version: string;
    description?: string;
  }` |
| `paths` | `Record<string, any>` |
| `components` | `{
    securitySchemes?: Record<string, SecurityScheme>;
  }` |

<!-- source: api-endpoint-removemember.md -->

# removeMember

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 237)

## Endpoint

`DELETE /projects/:id/members/:userId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `userId` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: component-entitytree.md -->

# EntityTree

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/EntityTree.tsx` (line 246)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `navMap` | `NavMap` | ✓ | - |
| `enrichedEntityIds` | `Set` | ✓ | - |
| `projectId` | `string` | ✓ | - |
| `selectedEntityId` | `string` | - | - |
| `entityHrefBase` | `string` | - | - |
| `curation` | `Curation` | - | - |
| `onCurate` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_EntityTree_25be53ad["EntityTree"]
    class component_EntityTree_25be53ad rootComponent
```

## Relationships

- RENDERS → `EntityIcon`
- RENDERS → `AppSection`
- RENDERS → `ChevronRightIcon`
- USES_HOOK → `useState`
- USES_HOOK → `useMemo`

<!-- source: interface-openchangerequestdto.md -->

# OpenChangeRequestDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/change-requests.ts` (line 93)

Payload for opening a change request.

`kind` is NOT sent: the API forces `kind: 'human'` for every client-opened CR (the 'regen'
and 'agent' kinds are reserved for internal server callers), so it is not part of the
client-facing payload.

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `files` | `ChangeRequestProposedFile[]` |

<!-- source: api-endpoint-removesource.md -->

# removeSource

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 247)

## Endpoint

`DELETE /technical-docs/:projectId/sources/:documentId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `documentId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: component-errorstate.md -->

# ErrorState

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Templates/TemplateGallery.tsx` (line 155)

Error state component

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `error` | `Error` | ✓ | - |
| `onRetry` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ErrorState_19b41561["ErrorState"]
    class component_ErrorState_19b41561 rootComponent
```

## Relationships

- RENDERS → `AlertCircle`

<!-- source: interface-pageelementprofile.md -->

# PageElementProfile

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/site-map.types.ts` (line 52)

## Properties

| Property | Type |
|---|---|
| `grids` | `GridProfile[]` |
| `tabs` | `TabProfile[]` |
| `buttons` | `ButtonProfile[]` |
| `inputs` | `InputProfile[]` |
| `forms` | `FormProfile[]` |
| `modals` | `ModalProfile[]` |

<!-- source: api-endpoint-render.md -->

# render

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 445)

## Endpoint

`GET /documents/:id/render`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `audiences` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: component-errorstate-2.md -->

# ErrorState

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/common/ErrorState.tsx` (line 114)

## Diagram

```mermaid
graph TD
    component_ErrorState_2fd96bd6["ErrorState"]
    class component_ErrorState_2fd96bd6 rootComponent
```

## Relationships

- RENDERS → `ErrorIcon`
- RENDERS → `AnimatePresence`
- RENDERS → `motion-div`
- RENDERS → `ErrorContent`
- RENDERS → `ActionButton`

<!-- source: interface-parameter-2.md -->

# Parameter

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/EndpointDetail.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `in` | `'query' | 'path' | 'header' | 'cookie'` |
| `description` | `string` |
| `required` | `boolean` |
| `schema` | `Schema` |
| `example` | `any` |

<!-- source: api-endpoint-reorder.md -->

# reorder

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/category.controller.ts` (line 109)

Reorder categories

## Endpoint

`POST /categories/reorder`

## Referenced By

- `CategoryController` (MODULE_DECLARES)

<!-- source: component-exportmodal.md -->

# ExportModal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/ExportModal.tsx` (line 48)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `open` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `defaultScope` | `ExportScope` | - | "technical" |

## Diagram

```mermaid
graph TD
    component_ExportModal_37cf2205["ExportModal"]
    class component_ExportModal_37cf2205 rootComponent
```

## Relationships

- RENDERS → `AnimatePresence`
- RENDERS → `motion-div`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-parameter-3.md -->

# Parameter

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/RequestPanel.ts` (line 17)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `in` | `'query' | 'path' | 'header' | 'cookie'` |
| `description` | `string` |
| `required` | `boolean` |
| `schema` | `{ type?: string; example?: any }` |

<!-- source: api-endpoint-reordercolumns.md -->

# reorderColumns

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 104)

## Endpoint

`PATCH /projects/:projectId/boards/:boardId/columns/reorder`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `boardId` | query | `string` | ✓ |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: component-field.md -->

# Field

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/branding/page.tsx` (line 1048)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `label` | `string` | ✓ | - |
| `hint` | `string` | - | - |
| `counter` | `string` | - | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Field_1065d226["Field"]
    class component_Field_1065d226 rootComponent
```

<!-- source: interface-parseerror-5.md -->

# ParseError

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 123)

Parse error

## Properties

| Property | Type |
|---|---|
| `type` | `'error'` |
| `message` | `string` |
| `line` | `number` |
| `column` | `number` |
| `severity` | `'error'` |

<!-- source: api-endpoint-reorderdocuments.md -->

# reorderDocuments

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 960)

## Endpoint

`PATCH /categories/:categoryId/documents/order`

| Parameter | In | Type | Required |
|---|---|---|---|
| `categoryId` | query | `string` | ✓ |

## Referenced By

- `CategoryDocumentsController` (MODULE_DECLARES)

<!-- source: component-fileupload.md -->

# FileUpload

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/FileUpload.tsx` (line 15)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onFileSelect` | `Function` | ✓ | - |
| `accept` | `string` | - | ".ts,.tsx,.js,.jsx,.py" |
| `maxSize` | `number` | - | unknown |
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_FileUpload_7bfea7be["FileUpload"]
    class component_FileUpload_7bfea7be rootComponent
```

## Relationships

- USES_HOOK → `useState`
- USES_HOOK → `useCallback`

<!-- source: interface-parseerrorinfo.md -->

# ParseErrorInfo

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-01.types.ts` (line 59)

## Properties

| Property | Type |
|---|---|
| `filePath` | `string` |
| `line` | `number` |
| `message` | `string` |
| `severity` | `'warning' | 'error'` |

<!-- source: api-endpoint-reply.md -->

# reply

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/desk.controller.ts` (line 85)

## Endpoint

`POST /desk/:projectId/threads/:id/reply`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `DeskController` (MODULE_DECLARES)

<!-- source: component-filterbar.md -->

# FilterBar

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Documents/FilterBar.tsx` (line 16)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `filters` | `DocumentFilters` | ✓ | - |
| `onChange` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FilterBar_1fba083d["FilterBar"]
    class component_FilterBar_1fba083d rootComponent
```

## Relationships

- RENDERS → `Select`

<!-- source: interface-parseinput.md -->

# ParseInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-01.types.ts` (line 23)

## Properties

| Property | Type |
|---|---|
| `config` | `Pick<
    JobConfig,
    'repositoryUrl' | 'branch' | 'includePaths' | 'excludePaths'
  > & {
    /** Parser-core configuration */
    parsers?: ParserCoreConfig;
    /** Scope paths for file discovery */
    scopePaths?: {
      frontend?: string;
      backend?: string;
    };
  }` |
| `workDir` | `string` |

<!-- source: api-endpoint-reply-2.md -->

# reply

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/public-issues.controller.ts` (line 32)

## Endpoint

`POST /public/issues/:projectSlugId/:ticketNumber/reply`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectSlugId` | query | `string` | ✓ |
| `ticketNumber` | query | `number` | ✓ |

## Referenced By

- `PublicIssuesController` (MODULE_DECLARES)

<!-- source: component-filterchips.md -->

# FilterChips

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Documents/FilterChips.tsx` (line 28)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `filters` | `DocumentFilters` | ✓ | - |
| `onRemoveFilter` | `Function` | ✓ | - |
| `onClearAll` | `Function` | ✓ | - |
| `categoryName` | `string` | - | - |
| `projectName` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_FilterChips_62faa03d["FilterChips"]
    class component_FilterChips_62faa03d rootComponent
```

## Relationships

- RENDERS → `AnimatePresence`
- RENDERS → `motion-div`
- RENDERS → `XMarkIcon`
- RENDERS → `motion-button`

<!-- source: interface-parsercoreconfig.md -->

# ParserCoreConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-01.types.ts` (line 14)

Parser configuration for parser-core integration

## Properties

| Property | Type |
|---|---|
| `explicit` | `string[]` |
| `additionalPatterns` | `string[]` |
| `useParserCore` | `boolean` |

<!-- source: api-endpoint-reportexternalfailure.md -->

# reportExternalFailure

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 194)

## Endpoint

`POST /doc-automation/jobs/:id/external-failed`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: component-forgotpasswordpage.md -->

# ForgotPasswordPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(auth)/forgot-password/page.tsx` (line 8)

## Diagram

```mermaid
graph TD
    component_ForgotPasswordPage_4692b37["ForgotPasswordPage"]
    class component_ForgotPasswordPage_4692b37 rootComponent
```

## Relationships

- RENDERS → `Link`
- USES_HOOK → `useState`

<!-- source: interface-parseresult-5.md -->

# ParseResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-01.types.ts` (line 39)

## Properties

| Property | Type |
|---|---|
| `entities` | `Entity[]` |
| `repoPath` | `string` |
| `stats` | `ParseStats` |
| `errors` | `ParseErrorInfo[]` |
| `routeMappings` | `RouteMappingResult` |

<!-- source: api-endpoint-reportexternalprogress.md -->

# reportExternalProgress

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 175)

## Endpoint

`POST /doc-automation/jobs/:id/external-progress`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: component-formsection.md -->

# FormSection

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/branding/page.tsx` (line 1013)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `icon` | `unknown` | ✓ | - |
| `title` | `string` | ✓ | - |
| `description` | `string` | - | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FormSection_4fa0b59f["FormSection"]
    class component_FormSection_4fa0b59f rootComponent
```

<!-- source: interface-parseroptions-2.md -->

# ParserOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 145)

Parser options

## Properties

| Property | Type |
|---|---|
| `expandIncludes` | `boolean` |
| `validateAudiences` | `boolean` |
| `knownAudiences` | `string[]` |
| `maxNestingDepth` | `number` |
| `allowUnknownAudiences` | `boolean` |

<!-- source: api-endpoint-requestapproval.md -->

# requestApproval

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 669)

## Endpoint

`POST /doc-versions/:projectId/:versionId/approval/request`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-freshnesscockpit.md -->

# FreshnessCockpit

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/FreshnessCockpit.tsx` (line 56)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_FreshnessCockpit_109afe6b["FreshnessCockpit"]
    class component_FreshnessCockpit_109afe6b rootComponent
```

## Relationships

- RENDERS → `ArrowPathIcon`
- RENDERS → `CameraIcon`
- RENDERS → `SparklesIcon`
- RENDERS → `OutOfCredits`
- RENDERS → `CheckCircleIcon`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-parsestats.md -->

# ParseStats

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-01.types.ts` (line 48)

## Properties

| Property | Type |
|---|---|
| `totalFiles` | `number` |
| `parsedFiles` | `number` |
| `skippedFiles` | `number` |
| `totalEntities` | `number` |
| `totalLines` | `number` |
| `byType` | `Record<string, number>` |
| `byTier` | `Record<string, number>` |
| `byExtension` | `Record<string, number>` |

<!-- source: api-endpoint-resendverification.md -->

# resendVerification

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/auth.controller.ts` (line 117)

## Endpoint

`POST /auth/resend-verification`

## Referenced By

- `AuthController` (MODULE_DECLARES)

<!-- source: component-generationhistory.md -->

# GenerationHistory

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/dashboard/GenerationHistory.tsx` (line 38)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `jobs` | `Job[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_GenerationHistory_5d76ce28["GenerationHistory"]
    class component_GenerationHistory_5d76ce28 rootComponent
```

<!-- source: interface-parsewarning-3.md -->

# ParseWarning

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 134)

Parse warning

## Properties

| Property | Type |
|---|---|
| `type` | `'warning'` |
| `message` | `string` |
| `line` | `number` |
| `column` | `number` |
| `severity` | `'warning'` |

<!-- source: api-endpoint-resetpassword.md -->

# resetPassword

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/auth.controller.ts` (line 106)

## Endpoint

`POST /auth/reset-password`

## Referenced By

- `AuthController` (MODULE_DECLARES)

<!-- source: component-generationprogress.md -->

# GenerationProgress

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/pme/generation-progress.tsx` (line 26)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onComplete` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_GenerationProgress_3fbedf8c["GenerationProgress"]
    class component_GenerationProgress_3fbedf8c rootComponent
```

## Relationships

- USES_HOOK → `usePmeStore`

<!-- source: interface-permissioncheck-2.md -->

# PermissionCheck

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 176)

A permission check found in source code

## Properties

| Property | Type |
|---|---|
| `permission` | `string` |
| `checkType` | `'route-guard' | 'template-conditional' | 'code-check' | 'decorator'` |
| `affectedElement` | `string` |
| `location` | `string` |
| `sourceFile` | `string` |
| `line` | `number` |

<!-- source: api-endpoint-reshoot.md -->

# reshoot

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/freshness.controller.ts` (line 27)

## Endpoint

`POST /freshness/:projectId/reshoot`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `FreshnessController` (MODULE_DECLARES)

<!-- source: component-generationwizard.md -->

# GenerationWizard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/pme/generation-wizard.tsx` (line 32)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onStarted` | `Function` | ✓ | - |
| `onBack` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_GenerationWizard_ffd9b70["GenerationWizard"]
    class component_GenerationWizard_ffd9b70 rootComponent
```

## Relationships

- USES_HOOK → `useProjectContext`
- USES_HOOK → `usePme`
- USES_HOOK → `useState`

<!-- source: interface-phase-2.md -->

# Phase

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-07.types.ts` (line 32)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `number` | `number` |
| `name` | `string` |
| `documents` | `PhaseDocument[]` |
| `priority` | `number` |
| `sharedContext` | `string[]` |
| `estimatedTokens` | `number` |

<!-- source: api-endpoint-reshootlocales.md -->

# reshootLocales

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/capture/capture.controller.ts` (line 88)

## Endpoint

`POST /capture/:projectId/flows/:id/reshoot-locales`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `CaptureController` (MODULE_DECLARES)

<!-- source: component-githubicon-2.md -->

# GitHubIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/integrations/page.tsx` (line 12)

## Diagram

```mermaid
graph TD
    component_GitHubIcon_1e895c58["GitHubIcon"]
    class component_GitHubIcon_1e895c58 rootComponent
```

<!-- source: interface-phasedocument.md -->

# PhaseDocument

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-07.types.ts` (line 42)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `order` | `number` |
| `dependencies` | `string[]` |

<!-- source: api-endpoint-reshootstep.md -->

# reshootStep

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/capture/capture.controller.ts` (line 76)

## Endpoint

`POST /capture/:projectId/flows/:id/steps/:stepIndex/reshoot`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |
| `stepIndex` | query | `number` | ✓ |

## Referenced By

- `CaptureController` (MODULE_DECLARES)

<!-- source: component-githubicon-3.md -->

# GitHubIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/scenes/SceneConnectProvider.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `size` | `number` | - | 36 |
| `color` | `string` | - | "#24292F" |

## Diagram

```mermaid
graph TD
    component_GitHubIcon_48ed4f36["GitHubIcon"]
    class component_GitHubIcon_48ed4f36 rootComponent
```

<!-- source: interface-phaseinput.md -->

# PhaseInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-07.types.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `documents` | `PlannedDocument[]` |
| `maxDocsPerPhase` | `number` |

<!-- source: api-endpoint-resolve.md -->

# resolve

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/change-request/change-request.controller.ts` (line 105)

## Endpoint

`POST /projects/:projectId/change-requests/:crId/resolve`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `crId` | query | `string` | ✓ |

## Referenced By

- `ChangeRequestController` (MODULE_DECLARES)

<!-- source: component-gitlabicon-2.md -->

# GitLabIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/integrations/page.tsx` (line 18)

## Diagram

```mermaid
graph TD
    component_GitLabIcon_2ffea310["GitLabIcon"]
    class component_GitLabIcon_2ffea310 rootComponent
```

<!-- source: interface-phaseresult-2.md -->

# PhaseResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-07.types.ts` (line 23)

## Properties

| Property | Type |
|---|---|
| `phases` | `Phase[]` |
| `stats` | `{
    totalPhases: number;
    avgDocsPerPhase: number;
    maxDocsInPhase: number;
  }` |

<!-- source: api-endpoint-resolve-2.md -->

# resolve

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/comment/comment.controller.ts` (line 270)

Resolve a comment thread

## Endpoint

`POST /documents/:documentId/comments/:id/resolve`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `CommentController` (MODULE_DECLARES)

<!-- source: component-gitlabicon-3.md -->

# GitLabIcon

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/scenes/SceneConnectProvider.tsx` (line 26)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `size` | `number` | - | 36 |

## Diagram

```mermaid
graph TD
    component_GitLabIcon_688ab162["GitLabIcon"]
    class component_GitLabIcon_688ab162 rootComponent
```

<!-- source: interface-pipelineerrorinfo.md -->

# PipelineErrorInfo

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 314)

## Properties

| Property | Type |
|---|---|
| `code` | `ErrorCode` |
| `message` | `string` |
| `stage` | `JobStage` |
| `recoverable` | `boolean` |
| `details` | `unknown` |

<!-- source: api-endpoint-resolve-3.md -->

# resolve

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 258)

## Endpoint

`POST /doc-versions/:projectId/:versionId/review/resolve`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-graphpage.md -->

# GraphPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/graph/page.tsx` (line 59)

## Diagram

```mermaid
graph TD
    component_GraphPage_6ebb50fc["GraphPage"]
    class component_GraphPage_6ebb50fc rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `Card`
- RENDERS → `CardContent`
- RENDERS → `ShareIcon`
- RENDERS → `CardHeader`
- RENDERS → `ReactFlowProvider`
- RENDERS → `MagnifyingGlassIcon`
- RENDERS → `FunnelIcon`
- RENDERS → `ReactFlow`
- RENDERS → `Background`
- RENDERS → `Controls`
- RENDERS → `MiniMap`
- RENDERS → `Panel`
- USES_HOOK → `useKnowledgeGraph`
- USES_HOOK → `useNodesState`
- USES_HOOK → `useEdgesState`
- USES_HOOK → `useState`
- USES_HOOK → `useMemo`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-pipelinemetrics.md -->

# PipelineMetrics

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/pipeline-metrics.ts` (line 17)

Pipeline Metrics Collector

Collects comprehensive metrics across all pipeline stages for
post-run analysis. Persisted to documentation_jobs.metrics as JSONB.

Categories tracked:
- Token usage per stage and total
- Screenshot mapping/capture/failure breakdown
- Quality gate + verification scores per document
- Business context extraction stats
- InteractionMap discovery stats
- Stage timing with timestamps
- Document-level metrics (word count, section count)

## Properties

| Property | Type |
|---|---|
| `tokens` | `{
    total: { input: number; output: number; cost?: number };
    byStage: Record<string, { input: number; output: number; calls: number }>;
  }` |
| `screenshots` | `{
    totalPlaceholders: number;
    mapped: number;
    unmapped: number;
    captured: number;
    failed: number;
    replaced: number;
    /** Breakdown by mapping source */
    mappingSources: {
      interactionMap: number;
      siteMap: number;
      aiFallback: number;
    };
    /** Capture types breakdown */
    captureTypes: Record<string, number>;
    /** Failed capture reasons */
    failureReasons: { url: string; reason: string }[];
    /** State-guided captures attempted/succeeded */
    stateGuided: { attempted: number; succeeded: number };
    /** Workflow sequences detected */
    workflowSequences: number;
  }` |
| `quality` | `{
    /** Quality gate scores */
    qualityGate: {
      totalScored: number;
      passed: number;
      failed: number;
      regenerated: number;
      averageScore: number;
      scores: { docId: string; title: string; score: number; passed: boolean }[];
    };
    /** Verification scores */
    verification: {
      totalVerified: number;
      passed: number;
      failed: number;
      averageAccuracy: number;
      scores: { docId: string; title: string; accuracy: number; claims: number; flagged: number }[];
    };
    /** Grounding scores */
    grounding: {
      averageScore: number;
      belowThreshold: number;
      scores: { docId: string; score: number }[];
    };
  }` |
| `extraction` | `{
    /** InteractionMap stats */
    interactionMap: {
      totalRoutes: number;
      routesWithModals: number;
      routesWithTabs: number;
      routesWithForms: number;
      totalModals: number;
      totalTabs: number;
      totalFormFields: number;
      totalPermissions: number;
    } | null;
    /** Business context extraction */
    businessContext: {
      sourcesProcessed: number;
      personas: number;
      features: number;
      glossaryTerms: number;
      workflows: number;
      extracted: boolean;
    } | null;
    /** Route mappings from Stage 1 */
    routeMappings: {
      totalRoutes: number;
      framework: string;
      withComponents: number;
      withTemplates: number;
    } | null;
  }` |
| `timing` | `{
    pipelineStartedAt: string;
    pipelineEndedAt: string;
    totalDurationMs: number;
    stages: {
      name: string;
      startedAt: string;
      endedAt: string;
      durationMs: number;
      status: 'success' | 'failed' | 'skipped';
    }[];
  }` |
| `documents` | `{
    total: number;
    byType: Record<string, number>;
    averageWordCount: number;
    averageSections: number;
    totalWordCount: number;
  }` |

<!-- source: api-endpoint-resolveall.md -->

# resolveAll

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 274)

## Endpoint

`POST /doc-versions/:projectId/:versionId/review/resolve-all`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-groundednesspage.md -->

# GroundednessPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/groundedness/page.tsx` (line 20)

## Diagram

```mermaid
graph TD
    component_GroundednessPage_1e3f0944["GroundednessPage"]
    class component_GroundednessPage_1e3f0944 rootComponent
```

<!-- source: interface-placeholderoccurrence.md -->

# PlaceholderOccurrence

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 27)

Where a placeholder appears in the documentation

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `documentPath` | `string` |
| `lineNumber` | `number` |
| `context` | `string` |

<!-- source: api-endpoint-restore.md -->

# restore

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 81)

## Endpoint

`POST /projects/:projectId/boards/:boardId/restore`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `boardId` | query | `string` | ✓ |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: component-healthycasestudypage.md -->

# HealthyCaseStudyPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/customers/healthy/page.tsx` (line 47)

## Diagram

```mermaid
graph TD
    component_HealthyCaseStudyPage_44b41e25["HealthyCaseStudyPage"]
    class component_HealthyCaseStudyPage_44b41e25 rootComponent
```

## Relationships

- RENDERS → `Link`

<!-- source: interface-planinput.md -->

# PlanInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-09.types.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `documents` | `PlannedDocument[]` |
| `features` | `UserFeature[]` |

<!-- source: api-endpoint-restorefromrevision.md -->

# restoreFromRevision

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 565)

## Endpoint

`POST /documents/:id/revisions/:revisionId/restore`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `revisionId` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: component-helpfulnesswidget.md -->

# HelpfulnessWidget

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/HelpfulnessWidget.tsx` (line 52)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `documentId` | `string` | - | - |
| `documentSlug` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_HelpfulnessWidget_b37518a["HelpfulnessWidget"]
    class component_HelpfulnessWidget_b37518a rootComponent
```

## Relationships

- RENDERS → `HandThumbUpIcon`
- RENDERS → `HandThumbDownIcon`
- RENDERS → `CheckIcon`
- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`

<!-- source: interface-planneddocument.md -->

# PlannedDocument

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-06.types.ts` (line 35)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `slug` | `string` |
| `type` | `DocumentType` |
| `category` | `string` |
| `description` | `string` |
| `targetPersonas` | `string[]` |
| `prerequisites` | `string[]` |
| `relatedDocuments` | `string[]` |
| `estimatedSections` | `number` |
| `priority` | `number` |
| `featureIds` | `string[]` |

<!-- source: api-endpoint-restorefromversion.md -->

# restoreFromVersion

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 754)

## Endpoint

`POST /documents/:id/versions/:versionNumber/restore`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `versionNumber` | query | `number` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: component-homepage.md -->

# HomePage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/page.tsx` (line 501)

## Diagram

```mermaid
graph TD
    component_HomePage_266c528["HomePage"]
    class component_HomePage_266c528 rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `Orb`
- RENDERS → `motion-div`
- RENDERS → `motion-h1`
- RENDERS → `motion-p`
- RENDERS → `DemoTerminal`
- RENDERS → `Reveal`
- RENDERS → `Counter`
- RENDERS → `KbPanel`
- RENDERS → `ManualPanel`
- RENDERS → `ApiPanel`
- RENDERS → `SupportPanel`
- RENDERS → `StepsSection`
- RENDERS → `Ticker`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-plannerprogresscallback.md -->

# PlannerProgressCallback

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-09-planning/doc-planner.service.ts` (line 25)

<!-- source: api-endpoint-retrycustomdomain.md -->

# retryCustomDomain

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 390)

## Endpoint

`POST /projects/:id/custom-domain/retry`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: component-horizontalbarchart.md -->

# HorizontalBarChart

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/HorizontalBarChart.tsx` (line 36)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `items` | `HorizontalBarItem[]` | ✓ | - |
| `maxItems` | `number` | - | 10 |
| `loading` | `boolean` | - | false |
| `emptyMessage` | `string` | - | "No data yet" |

## Diagram

```mermaid
graph TD
    component_HorizontalBarChart_60e61b63["HorizontalBarChart"]
    class component_HorizontalBarChart_60e61b63 rootComponent
```

<!-- source: interface-planresult.md -->

# PlanResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-09.types.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `plans` | `DocumentPlan[]` |
| `tokenUsage` | `TokenUsage[]` |

<!-- source: api-endpoint-revert.md -->

# revert

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 341)

## Endpoint

`POST /documents/:id/revert/:version`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `version` | query | `number` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: component-imageuploadfield.md -->

# ImageUploadField

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/branding/page.tsx` (line 1146)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `url` | `string` | ✓ | - |
| `placeholder` | `string` | ✓ | - |
| `uploading` | `boolean` | ✓ | - |
| `inputRef` | `unknown` | ✓ | - |
| `onUpload` | `Function` | ✓ | - |
| `onClear` | `Function` | ✓ | - |
| `small` | `boolean` | - | - |

## Diagram

```mermaid
graph TD
    component_ImageUploadField_78cc0a3e["ImageUploadField"]
    class component_ImageUploadField_78cc0a3e rootComponent
```

## Relationships

- RENDERS → `PhotoIcon`
- RENDERS → `ArrowUpTrayIcon`
- RENDERS → `XMarkIcon`
- USES_HOOK → `useState`

<!-- source: interface-previewlinkdialog.md -->

# PreviewLinkDialog

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/link-dialog/index.ts` (line 42)

The state of the link dialog when it is in preview mode.

## Properties

| Property | Type |
|---|---|
| `type` | `'preview'` |
| `title` | `string` |
| `url` | `string` |
| `linkNodeKey` | `string` |
| `rectangle` | `RectData` |

<!-- source: api-endpoint-run.md -->

# run

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr.controller.ts` (line 79)

Manually run the freshness-PR flow now (for testing / on-demand). Opt-in gated inside.

## Endpoint

`POST /docs-pr/:projectId/run`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocsPrController` (MODULE_DECLARES)

<!-- source: component-index-ts.md -->

# index.ts

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/stores/index.ts` (line 1)

## Diagram

```mermaid
graph TD
    component_index_ts_6ee637cf["index.ts"]
    class component_index_ts_6ee637cf rootComponent
```

<!-- source: interface-pricingcomparisontableprops-2.md -->

# PricingComparisonTableProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/pricing/pricing-comparison-table.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `plans` | `{ nameKey: string; priceKey: string; highlighted?: boolean }[]` |
| `features` | `{ featureKey: string; values: (boolean | string)[] }[]` |

<!-- source: api-endpoint-runreport.md -->

# runReport

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/export/analytics-export.controller.ts` (line 135)

## Endpoint

`POST /analytics/:projectId/reports/:id/run`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `AnalyticsExportController` (MODULE_DECLARES)

<!-- source: component-integrationspage.md -->

# IntegrationsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/integrations/page.tsx` (line 84)

## Diagram

```mermaid
graph TD
    component_IntegrationsPage_cb1f736["IntegrationsPage"]
    class component_IntegrationsPage_cb1f736 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `AnimatePresence`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-pricingfeature-3.md -->

# PricingFeature

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/pricing-tier-card.tsx` (line 14)

## Properties

| Property | Type |
|---|---|
| `textKey` | `string` |

<!-- source: api-endpoint-runuploadonexistingjob.md -->

# runUploadOnExistingJob

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 212)

## Endpoint

`POST /doc-automation/jobs/:id/run-upload`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: component-issuedetailpage.md -->

# IssueDetailPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/[ticketId]/page.tsx` (line 468)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_IssueDetailPage_97c934e["IssueDetailPage"]
    class component_IssueDetailPage_97c934e rootComponent
```

## Relationships

- RENDERS → `BoardsToastProvider`
- RENDERS → `IssueDetailPageInner`

<!-- source: interface-pricingfeature-4.md -->

# PricingFeature

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/pricing/pricing-hero-card.tsx` (line 12)

## Properties

| Property | Type |
|---|---|
| `textKey` | `string` |
| `included` | `boolean` |

<!-- source: api-endpoint-saveastemplate.md -->

# saveAsTemplate

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/template/template.controller.ts` (line 151)

Save an existing document as a template.
Any contributor or higher can save their documents as templates.

## Endpoint

`POST /templates/from-document/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `TemplateController` (MODULE_DECLARES)

<!-- source: component-issuesallpage.md -->

# IssuesAllPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/all/page.tsx` (line 182)

## Diagram

```mermaid
graph TD
    component_IssuesAllPage_601947d9["IssuesAllPage"]
    class component_IssuesAllPage_601947d9 rootComponent
```

## Relationships

- RENDERS → `BoardsToastProvider`
- RENDERS → `IssuesAllPageInner`

<!-- source: interface-pricingherocardprops-2.md -->

# PricingHeroCardProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/pricing/pricing-hero-card.tsx` (line 27)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `heroPlan` | `PricingPlan` |
| `secondaryPlans` | `PricingPlan[]` |

<!-- source: api-endpoint-search.md -->

# search

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 100)

## Endpoint

`GET /documents/search`

| Parameter | In | Type | Required |
|---|---|---|---|
| `filters` | query | `SearchDocumentsDto` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: component-issuesidepanel.md -->

# IssueSidePanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/IssueSidePanel.tsx` (line 163)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `card` | `BoardCardData | null` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `onIssueChanged` | `Function` | - | - |
| `onStatusChanged` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_IssueSidePanel_5e5fd282["IssueSidePanel"]
    class component_IssueSidePanel_5e5fd282 rootComponent
```

## Relationships

- RENDERS → `CheckCircleSolid`
- RENDERS → `ClipboardDocumentIcon`
- RENDERS → `XMarkIcon`
- RENDERS → `PencilSquareIcon`
- RENDERS → `StatusJourney`
- RENDERS → `Section`
- RENDERS → `Row`
- RENDERS → `ChevronDownIcon`
- RENDERS → `CheckIcon`
- RENDERS → `UserCircleIcon`
- RENDERS → `MagnifyingGlassIcon`
- RENDERS → `ArrowTopRightOnSquareIcon`
- RENDERS → `ActivityRow`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-pricingplan-2.md -->

# PricingPlan

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/pricing/pricing-hero-card.tsx` (line 17)

## Properties

| Property | Type |
|---|---|
| `nameKey` | `string` |
| `priceKey` | `string` |
| `intervalKey` | `string` |
| `descriptionKey` | `string` |
| `features` | `PricingFeature[]` |
| `ctaKey` | `string` |
| `ctaUrl` | `string` |

<!-- source: api-endpoint-search-2.md -->

# search

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/search.controller.ts` (line 44)

Search documentation

GET /search?q=query&type=workflow&category=sales&projectId=123

Query Parameters:
- q (required): Search query
- type: Document type filter (workflow, feature, tutorial)
- category: Category filter
- difficulty: Difficulty filter (beginner, intermediate, advanced)
- projectId: Filter to specific project (default: all projects in user's organization)
- limit: Max results (default: 20)
- offset: Pagination offset (default: 0)
- includeFacets: Include facet counts (default: true)

## Endpoint

`GET /search`

| Parameter | In | Type | Required |
|---|---|---|---|
| `q` | query | `string` | ✓ |
| `type` | query | `'workflow' | 'feature' | 'tutorial'` | - |
| `category` | query | `string` | - |
| `difficulty` | query | `'beginner' | 'intermediate' | 'advanced'` | - |
| `projectId` | query | `string` | - |
| `limit` | query | `string` | - |
| `offset` | query | `string` | - |
| `includeFacets` | query | `string` | - |

## Referenced By

- `SearchController` (MODULE_DECLARES)

<!-- source: component-issueslistpage.md -->

# IssuesListPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/issues/page.tsx` (line 581)

## Diagram

```mermaid
graph TD
    component_IssuesListPage_52341a28["IssuesListPage"]
    class component_IssuesListPage_52341a28 rootComponent
```

## Relationships

- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `ChartBarSquareIcon`
- RENDERS → `ListBulletIcon`
- RENDERS → `ViewColumnsIcon`
- RENDERS → `ArrowPathIcon`
- RENDERS → `MetricCard`
- RENDERS → `InboxIcon`
- RENDERS → `TicketIcon`
- RENDERS → `BoltIcon`
- RENDERS → `CheckCircleIcon`
- RENDERS → `FireIcon`
- RENDERS → `ClockIcon`
- RENDERS → `Card`
- RENDERS → `IssueTrendChart`
- RENDERS → `PriorityGauge`
- RENDERS → `DailyBarChart`
- RENDERS → `ArrowTopRightOnSquareIcon`
- RENDERS → `RecentTickets`
- RENDERS → `DonutChart`
- RENDERS → `StatusOverview`
- RENDERS → `ResolutionTimeChart`
- RENDERS → `HorizontalBarChart`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`
- USES_HOOK → `useMemo`

<!-- source: interface-pricingtiercardprops-2.md -->

# PricingTierCardProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/pricing-tier-card.tsx` (line 18)

## Properties

| Property | Type |
|---|---|
| `nameKey` | `string` |
| `priceKey` | `string` |
| `intervalKey` | `string` |
| `descriptionKey` | `string` |
| `features` | `PricingFeature[]` |
| `ctaKey` | `string` |
| `ctaUrl` | `string` |
| `highlighted` | `boolean` |
| `badgeKey` | `string` |

<!-- source: api-endpoint-search-3.md -->

# search

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/graph.controller.ts` (line 123)

## Endpoint

`GET /knowledge-graph/search`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `q` | query | `string` | ✓ |
| `type` | query | `string` | - |

## Referenced By

- `GraphController` (MODULE_DECLARES)

<!-- source: component-issuesviewtabs.md -->

# IssuesViewTabs

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Issues/IssuesViewTabs.tsx` (line 44)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `rightSlot` | `unknown` | - | - |
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_IssuesViewTabs_27fd783["IssuesViewTabs"]
    class component_IssuesViewTabs_27fd783 rootComponent
```

## Relationships

- RENDERS → `Icon`
- USES_HOOK → `usePathname`
- USES_HOOK → `useRouter`

<!-- source: interface-problemsplitvisualprops-2.md -->

# ProblemSplitVisualProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/problem/problem-split-visual.tsx` (line 19)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `problems` | `Problem[]` |
| `imageSrc` | `string` |
| `imageAlt` | `string` |
| `imagePosition` | `'start' | 'end'` |

<!-- source: api-endpoint-search-4.md -->

# search

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.controller.ts` (line 81)

GET /support-agent/:projectId/search?q=...

Scoped RAG search for the support agent. Returns relevant documents
from the types enabled in the agent config, scoped to this project
and organization.

## Endpoint

`GET /support-agent/:projectId/search`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `q` | query | `string` | ✓ |
| `limit` | query | `string` | - |

## Referenced By

- `SupportAgentController` (MODULE_DECLARES)

<!-- source: component-jobhistory.md -->

# JobHistory

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/DocAutomation/JobHistory.tsx` (line 426)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `jobs` | `DocumentationJobEntry[]` | ✓ | - |
| `loading` | `boolean` | ✓ | - |
| `error` | `Error | null` | ✓ | - |
| `liveProgress` | `Record` | ✓ | - |
| `projectId` | `string` | ✓ | - |
| `onRegenerate` | `Function` | - | - |
| `onCancelJob` | `Function` | - | - |
| `onDeleteJobDocuments` | `Function` | - | - |
| `onRefresh` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_JobHistory_156a1910["JobHistory"]
    class component_JobHistory_156a1910 rootComponent
```

## Relationships

- RENDERS → `History`
- RENDERS → `RefreshCw`
- RENDERS → `Loader2`
- RENDERS → `JobRow`

<!-- source: interface-progressstats.md -->

# ProgressStats

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/utils/progress-tracker.ts` (line 10)

## Properties

| Property | Type |
|---|---|
| `totalItems` | `number` |
| `completedItems` | `number` |
| `currentBatch` | `number` |
| `totalBatches` | `number` |
| `avgTimePerItem` | `number` |
| `avgTimePerItemFormatted` | `string` |
| `estimatedRemainingMs` | `number` |
| `estimatedRemainingFormatted` | `string` |
| `etaFormatted` | `string` |
| `elapsedMs` | `number` |
| `elapsedFormatted` | `string` |
| `percentComplete` | `number` |
| `progressPercent` | `number` |

<!-- source: api-endpoint-selectvariant.md -->

# selectVariant

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/pme/pme.controller.ts` (line 87)

## Endpoint

`PATCH /pme/variants/:variantId/select`

| Parameter | In | Type | Required |
|---|---|---|---|
| `variantId` | query | `string` | ✓ |

## Referenced By

- `PmeController` (MODULE_DECLARES)

<!-- source: component-languageprovider.md -->

# LanguageProvider

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/LanguageContext.tsx` (line 54)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |
| `slugId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_LanguageProvider_6b75a88a["LanguageProvider"]
    class component_LanguageProvider_6b75a88a rootComponent
```

## Relationships

- RENDERS → `LanguageContext-Provider`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-project.md -->

# Project

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/projects.ts` (line 11)

Project model for API responses

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `organizationId` | `string` |
| `themeId` | `string` |
| `repoUrl` | `string` |
| `repoBranch` | `string` |
| `createdAt` | `string` |
| `updatedAt` | `string` |

<!-- source: api-endpoint-set.md -->

# set

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/change-request/docs-config.controller.ts` (line 36)

## Endpoint

`PATCH /projects/:projectId/docs-config`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocsConfigController` (MODULE_DECLARES)

<!-- source: component-languagespage.md -->

# LanguagesPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/languages/page.tsx` (line 454)

## Diagram

```mermaid
graph TD
    component_LanguagesPage_67dc41cc["LanguagesPage"]
    class component_LanguagesPage_67dc41cc rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `motion-div`
- RENDERS → `motion-h1`
- RENDERS → `motion-p`
- RENDERS → `Reveal`
- RENDERS → `ParserCard`
- RENDERS → `React-Fragment`

<!-- source: interface-projectcardprops.md -->

# ProjectCardProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/components/ProjectCard.tsx` (line 9)

Props for ProjectCard component

## Properties

| Property | Type |
|---|---|
| `project` | `Project` |
| `onClick` | `(project: Project) => void` |
| `showDescription` | `boolean` |
| `showMenu` | `boolean` |
| `onDelete` | `(project: Project) => void` |

<!-- source: api-endpoint-setapitarget.md -->

# setApiTarget

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 376)

## Endpoint

`PUT /technical-docs/:projectId/api-target`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: component-languageswitcher.md -->

# LanguageSwitcher

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/LanguageSwitcher.tsx` (line 14)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `dark` | `boolean` | - | - |

## Diagram

```mermaid
graph TD
    component_LanguageSwitcher_61645552["LanguageSwitcher"]
    class component_LanguageSwitcher_61645552 rootComponent
```

## Relationships

- RENDERS → `Globe`
- RENDERS → `ChevronDown`
- RENDERS → `Check`
- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-projectcomplexity.md -->

# ProjectComplexity

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-05.types.ts` (line 84)

Project complexity assessment for adaptive documentation generation.
Determines document count targets and category depth based on project characteristics.

## Properties

| Property | Type |
|---|---|
| `level` | `'simple' | 'medium' | 'complex' | 'enterprise'` |
| `score` | `number` |
| `factors` | `{
    featureCount: number;
    personaCount: number;
    chunkCount: number; // From stage 4 analyses
    topicCount: number; // Aggregated suggested topics
    avgComplexity: number; // Average chunk complexity score (1-3)
  }` |
| `recommendations` | `{
    targetDocuments: { min: number; max: number };
    categoryDepth: 1 | 2 | 3;
    topLevelCategories: { min: number; max: number };
  }` |

<!-- source: api-endpoint-setconfig.md -->

# setConfig

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/docs-pr/docs-pr.controller.ts` (line 41)

## Endpoint

`PUT /docs-pr/:projectId/config`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocsPrController` (MODULE_DECLARES)

<!-- source: component-layout.md -->

# Layout

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/layout.tsx` (line 9)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Layout_603a2683["Layout"]
    class component_Layout_603a2683 rootComponent
```

## Relationships

- RENDERS → `EmailVerificationBanner`
- RENDERS → `DashboardLayout`

<!-- source: interface-projectlistparams.md -->

# ProjectListParams

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/projects.ts` (line 27)

Project list query parameters

## Properties

| Property | Type |
|---|---|
| `organizationId` | `string` |
| `search` | `string` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: api-endpoint-setconnectorenabled.md -->

# setConnectorEnabled

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 291)

## Endpoint

`PUT /technical-docs/:projectId/connectors/:id/enabled`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: component-lightbox.md -->

# Lightbox

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/Lightbox.tsx` (line 40)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onClose` | `Function` | ✓ | - |
| `label` | `string` | ✓ | - |
| `closeLabel` | `string` | ✓ | - |
| `caption` | `string | null` | - | - |
| `dir` | `unknown | unknown` | - | "ltr" |
| `returnFocusRef` | `unknown` | - | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Lightbox_5b913125["Lightbox"]
    class component_Lightbox_5b913125 rootComponent
```

## Relationships

- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-publishdocumentdto.md -->

# PublishDocumentDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/document.dto.ts` (line 48)

DTO for publishing a document

## Properties

| Property | Type |
|---|---|
| `state` | `DocumentState.PUBLISHED` |
| `isPublic` | `boolean` |
| `updatedById` | `string` |

<!-- source: api-endpoint-setcuration.md -->

# setCuration

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 180)

## Endpoint

`PUT /technical-docs/:projectId/curation`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: component-loadingstate.md -->

# LoadingState

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Templates/TemplateGallery.tsx` (line 143)

Loading state component

## Diagram

```mermaid
graph TD
    component_LoadingState_38c1466b["LoadingState"]
    class component_LoadingState_38c1466b rootComponent
```

## Relationships

- RENDERS → `Loader2`

<!-- source: interface-publishedprojectresponse-2.md -->

# PublishedProjectResponse

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/project.dto.ts` (line 36)

Response after publishing a project

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `slug` | `string` |
| `urlId` | `string` |
| `publishedSlug` | `string` |
| `publicUrl` | `string` |
| `publishedAt` | `Date` |
| `isPublic` | `boolean` |

<!-- source: api-endpoint-setescalation.md -->

# setEscalation

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 338)

## Endpoint

`PUT /technical-docs/:projectId/escalation`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: component-loginpage.md -->

# LoginPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(auth)/login/page.tsx` (line 12)

## Diagram

```mermaid
graph TD
    component_LoginPage_502dfa92["LoginPage"]
    class component_LoginPage_502dfa92 rootComponent
```

## Relationships

- RENDERS → `motion-div-9cf15`
- RENDERS → `motion-h1`
- RENDERS → `motion-button`
- RENDERS → `Link`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`

<!-- source: interface-publishprojectdto.md -->

# PublishProjectDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/project.dto.ts` (line 29)

DTO for publishing a project

## Properties

| Property | Type |
|---|---|
| `isPublic` | `boolean` |

<!-- source: api-endpoint-setplaygroundtestkey.md -->

# setPlaygroundTestKey

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 356)

## Endpoint

`PUT /technical-docs/:projectId/playground/test-key`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: component-manualfreshnessbadge.md -->

# ManualFreshnessBadge

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/ManualFreshnessBadge.tsx` (line 19)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `slug` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ManualFreshnessBadge_41f0c858["ManualFreshnessBadge"]
    class component_ManualFreshnessBadge_41f0c858 rootComponent
```

## Relationships

- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-pydanticfield.md -->

# PydanticField

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/fastapi-detector.ts` (line 59)

Pydantic field

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `required` | `boolean` |
| `default` | `string` |
| `description` | `string` |

<!-- source: api-endpoint-setsubdomain.md -->

# setSubdomain

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 348)

## Endpoint

`PATCH /projects/:id/subdomain`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: component-manualinsightspanel.md -->

# ManualInsightsPanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/ops/ManualInsightsPanel.tsx` (line 31)

## Diagram

```mermaid
graph TD
    component_ManualInsightsPanel_53af0050["ManualInsightsPanel"]
    class component_ManualInsightsPanel_53af0050 rootComponent
```

## Relationships

- RENDERS → `DraftLink`
- USES_HOOK → `useSession`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-qualitygateconfig.md -->

# QualityGateConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/quality-gate.ts` (line 30)

## Properties

| Property | Type |
|---|---|
| `maxRegenAttempts` | `number` |
| `regenBatchSize` | `number` |
| `enabled` | `boolean` |

<!-- source: api-endpoint-stale.md -->

# stale

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/freshness.controller.ts` (line 19)

## Endpoint

`GET /freshness/:projectId/stale`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `FreshnessController` (MODULE_DECLARES)

<!-- source: component-manualsbenchmarkpage.md -->

# ManualsBenchmarkPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/manuals-benchmark/page.tsx` (line 66)

## Diagram

```mermaid
graph TD
    component_ManualsBenchmarkPage_41c079a1["ManualsBenchmarkPage"]
    class component_ManualsBenchmarkPage_41c079a1 rootComponent
```

<!-- source: interface-qualitygateresult.md -->

# QualityGateResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/quality-gate.ts` (line 36)

## Properties

| Property | Type |
|---|---|
| `documents` | `GeneratedDocument[]` |
| `scores` | `QualityScore[]` |
| `regenScores` | `QualityScore[]` |
| `tokenUsage` | `TokenUsage[]` |
| `stats` | `{
    total: number;
    passed: number;
    failed: number;
    regenerated: number;
    improvedAfterRegen: number;
  }` |

<!-- source: api-endpoint-startfullsync.md -->

# startFullSync

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/sync.controller.ts` (line 111)

## Endpoint

`POST /projects/sync/full`

## Referenced By

- `SyncController` (MODULE_DECLARES)

<!-- source: component-markdowneditor.md -->

# MarkdownEditor

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/MarkdownEditor.tsx` (line 12)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `content` | `string` | ✓ | - |
| `onChange` | `Function` | ✓ | - |
| `editable` | `boolean` | - | true |

## Diagram

```mermaid
graph TD
    component_MarkdownEditor_7b2c1152["MarkdownEditor"]
    class component_MarkdownEditor_7b2c1152 rootComponent
```

## Relationships

- RENDERS → `Editor`
- USES_HOOK → `useRef`

<!-- source: interface-qualityscore.md -->

# QualityScore

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/quality-scorer.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `title` | `string` |
| `overall` | `number` |
| `dimensions` | `{
    domainSpecificity: number;   // 0.35 weight
    contentDepth: number;        // 0.25 weight
    sectionCompleteness: number; // 0.25 weight
    entityCoverage: number;      // 0.15 weight
  }` |
| `passesThreshold` | `boolean` |
| `failureReasons` | `string[]` |
| `suggestions` | `string[]` |

<!-- source: api-endpoint-startjob.md -->

# startJob

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 129)

## Endpoint

`POST /doc-automation/jobs`

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: component-markdownrenderer.md -->

# MarkdownRenderer

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MarkdownRenderer.tsx` (line 279)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `content` | `string` | ✓ | - |
| `capturedScreenshots` | `Record` | - | - |
| `screenshotPlaceholders` | `Record` | - | - |
| `projectSlugId` | `string` | - | - |
| `audienceSlug` | `string` | - | - |
| `documentSlugs` | `string[]` | - | - |
| `categorySlugs` | `Record` | - | - |
| `documentTitle` | `string` | - | - |
| `lang` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_MarkdownRenderer_14b499eb["MarkdownRenderer"]
    class component_MarkdownRenderer_14b499eb rootComponent
```

## Relationships

- RENDERS → `ReactMarkdown`
- RENDERS → `CustomImage`

<!-- source: interface-ratelimiterconfig.md -->

# RateLimiterConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/rate-limiter.ts` (line 10)

## Properties

| Property | Type |
|---|---|
| `maxConcurrent` | `number` |
| `minDelayMs` | `number` |

<!-- source: api-endpoint-startjob-2.md -->

# startJob

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 43)

Trigger a technical docs generation job for a project.
Uses the project's stored repoUrl. Runs async — returns immediately with status.

## Endpoint

`POST /technical-docs/:projectId/jobs`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: component-marketinglayout.md -->

# MarketingLayout

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/layout.tsx` (line 15)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_MarketingLayout_7ec31db9["MarketingLayout"]
    class component_MarketingLayout_7ec31db9 rootComponent
```

## Relationships

- RENDERS → `Link`

<!-- source: interface-realmplugin.md -->

# RealmPlugin

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/RealmWithPlugins.tsx` (line 9)

A plugin for the editor.

## Properties

| Property | Type |
|---|---|
| `init` | `(realm: Realm) => void` |
| `update` | `(realm: Realm) => void` |
| `postInit` | `(realm: Realm) => void` |

<!-- source: api-endpoint-startstrategy.md -->

# startStrategy

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/pme/pme.controller.ts` (line 102)

## Endpoint

`POST /pme/strategy`

## Referenced By

- `PmeController` (MODULE_DECLARES)

<!-- source: component-mcpinstallblock.md -->

# McpInstallBlock

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/McpInstallBlock.tsx` (line 111)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `mcpUrl` | `string` | ✓ | - |
| `serverName` | `string` | - | "atloria-docs" |
| `authToken` | `string` | - | - |
| `variant` | `unknown | unknown | unknown` | - | "inline" |

## Diagram

```mermaid
graph TD
    component_McpInstallBlock_34beb58c["McpInstallBlock"]
    class component_McpInstallBlock_34beb58c rootComponent
```

## Relationships

- USES_HOOK → `useState`

<!-- source: interface-registerdto.md -->

# RegisterDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/auth.ts` (line 14)

## Properties

| Property | Type |
|---|---|
| `email` | `string` |
| `password` | `string` |
| `name` | `string` |

<!-- source: api-endpoint-status.md -->

# status

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/trial/trial.controller.ts` (line 28)

## Endpoint

`GET /trial/:projectId/status`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TrialController` (MODULE_DECLARES)

<!-- source: component-mdxrenderer.md -->

# MDXRenderer

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/MDXRenderer.tsx` (line 36)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `content` | `string` | ✓ | - |
| `capturedScreenshots` | `Record` | - | - |

## Diagram

```mermaid
graph TD
    component_MDXRenderer_626cfb7b["MDXRenderer"]
    class component_MDXRenderer_626cfb7b rootComponent
```

## Relationships

- RENDERS → `MDXContent`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-renderoptions.md -->

# RenderOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/audience-renderer.ts` (line 23)

Render options

## Properties

| Property | Type |
|---|---|
| `viewerAudiences` | `string[]` |
| `expandIncludes` | `boolean` |
| `stripDirectives` | `boolean` |
| `maxIncludeDepth` | `number` |

<!-- source: api-endpoint-stream.md -->

# stream

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs-chat.controller.ts` (line 65)

## Endpoint

`POST /technical-docs/:projectId/chat/stream`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsChatController` (MODULE_DECLARES)

<!-- source: component-messagelist.md -->

# MessageList

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/MessageList.tsx` (line 27)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `messages` | `Message[]` | ✓ | - |
| `isLoading` | `boolean` | - | - |

## Diagram

```mermaid
graph TD
    component_MessageList_3afe25["MessageList"]
    class component_MessageList_3afe25 rootComponent
```

## Relationships

- RENDERS → `EmptyState`
- RENDERS → `ChatMessage`
- RENDERS → `LoadingSpinner`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-reordercategoriesdto.md -->

# ReorderCategoriesDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/category.dto.ts` (line 43)

DTO for reordering categories

## Properties

| Property | Type |
|---|---|
| `categoryIds` | `string[]` |

<!-- source: api-endpoint-submitfeedback.md -->

# submitFeedback

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 184)

## Endpoint

`POST /analytics/feedback`

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: component-metriccard.md -->

# MetricCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/MetricCard.tsx` (line 41)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `label` | `string` | ✓ | - |
| `value` | `number | null | undefined` | ✓ | - |
| `previousValue` | `number | null` | - | - |
| `format` | `unknown | unknown | unknown` | - | "number" |
| `trend` | `number[]` | - | - |
| `icon` | `unknown` | - | - |
| `accent` | `string` | - | unknown |
| `onClick` | `Function` | - | - |
| `loading` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_MetricCard_622499c5["MetricCard"]
    class component_MetricCard_622499c5 rootComponent
```

## Relationships

- RENDERS → `ArrowUpIcon`
- RENDERS → `ArrowDownIcon`
- RENDERS → `MinusIcon`
- RENDERS → `ResponsiveContainer`
- RENDERS → `AreaChart`
- RENDERS → `Area`

<!-- source: interface-replacementconfig.md -->

# ReplacementConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 302)

Replacement configuration

## Properties

| Property | Type |
|---|---|
| `format` | `ReplacementFormat` |
| `imageBaseUrl` | `string` |
| `addAltText` | `boolean` |
| `addCaption` | `boolean` |
| `wrapInFigure` | `boolean` |

<!-- source: api-endpoint-summarize.md -->

# summarize

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/ai/ai.controller.ts` (line 149)

## Endpoint

`POST /ai/summarize`

## Referenced By

- `AIController` (MODULE_DECLARES)

<!-- source: component-modal.md -->

# Modal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Boards/Modal.tsx` (line 19)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `open` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `title` | `string` | ✓ | - |
| `subtitle` | `string` | - | - |
| `children` | `unknown` | ✓ | - |
| `footer` | `unknown` | - | - |
| `maxWidth` | `number` | - | 520 |

## Diagram

```mermaid
graph TD
    component_Modal_6532d240["Modal"]
    class component_Modal_6532d240 rootComponent
```

## Relationships

- RENDERS → `XMarkIcon`
- USES_HOOK → `useEffect`

<!-- source: interface-replacementprogress.md -->

# ReplacementProgress

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-replacer.service.ts` (line 34)

Progress callback for replacement operations

## Properties

| Property | Type |
|---|---|
| `completed` | `number` |
| `total` | `number` |
| `currentDocument` | `string` |

<!-- source: api-endpoint-summary.md -->

# summary

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/billing/billing.controller.ts` (line 49)

## Endpoint

`GET /billing/summary`

## Referenced By

- `BillingController` (MODULE_DECLARES)

<!-- source: component-navbar.md -->

# Navbar

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Layout/Navbar.tsx` (line 42)

## Diagram

```mermaid
graph TD
    component_Navbar_a0423c7["Navbar"]
    class component_Navbar_a0423c7 rootComponent
```

## Relationships

- RENDERS → `motion-nav`
- RENDERS → `Link`
- RENDERS → `Breadcrumbs`
- RENDERS → `ProjectDropdown`
- RENDERS → `VersionDropdown`
- RENDERS → `motion-button`
- RENDERS → `MagnifyingGlassIcon`
- RENDERS → `BellIcon`
- RENDERS → `ThemeToggle`
- USES_HOOK → `useSession`
- USES_HOOK → `useProjectContext`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-replacementstats.md -->

# ReplacementStats

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-replacer.service.ts` (line 45)

Replacement statistics

## Properties

| Property | Type |
|---|---|
| `documentsProcessed` | `number` |
| `totalReplacements` | `number` |
| `successfulReplacements` | `number` |
| `failedReplacements` | `number` |
| `skippedPlaceholders` | `number` |

<!-- source: api-endpoint-syncconnector.md -->

# syncConnector

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/technical-docs/technical-docs.controller.ts` (line 279)

## Endpoint

`POST /technical-docs/:projectId/connectors/:id/sync`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `TechnicalDocsController` (MODULE_DECLARES)

<!-- source: component-newcommentform.md -->

# NewCommentForm

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Comments/NewCommentForm.tsx` (line 14)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `documentId` | `string` | ✓ | - |
| `onSubmit` | `Function` | ✓ | - |
| `placeholder` | `string` | - | "Add a comment..." |

## Diagram

```mermaid
graph TD
    component_NewCommentForm_13199295["NewCommentForm"]
    class component_NewCommentForm_13199295 rootComponent
```

## Relationships

- RENDERS → `Send`
- USES_HOOK → `useState`

<!-- source: interface-requestbody.md -->

# RequestBody

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/EndpointDetail.ts` (line 31)

## Properties

| Property | Type |
|---|---|
| `description` | `string` |
| `required` | `boolean` |
| `content` | `Record<string, { schema?: Schema; example?: any }>` |

<!-- source: api-endpoint-syncdocuments.md -->

# syncDocuments

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/sync.controller.ts` (line 45)

## Endpoint

`POST /projects/:projectId/documents/sync`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `SyncController` (MODULE_DECLARES)

<!-- source: component-newdocumentpage.md -->

# NewDocumentPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/documents/new/page.tsx` (line 25)

## Diagram

```mermaid
graph TD
    component_NewDocumentPage_11ba364c["NewDocumentPage"]
    class component_NewDocumentPage_11ba364c rootComponent
```

## Relationships

- RENDERS → `Button`
- RENDERS → `PenLine`
- RENDERS → `TemplateGallery`
- RENDERS → `ArrowLeft`
- RENDERS → `FileText`
- USES_HOOK → `useRouter`
- USES_HOOK → `useSearchParams`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useProjects`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-requestbody-2.md -->

# RequestBody

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/RequestPanel.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `content` | `Record<string, { schema?: any; example?: any }>` |

<!-- source: api-endpoint-syncentities.md -->

# syncEntities

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/kg-sync.controller.ts` (line 138)

Bulk sync entities

## Endpoint

`POST /projects/:projectId/entities/sync`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `KgSyncController` (MODULE_DECLARES)

<!-- source: component-newprojectpage.md -->

# NewProjectPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/new/page.tsx` (line 13)

## Diagram

```mermaid
graph TD
    component_NewProjectPage_13d75a88["NewProjectPage"]
    class component_NewProjectPage_13d75a88 rootComponent
```

## Relationships

- RENDERS → `NewProjectWizard`
- USES_HOOK → `useProjectContext`
- USES_HOOK → `useEffect`

<!-- source: interface-requestconfig.md -->

# RequestConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/types/config.ts` (line 58)

Request configuration for individual API calls

## Properties

| Property | Type |
|---|---|
| `method` | `'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'` |
| `path` | `string` |
| `params` | `Record<string, string | number | boolean | undefined>` |
| `body` | `unknown` |
| `headers` | `Record<string, string>` |
| `signal` | `AbortSignal` |
| `skipRetry` | `boolean` |
| `skipAuth` | `boolean` |

<!-- source: api-endpoint-syncentities-2.md -->

# syncEntities

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/sync.controller.ts` (line 196)

## Endpoint

`POST /projects/:projectId/entities/sync`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `SyncController` (MODULE_DECLARES)

<!-- source: component-newprojectwizard.md -->

# NewProjectWizard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/NewProjectWizard.tsx` (line 23)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onComplete` | `Function` | - | - |
| `compact` | `boolean` | - | - |

## Diagram

```mermaid
graph TD
    component_NewProjectWizard_3328f9a7["NewProjectWizard"]
    class component_NewProjectWizard_3328f9a7 rootComponent
```

## Relationships

- RENDERS → `StepIndicator`
- RENDERS → `AnimatePresence`
- RENDERS → `SceneUrlInput`
- RENDERS → `SceneProjectDetails`
- RENDERS → `SceneBrowseRepos`
- RENDERS → `SceneDocTypes`
- RENDERS → `SceneGeneration`
- RENDERS → `SceneConnectProvider`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useNewProjectWizard`
- USES_HOOK → `useEffect`

<!-- source: interface-requestdata.md -->

# RequestData

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/RequestPanel.ts` (line 35)

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `method` | `string` |
| `headers` | `Record<string, string>` |
| `queryParams` | `Record<string, string>` |
| `pathParams` | `Record<string, string>` |
| `body` | `string` |

<!-- source: api-endpoint-syncrelationships.md -->

# syncRelationships

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/graph/kg-sync.controller.ts` (line 290)

Bulk sync relationships

## Endpoint

`POST /projects/:projectId/relationships/sync`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `KgSyncController` (MODULE_DECLARES)

<!-- source: component-notfound.md -->

# NotFound

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/not-found.tsx` (line 3)

## Diagram

```mermaid
graph TD
    component_NotFound_1039b42e["NotFound"]
    class component_NotFound_1039b42e rootComponent
```

## Relationships

- RENDERS → `Link`

<!-- source: interface-requiredstate.md -->

# RequiredState

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/screenshot-spec.types.ts` (line 33)

Required application state to capture this screenshot

## Properties

| Property | Type |
|---|---|
| `workflowStage` | `string` |
| `role` | `string` |
| `permission` | `string` |
| `dataCondition` | `string` |
| `resolution` | `StateResolutionHint` |

<!-- source: api-endpoint-syncrelationships-2.md -->

# syncRelationships

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/sync.controller.ts` (line 316)

## Endpoint

`POST /projects/:projectId/relationships/sync`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `SyncController` (MODULE_DECLARES)

<!-- source: component-opengraphimage.md -->

# OpenGraphImage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/opengraph-image.tsx` (line 12)

## Diagram

```mermaid
graph TD
    component_OpenGraphImage_581c30c4["OpenGraphImage"]
    class component_OpenGraphImage_581c30c4 rootComponent
```

<!-- source: interface-resolvechangerequestdto.md -->

# ResolveChangeRequestDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/change-requests.ts` (line 108)

Payload for resolving one conflicted file of a change request

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `resolvedContent` | `string` |

<!-- source: api-endpoint-testconnection.md -->

# testConnection

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/parsing/test-connection.controller.ts` (line 32)

## Endpoint

`POST /git/test-connection`

## Referenced By

- `TestConnectionController` (MODULE_DECLARES)

<!-- source: component-opspage.md -->

# OpsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/ops/page.tsx` (line 13)

## Diagram

```mermaid
graph TD
    component_OpsPage_5b7d60c["OpsPage"]
    class component_OpsPage_5b7d60c rootComponent
```

## Relationships

- RENDERS → `Stat`
- RENDERS → `ManualInsightsPanel`
- USES_HOOK → `useSession`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-response.md -->

# Response

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/EndpointDetail.ts` (line 37)

## Properties

| Property | Type |
|---|---|
| `description` | `string` |
| `content` | `Record<string, { schema?: Schema; example?: any }>` |

<!-- source: api-endpoint-tickettopics.md -->

# ticketTopics

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/manuals-insights/manuals-insights.controller.ts` (line 41)

## Endpoint

`GET /manuals-insights/:projectId/ticket-topics`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `ManualsInsightsController` (MODULE_DECLARES)

<!-- source: component-organizationsettingspage.md -->

# OrganizationSettingsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/organization/page.tsx` (line 34)

## Diagram

```mermaid
graph TD
    component_OrganizationSettingsPage_ca1d90d["OrganizationSettingsPage"]
    class component_OrganizationSettingsPage_ca1d90d rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `UserGroupIcon`
- RENDERS → `Card`
- RENDERS → `CardHeader`
- RENDERS → `CardContent`
- RENDERS → `EnvelopeIcon`
- USES_HOOK → `useSession`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-restructureresult.md -->

# RestructureResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-14-meta/generators/category-restructure.ts` (line 39)

## Properties

| Property | Type |
|---|---|
| `categories` | `DocumentCategoryStructure[]` |
| `documents` | `PlannedDocument[]` |
| `adminDocIds` | `Set<string>` |
| `categoriesMoved` | `number` |

<!-- source: api-endpoint-togglesaml.md -->

# toggleSaml

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/saml/saml.controller.ts` (line 108)

Enable/disable SAML

## Endpoint

`POST /auth/saml/:orgId/toggle`

| Parameter | In | Type | Required |
|---|---|---|---|
| `orgId` | query | `string` | ✓ |

## Referenced By

- `SamlController` (MODULE_DECLARES)

<!-- source: component-outofcredits.md -->

# OutOfCredits

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/common/OutOfCredits.tsx` (line 10)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `message` | `string` | - | - |
| `compact` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_OutOfCredits_100c002["OutOfCredits"]
    class component_OutOfCredits_100c002 rootComponent
```

## Relationships

- RENDERS → `Link`

<!-- source: interface-retrievedcontext.md -->

# RetrievedContext

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-10.types.ts` (line 19)

Context retrieved from earlier pipeline stages for a specific document.
Built by ContextRetriever (Phase 2) using the StageResultStore.

## Properties

| Property | Type |
|---|---|
| `primaryChunkAnalysis` | `ChunkAnalysis` |
| `relatedChunkAnalyses` | `ChunkAnalysis[]` |
| `features` | `UserFeature[]` |
| `contextSummary` | `string` |

<!-- source: api-endpoint-track.md -->

# track

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/analytics.controller.ts` (line 17)

## Endpoint

`POST /analytics/track`

## Referenced By

- `AnalyticsController` (MODULE_DECLARES)

<!-- source: component-overviewtab.md -->

# OverviewTab

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/dashboard/OverviewTab.tsx` (line 21)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `project` | `any` | ✓ | - |
| `documentCount` | `number` | ✓ | - |
| `categoryCount` | `number` | ✓ | - |
| `lastGeneratedAt` | `string | null` | ✓ | - |
| `recentDocuments` | `any[]` | ✓ | - |
| `jobs` | `any[]` | ✓ | - |
| `onGenerate` | `Function` | ✓ | - |
| `onNavigateSettings` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_OverviewTab_6d674d18["OverviewTab"]
    class component_OverviewTab_6d674d18 rootComponent
```

## Relationships

- RENDERS → `StatsRow`
- RENDERS → `RecentDocuments`
- RENDERS → `GenerationHistory`
- RENDERS → `QuickActions`
- RENDERS → `RepositoryInfo`
- RENDERS → `TeamActivity`

<!-- source: interface-retryconfig-3.md -->

# RetryConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/providers/retry.ts` (line 10)

## Properties

| Property | Type |
|---|---|
| `maxRetries` | `number` |
| `baseDelayMs` | `number` |
| `maxDelayMs` | `number` |
| `retryableErrors` | `string[]` |

<!-- source: api-endpoint-traffic.md -->

# traffic

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/events/agent-analytics.controller.ts` (line 17)

## Endpoint

`GET /agent-analytics/:projectId/traffic`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `days` | query | `string` | - |

## Referenced By

- `AgentAnalyticsController` (MODULE_DECLARES)

<!-- source: component-pagination.md -->

# Pagination

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/enterprise/screenshots/Pagination.tsx` (line 9)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `currentPage` | `number` | ✓ | - |
| `totalPages` | `number` | ✓ | - |
| `totalItems` | `number` | ✓ | - |
| `pageSize` | `number` | ✓ | - |
| `onPageChange` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Pagination_642a4f8f["Pagination"]
    class component_Pagination_642a4f8f rootComponent
```

<!-- source: interface-retryoptions.md -->

# RetryOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/utils/retry.ts` (line 6)

Options for retry logic

## Properties

| Property | Type |
|---|---|
| `maxRetries` | `number` |
| `baseDelay` | `number` |
| `maxDelay` | `number` |
| `shouldRetry` | `(error: Error, attempt: number) => boolean` |
| `onRetry` | `(error: Error, attempt: number, delay: number) => void` |

<!-- source: api-endpoint-transition.md -->

# transition

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/desk.controller.ts` (line 72)

## Endpoint

`POST /desk/:projectId/threads/:id/transition`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `DeskController` (MODULE_DECLARES)

<!-- source: component-pagination-2.md -->

# Pagination

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Documents/Pagination.tsx` (line 9)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `currentPage` | `number` | ✓ | - |
| `totalPages` | `number` | ✓ | - |
| `onPageChange` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Pagination_1dabc9f3["Pagination"]
    class component_Pagination_1dabc9f3 rootComponent
```

<!-- source: interface-reviewresult-2.md -->

# ReviewResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/openai-reviewer.service.ts` (line 37)

## Properties

| Property | Type |
|---|---|
| `overallScore` | `number` |
| `categories` | `{
    accuracy: number;
    completeness: number;
    clarity: number;
    userFriendliness: number;
  }` |
| `suggestions` | `string[]` |
| `issues` | `string[]` |

<!-- source: api-endpoint-triggerscreenshots.md -->

# triggerScreenshots

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 260)

## Endpoint

`POST /doc-automation/jobs/:id/screenshots`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: component-parserpage.md -->

# ParserPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/parser/page.tsx` (line 11)

## Diagram

```mermaid
graph TD
    component_ParserPage_1c3ca46["ParserPage"]
    class component_ParserPage_1c3ca46 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `CodeBracketIcon`
- RENDERS → `Card`
- RENDERS → `CardHeader`
- RENDERS → `CardContent`

<!-- source: interface-routeinteractionmap.md -->

# RouteInteractionMap

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 214)

Complete interaction map for a single route

## Properties

| Property | Type |
|---|---|
| `route` | `string` |
| `componentName` | `string` |
| `sourceFile` | `string` |
| `templateFile` | `string` |
| `modals` | `ModalDefinition[]` |
| `tabs` | `TabDefinition[]` |
| `forms` | `FormDefinition[]` |
| `workflowStates` | `WorkflowStateDefinition[]` |
| `permissions` | `PermissionCheck[]` |

<!-- source: api-endpoint-unpublish.md -->

# unpublish

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 412)

## Endpoint

`POST /documents/:id/unpublish`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: component-parsingresults.md -->

# ParsingResults

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/ParsingResults.tsx` (line 22)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `result` | `ParseResult` | ✓ | - |
| `code` | `string` | ✓ | - |
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_ParsingResults_746c7c70["ParsingResults"]
    class component_ParsingResults_746c7c70 rootComponent
```

## Relationships

- RENDERS → `TabButton`
- RENDERS → `SymbolList`
- RENDERS → `DependencyGraph`
- RENDERS → `CodeViewer`
- RENDERS → `ErrorIcon`
- RENDERS → `WarningIcon`
- USES_HOOK → `useState`

<!-- source: interface-routemapentry.md -->

# RouteMapEntry

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 141)

Route mapping entry for AI-assisted screenshot capture
Maps URL paths to their component/template files and extracted selectors

## Properties

| Property | Type |
|---|---|
| `componentFile` | `string` |
| `templateFile` | `string` |
| `selectors` | `{
    buttons?: Array<{ selector: string; text?: string }>;
    inputs?: Array<{ selector: string }>;
    links?: Array<{ selector: string; text?: string }>;
    modals?: Array<{ selector: string }>;
    tables?: Array<{ selector: string }>;
    forms?: Array<{ selector: string }>;
  }` |
| `requiredAuth` | `boolean` |

<!-- source: api-endpoint-unpublish-2.md -->

# unpublish

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 409)

## Endpoint

`POST /projects/:id/unpublish`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: component-pmepage.md -->

# PmePage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/pme/page.tsx` (line 20)

## Diagram

```mermaid
graph TD
    component_PmePage_4b64d5b8["PmePage"]
    class component_PmePage_4b64d5b8 rootComponent
```

## Relationships

- RENDERS → `GenerationWizard`
- RENDERS → `GenerationProgress`
- RENDERS → `VariantPicker`
- RENDERS → `PreviewPanel`
- USES_HOOK → `useState`
- USES_HOOK → `usePme`
- USES_HOOK → `useProjectContext`
- USES_HOOK → `useEffect`

<!-- source: interface-routemapping.md -->

# RouteMapping

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 75)

Mapping from a route path to its component, template, and selectors

## Properties

| Property | Type |
|---|---|
| `path` | `string` |
| `fullUrl` | `string` |
| `routeFile` | `string` |
| `componentFile` | `string` |
| `templateFile` | `string` |
| `extractedSelectors` | `ExtractedSelectors` |
| `requiredAuth` | `boolean` |
| `requiredRoles` | `string[]` |
| `framework` | `FrameworkType` |
| `confidence` | `ConfidenceLevel` |

<!-- source: api-endpoint-unresolve.md -->

# unresolve

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/comment/comment.controller.ts` (line 308)

Unresolve a previously resolved comment thread

## Endpoint

`POST /documents/:documentId/comments/:id/unresolve`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `CommentController` (MODULE_DECLARES)

<!-- source: component-pmestore-ts.md -->

# pmeStore.ts

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/stores/pmeStore.ts` (line 1)

## Diagram

```mermaid
graph TD
    component_pmeStore_ts_4662f3c5["pmeStore.ts"]
    class component_pmeStore_ts_4662f3c5 rootComponent
```

<!-- source: interface-routemappingresult.md -->

# RouteMappingResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 119)

Result of route mapping extraction

## Properties

| Property | Type |
|---|---|
| `mappings` | `RouteMapping[]` |
| `stats` | `RouteMappingStats` |

<!-- source: api-endpoint-update-2.md -->

# update

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/audience/audience.controller.ts` (line 73)

## Endpoint

`PATCH /audiences/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `AudienceController` (MODULE_DECLARES)

<!-- source: component-previewpanel.md -->

# PreviewPanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/pme/preview-panel.tsx` (line 16)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onBack` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PreviewPanel_4d929768["PreviewPanel"]
    class component_PreviewPanel_4d929768 rootComponent
```

## Relationships

- USES_HOOK → `usePmeStore`
- USES_HOOK → `usePme`

<!-- source: interface-routemappingstats.md -->

# RouteMappingStats

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 101)

Statistics about route mapping extraction

## Properties

| Property | Type |
|---|---|
| `totalRoutes` | `number` |
| `mappedRoutes` | `number` |
| `unmappedRoutes` | `number` |
| `routesWithSelectors` | `number` |
| `totalSelectors` | `number` |
| `framework` | `FrameworkType` |

<!-- source: api-endpoint-update-3.md -->

# update

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 60)

## Endpoint

`PATCH /projects/:projectId/boards/:boardId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `boardId` | query | `string` | ✓ |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: component-prevnextnav.md -->

# PrevNextNav

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/PrevNextNav.tsx` (line 25)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `previous` | `NavDoc | null` | ✓ | - |
| `next` | `NavDoc | null` | ✓ | - |
| `slugId` | `string` | ✓ | - |
| `audienceSlug` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PrevNextNav_40589eca["PrevNextNav"]
    class component_PrevNextNav_40589eca rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `ArrowLeftIcon`
- RENDERS → `ArrowRightIcon`
- USES_HOOK → `useLanguageContext`

<!-- source: interface-sandpackeditorprops.md -->

# SandpackEditorProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/sandpack/SandpackEditor.tsx` (line 22)

## Properties

| Property | Type |
|---|---|
| `preset` | `SandpackPreset` |

<!-- source: api-endpoint-update-4.md -->

# update

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/comment/comment.controller.ts` (line 147)

Update a comment's content

## Endpoint

`PATCH /documents/:documentId/comments/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `CommentController` (MODULE_DECLARES)

<!-- source: component-pricingpage.md -->

# PricingPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/pricing/page.tsx` (line 70)

## Diagram

```mermaid
graph TD
    component_PricingPage_f84597e["PricingPage"]
    class component_PricingPage_f84597e rootComponent
```

<!-- source: interface-saveimageparameters.md -->

# SaveImageParameters

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 81)

## Properties

| Property | Type |
|---|---|
| `src` | `string` |
| `file` | `FileList` |

<!-- source: api-endpoint-update-5.md -->

# update

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 167)

## Endpoint

`PATCH /doc-versions/:projectId/:versionId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-privacypage.md -->

# PrivacyPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/privacy/page.tsx` (line 182)

## Diagram

```mermaid
graph TD
    component_PrivacyPage_41ce2e26["PrivacyPage"]
    class component_PrivacyPage_41ce2e26 rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `motion-div`
- RENDERS → `Reveal`

<!-- source: interface-schema.md -->

# Schema

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/EndpointDetail.ts` (line 42)

## Properties

| Property | Type |
|---|---|
| `type` | `string` |
| `format` | `string` |
| `properties` | `Record<string, Schema>` |
| `items` | `Schema` |
| `required` | `string[]` |
| `example` | `any` |
| `enum` | `any[]` |
| `description` | `string` |
| `$ref` | `string` |
| `nullable` | `boolean` |

<!-- source: api-endpoint-update-6.md -->

# update

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/category.controller.ts` (line 81)

Update a category

## Endpoint

`PATCH /categories/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `CategoryController` (MODULE_DECLARES)

<!-- source: component-progresspanel.md -->

# ProgressPanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/DocAutomation/ProgressPanel.tsx` (line 177)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `progress` | `number` | ✓ | - |
| `currentStage` | `string | null` | ✓ | - |
| `stageProgress` | `number` | ✓ | - |
| `currentItem` | `string | null` | ✓ | - |
| `elapsedMs` | `number` | - | - |
| `estimatedRemainingMs` | `number` | - | - |
| `isRunning` | `boolean` | ✓ | - |
| `isFailed` | `boolean` | ✓ | - |
| `isCancelled` | `boolean` | ✓ | - |
| `error` | `Error | null` | ✓ | - |
| `onCancel` | `Function` | - | - |
| `screenshotProgress` | `unknown | null` | - | - |
| `onCancelScreenshots` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_ProgressPanel_95fc7d4["ProgressPanel"]
    class component_ProgressPanel_95fc7d4 rootComponent
```

## Relationships

- RENDERS → `StopCircle`
- RENDERS → `motion-div`
- RENDERS → `Clock`
- RENDERS → `Loader2`
- RENDERS → `XCircle`
- RENDERS → `CheckCircle2`
- RENDERS → `Icon`
- RENDERS → `Camera`

<!-- source: interface-screenapimap.md -->

# ScreenApiMap

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/cross-language.types.ts` (line 117)

Full Screen-to-API map for a component

The final output connecting UI to backend for documentation.

## Properties

| Property | Type |
|---|---|
| `componentName` | `string` |
| `componentPath` | `string` |
| `route` | `string` |
| `apiCalls` | `Array<{
    userAction: string; // "Click Save button"
    serviceMethod: string; // "newJobService.createJob()"
    httpMethod: string; // "POST"
    endpoint: string; // "/api/sales/jobs"
    purpose: string; // "Create new sales job"
    triggerElement?: string; // "dx-button[text='Save']"
  }>` |
| `stateBasedCalls` | `Array<{
    state: string; // "OrderStageEnum.Pending"
    availableActions: string[]; // ["approve", "reject", "cancel"]
    disabledActions: string[]; // ["createNew"]
  }>` |

<!-- source: api-endpoint-update-7.md -->

# update

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 224)

## Endpoint

`PATCH /documents/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: component-projectcontext-ts.md -->

# projectContext.ts

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/stores/projectContext.ts` (line 1)

## Diagram

```mermaid
graph TD
    component_projectContext_ts_4b94091b["projectContext.ts"]
    class component_projectContext_ts_4b94091b rootComponent
```

<!-- source: interface-screenshotaction.md -->

# ScreenshotAction

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 16)

Screenshot Worker Client Types

Type definitions for communication with the screenshot-worker API.
These types mirror the screenshot-worker DTOs but are decoupled for
use in the doc-automation package.

## Properties

| Property | Type |
|---|---|
| `type` | `'click' | 'dblclick' | 'type' | 'fill' | 'press' | 'wait' | 'scroll' | 'hover' | 'focus' | 'blur' | 'select' | 'navigate' | 'frame' | 'close-modal' | 'switch-tab' | 'freeze-toast'` |
| `selector` | `string` |
| `selectorHint` | `string` |
| `value` | `string` |
| `duration` | `number` |
| `key` | `string` |
| `frameAction` | `'enter' | 'exit'` |
| `optional` | `boolean` |
| `description` | `string` |
| `waitAfter` | `number` |

<!-- source: api-endpoint-update-8.md -->

# update

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/issues/issues.controller.ts` (line 85)

## Endpoint

`PATCH /projects/:projectId/issues/:issueId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `issueId` | query | `string` | ✓ |

## Referenced By

- `IssuesController` (MODULE_DECLARES)

<!-- source: component-projectdropdown.md -->

# ProjectDropdown

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Layout/ProjectDropdown.tsx` (line 28)

## Diagram

```mermaid
graph TD
    component_ProjectDropdown_2feb723["ProjectDropdown"]
    class component_ProjectDropdown_2feb723 rootComponent
```

## Relationships

- RENDERS → `FolderIcon`
- RENDERS → `Menu`
- RENDERS → `Menu-Button`
- RENDERS → `ChevronDownIcon`
- RENDERS → `Transition`
- RENDERS → `Menu-Items`
- RENDERS → `MagnifyingGlassIcon`
- RENDERS → `ClockIcon`
- RENDERS → `Menu-Item`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useProjectContext`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-screenshotaction-2.md -->

# ScreenshotAction

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 78)

Action to perform before taking screenshot

## Properties

| Property | Type |
|---|---|
| `type` | `'click' | 'dblclick' | 'type' | 'fill' | 'press' | 'wait' | 'scroll' | 'hover' | 'focus' | 'blur' | 'select' | 'navigate' | 'frame' | 'close-modal' | 'switch-tab' | 'freeze-toast'` |
| `selector` | `string` |
| `value` | `string` |
| `duration` | `number` |
| `key` | `string` |
| `optional` | `boolean` |
| `waitAfter` | `number` |
| `description` | `string` |

<!-- source: api-endpoint-update-9.md -->

# update

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/organization/organization.controller.ts` (line 70)

## Endpoint

`PATCH /organizations/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `OrganizationController` (MODULE_DECLARES)

<!-- source: component-projectheader.md -->

# ProjectHeader

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/dashboard/ProjectHeader.tsx` (line 21)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `project` | `any` | ✓ | - |
| `onRegenerate` | `Function` | ✓ | - |
| `onNavigateSettings` | `Function` | ✓ | - |
| `onGenerate` | `Function` | - | - |
| `onExport` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_ProjectHeader_4cf00d68["ProjectHeader"]
    class component_ProjectHeader_4cf00d68 rootComponent
```

## Relationships

- RENDERS → `Link`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`

<!-- source: interface-screenshotbatchrequest.md -->

# ScreenshotBatchRequest

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 170)

Main batch screenshot request

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `organizationId` | `string` |
| `capturedBy` | `string` |
| `name` | `string` |
| `description` | `string` |
| `auth` | `BatchAuthConfig` |
| `screenshots` | `ScreenshotItem[]` |
| `config` | `BatchConfig` |
| `repoPath` | `string` |
| `routeMap` | `Record<string, RouteMapEntry>` |
| `aiAssisted` | `AIAssistedConfig` |

<!-- source: api-endpoint-update-10.md -->

# update

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 95)

## Endpoint

`PATCH /projects/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: component-projectpage.md -->

# ProjectPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/page.tsx` (line 43)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ProjectPage_767b481d["ProjectPage"]
    class component_ProjectPage_767b481d rootComponent
```

## Relationships

- RENDERS → `ProjectHeader`
- RENDERS → `DashboardTabBar`
- RENDERS → `DocsChangesBanner`
- RENDERS → `OverviewTab`
- RENDERS → `VersionsContent`
- RENDERS → `ChangesContent`
- RENDERS → `ExportModal`
- RENDERS → `GenerateDocModal`
- RENDERS → `Check`
- RENDERS → `Copy`
- RENDERS → `ExternalLink`
- RENDERS → `DocsReviewToggle`
- RENDERS → `SiteUrlField`
- RENDERS → `CustomDomainPublishingRow`
- RENDERS → `ProjectPublishButton`
- RENDERS → `DocumentationAutomationSection`
- RENDERS → `WebhooksContent`
- RENDERS → `TechnicalDocsSection`
- RENDERS → `CapturedFlows`
- RENDERS → `RetentionPolicySection`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useProjectContext`
- USES_HOOK → `useProject`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useSearchParams`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-screenshoterror.md -->

# ScreenshotError

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 431)

Error during screenshot processing

## Properties

| Property | Type |
|---|---|
| `stage` | `'12A' | '12B' | '12C' | '12D' | '12E'` |
| `placeholderId` | `string` |
| `documentId` | `string` |
| `error` | `string` |
| `recoverable` | `boolean` |
| `timestamp` | `Date` |

<!-- source: api-endpoint-update-11.md -->

# update

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/template/template.controller.ts` (line 189)

Update a template.
Only admins and maintainers can update templates.

## Endpoint

`PATCH /templates/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `TemplateController` (MODULE_DECLARES)

<!-- source: component-projectspage.md -->

# ProjectsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/page.tsx` (line 31)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `showMenu` | `boolean` | - | true |
| `limit` | `number` | - | 0 |

## Diagram

```mermaid
graph TD
    component_ProjectsPage_781eeb9a["ProjectsPage"]
    class component_ProjectsPage_781eeb9a rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `EmptyState-98f5e`
- RENDERS → `MagnifyingGlassIcon`
- RENDERS → `PlusIcon`
- RENDERS → `StatCard`
- RENDERS → `FolderIcon`
- RENDERS → `BoltIcon`
- RENDERS → `CheckCircleIcon`
- RENDERS → `DocumentTextIcon`
- RENDERS → `AnimatePresence`
- RENDERS → `ProjectCardCustom`
- RENDERS → `DeleteProjectModal`
- USES_HOOK → `useSession`
- USES_HOOK → `useProjects`
- USES_HOOK → `useRouter`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useProjectContext`
- USES_HOOK → `useState`
- USES_HOOK → `useMemo`

<!-- source: interface-screenshotfailure.md -->

# ScreenshotFailure

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 240)

Screenshot failure record

## Properties

| Property | Type |
|---|---|
| `url` | `string` |
| `error` | `string` |
| `retryCount` | `number` |
| `stage` | `string` |
| `failedAt` | `string` |

<!-- source: api-endpoint-updateaccess.md -->

# updateAccess

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 637)

## Endpoint

`POST /doc-versions/:projectId/:versionId/access`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-promptinput.md -->

# PromptInput

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/PromptInput.tsx` (line 27)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onSubmit` | `Function` | ✓ | - |
| `onEnhance` | `Function` | - | - |
| `onOutline` | `Function` | - | - |
| `onImprove` | `Function` | - | - |
| `onSummarize` | `Function` | - | - |
| `isLoading` | `boolean` | - | false |
| `isStreaming` | `boolean` | - | false |
| `placeholder` | `string` | - | "Ask the AI assistant..." |

## Diagram

```mermaid
graph TD
    component_PromptInput_25256c05["PromptInput"]
    class component_PromptInput_25256c05 rootComponent
```

## Relationships

- RENDERS → `QuickActionButton`
- RENDERS → `Sparkles`
- RENDERS → `FileText`
- RENDERS → `Edit3`
- RENDERS → `FileCheck`
- RENDERS → `Loader2`
- RENDERS → `Send`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`

<!-- source: interface-screenshotitem.md -->

# ScreenshotItem

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 65)

Individual screenshot item in a batch request

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `description` | `string` |
| `url` | `string` |
| `expectedState` | `string` |
| `viewport` | `Viewport` |
| `fullPage` | `boolean` |
| `waitFor` | `WaitFor` |
| `waitForSelector` | `string` |
| `waitForTimeout` | `number` |
| `actions` | `ScreenshotAction[]` |
| `stateType` | `'default' | 'hover' | 'modal' | 'error' | 'success' | 'loading' | 'focus' | 'active' | 'disabled'` |
| `category` | `string` |
| `clip` | `Clip` |
| `metadata` | `Record<string, unknown>` |
| `flowStepId` | `string` |
| `priority` | `number` |
| `stateResolution` | `{
    listUrl: string;
    statusColumnHint: string;
    targetStatusValue: string;
    maxRowsToScan?: number;
    rowAction: 'click' | 'dblclick';
  }` |
| `parentPlaceholderId` | `string` |
| `sequenceOrder` | `number` |

<!-- source: api-endpoint-updateagent.md -->

# updateAgent

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.controller.ts` (line 133)

## Endpoint

`PUT /support-agent/:projectId/agents/:agentId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `agentId` | query | `string` | ✓ |

## Referenced By

- `SupportAgentController` (MODULE_DECLARES)

<!-- source: component-promptlibrary.md -->

# PromptLibrary

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/PromptLibrary.tsx` (line 14)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `prompts` | `PromptTemplate[]` | ✓ | - |
| `onCreatePrompt` | `Function` | ✓ | - |
| `onUpdatePrompt` | `Function` | ✓ | - |
| `onDeletePrompt` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PromptLibrary_15c6ac65["PromptLibrary"]
    class component_PromptLibrary_15c6ac65 rootComponent
```

## Relationships

- RENDERS → `PromptForm`
- RENDERS → `PromptCard`
- USES_HOOK → `useState`

<!-- source: interface-screenshotmapping.md -->

# ScreenshotMapping

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 294)

Screenshot upload mapping

## Properties

| Property | Type |
|---|---|
| `localPath` | `string` |
| `cdnUrl` | `string` |
| `screenshotId` | `string` |

<!-- source: api-endpoint-updatebranding.md -->

# updateBranding

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/branding/branding.controller.ts` (line 24)

## Endpoint

`PATCH /projects/:projectId/branding`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `BrandingController` (MODULE_DECLARES)

<!-- source: component-providerconfig.md -->

# ProviderConfig

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/ProviderConfig.tsx` (line 14)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `providers` | `AIProvider[]` | ✓ | - |
| `defaultProvider` | `AIProviderName` | ✓ | - |
| `onProviderChange` | `Function` | ✓ | - |
| `onTestConnection` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ProviderConfig_5a261ae1["ProviderConfig"]
    class component_ProviderConfig_5a261ae1 rootComponent
```

## Relationships

- RENDERS → `StatusBadge`
- RENDERS → `TestResultBadge`
- USES_HOOK → `useState`

<!-- source: interface-screenshotmapping-2.md -->

# ScreenshotMapping

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 103)

Mapping from description to capture instructions

## Properties

| Property | Type |
|---|---|
| `placeholderId` | `string` |
| `description` | `string` |
| `url` | `string` |
| `waitForSelector` | `string` |
| `waitForTimeout` | `number` |
| `actions` | `ScreenshotAction[]` |
| `viewport` | `Viewport` |
| `fullPage` | `boolean` |
| `clip` | `{ x: number; y: number; width: number; height: number }` |
| `category` | `string` |
| `confidence` | `number` |
| `requiresAuth` | `boolean` |
| `notes` | `string` |
| `stateResolution` | `StateResolutionConfig` |
| `sequenceSteps` | `ScreenshotMapping[]` |
| `sequenceOrder` | `number` |
| `parentPlaceholderId` | `string` |

<!-- source: api-endpoint-updatecolumn.md -->

# updateColumn

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/boards/boards.controller.ts` (line 115)

## Endpoint

`PATCH /projects/:projectId/boards/:boardId/columns/:columnId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `boardId` | query | `string` | ✓ |
| `columnId` | query | `string` | ✓ |

## Referenced By

- `BoardsController` (MODULE_DECLARES)

<!-- source: component-providers.md -->

# Providers

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Providers.tsx` (line 55)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_Providers_715f6a8c["Providers"]
    class component_Providers_715f6a8c rootComponent
```

## Relationships

- RENDERS → `SessionProvider`
- RENDERS → `AtloriaProviderWrapper`

<!-- source: interface-screenshotplaceholder.md -->

# ScreenshotPlaceholder

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 37)

A screenshot placeholder extracted from documents

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `description` | `string` |
| `occurrences` | `PlaceholderOccurrence[]` |
| `status` | `ScreenshotStatus` |
| `category` | `string` |
| `priority` | `number` |

<!-- source: api-endpoint-updateconfig.md -->

# updateConfig

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 94)

## Endpoint

`PUT /doc-automation/config/:projectId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: component-publicapiplaygroundpage.md -->

# PublicApiPlaygroundPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/api/page.tsx` (line 24)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PublicApiPlaygroundPage_a977278["PublicApiPlaygroundPage"]
    class component_PublicApiPlaygroundPage_a977278 rootComponent
```

## Relationships

- RENDERS → `Link`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-screenshotprogress.md -->

# ScreenshotProgress

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 491)

## Properties

| Property | Type |
|---|---|
| `stage` | `'12A' | '12B' | '12C' | '12D' | '12E'` |
| `stageProgress` | `number` |
| `overallProgress` | `number` |
| `currentItem` | `string` |
| `stats` | `Partial<ScreenshotStats>` |

<!-- source: api-endpoint-updatememberrole.md -->

# updateMemberRole

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 210)

## Endpoint

`PATCH /projects/:id/members/:userId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `userId` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: component-publicdocumentpage.md -->

# PublicDocumentPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/[audienceSlug]/[documentSlug]/page.tsx` (line 286)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PublicDocumentPage_9f14768["PublicDocumentPage"]
    class component_PublicDocumentPage_9f14768 rootComponent
```

## Relationships

- RENDERS → `CategoryDocumentList`
- RENDERS → `PortalTableOfContents`
- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `Breadcrumbs`
- RENDERS → `ManualFreshnessBadge`
- RENDERS → `DocMeta`
- RENDERS → `ConnectAiMenu`
- RENDERS → `MarkdownRenderer`
- RENDERS → `HelpfulnessWidget`
- RENDERS → `RelatedArticles`
- RENDERS → `PrevNextNav`
- RENDERS → `ReportIssueModal`
- USES_HOOK → `useParams`
- USES_HOOK → `useSession`
- USES_HOOK → `useRouter`
- USES_HOOK → `usePublicProjectContext`
- USES_HOOK → `useVersionContext`
- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useBranding`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useMemo`
- USES_HOOK → `useEffect`
- USES_HOOK → `usePageTracking`
- USES_HOOK → `useCallback`

<!-- source: interface-screenshotregistry.md -->

# ScreenshotRegistry

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 58)

Registry of all screenshot placeholders for a job

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `configId` | `string` |
| `jobId` | `string` |
| `totalPlaceholders` | `number` |
| `uniqueDescriptions` | `number` |
| `placeholders` | `ScreenshotPlaceholder[]` |
| `urlGroups` | `UrlGroup[]` |
| `stats` | `ScreenshotStats` |
| `createdAt` | `Date` |
| `updatedAt` | `Date` |

<!-- source: api-endpoint-updateplaceholder.md -->

# updatePlaceholder

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 431)

PATCH a screenshot placeholder — update blob URL, status, or other fields.
Used by the screenshot management page to manually replace or update screenshots.

## Endpoint

`PATCH /doc-versions/:projectId/:versionId/screenshots/placeholders/:placeholderId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `versionId` | query | `string` | ✓ |
| `placeholderId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-publicdocumentpage-2.md -->

# PublicDocumentPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/public/documents/[id]/page.tsx` (line 33)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PublicDocumentPage_12b0d4c8["PublicDocumentPage"]
    class component_PublicDocumentPage_12b0d4c8 rootComponent
```

## Relationships

- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `MDXEditor`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-screenshotresult-2.md -->

# ScreenshotResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 215)

Individual screenshot result

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `screenshotId` | `string` |
| `url` | `string` |
| `blobUrl` | `string` |
| `viewport` | `{ width: number; height: number }` |
| `dimensions` | `{ width: number; height: number }` |
| `size` | `number` |
| `version` | `number` |
| `isNew` | `boolean` |
| `stateType` | `string` |
| `category` | `string` |
| `description` | `string` |
| `capturedAt` | `string` |
| `featureArea` | `string` |
| `pageType` | `string` |
| `semanticTags` | `string[]` |
| `recoveryAttempts` | `number` |
| `recoverySucceeded` | `boolean` |
| `successfulSelector` | `string` |

<!-- source: api-endpoint-updateput.md -->

# updatePut

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 120)

## Endpoint

`PUT /projects/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: component-publicentitydetailpage.md -->

# PublicEntityDetailPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/technical/entity/[entityId]/page.tsx` (line 109)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PublicEntityDetailPage_6bd574bb["PublicEntityDetailPage"]
    class component_PublicEntityDetailPage_6bd574bb rootComponent
```

## Relationships

- RENDERS → `EntityTree`
- RENDERS → `RelationsPanel`
- RENDERS → `Link`
- RENDERS → `typeConfig-Icon`
- RENDERS → `SparklesIcon`
- RENDERS → `Tab`
- RENDERS → `FieldsTable`
- RENDERS → `MethodsTable`
- RENDERS → `AiEnrichmentContent`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-screenshotspec.md -->

# ScreenshotSpec

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/screenshot-spec.types.ts` (line 135)

Enhanced screenshot specification combining InteractionMap + SiteMap data.
Extends the base ScreenshotMapping with source-grounded metadata.

## Properties

| Property | Type |
|---|---|
| `placeholderId` | `string` |
| `description` | `string` |
| `url` | `string` |
| `source` | `MappingSource` |
| `confidence` | `number` |
| `captureType` | `CaptureType` |
| `requiredState` | `RequiredState` |
| `modal` | `ModalCaptureSpec` |
| `tab` | `TabCaptureSpec` |
| `form` | `FormCaptureSpec` |
| `workflowSequence` | `WorkflowSequenceSpec` |
| `actions` | `ScreenshotAction[]` |
| `viewport` | `Viewport` |
| `fullPage` | `boolean` |
| `clip` | `{ x: number; y: number; width: number; height: number }` |
| `category` | `string` |
| `requiresAuth` | `boolean` |
| `notes` | `string` |
| `componentName` | `string` |
| `sourceFile` | `string` |

<!-- source: api-endpoint-updatereport.md -->

# updateReport

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/analytics/export/analytics-export.controller.ts` (line 110)

## Endpoint

`PATCH /analytics/:projectId/reports/:id`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `AnalyticsExportController` (MODULE_DECLARES)

<!-- source: component-publiclayoutshell.md -->

# PublicLayoutShell

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/PublicLayoutShell.tsx` (line 223)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PublicLayoutShell_20e422b6["PublicLayoutShell"]
    class component_PublicLayoutShell_20e422b6 rootComponent
```

## Relationships

- RENDERS → `PublicProjectProvider`
- RENDERS → `BrandingProviderWrapper`
- RENDERS → `VersionProviderWrapper`
- RENDERS → `LanguageProviderWrapper`
- RENDERS → `PublicProjectLayoutInner`
- USES_HOOK → `usePathname`

<!-- source: interface-screenshotstageconfig.md -->

# ScreenshotStageConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 343)

Configuration for the entire screenshot stage

## Properties

| Property | Type |
|---|---|
| `siteUrl` | `string` |
| `siteLoginUrl` | `string` |
| `siteEmail` | `string` |
| `sitePassword` | `string` |
| `framework` | `string` |
| `viewport` | `Viewport` |
| `fullPage` | `boolean` |
| `format` | `'png' | 'jpeg' | 'webp'` |
| `quality` | `number` |
| `maxConcurrentSessions` | `number` |
| `batchSize` | `number` |
| `maxRetries` | `number` |
| `uploadToAzure` | `boolean` |
| `azureContainerName` | `string` |
| `checkForDuplicates` | `boolean` |
| `replacementFormat` | `ReplacementFormat` |
| `skipCapture` | `boolean` |
| `skipUpload` | `boolean` |
| `skipReplacement` | `boolean` |

<!-- source: api-endpoint-updatesettings.md -->

# updateSettings

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/organization/organization.controller.ts` (line 155)

## Endpoint

`PATCH /organizations/:id/settings`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `OrganizationController` (MODULE_DECLARES)

<!-- source: component-publicprojectaudiencepage.md -->

# PublicProjectAudiencePage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/[audienceSlug]/page.tsx` (line 50)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PublicProjectAudiencePage_8337f31["PublicProjectAudiencePage"]
    class component_PublicProjectAudiencePage_8337f31 rootComponent
```

## Relationships

- RENDERS → `CategoryDocumentList`
- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `Breadcrumbs`
- RENDERS → `Link`
- RENDERS → `ArrowRightIcon`
- USES_HOOK → `useSession`
- USES_HOOK → `useRouter`
- USES_HOOK → `usePublicProjectContext`
- USES_HOOK → `useVersionContext`
- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useState`
- USES_HOOK → `useMemo`
- USES_HOOK → `useEffect`

<!-- source: interface-screenshotstageinput.md -->

# ScreenshotStageInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 328)

Input to Stage 12

## Properties

| Property | Type |
|---|---|
| `documents` | `GeneratedDocument[]` |
| `config` | `ScreenshotStageConfig` |
| `outputDir` | `string` |
| `jobId` | `string` |
| `projectId` | `string` |
| `routeMappings` | `RouteMappingResult` |
| `repoPath` | `string` |

<!-- source: api-endpoint-updatesettings-2.md -->

# updateSettings

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/project/project.controller.ts` (line 280)

## Endpoint

`PATCH /projects/:id/settings`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `ProjectController` (MODULE_DECLARES)

<!-- source: component-publicprojectlayout.md -->

# PublicProjectLayout

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/layout.tsx` (line 63)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PublicProjectLayout_4eda7201["PublicProjectLayout"]
    class component_PublicProjectLayout_4eda7201 rootComponent
```

## Relationships

- RENDERS → `PublicLayoutShell`

<!-- source: interface-screenshotstageoutput.md -->

# ScreenshotStageOutput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 380)

Output from Stage 12

## Properties

| Property | Type |
|---|---|
| `registry` | `ScreenshotRegistry` |
| `screenshots` | `CapturedScreenshot[]` |
| `updatedDocuments` | `GeneratedDocument[]` |
| `stats` | `ScreenshotStats` |
| `errors` | `ScreenshotError[]` |

<!-- source: api-endpoint-updatesteps.md -->

# updateSteps

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/capture/capture.controller.ts` (line 65)

## Endpoint

`PATCH /capture/:projectId/flows/:id/steps`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |
| `id` | query | `string` | ✓ |

## Referenced By

- `CaptureController` (MODULE_DECLARES)

<!-- source: component-publicprojectpage.md -->

# PublicProjectPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/page.tsx` (line 65)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PublicProjectPage_6b0f4c1f["PublicProjectPage"]
    class component_PublicProjectPage_6b0f4c1f rootComponent
```

## Relationships

- RENDERS → `FileText`
- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `VersionSwitcher`
- USES_HOOK → `useSession`
- USES_HOOK → `useRouter`
- USES_HOOK → `usePathname`
- USES_HOOK → `useSearchParams`
- USES_HOOK → `usePublicProjectContext`
- USES_HOOK → `useVersionContext`
- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useState`
- USES_HOOK → `useMemo`
- USES_HOOK → `usePageTracking`
- USES_HOOK → `useEffect`

<!-- source: interface-screenshotstats.md -->

# ScreenshotStats

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 391)

Statistics for the screenshot stage

## Properties

| Property | Type |
|---|---|
| `totalPlaceholders` | `number` |
| `uniqueDescriptions` | `number` |
| `mapped` | `number` |
| `unmapped` | `number` |
| `lowConfidence` | `number` |
| `captured` | `number` |
| `captureFailed` | `number` |
| `captureSkipped` | `number` |
| `uploaded` | `number` |
| `uploadFailed` | `number` |
| `reused` | `number` |
| `replaced` | `number` |
| `replacementFailed` | `number` |
| `extractionTimeMs` | `number` |
| `mappingTimeMs` | `number` |
| `captureTimeMs` | `number` |
| `uploadTimeMs` | `number` |
| `replacementTimeMs` | `number` |
| `totalTimeMs` | `number` |
| `mappingTokenUsage` | `TokenUsage` |
| `estimatedCost` | `number` |

<!-- source: api-endpoint-updatetriggerconfig.md -->

# updateTriggerConfig

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/documentation/doc-automation.controller.ts` (line 292)

## Endpoint

`PUT /doc-automation/config/:projectId/triggers`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `DocAutomationController` (MODULE_DECLARES)

<!-- source: component-publicprojectprovider.md -->

# PublicProjectProvider

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/project-context.tsx` (line 58)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PublicProjectProvider_3203aa9f["PublicProjectProvider"]
    class component_PublicProjectProvider_3203aa9f rootComponent
```

## Relationships

- RENDERS → `PublicProjectContext-Provider`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-screenshotworkerclientconfig.md -->

# ScreenshotWorkerClientConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.client.ts` (line 17)

Configuration for the screenshot worker client

## Properties

| Property | Type |
|---|---|
| `baseUrl` | `string` |
| `timeoutMs` | `number` |
| `pollIntervalMs` | `number` |

<!-- source: api-endpoint-updateuseraudiences.md -->

# updateUserAudiences

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/organization/organization.controller.ts` (line 206)

## Endpoint

`PATCH /organizations/:id/members/:userId/audiences`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `userId` | query | `string` | ✓ |

## Referenced By

- `OrganizationController` (MODULE_DECLARES)

<!-- source: component-publicsearchmodal.md -->

# PublicSearchModal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/PublicSearchModal.tsx` (line 45)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `slugId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PublicSearchModal_78f3e556["PublicSearchModal"]
    class component_PublicSearchModal_78f3e556 rootComponent
```

## Relationships

- RENDERS → `Search`
- RENDERS → `X`
- RENDERS → `FileText`
- RENDERS → `ArrowRight`
- RENDERS → `WifiOff`
- USES_HOOK → `useRouter`
- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-screentoapimapping.md -->

# ScreenToApiMapping

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/cross-language.types.ts` (line 35)

## Properties

| Property | Type |
|---|---|
| `screenId` | `string` |
| `screenName` | `string` |
| `screenPath` | `string` |
| `apiCalls` | `Array<{
    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
    endpoint: string; // "/api/sales/orders"
    controllerId?: string; // Entity ID of controller
    controllerName?: string; // "SalesOrderController"
    purpose: string; // "Create new order"
  }>` |
| `userActions` | `Array<{
    trigger: 'button_click' | 'form_submit' | 'page_load' | 'auto';
    label: string; // "Submit Order"
    resultingCall: string; // endpoint reference
  }>` |

<!-- source: api-endpoint-updateversionmetadata.md -->

# updateVersionMetadata

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/document/document.controller.ts` (line 682)

## Endpoint

`PATCH /documents/:id/versions/:versionId`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocumentController` (MODULE_DECLARES)

<!-- source: component-publictechnicalpage.md -->

# PublicTechnicalPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/technical/page.tsx` (line 14)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PublicTechnicalPage_313152cd["PublicTechnicalPage"]
    class component_PublicTechnicalPage_313152cd rootComponent
```

## Relationships

- RENDERS → `EntityTree`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-sectionplan.md -->

# SectionPlan

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-09.types.ts` (line 54)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `type` | `SectionType` |
| `order` | `number` |
| `contentOutline` | `string[]` |
| `codeExamples` | `boolean` |
| `screenshots` | `boolean` |
| `subsections` | `SubsectionPlan[]` |

<!-- source: api-endpoint-uploadimage.md -->

# uploadImage

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/assets/assets.controller.ts` (line 26)

## Endpoint

`POST /assets/upload`

## Referenced By

- `AssetsController` (MODULE_DECLARES)

<!-- source: component-publicticketpage.md -->

# PublicTicketPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/issues/[ticketNumber]/page.tsx` (line 264)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_PublicTicketPage_6cb2e091["PublicTicketPage"]
    class component_PublicTicketPage_6cb2e091 rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `BackgroundDecoration`
- RENDERS → `TopBar`
- RENDERS → `StatusJourney`
- RENDERS → `ReactMarkdown`
- RENDERS → `CsatCard`
- RENDERS → `ReplyComposer`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-securityscheme.md -->

# SecurityScheme

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-core/src/components/api-explorer/APIExplorer.ts` (line 30)

## Properties

| Property | Type |
|---|---|
| `type` | `'http' | 'apiKey' | 'oauth2' | 'openIdConnect'` |
| `scheme` | `string` |
| `bearerFormat` | `string` |
| `description` | `string` |
| `name` | `string` |
| `in` | `'query' | 'header' | 'cookie'` |

<!-- source: api-endpoint-uploadscreenshot.md -->

# uploadScreenshot

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/doc-version/doc-version.controller.ts` (line 359)

## Endpoint

`POST /doc-versions/:projectId/:versionId/screenshots/upload`

| Parameter | In | Type | Required |
|---|---|---|---|
| `versionId` | query | `string` | ✓ |

## Referenced By

- `DocVersionController` (MODULE_DECLARES)

<!-- source: component-queuerail.md -->

# QueueRail

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/QueueRail.tsx` (line 51)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `bucket` | `BucketKey` | ✓ | - |
| `counts` | `DeskCounts | null` | ✓ | - |
| `hotBuckets` | `Set` | ✓ | - |
| `onSelect` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_QueueRail_17b0a62a["QueueRail"]
    class component_QueueRail_17b0a62a rootComponent
```

## Relationships

- RENDERS → `InboxIcon`

<!-- source: interface-selectorinfo.md -->

# SelectorInfo

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/types/route-mapping.ts` (line 45)

Information about an interactive element selector

## Properties

| Property | Type |
|---|---|
| `selector` | `string` |
| `type` | `SelectorType` |
| `text` | `string` |
| `testId` | `string` |
| `ariaLabel` | `string` |
| `confidence` | `ConfidenceLevel` |

<!-- source: api-endpoint-upsertconfig.md -->

# upsertConfig

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/support-agent/support-agent.controller.ts` (line 55)

PUT /support-agent/:projectId/config
Upserts the support agent config.

## Endpoint

`PUT /support-agent/:projectId/config`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | ✓ |

## Referenced By

- `SupportAgentController` (MODULE_DECLARES)

<!-- source: component-quickactions.md -->

# QuickActions

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/dashboard/QuickActions.tsx` (line 51)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `onGenerate` | `Function` | ✓ | - |
| `onNavigateSettings` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_QuickActions_7a290d12["QuickActions"]
    class component_QuickActions_7a290d12 rootComponent
```

## Relationships

- USES_HOOK → `useRouter`

<!-- source: interface-semanticcolorscale.md -->

# SemanticColorScale

**Kind:** Interface

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `500` | `string` |
| `600` | `string` |
| `700` | `string` |

<!-- source: api-endpoint-usagelogs.md -->

# usageLogs

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/ai/ai.controller.ts` (line 39)

## Endpoint

`GET /ai/usage/logs`

| Parameter | In | Type | Required |
|---|---|---|---|
| `projectId` | query | `string` | - |
| `userId` | query | `string` | - |
| `provider` | query | `string` | - |
| `model` | query | `string` | - |
| `operationType` | query | `string` | - |
| `startDate` | query | `string` | - |
| `endDate` | query | `string` | - |
| `limit` | query | `string` | - |
| `offset` | query | `string` | - |

## Referenced By

- `AIController` (MODULE_DECLARES)

<!-- source: component-recentdocuments.md -->

# RecentDocuments

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/dashboard/RecentDocuments.tsx` (line 46)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `documents` | `RecentDoc[]` | ✓ | - |
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_RecentDocuments_6feb1c08["RecentDocuments"]
    class component_RecentDocuments_6feb1c08 rootComponent
```

## Relationships

- USES_HOOK → `useRouter`

<!-- source: interface-sessionhealthcheck.md -->

# SessionHealthCheck

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 99)

Session health check configuration

## Properties

| Property | Type |
|---|---|
| `enabled` | `boolean` |
| `loginPageIndicators` | `string[]` |
| `authenticatedIndicators` | `string[]` |
| `loginUrlPatterns` | `string[]` |
| `maxReauthAttempts` | `number` |

<!-- source: api-endpoint-usetemplate.md -->

# useTemplate

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/template/template.controller.ts` (line 114)

Create a document from a template.
Any authenticated user can use templates to create documents.

## Endpoint

`POST /templates/:id/use`

| Parameter | In | Type | Required |
|---|---|---|---|
| `id` | query | `string` | ✓ |

## Referenced By

- `TemplateController` (MODULE_DECLARES)

<!-- source: component-registerpage.md -->

# RegisterPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(auth)/register/page.tsx` (line 12)

## Diagram

```mermaid
graph TD
    component_RegisterPage_270199ae["RegisterPage"]
    class component_RegisterPage_270199ae rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-h1`
- RENDERS → `motion-button`
- RENDERS → `Link`
- USES_HOOK → `useRouter`
- USES_HOOK → `useSearchParams`
- USES_HOOK → `useState`

<!-- source: interface-sessioninput.md -->

# SessionInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-08.types.ts` (line 18)

## Properties

| Property | Type |
|---|---|
| `phases` | `Phase[]` |
| `budget` | `TokenBudget` |

<!-- source: api-endpoint-verifyemail.md -->

# verifyEmail

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/auth/auth.controller.ts` (line 83)

## Endpoint

`POST /auth/verify-email`

## Referenced By

- `AuthController` (MODULE_DECLARES)

<!-- source: component-relatedarticles.md -->

# RelatedArticles

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/RelatedArticles.tsx` (line 36)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `slugId` | `string` | ✓ | - |
| `audienceSlug` | `string` | ✓ | - |
| `docSlug` | `string` | ✓ | - |
| `version` | `string` | - | - |
| `lang` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_RelatedArticles_1614f3ea["RelatedArticles"]
    class component_RelatedArticles_1614f3ea rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `DocumentTextIcon`
- RENDERS → `ArrowUpRightIcon`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-sessionresult.md -->

# SessionResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-08.types.ts` (line 23)

## Properties

| Property | Type |
|---|---|
| `sessions` | `AISession[]` |
| `batches` | `ExecutionBatch[]` |

<!-- source: api-endpoint-webhook.md -->

# webhook

**Kind:** API Endpoint

**Source:** `atloria-monorepo/apps/api/src/billing/billing.controller.ts` (line 57)

## Endpoint

`POST /billing/webhook`

## Referenced By

- `BillingController` (MODULE_DECLARES)

<!-- source: component-relationspanel.md -->

# RelationsPanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/components/RelationsPanel.tsx` (line 104)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `entity` | `any` | ✓ | - |
| `outgoing` | `Relationship[]` | ✓ | - |
| `incoming` | `Relationship[]` | ✓ | - |
| `linkedDocs` | `LinkedDoc[]` | ✓ | - |
| `projectId` | `string` | ✓ | - |
| `entityMap` | `Record` | ✓ | - |
| `entityHrefBase` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_RelationsPanel_656c85ab["RelationsPanel"]
    class component_RelationsPanel_656c85ab rootComponent
```

## Relationships

- RENDERS → `RelItem`
- RENDERS → `SparklesIcon`

<!-- source: interface-shadcndetectionconfig.md -->

# ShadcnDetectionConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/shadcn.patterns.ts` (line 280)

## Properties

| Property | Type |
|---|---|
| `name` | `'shadcn'` |
| `filePatterns` | `string[]` |
| `identifiers` | `RegExp[]` |
| `configFiles` | `string[]` |

<!-- source: component-replyform.md -->

# ReplyForm

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Comments/CommentForm.tsx` (line 359)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `documentId` | `string` | ✓ | - |
| `projectId` | `string` | - | - |
| `parentId` | `string` | ✓ | - |
| `onSubmit` | `Function` | ✓ | - |
| `onCancel` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ReplyForm_5dcf293c["ReplyForm"]
    class component_ReplyForm_5dcf293c rootComponent
```

## Relationships

- RENDERS → `CommentForm`

<!-- source: interface-shadows.md -->

# Shadows

**Kind:** Interface

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 99)

## Properties

| Property | Type |
|---|---|
| `sm` | `string` |
| `md` | `string` |
| `lg` | `string` |
| `xl` | `string` |

<!-- source: component-reportissuemodal.md -->

# ReportIssueModal

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/ReportIssueModal.tsx` (line 140)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `open` | `boolean` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `slugId` | `string` | ✓ | - |
| `pageTitle` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ReportIssueModal_1c70b190["ReportIssueModal"]
    class component_ReportIssueModal_1c70b190 rootComponent
```

## Relationships

- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-sharedcontext.md -->

# SharedContext

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-08.types.ts` (line 42)

## Properties

| Property | Type |
|---|---|
| `featureIds` | `string[]` |
| `entitySummaries` | `string[]` |
| `previousDocSummaries` | `string[]` |

<!-- source: component-repositoryinfo.md -->

# RepositoryInfo

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/dashboard/RepositoryInfo.tsx` (line 27)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `repoUrl` | `string | null` | - | - |
| `repoBranch` | `string` | ✓ | - |
| `lastSyncedAt` | `string | null` | - | - |

## Diagram

```mermaid
graph TD
    component_RepositoryInfo_670d61c2["RepositoryInfo"]
    class component_RepositoryInfo_670d61c2 rootComponent
```

<!-- source: interface-sitemap.md -->

# SiteMap

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/site-map.types.ts` (line 100)

## Properties

| Property | Type |
|---|---|
| `baseUrl` | `string` |
| `routes` | `DiscoveredRoute[]` |
| `discoveryTimeMs` | `number` |
| `generatedAt` | `string` |
| `stats` | `SiteMapStats` |

<!-- source: component-requesthistory.md -->

# RequestHistory

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/RequestHistory.tsx` (line 13)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `logs` | `AIRequestLog[]` | ✓ | - |
| `loading` | `boolean` | - | - |
| `onRefresh` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_RequestHistory_5ad820bb["RequestHistory"]
    class component_RequestHistory_5ad820bb rootComponent
```

## Relationships

- RENDERS → `StatusBadge`
- USES_HOOK → `useState`

<!-- source: interface-sitemapstats.md -->

# SiteMapStats

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/site-map.types.ts` (line 86)

## Properties

| Property | Type |
|---|---|
| `totalRoutes` | `number` |
| `listPages` | `number` |
| `detailPages` | `number` |
| `formPages` | `number` |
| `dashboardPages` | `number` |
| `totalGrids` | `number` |
| `totalTabs` | `number` |
| `totalButtons` | `number` |
| `totalForms` | `number` |
| `routesWithGrids` | `number` |
| `routesWithTabs` | `number` |

<!-- source: component-resetpasswordpage.md -->

# ResetPasswordPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(auth)/reset-password/page.tsx` (line 112)

## Diagram

```mermaid
graph TD
    component_ResetPasswordPage_42a19aef["ResetPasswordPage"]
    class component_ResetPasswordPage_42a19aef rootComponent
```

## Relationships

- RENDERS → `Suspense`
- RENDERS → `ResetPasswordForm`

<!-- source: interface-sociallink.md -->

# SocialLink

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/layout/footer.tsx` (line 15)

## Properties

| Property | Type |
|---|---|
| `platform` | `string` |
| `href` | `string` |
| `icon` | `React.ReactNode` |

<!-- source: component-reviewpage.md -->

# ReviewPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/versions/[versionId]/review/page.tsx` (line 139)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ReviewPage_191d786b["ReviewPage"]
    class component_ReviewPage_191d786b rootComponent
```

## Relationships

- RENDERS → `SummaryCard`
- RENDERS → `FlaggedDocCard`
- RENDERS → `ScreenshotReviewSection`
- USES_HOOK → `useSession`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useEffect`

<!-- source: interface-socialprooftimelineprops-2.md -->

# SocialProofTimelineProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/social-proof/social-proof-timeline.tsx` (line 17)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `milestones` | `Milestone[]` |

<!-- source: component-rootlayout.md -->

# RootLayout

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/layout.tsx` (line 35)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_RootLayout_99adbaf["RootLayout"]
    class component_RootLayout_99adbaf rootComponent
```

## Relationships

- RENDERS → `Providers`
- RENDERS → `Script`

<!-- source: interface-socialprooftrustbadgesprops-2.md -->

# SocialProofTrustBadgesProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/social-proof/social-proof-trust-badges.tsx` (line 26)

## Properties

| Property | Type |
|---|---|
| `headlineKey` | `string` |
| `descriptionKey` | `string` |
| `badges` | `TrustBadge[]` |

<!-- source: component-scenebrowserepos.md -->

# SceneBrowseRepos

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/scenes/SceneBrowseRepos.tsx` (line 73)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `state` | `WizardState` | ✓ | - |
| `provider` | `unknown | unknown` | - | "github" |
| `onUpdate` | `Function` | ✓ | - |
| `onContinue` | `Function` | ✓ | - |
| `onBack` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SceneBrowseRepos_301eda0b["SceneBrowseRepos"]
    class component_SceneBrowseRepos_301eda0b rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-button`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useMemo`

<!-- source: interface-sourcecodeintelligence.md -->

# SourceCodeIntelligence

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/agent-screenshot-mapper.ts` (line 53)

Complete intelligence extracted from source code

## Properties

| Property | Type |
|---|---|
| `routes` | `SourceRoute[]` |
| `menuTree` | `SourceMenuItem[]` |
| `framework` | `string` |
| `routingStrategy` | `'hash' | 'html5'` |
| `commonSelectors` | `Record<string, string>` |
| `auth` | `{
    loginRoute: string;
    usernameSelector?: string;
    passwordSelector?: string;
    submitSelector?: string;
  }` |

<!-- source: component-sceneconnectprovider.md -->

# SceneConnectProvider

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/scenes/SceneConnectProvider.tsx` (line 64)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `state` | `WizardState` | ✓ | - |
| `provider` | `unknown | unknown | unknown` | - | "github" |
| `onUpdate` | `Function` | ✓ | - |
| `onConnected` | `Function` | ✓ | - |
| `onCancel` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SceneConnectProvider_4948ccc3["SceneConnectProvider"]
    class component_SceneConnectProvider_4948ccc3 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `AnimatePresence`
- USES_HOOK → `useState`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useEffect`

<!-- source: interface-sourcemenuitem.md -->

# SourceMenuItem

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/agent-screenshot-mapper.ts` (line 44)

Menu item from sidebar/navigation analysis

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `route` | `string` |
| `icon` | `string` |
| `parent` | `string` |
| `children` | `SourceMenuItem[]` |

<!-- source: component-scenedoctypes.md -->

# SceneDocTypes

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/scenes/SceneDocTypes.tsx` (line 55)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `state` | `WizardState` | ✓ | - |
| `onUpdate` | `Function` | ✓ | - |
| `onGenerate` | `Function` | ✓ | - |
| `onBack` | `Function` | ✓ | - |
| `generating` | `boolean` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SceneDocTypes_1eacf889["SceneDocTypes"]
    class component_SceneDocTypes_1eacf889 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-button`

<!-- source: interface-sourceroute.md -->

# SourceRoute

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/agent-screenshot-mapper.ts` (line 26)

Route extracted from source code analysis

## Properties

| Property | Type |
|---|---|
| `path` | `string` |
| `component` | `string` |
| `requiresAuth` | `boolean` |
| `hasDeactivateGuard` | `boolean` |
| `params` | `string[]` |
| `menuPath` | `string[]` |
| `menuIcon` | `string` |

<!-- source: component-scenegeneration.md -->

# SceneGeneration

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/scenes/SceneGeneration.tsx` (line 105)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `selectedDocTypes` | `string[]` | - | [] |
| `onRetry` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SceneGeneration_496b04d7["SceneGeneration"]
    class component_SceneGeneration_496b04d7 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `CountUp`
- USES_HOOK → `useRouter`
- USES_HOOK → `useSession`
- USES_HOOK → `useRef`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-spacing.md -->

# Spacing

**Kind:** Interface

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 73)

## Properties

| Property | Type |
|---|---|
| `0` | `string` |
| `1` | `string` |
| `2` | `string` |
| `3` | `string` |
| `4` | `string` |
| `5` | `string` |
| `6` | `string` |
| `8` | `string` |
| `10` | `string` |
| `12` | `string` |
| `16` | `string` |
| `20` | `string` |
| `24` | `string` |
| `32` | `string` |

<!-- source: component-sceneprojectdetails.md -->

# SceneProjectDetails

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/scenes/SceneProjectDetails.tsx` (line 18)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `state` | `WizardState` | ✓ | - |
| `onUpdate` | `Function` | ✓ | - |
| `onContinue` | `Function` | ✓ | - |
| `onBack` | `Function` | ✓ | - |
| `onConnectProvider` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_SceneProjectDetails_7dfd9b89["SceneProjectDetails"]
    class component_SceneProjectDetails_7dfd9b89 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-button`
- RENDERS → `AnimatePresence`
- RENDERS → `BranchPickerModal`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`

<!-- source: interface-springdetectionconfig.md -->

# SpringDetectionConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/spring.patterns.ts` (line 252)

## Properties

| Property | Type |
|---|---|
| `name` | `'spring'` |
| `filePatterns` | `string[]` |
| `identifiers` | `RegExp[]` |
| `configFiles` | `string[]` |

<!-- source: component-sceneurlinput.md -->

# SceneUrlInput

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/scenes/SceneUrlInput.tsx` (line 34)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `state` | `WizardState` | ✓ | - |
| `onUrlChange` | `Function` | ✓ | - |
| `onGetStarted` | `Function` | ✓ | - |
| `onSkipRepo` | `Function` | ✓ | - |
| `onProviderClick` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SceneUrlInput_55eddbc9["SceneUrlInput"]
    class component_SceneUrlInput_55eddbc9 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-button`
- RENDERS → `AnimatePresence`
- RENDERS → `motion-p`
- RENDERS → `GitHubIcon`
- RENDERS → `GitLabIcon`
- RENDERS → `BitbucketIcon`
- USES_HOOK → `useState`

<!-- source: interface-springendpoint.md -->

# SpringEndpoint

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/spring-detector.ts` (line 37)

Spring endpoint

## Properties

| Property | Type |
|---|---|
| `method` | `'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'` |
| `path` | `string` |
| `handlerName` | `string` |
| `requestBody` | `string` |
| `responseType` | `string` |
| `pathVariables` | `string[]` |
| `requestParams` | `string[]` |
| `security` | `string` |

<!-- source: component-screenshot.md -->

# Screenshot

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/Screenshot.tsx` (line 19)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `src` | `string` | - | - |
| `alt` | `string` | - | - |
| `caption` | `string` | - | - |
| `metadata` | `string | unknown` | - | - |
| `children` | `any` | - | - |

## Diagram

```mermaid
graph TD
    component_Screenshot_55886afd["Screenshot"]
    class component_Screenshot_55886afd rootComponent
```

## Relationships

- RENDERS → `Image`

<!-- source: interface-springmethod.md -->

# SpringMethod

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/spring-detector.ts` (line 73)

Spring method

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `returnType` | `string` |
| `parameters` | `SpringParameter[]` |
| `isTransactional` | `boolean` |

<!-- source: component-screenshotannotation.md -->

# ScreenshotAnnotation

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/ScreenshotAnnotation.tsx` (line 52)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `src` | `string` | ✓ | - |
| `alt` | `string` | - | - |
| `annotations` | `Annotation[]` | - | - |

## Diagram

```mermaid
graph TD
    component_ScreenshotAnnotation_703f4aa5["ScreenshotAnnotation"]
    class component_ScreenshotAnnotation_703f4aa5 rootComponent
```

<!-- source: interface-springparameter.md -->

# SpringParameter

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/spring-detector.ts` (line 83)

Spring parameter

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `annotation` | `string` |

<!-- source: component-screenshotdashboard.md -->

# ScreenshotDashboard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/versions/[versionId]/screenshots/page.tsx` (line 248)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ScreenshotDashboard_41993c5b["ScreenshotDashboard"]
    class component_ScreenshotDashboard_41993c5b rootComponent
```

## Relationships

- RENDERS → `ScreenshotsContent`

<!-- source: interface-srcimageparameters.md -->

# SrcImageParameters

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/image/index.ts` (line 70)

## Properties

| Property | Type |
|---|---|
| `src` | `string` |

<!-- source: component-screenshotfigure.md -->

# ScreenshotFigure

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Viewer/ScreenshotFigure.tsx` (line 38)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `src` | `string` | ✓ | - |
| `alt` | `string` | - | - |
| `annotations` | `Annotation[]` | - | - |
| `caption` | `string | null` | - | - |
| `lang` | `string` | - | - |
| `dir` | `unknown | unknown` | - | "ltr" |

## Diagram

```mermaid
graph TD
    component_ScreenshotFigure_16491445["ScreenshotFigure"]
    class component_ScreenshotFigure_16491445 rootComponent
```

## Relationships

- RENDERS → `ScreenshotAnnotation`
- RENDERS → `Lightbox`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`

<!-- source: interface-stagetokensummary.md -->

# StageTokenSummary

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/pipeline/token-tracker.ts` (line 40)

## Properties

| Property | Type |
|---|---|
| `inputTokens` | `number` |
| `outputTokens` | `number` |
| `totalTokens` | `number` |
| `costUsd` | `number` |
| `callCount` | `number` |

<!-- source: component-screenshotgallery.md -->

# ScreenshotGallery

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/enterprise/screenshots/ScreenshotGallery.tsx` (line 16)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `screenshots` | `any[]` | ✓ | - |
| `onPreview` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ScreenshotGallery_12a9ee39["ScreenshotGallery"]
    class component_ScreenshotGallery_12a9ee39 rootComponent
```

## Relationships

- USES_HOOK → `useRef`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-statcardprops-2.md -->

# StatCardProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/stat-card.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `valueKey` | `string` |
| `labelKey` | `string` |
| `className` | `string` |

<!-- source: component-screenshotplaceholder.md -->

# ScreenshotPlaceholder

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/ScreenshotPlaceholder.tsx` (line 17)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `routePath` | `string` | ✓ | - |
| `description` | `string` | - | - |
| `onCapture` | `Function` | - | - |
| `onUpload` | `Function` | - | - |
| `onRemove` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_ScreenshotPlaceholder_61a40aa0["ScreenshotPlaceholder"]
    class component_ScreenshotPlaceholder_61a40aa0 rootComponent
```

## Relationships

- RENDERS → `Camera`
- RENDERS → `Upload`
- RENDERS → `X`

<!-- source: interface-statedefinition.md -->

# StateDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/state-machine-detector.ts` (line 38)

A single state/status value

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `value` | `string | number` |
| `description` | `string` |
| `isInitial` | `boolean` |
| `isFinal` | `boolean` |

<!-- source: component-screenshotspage.md -->

# ScreenshotsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/enterprise/screenshots/page.tsx` (line 40)

## Diagram

```mermaid
graph TD
    component_ScreenshotsPage_35829f10["ScreenshotsPage"]
    class component_ScreenshotsPage_35829f10 rootComponent
```

## Relationships

- RENDERS → `CaptureModal`
- RENDERS → `StatusBadge`
- RENDERS → `ScreenshotGallery`
- RENDERS → `Pagination`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-stateresolutionconfig.md -->

# StateResolutionConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 131)

Configuration for resolving a record in a specific workflow state at capture time.
Used by the screenshot-worker's StateResolverService.

## Properties

| Property | Type |
|---|---|
| `listUrl` | `string` |
| `statusColumnHint` | `string` |
| `targetStatusValue` | `string` |
| `maxRowsToScan` | `number` |
| `rowAction` | `'click' | 'dblclick'` |

<!-- source: component-screenshotstabcontent.md -->

# ScreenshotsTabContent

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/page.tsx` (line 1047)

Phase 4: Screenshots tab — loads active version's screenshot dashboard.

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ScreenshotsTabContent_391b89a["ScreenshotsTabContent"]
    class component_ScreenshotsTabContent_391b89a rootComponent
```

## Relationships

- RENDERS → `ScreenshotsContent`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useSession`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-stateresolutionhint.md -->

# StateResolutionHint

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/screenshot-spec.types.ts` (line 51)

Hints for the state resolver about where/how to find matching records.
Used by the screenshot-worker's StateResolverService to navigate to a
list view, scan the grid, and click into a matching record.

## Properties

| Property | Type |
|---|---|
| `listRoute` | `string` |
| `statusColumnHint` | `string` |
| `statusValue` | `string` |
| `entityType` | `string` |

<!-- source: component-scrollprogress.md -->

# ScrollProgress

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/ScrollProgress.tsx` (line 13)

## Diagram

```mermaid
graph TD
    component_ScrollProgress_2f94e9ec["ScrollProgress"]
    class component_ScrollProgress_2f94e9ec rootComponent
```

## Relationships

- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-statetransition-3.md -->

# StateTransition

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/state-machine-detector.ts` (line 49)

A transition between states

## Properties

| Property | Type |
|---|---|
| `from` | `string` |
| `to` | `string` |
| `trigger` | `string` |
| `condition` | `string` |
| `action` | `string` |

<!-- source: component-searchbar.md -->

# SearchBar

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Documents/SearchBar.tsx` (line 9)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onSearch` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SearchBar_1ddcd63d["SearchBar"]
    class component_SearchBar_1ddcd63d rootComponent
```

## Relationships

- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-stepindicatorprops-2.md -->

# StepIndicatorProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/step-indicator.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `step` | `number` |
| `icon` | `LucideIcon` |
| `titleKey` | `string` |
| `descriptionKey` | `string` |

<!-- source: component-securitypage.md -->

# SecurityPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/security/page.tsx` (line 56)

## Diagram

```mermaid
graph TD
    component_SecurityPage_6913ae5c["SecurityPage"]
    class component_SecurityPage_6913ae5c rootComponent
```

## Relationships

- RENDERS → `Link`

<!-- source: interface-strikethroughsupsubtogglesprops.md -->

# StrikeThroughSupSubTogglesProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/toolbar/components/BoldItalicUnderlineToggles.tsx` (line 81)

## Properties

| Property | Type |
|---|---|
| `options` | `('Strikethrough' | 'Sub' | 'Sup')[]` |

<!-- source: component-securitypage-2.md -->

# SecurityPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/admin/security/page.tsx` (line 121)

## Diagram

```mermaid
graph TD
    component_SecurityPage_d8aafe6["SecurityPage"]
    class component_SecurityPage_d8aafe6 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `ShieldCheckIcon`
- RENDERS → `React-Fragment`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-structureindex.md -->

# StructureIndex

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 115)

Structure index loaded from _structure.json

## Properties

| Property | Type |
|---|---|
| `generatedAt` | `string` |
| `project` | `string` |
| `categories` | `CategoryNode[]` |
| `flatCategories` | `FlatCategory[]` |
| `stats` | `{
    totalDocuments: number;
    totalCategories: number;
    categoriesByLevel: {
      level1: number;
      level2: number;
      level3: number;
    };
  }` |

<!-- source: component-settingsmanager.md -->

# SettingsManager

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/SettingsManager.tsx` (line 13)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `settings` | `AISettings` | ✓ | - |
| `onSettingsChange` | `Function` | ✓ | - |
| `onReset` | `Function` | ✓ | - |
| `onExport` | `Function` | ✓ | - |
| `onImport` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SettingsManager_2e1b2e05["SettingsManager"]
    class component_SettingsManager_2e1b2e05 rootComponent
```

<!-- source: interface-structureinput.md -->

# StructureInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-06.types.ts` (line 15)

## Properties

| Property | Type |
|---|---|
| `synthesis` | `SynthesisResult` |
| `suggestedCategories` | `string[]` |
| `routeMappings` | `RouteMappingResult` |

<!-- source: component-settingspage.md -->

# SettingsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/page.tsx` (line 11)

## Diagram

```mermaid
graph TD
    component_SettingsPage_e60fd46["SettingsPage"]
    class component_SettingsPage_e60fd46 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `Cog6ToothIcon`
- RENDERS → `Card`
- RENDERS → `CardHeader`
- RENDERS → `CardContent`

<!-- source: interface-structureissue.md -->

# StructureIssue

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/structure-scorer.ts` (line 32)

## Properties

| Property | Type |
|---|---|
| `type` | `| 'long-paragraph'
    | 'no-lists'
    | 'no-tables'
    | 'sparse-headings'
    | 'uniform-blocks'
    | 'long-document'
    | 'no-callouts'` |
| `severity` | `'warning' | 'fail'` |
| `location` | `string` |
| `detail` | `string` |
| `suggestion` | `string` |

<!-- source: component-shortcutoverlay.md -->

# ShortcutOverlay

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/DeskDialogs.tsx` (line 207)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onClose` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ShortcutOverlay_471308ce["ShortcutOverlay"]
    class component_ShortcutOverlay_471308ce rootComponent
```

## Relationships

- RENDERS → `Backdrop`
- RENDERS → `XMarkIcon`

<!-- source: interface-structuremodification.md -->

# StructureModification

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 116)

## Properties

| Property | Type |
|---|---|
| `action` | `'add' | 'remove' | 'rename' | 'move'` |
| `targetType` | `'category' | 'subcategory' | 'document'` |
| `targetId` | `string` |
| `newValue` | `string` |
| `newParentId` | `string` |

<!-- source: component-sidebar.md -->

# Sidebar

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Layout/Sidebar.tsx` (line 44)

## Diagram

```mermaid
graph TD
    component_Sidebar_72fc4ee3["Sidebar"]
    class component_Sidebar_72fc4ee3 rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `motion-div`
- RENDERS → `Icon`
- USES_HOOK → `usePathname`

<!-- source: interface-structureresult.md -->

# StructureResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-06.types.ts` (line 29)

## Properties

| Property | Type |
|---|---|
| `documents` | `PlannedDocument[]` |
| `categories` | `DocumentCategoryStructure[]` |
| `tokenUsage` | `TokenUsage[]` |

<!-- source: component-skeletonbuilder.md -->

# SkeletonBuilder

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/DocAutomation/SkeletonBuilder.tsx` (line 37)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `skeleton` | `SkeletonStructure | null` | ✓ | - |
| `isDirty` | `boolean` | - | false |
| `loading` | `boolean` | - | false |
| `onAddCategory` | `Function` | ✓ | - |
| `onRemoveCategory` | `Function` | ✓ | - |
| `onUpdateCategory` | `Function` | ✓ | - |
| `onAddDocument` | `Function` | ✓ | - |
| `onRemoveDocument` | `Function` | ✓ | - |
| `onUpdateDocument` | `Function` | ✓ | - |
| `onReorderCategories` | `Function` | ✓ | - |
| `onReorderDocuments` | `Function` | ✓ | - |
| `onSave` | `Function` | ✓ | - |
| `onReset` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SkeletonBuilder_4d65a3cc["SkeletonBuilder"]
    class component_SkeletonBuilder_4d65a3cc rootComponent
```

## Relationships

- RENDERS → `Button`
- RENDERS → `RotateCcw`
- RENDERS → `Loader2`
- RENDERS → `Save`
- RENDERS → `FolderPlus`
- RENDERS → `Reorder-Group`
- RENDERS → `CategoryItem`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`

<!-- source: interface-structurescore.md -->

# StructureScore

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/structure-scorer.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `overall` | `number` |
| `dimensions` | `{
    paragraphDensity: number;
    listUsage: number;
    tablePresence: number;
    headingGranularity: number;
    visualVariety: number;
  }` |
| `issues` | `StructureIssue[]` |
| `passesGate` | `boolean` |

<!-- source: component-snoozemenu.md -->

# SnoozeMenu

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/DeskDialogs.tsx` (line 52)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onPick` | `Function` | ✓ | - |
| `onClose` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SnoozeMenu_a1545bf["SnoozeMenu"]
    class component_SnoozeMenu_a1545bf rootComponent
```

## Relationships

- RENDERS → `Backdrop`
- USES_HOOK → `useEffect`

<!-- source: interface-subsectionplan.md -->

# SubsectionPlan

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-09.types.ts` (line 65)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `title` | `string` |
| `contentOutline` | `string[]` |

<!-- source: component-sortabledocumentlist.md -->

# SortableDocumentList

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/PublishingSidebar/SortableDocumentList.tsx` (line 141)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `categories` | `CategoryGroup[]` | ✓ | - |
| `selectedDocument` | `string | null` | ✓ | - |
| `onSelectDocument` | `Function` | ✓ | - |
| `onReorder` | `Function` | ✓ | - |
| `loading` | `boolean` | - | false |
| `loadingProgress` | `unknown` | - | {} |
| `processing` | `boolean` | - | false |
| `editMode` | `boolean` | - | false |

## Diagram

```mermaid
graph TD
    component_SortableDocumentList_68686a96["SortableDocumentList"]
    class component_SortableDocumentList_68686a96 rootComponent
```

## Relationships

- RENDERS → `FileText`
- RENDERS → `CategoryIcon`
- RENDERS → `Folder`
- RENDERS → `DndContext`
- RENDERS → `SortableContext`
- RENDERS → `SortableDocumentItem`
- USES_HOOK → `useSensors`
- USES_HOOK → `useSensor`

<!-- source: interface-suggestionlistparams.md -->

# SuggestionListParams

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/suggestions.ts` (line 13)

Suggestion list query parameters

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `status` | `SuggestionStatus` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: component-sortcontrol.md -->

# SortControl

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Documents/SortControl.tsx` (line 30)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `value` | `SortOption` | ✓ | - |
| `onChange` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SortControl_65f325c3["SortControl"]
    class component_SortControl_65f325c3 rootComponent
```

## Relationships

- RENDERS → `BarsArrowDownIcon`
- RENDERS → `BarsArrowUpIcon`
- USES_HOOK → `useState`

<!-- source: interface-suggestionwithuser.md -->

# SuggestionWithUser

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/suggestion.dto.ts` (line 8)

Suggestion DTO with populated user relation

## Properties

| Property | Type |
|---|---|
| `user` | `Pick<User, 'id' | 'name' | 'email'>` |

<!-- source: component-statsrow.md -->

# StatsRow

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/dashboard/StatsRow.tsx` (line 24)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `documentCount` | `number` | ✓ | - |
| `categoryCount` | `number` | ✓ | - |
| `lastGeneratedAt` | `string | null` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StatsRow_27f4ffc4["StatsRow"]
    class component_StatsRow_27f4ffc4 rootComponent
```

<!-- source: interface-sveltedetectionconfig.md -->

# SvelteDetectionConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/patterns/svelte.patterns.ts` (line 243)

## Properties

| Property | Type |
|---|---|
| `name` | `'svelte'` |
| `filePatterns` | `string[]` |
| `identifiers` | `RegExp[]` |
| `configFiles` | `string[]` |

<!-- source: component-stepeditor.md -->

# StepEditor

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/StepEditor.tsx` (line 56)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `flowId` | `string` | ✓ | - |
| `token` | `string` | - | - |
| `onClose` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StepEditor_62b70f9b["StepEditor"]
    class component_StepEditor_62b70f9b rootComponent
```

## Relationships

- RENDERS → `Loader2`
- RENDERS → `Save`
- RENDERS → `X`
- RENDERS → `Languages`
- RENDERS → `Camera`
- RENDERS → `ArrowUp`
- RENDERS → `ArrowDown`
- RENDERS → `SquareDashedMousePointer`
- RENDERS → `Trash2`
- RENDERS → `RedactionCanvas`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-svelteprop.md -->

# SvelteProp

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/svelte-detector.ts` (line 48)

Svelte prop

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `defaultValue` | `string` |

<!-- source: component-stepindicator.md -->

# StepIndicator

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/NewProjectWizard/StepIndicator.tsx` (line 17)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `activeStep` | `number` | ✓ | - |
| `completedSteps` | `number[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StepIndicator_20f10177["StepIndicator"]
    class component_StepIndicator_20f10177 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `motion-svg`

<!-- source: interface-synthesisinput.md -->

# SynthesisInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-05.types.ts` (line 19)

## Properties

| Property | Type |
|---|---|
| `analyses` | `ChunkAnalysis[]` |

<!-- source: component-stylecard.md -->

# StyleCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/settings/branding/page.tsx` (line 1355)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `name` | `string` | ✓ | - |
| `description` | `string` | ✓ | - |
| `tag` | `string` | ✓ | - |
| `active` | `boolean` | ✓ | - |
| `onClick` | `Function` | ✓ | - |
| `primaryColor` | `string` | ✓ | - |
| `accentColor` | `string` | ✓ | - |
| `children` | `unknown` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_StyleCard_390ce941["StyleCard"]
    class component_StyleCard_390ce941 rootComponent
```

## Relationships

- RENDERS → `CheckIcon`

<!-- source: interface-synthesisresult.md -->

# SynthesisResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-05.types.ts` (line 30)

## Properties

| Property | Type |
|---|---|
| `summary` | `ApplicationSummary` |
| `personas` | `UserPersona[]` |
| `featureAreas` | `FeatureArea[]` |
| `plan` | `DocumentationPlan` |
| `complexity` | `ProjectComplexity` |
| `crossModuleRelationships` | `CrossModuleRelationship[]` |
| `tokenUsage` | `TokenUsage[]` |

<!-- source: component-suggestioncard.md -->

# SuggestionCard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Suggestions/SuggestionCard.tsx` (line 13)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `suggestion` | `SuggestionWithUser` | ✓ | - |
| `onAccept` | `Function` | ✓ | - |
| `onReject` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SuggestionCard_6b94172a["SuggestionCard"]
    class component_SuggestionCard_6b94172a rootComponent
```

## Relationships

- RENDERS → `Avatar`
- RENDERS → `StatusBadge`
- RENDERS → `Check`
- RENDERS → `X`

<!-- source: interface-tabcapturespec.md -->

# TabCaptureSpec

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/screenshot-spec.types.ts` (line 108)

Tab capture specification

## Properties

| Property | Type |
|---|---|
| `tabLabel` | `string` |
| `tabIndex` | `number` |
| `tabSelector` | `string` |
| `tabSystem` | `string` |

<!-- source: component-suggestionpanel.md -->

# SuggestionPanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Suggestions/SuggestionPanel.tsx` (line 18)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `documentId` | `string` | ✓ | - |
| `enableRealtime` | `boolean` | - | true |

## Diagram

```mermaid
graph TD
    component_SuggestionPanel_c0049cc["SuggestionPanel"]
    class component_SuggestionPanel_c0049cc rootComponent
```

## Relationships

- RENDERS → `Loader2`
- RENDERS → `Filter`
- RENDERS → `FilterButton`
- RENDERS → `SuggestionCard`
- USES_HOOK → `useSuggestions`
- USES_HOOK → `useState`

<!-- source: interface-tabdefinition-2.md -->

# TabDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 55)

A tab discovered in source code

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `index` | `number` |
| `selector` | `string` |
| `tabSystem` | `string` |
| `conditionalOn` | `string` |
| `hostComponent` | `string` |
| `sourceFile` | `string` |

<!-- source: component-supportagentpage.md -->

# SupportAgentPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/enterprise/support-agent/page.tsx` (line 43)

## Diagram

```mermaid
graph TD
    component_SupportAgentPage_2af58ae9["SupportAgentPage"]
    class component_SupportAgentPage_2af58ae9 rootComponent
```

## Relationships

- USES_HOOK → `useSession`
- USES_HOOK → `useRouter`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-tableeditorprops.md -->

# TableEditorProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/plugins/table/TableEditor.tsx` (line 70)

## Properties

| Property | Type |
|---|---|
| `parentEditor` | `LexicalEditor` |
| `lexicalTable` | `TableNode` |
| `mdastNode` | `Mdast.Table` |

<!-- source: component-supportagentsection.md -->

# SupportAgentSection

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/SupportAgentSection.tsx` (line 86)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SupportAgentSection_4a89d7a3["SupportAgentSection"]
    class component_SupportAgentSection_4a89d7a3 rootComponent
```

## Relationships

- RENDERS → `ChevronUp`
- RENDERS → `ChevronDown`
- RENDERS → `Code2`
- RENDERS → `EmbedCodeGenerator`
- RENDERS → `Sparkles`
- RENDERS → `MessageCircle`
- RENDERS → `Send`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`
- USES_HOOK → `useRef`
- USES_HOOK → `useCallback`

<!-- source: interface-tableofcontentsprops.md -->

# TableOfContentsProps

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/components/TableOfContents.tsx` (line 18)

## Properties

| Property | Type |
|---|---|
| `entries` | `TocEntry[]` |
| `onNavigate` | `(id: string) => void` |
| `title` | `string` |
| `className` | `string` |
| `scrollOffset` | `number` |

<!-- source: component-supportagentsettingspage.md -->

# SupportAgentSettingsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/enterprise/support-agent/settings/page.tsx` (line 66)

## Diagram

```mermaid
graph TD
    component_SupportAgentSettingsPage_68057196["SupportAgentSettingsPage"]
    class component_SupportAgentSettingsPage_68057196 rootComponent
```

## Relationships

- RENDERS → `ArrowLeft`
- RENDERS → `Sparkles`
- RENDERS → `Code2`
- RENDERS → `EmbedCodeGenerator`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useCurrentProjectId`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useCallback`
- USES_HOOK → `useEffect`

<!-- source: interface-tabprofile.md -->

# TabProfile

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/site-map.types.ts` (line 20)

## Properties

| Property | Type |
|---|---|
| `label` | `string` |
| `index` | `number` |
| `selector` | `string` |
| `detectionMethod` | `string` |

<!-- source: component-supportchatwidget.md -->

# SupportChatWidget

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/SupportChatWidget.tsx` (line 38)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `slugId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_SupportChatWidget_41827e0a["SupportChatWidget"]
    class component_SupportChatWidget_41827e0a rootComponent
```

## Relationships

- RENDERS → `MessageCircle`
- RENDERS → `X`
- RENDERS → `LifeBuoy`
- RENDERS → `ReactMarkdown`
- RENDERS → `StreamingDots`
- RENDERS → `ThumbsUp`
- RENDERS → `ThumbsDown`
- RENDERS → `Send`
- RENDERS → `EscalatePanel`
- USES_HOOK → `useVersionContext`
- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`
- USES_HOOK → `useCallback`

<!-- source: interface-termdefinition.md -->

# TermDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-11.types.ts` (line 115)

## Properties

| Property | Type |
|---|---|
| `term` | `string` |
| `variants` | `string[]` |
| `definition` | `string` |
| `usageGuideline` | `string` |

<!-- source: component-symbollist.md -->

# SymbolList

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Parser/SymbolList.tsx` (line 18)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `symbols` | `Symbol[]` | ✓ | - |
| `onSymbolClick` | `Function` | - | - |
| `selectedSymbol` | `Symbol` | - | - |
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_SymbolList_40b58770["SymbolList"]
    class component_SymbolList_40b58770 rootComponent
```

## Relationships

- RENDERS → `FilterButton`
- RENDERS → `SymbolIcon`
- USES_HOOK → `useState`
- USES_HOOK → `useMemo`

<!-- source: interface-testimonialcardprops-2.md -->

# TestimonialCardProps

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/components/shared/testimonial-card.tsx` (line 13)

## Properties

| Property | Type |
|---|---|
| `quoteKey` | `string` |
| `authorNameKey` | `string` |
| `authorRoleKey` | `string` |
| `avatarSrc` | `string` |
| `rating` | `number` |

<!-- source: component-teamactivity.md -->

# TeamActivity

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/dashboard/TeamActivity.tsx` (line 44)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `documents` | `RecentDoc[]` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TeamActivity_3ecf8766["TeamActivity"]
    class component_TeamActivity_3ecf8766 rootComponent
```

<!-- source: interface-textnode.md -->

# TextNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 20)

Text content node (markdown)

## Properties

| Property | Type |
|---|---|
| `type` | `'text'` |
| `content` | `string` |

<!-- source: component-technicaldocsindexpage.md -->

# TechnicalDocsIndexPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/page.tsx` (line 20)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TechnicalDocsIndexPage_32fb2aea["TechnicalDocsIndexPage"]
    class component_TechnicalDocsIndexPage_32fb2aea rootComponent
```

## Relationships

- RENDERS → `EntityTree`
- RENDERS → `ArrowUpTrayIcon`
- RENDERS → `ArrowPathIcon`
- RENDERS → `FreshnessCockpit`
- RENDERS → `ConnectorsPanel`
- RENDERS → `DocsPrPanel`
- RENDERS → `ExportModal`
- RENDERS → `CodebaseChat`
- RENDERS → `CommandPalette`
- USES_HOOK → `useState`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useRouter`
- USES_HOOK → `useEffect`

<!-- source: interface-themecolors.md -->

# ThemeColors

**Kind:** Interface

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `primary` | `ColorScale` |
| `secondary` | `ColorScale` |
| `neutral` | `ColorScale` |
| `success` | `SemanticColorScale` |
| `warning` | `SemanticColorScale` |
| `error` | `SemanticColorScale` |
| `info` | `SemanticColorScale` |

<!-- source: component-technicaldocslayout.md -->

# TechnicalDocsLayout

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/technical-docs/layout.tsx` (line 16)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `unknown` | ✓ | - |
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TechnicalDocsLayout_5fecf67a["TechnicalDocsLayout"]
    class component_TechnicalDocsLayout_5fecf67a rootComponent
```

## Relationships

- RENDERS → `Link`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-themeconfig-2.md -->

# ThemeConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 125)

Theme configuration

## Properties

| Property | Type |
|---|---|
| `defaultMode` | `ThemeMode` |
| `enablePersistence` | `boolean` |
| `storageKey` | `string` |
| `enableSystemPreference` | `boolean` |
| `customTokens` | `Partial<ThemeTokens>` |

<!-- source: component-termspage.md -->

# TermsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/terms/page.tsx` (line 159)

## Diagram

```mermaid
graph TD
    component_TermsPage_6db3bb5c["TermsPage"]
    class component_TermsPage_6db3bb5c rootComponent
```

## Relationships

- RENDERS → `Link`
- RENDERS → `motion-div`
- RENDERS → `Reveal`

<!-- source: interface-themetokens-2.md -->

# ThemeTokens

**Kind:** Interface

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 109)

Complete theme token definition

## Properties

| Property | Type |
|---|---|
| `colors` | `ThemeColors` |
| `typography` | `Typography` |
| `spacing` | `Spacing` |
| `borderRadius` | `BorderRadius` |
| `shadows` | `Shadows` |

<!-- source: component-themetoggle.md -->

# ThemeToggle

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/ui/theme-toggle.tsx` (line 9)

## Diagram

```mermaid
graph TD
    component_ThemeToggle_a6ab26a["ThemeToggle"]
    class component_ThemeToggle_a6ab26a rootComponent
```

## Relationships

- RENDERS → `motion-button`
- RENDERS → `AnimatePresence`
- RENDERS → `motion-div`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-themeupdateevent.md -->

# ThemeUpdateEvent

**Kind:** Interface

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 141)

Theme update event

## Properties

| Property | Type |
|---|---|
| `mode` | `ThemeMode` |
| `tokens` | `ThemeTokens` |
| `timestamp` | `number` |

<!-- source: interface-themevars-2.md -->

# ThemeVars

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/lib/theme.ts` (line 10)

## Properties

| Property | Type |
|---|---|
| `'--bg-page'` | `string` |
| `'--bg-surface'` | `string` |
| `'--bg-surface-alt'` | `string` |
| `'--bg-nav'` | `string` |
| `'--text-heading'` | `string` |
| `'--text-body'` | `string` |
| `'--text-muted'` | `string` |
| `'--text-on-accent'` | `string` |
| `'--accent'` | `string` |
| `'--accent-hover'` | `string` |
| `'--accent-subtle'` | `string` |
| `'--accent-glow'` | `string` |
| `'--border'` | `string` |
| `'--border-hover'` | `string` |

<!-- source: component-threadlist.md -->

# ThreadList

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/ThreadList.tsx` (line 80)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `bucket` | `BucketKey` | ✓ | - |
| `threads` | `DeskThread[]` | ✓ | - |
| `loading` | `boolean` | ✓ | - |
| `selectedIndex` | `number` | ✓ | - |
| `openThreadId` | `string | null` | ✓ | - |
| `now` | `number` | ✓ | - |
| `gaps` | `TicketTopicProposal[]` | ✓ | - |
| `gapDrafts` | `Record` | ✓ | - |
| `onSelect` | `Function` | ✓ | - |
| `onOpen` | `Function` | ✓ | - |
| `onDraftGap` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ThreadList_6947c1c4["ThreadList"]
    class component_ThreadList_6947c1c4 rootComponent
```

## Relationships

- RENDERS → `ChatBubbleLeftRightIcon`
- RENDERS → `InboxIcon`
- RENDERS → `GapCard`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: component-threadview.md -->

# ThreadView

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/desk/components/ThreadView.tsx` (line 95)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `thread` | `DeskThreadDetail | null` | ✓ | - |
| `loading` | `boolean` | ✓ | - |
| `composerBody` | `string` | ✓ | - |
| `onComposerBodyChange` | `Function` | ✓ | - |
| `internalMode` | `boolean` | ✓ | - |
| `onToggleInternal` | `Function` | ✓ | - |
| `composerRef` | `unknown` | ✓ | - |
| `sending` | `boolean` | ✓ | - |
| `onSend` | `Function` | ✓ | - |
| `onTransition` | `Function` | ✓ | - |
| `onOpenSnooze` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ThreadView_3f845f6["ThreadView"]
    class component_ThreadView_3f845f6 rootComponent
```

## Relationships

- RENDERS → `ChatBubbleLeftEllipsisIcon`
- RENDERS → `Chip`
- RENDERS → `LockClosedIcon`
- RENDERS → `MessageBody`
- RENDERS → `ExclamationTriangleIcon`
- RENDERS → `PaperClipIcon`
- RENDERS → `EyeIcon`
- RENDERS → `PaperAirplaneIcon`
- USES_HOOK → `useRef`
- USES_HOOK → `useState`
- USES_HOOK → `useMemo`
- USES_HOOK → `useEffect`

<!-- source: interface-tocentry-2.md -->

# TocEntry

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/components/TableOfContents.tsx` (line 11)

Table of Contents entry interface

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `text` | `string` |
| `level` | `number` |
| `children` | `TocEntry[]` |

<!-- source: component-ticketcontentopportunities.md -->

# TicketContentOpportunities

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/TicketContentOpportunities.tsx` (line 35)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TicketContentOpportunities_5c27b5ed["TicketContentOpportunities"]
    class component_TicketContentOpportunities_5c27b5ed rootComponent
```

## Relationships

- USES_HOOK → `useSession`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-tokenbudget.md -->

# TokenBudget

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 285)

## Properties

| Property | Type |
|---|---|
| `maxInput` | `number` |
| `maxOutput` | `number` |
| `maxTotal` | `number` |

<!-- source: component-timeperiodselector.md -->

# TimePeriodSelector

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/TimePeriodSelector.tsx` (line 21)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `value` | `TimePeriod` | ✓ | - |
| `onChange` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_TimePeriodSelector_7d8b7e65["TimePeriodSelector"]
    class component_TimePeriodSelector_7d8b7e65 rootComponent
```

<!-- source: interface-tokensummary.md -->

# TokenSummary

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/pipeline/token-tracker.ts` (line 29)

## Properties

| Property | Type |
|---|---|
| `totalInputTokens` | `number` |
| `totalOutputTokens` | `number` |
| `totalTokens` | `number` |
| `totalCostUsd` | `number` |
| `byStage` | `Record<string, StageTokenSummary>` |
| `byModel` | `Record<string, ModelTokenSummary>` |
| `budgetRemaining` | `number` |
| `budgetUsedPercent` | `number` |

<!-- source: component-timeserieschart.md -->

# TimeSeriesChart

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Analytics/charts/TimeSeriesChart.tsx` (line 60)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `data` | `TimeSeriesDataPoint[]` | ✓ | - |
| `loading` | `boolean` | - | false |
| `title` | `string` | - | - |
| `height` | `number` | - | 280 |

## Diagram

```mermaid
graph TD
    component_TimeSeriesChart_b9d8671["TimeSeriesChart"]
    class component_TimeSeriesChart_b9d8671 rootComponent
```

## Relationships

- RENDERS → `ResponsiveContainer`
- RENDERS → `AreaChart`
- RENDERS → `CartesianGrid`
- RENDERS → `XAxis`
- RENDERS → `YAxis`
- RENDERS → `Tooltip`
- RENDERS → `CustomTooltip`
- RENDERS → `Area`

<!-- source: interface-tokentrackerconfig.md -->

# TokenTrackerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/pipeline/token-tracker.ts` (line 24)

## Properties

| Property | Type |
|---|---|
| `budget` | `TokenBudget` |
| `warnThreshold` | `number` |

<!-- source: interface-tokenusage-3.md -->

# TokenUsage

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/common.types.ts` (line 291)

## Properties

| Property | Type |
|---|---|
| `stage` | `JobStage` |
| `inputTokens` | `number` |
| `outputTokens` | `number` |
| `model` | `'claude' | 'openai'` |
| `timestamp` | `Date` |
| `cost` | `number` |

<!-- source: component-tourembed.md -->

# TourEmbed

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/components/TourEmbed.tsx` (line 38)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `flowId` | `string` | ✓ | - |
| `flowName` | `string` | - | - |
| `primaryColor` | `string` | - | "#0891B2" |

## Diagram

```mermaid
graph TD
    component_TourEmbed_4b72491d["TourEmbed"]
    class component_TourEmbed_4b72491d rootComponent
```

## Relationships

- RENDERS → `Route`
- RENDERS → `Square`
- RENDERS → `Play`
- RENDERS → `Check`
- RENDERS → `Copy`
- USES_HOOK → `useState`

<!-- source: interface-troubleshootinggeneratorinput.md -->

# TroubleshootingGeneratorInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-14.types.ts` (line 139)

## Properties

| Property | Type |
|---|---|
| `appName` | `string` |
| `synthesis` | `{
    summary: string;
    personas: Array<{ name: string; description: string }>;
    featureAreas: Array<{ name: string; description: string; modules: string[] }>;
  }` |
| `troubleshootingSections` | `ExtractedTroubleshootingSection[]` |
| `existingCategories` | `DocumentCategoryStructure[]` |
| `existingDocuments` | `PlannedDocument[]` |
| `generatedDocuments` | `GeneratedDocument[]` |
| `adminDocIds` | `Set<string>` |

<!-- source: component-trypage.md -->

# TryPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/try/page.tsx` (line 22)

## Diagram

```mermaid
graph TD
    component_TryPage_79b58c98["TryPage"]
    class component_TryPage_79b58c98 rootComponent
```

## Relationships

- RENDERS → `CodebaseChat`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-trustbadge-2.md -->

# TrustBadge

**Kind:** Interface

**Source:** `atloria-monorepo/templates/site-bootstrap/src/sections/social-proof/social-proof-trust-badges.tsx` (line 20)

## Properties

| Property | Type |
|---|---|
| `icon` | `LucideIcon` |
| `logoSrc` | `string` |
| `nameKey` | `string` |

<!-- source: component-usagedashboard.md -->

# UsageDashboard

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/AI/UsageDashboard.tsx` (line 10)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `stats` | `AIUsageStats` | ✓ | - |
| `loading` | `boolean` | - | - |

## Diagram

```mermaid
graph TD
    component_UsageDashboard_75f6d25f["UsageDashboard"]
    class component_UsageDashboard_75f6d25f rootComponent
```

## Relationships

- RENDERS → `StatCard`

<!-- source: interface-typography.md -->

# Typography

**Kind:** Interface

**Source:** `atloria-monorepo/packages/theme-engine/src/lib/types.ts` (line 66)

## Properties

| Property | Type |
|---|---|
| `fontFamily` | `FontFamily` |
| `fontSize` | `FontSize` |
| `fontWeight` | `FontWeight` |
| `lineHeight` | `LineHeight` |

<!-- source: component-usercursors.md -->

# UserCursors

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Editor/UserCursors.tsx` (line 111)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `users` | `UserWithPosition[]` | ✓ | - |
| `showLabels` | `boolean` | - | true |
| `containerRef` | `unknown` | - | - |
| `className` | `string` | - | "" |

## Diagram

```mermaid
graph TD
    component_UserCursors_31adce80["UserCursors"]
    class component_UserCursors_31adce80 rootComponent
```

## Relationships

- RENDERS → `Cursor`
- USES_HOOK → `useMemo`

<!-- source: interface-uilibrarysummary.md -->

# UILibrarySummary

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/ui-library-detector.ts` (line 39)

UI library usage summary

## Properties

| Property | Type |
|---|---|
| `library` | `UILibrary` |
| `componentCount` | `number` |
| `uniqueComponents` | `string[]` |
| `formComponents` | `number` |
| `dataComponents` | `number` |
| `layoutComponents` | `number` |

<!-- source: component-usermanualspage.md -->

# UserManualsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(marketing)/product/user-manuals/page.tsx` (line 72)

## Diagram

```mermaid
graph TD
    component_UserManualsPage_279812b9["UserManualsPage"]
    class component_UserManualsPage_279812b9 rootComponent
```

## Relationships

- RENDERS → `Link`

<!-- source: interface-uncertainty.md -->

# Uncertainty

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-10.types.ts` (line 128)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `description` | `string` |
| `severity` | `'low' | 'medium' | 'high'` |
| `resolved` | `boolean` |
| `resolution` | `string` |

<!-- source: component-userspage.md -->

# UsersPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/admin/users/page.tsx` (line 9)

## Diagram

```mermaid
graph TD
    component_UsersPage_2f8baf48["UsersPage"]
    class component_UsersPage_2f8baf48 rootComponent
```

## Relationships

- RENDERS → `motion-div`
- RENDERS → `UsersIcon`

<!-- source: interface-updateaudiencedto.md -->

# UpdateAudienceDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/audiences.ts` (line 19)

Audience update DTO

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `color` | `string` |
| `icon` | `string` |
| `description` | `string` |

<!-- source: component-variantpicker.md -->

# VariantPicker

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/pme/variant-picker.tsx` (line 24)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `onPreview` | `Function` | ✓ | - |
| `onBack` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_VariantPicker_1aaae3b4["VariantPicker"]
    class component_VariantPicker_1aaae3b4 rootComponent
```

## Relationships

- USES_HOOK → `usePmeStore`
- USES_HOOK → `usePme`
- USES_HOOK → `useState`

<!-- source: interface-updatecategorydto.md -->

# UpdateCategoryDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/category.dto.ts` (line 21)

DTO for updating an existing category

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `icon` | `string` |
| `color` | `string` |
| `order` | `number` |
| `parentId` | `string` |
| `defaultDocId` | `string` |

<!-- source: component-verifyemailpage.md -->

# VerifyEmailPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/(auth)/verify-email/page.tsx` (line 58)

## Diagram

```mermaid
graph TD
    component_VerifyEmailPage_357d51f7["VerifyEmailPage"]
    class component_VerifyEmailPage_357d51f7 rootComponent
```

## Relationships

- RENDERS → `Suspense`
- RENDERS → `VerifyEmailContent`

<!-- source: interface-updatecommentdto.md -->

# UpdateCommentDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/comment.dto.ts` (line 26)

Update comment DTO

## Properties

| Property | Type |
|---|---|
| `content` | `string` |
| `resolved` | `boolean` |

<!-- source: component-versionbanners.md -->

# VersionBanners

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/DeprecationBanner.tsx` (line 8)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `slugId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_VersionBanners_2111a7a5["VersionBanners"]
    class component_VersionBanners_2111a7a5 rootComponent
```

## Relationships

- USES_HOOK → `useVersionContext`
- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useState`

<!-- source: interface-updatedocumentdto.md -->

# UpdateDocumentDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/document.dto.ts` (line 28)

DTO for updating a document

## Properties

| Property | Type |
|---|---|
| `title` | `string` |
| `slug` | `string` |
| `content` | `string` |
| `contentHtml` | `string` |
| `type` | `DocumentType` |
| `audiences` | `Audience[]` |
| `state` | `DocumentState` |
| `kgEntityId` | `string` |
| `kgEntityType` | `string` |
| `isPublic` | `boolean` |
| `canRegenerate` | `boolean` |
| `updatedById` | `string` |

<!-- source: component-versioncontext-ts.md -->

# versionContext.ts

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/stores/versionContext.ts` (line 1)

## Diagram

```mermaid
graph TD
    component_versionContext_ts_61f905["versionContext.ts"]
    class component_versionContext_ts_61f905 rootComponent
```

<!-- source: interface-updateorganizationdto.md -->

# UpdateOrganizationDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/organization.dto.ts` (line 12)

DTO for updating an organization

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |

<!-- source: component-versiondropdown.md -->

# VersionDropdown

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Layout/VersionDropdown.tsx` (line 12)

## Diagram

```mermaid
graph TD
    component_VersionDropdown_4ed9973d["VersionDropdown"]
    class component_VersionDropdown_4ed9973d rootComponent
```

## Relationships

- RENDERS → `TagIcon`
- USES_HOOK → `useSession`
- USES_HOOK → `useProjectContext`
- USES_HOOK → `useVersionContext`
- USES_HOOK → `useEffect`

<!-- source: interface-updateprojectdto.md -->

# UpdateProjectDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/project.dto.ts` (line 17)

DTO for updating a project

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `slug` | `string` |
| `description` | `string` |
| `themeId` | `string` |
| `repoUrl` | `string` |
| `repoBranch` | `string` |

<!-- source: component-versionedaudiencepage.md -->

# VersionedAudiencePage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/v/[versionNumber]/[audienceSlug]/page.tsx` (line 9)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_VersionedAudiencePage_64a5ab97["VersionedAudiencePage"]
    class component_VersionedAudiencePage_64a5ab97 rootComponent
```

## Relationships

- RENDERS → `Link`
- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-updatesuggestiondto.md -->

# UpdateSuggestionDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/suggestion.dto.ts` (line 25)

Update suggestion DTO

## Properties

| Property | Type |
|---|---|
| `status` | `SuggestionStatus` |
| `reviewComment` | `string` |

<!-- source: component-versioneddocumentpage.md -->

# VersionedDocumentPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/v/[versionNumber]/[audienceSlug]/[documentSlug]/page.tsx` (line 8)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_VersionedDocumentPage_2cb8a95b["VersionedDocumentPage"]
    class component_VersionedDocumentPage_2cb8a95b rootComponent
```

## Relationships

- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-updatethemedto.md -->

# UpdateThemeDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/theme.dto.ts` (line 27)

DTO for updating a theme

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `colors` | `ThemeColors` |
| `typography` | `ThemeTypography` |
| `layout` | `ThemeLayout` |
| `customCss` | `string` |
| `darkModeEnabled` | `boolean` |
| `darkModeDefault` | `string` |
| `darkModeColors` | `ThemeColors` |
| `whiteLabelEnabled` | `boolean` |
| `hidePoweredBy` | `boolean` |
| `customDomain` | `string` |
| `customFooter` | `string` |
| `audienceThemes` | `AudienceThemes` |
| `isActive` | `boolean` |

<!-- source: component-versionedprojectpage.md -->

# VersionedProjectPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/v/[versionNumber]/page.tsx` (line 10)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_VersionedProjectPage_6b6f3d00["VersionedProjectPage"]
    class component_VersionedProjectPage_6b6f3d00 rootComponent
```

## Relationships

- RENDERS → `Link`
- USES_HOOK → `useVersionContext`
- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-updateuserdto.md -->

# UpdateUserDto

**Kind:** Interface

**Source:** `atloria-monorepo/packages/types/src/dtos/user.dto.ts` (line 17)

DTO for updating a user

## Properties

| Property | Type |
|---|---|
| `email` | `string` |
| `name` | `string` |
| `passwordHash` | `string` |
| `role` | `UserRole` |

<!-- source: component-versionhistorypanel.md -->

# VersionHistoryPanel

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Document/VersionHistoryPanel.tsx` (line 41)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `documentId` | `string` | ✓ | - |
| `currentVersion` | `number` | ✓ | - |
| `onSelectVersion` | `Function` | ✓ | - |
| `onRestore` | `Function` | ✓ | - |
| `onClose` | `Function` | ✓ | - |
| `selectedRevisionId` | `string` | - | - |

## Diagram

```mermaid
graph TD
    component_VersionHistoryPanel_48e35512["VersionHistoryPanel"]
    class component_VersionHistoryPanel_48e35512 rootComponent
```

## Relationships

- RENDERS → `motion-aside`
- RENDERS → `ClockIcon`
- RENDERS → `XMarkIcon`
- RENDERS → `ArrowsRightLeftIcon`
- RENDERS → `CheckIcon`
- RENDERS → `RevisionCard`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useEffect`
- USES_HOOK → `useMemo`

<!-- source: interface-uploadbatchconfig.md -->

# UploadBatchConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 91)

Upload batch configuration

## Properties

| Property | Type |
|---|---|
| `maxRetries` | `number` |
| `retryDelay` | `number` |
| `maxConcurrency` | `number` |
| `requestsPerSecond` | `number` |
| `uploadScreenshotsFirst` | `boolean` |

<!-- source: component-versioningtogglesection.md -->

# VersioningToggleSection

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/page.tsx` (line 979)

Versioning Toggle Section — enables/disables doc versioning for a project.

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_VersioningToggleSection_255523a4["VersioningToggleSection"]
    class component_VersioningToggleSection_255523a4 rootComponent
```

## Relationships

- USES_HOOK → `useAPIClient`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-uploadbatchconfig-2.md -->

# UploadBatchConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-13.types.ts` (line 48)

Upload batch configuration

## Properties

| Property | Type |
|---|---|
| `maxConcurrency` | `number` |
| `maxRetries` | `number` |
| `retryDelay` | `number` |
| `requestsPerSecond` | `number` |
| `uploadScreenshotsFirst` | `boolean` |

<!-- source: component-versionprovider.md -->

# VersionProvider

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/VersionContext.tsx` (line 39)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `children` | `ReactNode` | ✓ | - |
| `slugId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_VersionProvider_6eaf0372["VersionProvider"]
    class component_VersionProvider_6eaf0372 rootComponent
```

## Relationships

- RENDERS → `VersionContext-Provider`
- USES_HOOK → `usePathname`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-uploadconfig.md -->

# UploadConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 29)

Upload configuration

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `organizationId` | `string` |
| `audienceSlug` | `string` |
| `outputDir` | `string` |
| `jobId` | `string` |
| `batch` | `UploadBatchConfig` |
| `uploadImage` | `ImageUploadFn` |
| `skipUnverifiableContent` | `boolean` |
| `skipSlugs` | `string[]` |
| `docVersionId` | `string` |
| `updateAssetsOnly` | `boolean` |
| `onlySlugs` | `string[]` |
| `deltaMerge` | `boolean` |
| `removedSlugs` | `string[]` |

<!-- source: component-versionscontent.md -->

# VersionsContent

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/versions/page.tsx` (line 96)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `projectId` | `string` | ✓ | - |
| `onGenerate` | `Function` | - | - |

## Diagram

```mermaid
graph TD
    component_VersionsContent_7bbc343f["VersionsContent"]
    class component_VersionsContent_7bbc343f rootComponent
```

## Relationships

- RENDERS → `RunningJobCard`
- USES_HOOK → `useSession`
- USES_HOOK → `useAPIClient`
- USES_HOOK → `useRouter`
- USES_HOOK → `useState`
- USES_HOOK → `useEffect`

<!-- source: interface-uploadconfig-2.md -->

# UploadConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 280)

Configuration for the upload service

## Properties

| Property | Type |
|---|---|
| `connectionString` | `string` |
| `containerName` | `string` |
| `projectPrefix` | `string` |
| `checkForDuplicates` | `boolean` |
| `duplicateThreshold` | `number` |
| `maxConcurrentUploads` | `number` |
| `retryCount` | `number` |

<!-- source: component-versionspage.md -->

# VersionsPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/versions/page.tsx` (line 564)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_VersionsPage_6627afb9["VersionsPage"]
    class component_VersionsPage_6627afb9 rootComponent
```

## Relationships

- USES_HOOK → `useRouter`
- USES_HOOK → `useEffect`

<!-- source: interface-uploadeddocument.md -->

# UploadedDocument

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-13.types.ts` (line 31)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `title` | `string` |
| `url` | `string` |
| `uploadedAt` | `Date` |

<!-- source: component-versionswitcher.md -->

# VersionSwitcher

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/p/[slugId]/components/VersionSwitcher.tsx` (line 9)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `slugId` | `string` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_VersionSwitcher_5bf937b6["VersionSwitcher"]
    class component_VersionSwitcher_5bf937b6 rootComponent
```

## Relationships

- RENDERS → `ChevronDownIcon`
- RENDERS → `CheckIcon`
- USES_HOOK → `useVersionContext`
- USES_HOOK → `useLanguageContext`
- USES_HOOK → `useState`
- USES_HOOK → `useRef`
- USES_HOOK → `useEffect`

<!-- source: interface-uploadeditem.md -->

# UploadedItem

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 220)

Successfully uploaded item

## Properties

| Property | Type |
|---|---|
| `type` | `'category' | 'document' | 'screenshot'` |
| `id` | `string` |
| `databaseId` | `string` |
| `title` | `string` |
| `slug` | `string` |
| `action` | `'created' | 'updated'` |
| `version` | `number` |

<!-- source: component-viewtoggle.md -->

# ViewToggle

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/components/Documents/ViewToggle.tsx` (line 16)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `view` | `ViewMode` | ✓ | - |
| `onChange` | `Function` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_ViewToggle_5307b14b["ViewToggle"]
    class component_ViewToggle_5307b14b rootComponent
```

## Relationships

- RENDERS → `Squares2X2Icon`
- RENDERS → `ListBulletIcon`

<!-- source: interface-uploadfailure.md -->

# UploadFailure

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-13.types.ts` (line 38)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `title` | `string` |
| `error` | `string` |
| `retryable` | `boolean` |

<!-- source: component-webhookspage.md -->

# WebhooksPage

**Kind:** Component

**Source:** `atloria-monorepo/apps/web/src/app/app/projects/[id]/settings/webhooks/page.tsx` (line 272)

## Props

| Name | Type | Required | Default |
|---|---|---|---|
| `params` | `Promise` | ✓ | - |

## Diagram

```mermaid
graph TD
    component_WebhooksPage_41434e83["WebhooksPage"]
    class component_WebhooksPage_41434e83 rootComponent
```

## Relationships

- RENDERS → `WebhooksContent`

<!-- source: interface-uploadinput.md -->

# UploadInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-13.types.ts` (line 13)

## Properties

| Property | Type |
|---|---|
| `documents` | `GeneratedDocument[]` |
| `screenshots` | `CapturedScreenshot[]` |
| `projectId` | `string` |
| `apiKey` | `string` |

<!-- source: interface-uploadprogress.md -->

# UploadProgress

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 191)

Upload progress update

## Properties

| Property | Type |
|---|---|
| `phase` | `'screenshots' | 'categories' | 'documents'` |
| `current` | `number` |
| `total` | `number` |
| `currentItem` | `string` |
| `percentage` | `number` |
| `message` | `string` |

<!-- source: interface-uploadprogress-2.md -->

# UploadProgress

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-13.types.ts` (line 77)

Upload progress tracking

## Properties

| Property | Type |
|---|---|
| `phase` | `'screenshots' | 'documents' | 'complete'` |
| `total` | `number` |
| `completed` | `number` |
| `failed` | `number` |
| `currentItem` | `string` |
| `estimatedTimeRemaining` | `number` |

<!-- source: interface-uploadprogress-3.md -->

# UploadProgress

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-uploader.service.ts` (line 26)

Progress callback for upload operations

## Properties

| Property | Type |
|---|---|
| `completed` | `number` |
| `total` | `number` |
| `currentItem` | `string` |

<!-- source: interface-uploadresult-2.md -->

# UploadResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 265)

Result of uploading a screenshot

## Properties

| Property | Type |
|---|---|
| `placeholderId` | `string` |
| `success` | `boolean` |
| `blobUrl` | `string` |
| `isNew` | `boolean` |
| `reusedFromId` | `string` |
| `reusedFromUrl` | `string` |
| `contentHash` | `string` |
| `perceptualHash` | `string` |
| `error` | `string` |

<!-- source: interface-uploadstats.md -->

# UploadStats

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-13-upload/upload.types.ts` (line 244)

Upload statistics

## Properties

| Property | Type |
|---|---|
| `categoriesCreated` | `number` |
| `categoriesUpdated` | `number` |
| `documentsCreated` | `number` |
| `documentsUpdated` | `number` |
| `documentsOutdated` | `number` |
| `screenshotsUploaded` | `number` |
| `screenshotsFailed` | `number` |
| `assetsUpdated` | `number` |
| `totalDurationMs` | `number` |

<!-- source: interface-uploadstats-2.md -->

# UploadStats

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-uploader.service.ts` (line 37)

Upload statistics

## Properties

| Property | Type |
|---|---|
| `totalUploaded` | `number` |
| `newUploads` | `number` |
| `reused` | `number` |
| `failed` | `number` |
| `totalBytes` | `number` |

<!-- source: interface-urlgroup.md -->

# UrlGroup

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 147)

Group of screenshots on the same URL (for efficient capture)

## Properties

| Property | Type |
|---|---|
| `baseUrl` | `string` |
| `screenshotIds` | `string[]` |
| `requiresAuth` | `boolean` |
| `estimatedCaptureTime` | `number` |
| `priority` | `number` |

<!-- source: interface-useaudiencesoptions.md -->

# UseAudiencesOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useAudiences.ts` (line 10)

Options for useAudiences hook

## Properties

| Property | Type |
|---|---|
| `autoFetch` | `boolean` |

<!-- source: interface-useaudiencesreturn.md -->

# UseAudiencesReturn

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useAudiences.ts` (line 17)

Return type for useAudiences hook

## Properties

| Property | Type |
|---|---|
| `audiences` | `AudienceModel[]` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `refresh` | `() => Promise<void>` |
| `createAudience` | `(data: {
    name: string;
    slug: string;
    color: string;
    icon: string;
    description?: string;
  }) => Promise<AudienceModel>` |
| `updateAudience` | `(
    id: string,
    data: {
      name?: string;
      slug?: string;
      color?: string;
      icon?: string;
      description?: string;
    },
  ) => Promise<AudienceModel>` |
| `deleteAudience` | `(id: string) => Promise<void>` |

<!-- source: interface-useauthreturn.md -->

# UseAuthReturn

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useAuth.ts` (line 10)

Return type for useAuth hook

## Properties

| Property | Type |
|---|---|
| `user` | `User | null` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `login` | `(email: string, password: string) => Promise<void>` |
| `logout` | `() => Promise<void>` |
| `register` | `(data: { email: string; password: string; name: string }) => Promise<void>` |
| `isAuthenticated` | `boolean` |

<!-- source: interface-usecommentsoptions.md -->

# UseCommentsOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useComments.ts` (line 10)

Options for useComments hook

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `autoFetch` | `boolean` |
| `enableRealtime` | `boolean` |

<!-- source: interface-usecommentsreturn.md -->

# UseCommentsReturn

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useComments.ts` (line 19)

Return type for useComments hook

## Properties

| Property | Type |
|---|---|
| `comments` | `CommentWithUser[]` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `addComment` | `(dto: CreateCommentDto) => Promise<CommentWithUser>` |
| `updateComment` | `(commentId: string, content: string) => Promise<CommentWithUser>` |
| `deleteComment` | `(commentId: string) => Promise<void>` |
| `resolveComment` | `(commentId: string) => Promise<CommentWithUser>` |
| `unresolveComment` | `(commentId: string) => Promise<CommentWithUser>` |
| `addReply` | `(parentCommentId: string, content: string) => Promise<CommentWithUser>` |
| `refresh` | `() => Promise<void>` |

<!-- source: interface-usedocumentoptions.md -->

# UseDocumentOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useDocument.ts` (line 11)

Options for useDocument hook

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `autoFetch` | `boolean` |

<!-- source: interface-usedocumentreturn.md -->

# UseDocumentReturn

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useDocument.ts` (line 19)

Return type for useDocument hook

## Properties

| Property | Type |
|---|---|
| `document` | `Document | null` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `save` | `(doc: Partial<Document>) => Promise<Document>` |
| `create` | `(doc: Partial<Document>) => Promise<Document>` |
| `remove` | `() => Promise<void>` |
| `refresh` | `() => Promise<void>` |
| `canEdit` | `(user: User) => boolean` |
| `canPublish` | `(user: User) => boolean` |
| `canDelete` | `(user: User) => boolean` |
| `canView` | `(user: User | null) => boolean` |
| `manager` | `DocumentManager` |

<!-- source: interface-usedocumentsoptions.md -->

# UseDocumentsOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useDocuments.ts` (line 10)

Options for useDocuments hook

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `autoFetch` | `boolean` |
| `filters` | `DocumentFilters` |

<!-- source: interface-usedocumentsreturn.md -->

# UseDocumentsReturn

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useDocuments.ts` (line 19)

Return type for useDocuments hook

## Properties

| Property | Type |
|---|---|
| `documents` | `Document[]` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `totalCount` | `number` |
| `refresh` | `() => Promise<void>` |

<!-- source: interface-useprojectoptions.md -->

# UseProjectOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useProject.ts` (line 11)

Options for useProject hook

## Properties

| Property | Type |
|---|---|
| `projectId` | `string` |
| `autoFetch` | `boolean` |

<!-- source: interface-useprojectreturn.md -->

# UseProjectReturn

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useProject.ts` (line 19)

Return type for useProject hook

## Properties

| Property | Type |
|---|---|
| `project` | `Project | null` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `save` | `(project: Partial<Project>) => Promise<Project>` |
| `create` | `(project: Partial<Project>) => Promise<Project>` |
| `remove` | `() => Promise<void>` |
| `refresh` | `() => Promise<void>` |
| `canAccess` | `(user: User) => boolean` |
| `canEdit` | `(user: User) => boolean` |
| `canDelete` | `(user: User) => boolean` |
| `canCreateDocuments` | `(user: User) => boolean` |
| `canManageSettings` | `(user: User) => boolean` |
| `getPermissions` | `(user: User) => {
    canView: boolean;
    canEdit: boolean;
    canDelete: boolean;
    canCreateDocuments: boolean;
    canManageSettings: boolean;
  }` |
| `manager` | `ProjectManager` |

<!-- source: interface-useprojectsoptions.md -->

# UseProjectsOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useProjects.ts` (line 10)

Options for useProjects hook

## Properties

| Property | Type |
|---|---|
| `organizationId` | `string` |
| `autoFetch` | `boolean` |

<!-- source: interface-useprojectsreturn.md -->

# UseProjectsReturn

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useProjects.ts` (line 18)

Return type for useProjects hook

## Properties

| Property | Type |
|---|---|
| `projects` | `Project[]` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `refresh` | `() => Promise<void>` |
| `deleteProject` | `(id: string) => Promise<void>` |

<!-- source: interface-user.md -->

# User

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/users.ts` (line 8)

User model for API responses

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `email` | `string` |
| `name` | `string` |
| `role` | `string` |
| `organizationId` | `string` |
| `createdAt` | `string` |
| `updatedAt` | `string` |

<!-- source: interface-useraction.md -->

# UserAction

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-03.types.ts` (line 46)

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `description` | `string` |
| `httpMethod` | `'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'` |
| `path` | `string` |
| `component` | `string` |

<!-- source: interface-userfeature.md -->

# UserFeature

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-03.types.ts` (line 35)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `actions` | `UserAction[]` |
| `requiredRoles` | `string[]` |
| `relatedFeatures` | `string[]` |
| `evidence` | `FeatureEvidence[]` |
| `confidence` | `number` |

<!-- source: interface-userjourneystep.md -->

# UserJourneyStep

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/cross-language.types.ts` (line 150)

UserJourneyStep - Complete step in a user workflow

Combines frontend action with backend processing for clear user docs.

## Properties

| Property | Type |
|---|---|
| `order` | `number` |
| `action` | `string` |
| `screen` | `string` |
| `screenPath` | `string` |
| `processing` | `{
    description: string; // "System validates and saves order"
    validationRules?: string[]; // ["Customer is required", "At least one item"]
    permissionRequired?: string; // "Sales Manager or Admin"
  }` |
| `outcomes` | `Array<{
    type: 'success' | 'error' | 'redirect';
    description: string; // "Order created successfully"
    nextScreen?: string; // Where user goes next
  }>` |

<!-- source: interface-userlistparams.md -->

# UserListParams

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/endpoints/users.ts` (line 21)

User list query parameters

## Properties

| Property | Type |
|---|---|
| `organizationId` | `string` |
| `role` | `string` |
| `search` | `string` |
| `limit` | `number` |
| `offset` | `number` |

<!-- source: interface-userpersona.md -->

# UserPersona

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-05.types.ts` (line 48)

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `description` | `string` |
| `goals` | `string[]` |
| `painPoints` | `string[]` |
| `relevantFeatures` | `string[]` |

<!-- source: interface-usesuggestionsoptions.md -->

# UseSuggestionsOptions

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useSuggestions.ts` (line 10)

Options for useSuggestions hook

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `autoFetch` | `boolean` |
| `enableRealtime` | `boolean` |

<!-- source: interface-usesuggestionsreturn.md -->

# UseSuggestionsReturn

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/hooks/useSuggestions.ts` (line 19)

Return type for useSuggestions hook

## Properties

| Property | Type |
|---|---|
| `suggestions` | `SuggestionWithUser[]` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `addSuggestion` | `(dto: CreateSuggestionDto) => Promise<SuggestionWithUser>` |
| `updateSuggestion` | `(suggestionId: string, status: SuggestionStatus, reviewComment?: string) => Promise<SuggestionWithUser>` |
| `deleteSuggestion` | `(suggestionId: string) => Promise<void>` |
| `acceptSuggestion` | `(suggestionId: string, reviewComment?: string) => Promise<SuggestionWithUser>` |
| `rejectSuggestion` | `(suggestionId: string, reviewComment?: string) => Promise<SuggestionWithUser>` |
| `refresh` | `() => Promise<void>` |

<!-- source: interface-v2pipelineconfig.md -->

# V2PipelineConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/orchestrator.ts` (line 87)

## Properties

| Property | Type |
|---|---|
| `repository` | `{
    url: string;
    branch: string;
    username?: string;
    password?: string;
    paths: {
      frontend?: string;
      backend?: string;
    };
    /** Parser configuration for parser-core integration */
    parsers?: {
      /** Explicit parser names to use (e.g. ['odoo-xml', 'python', 'django']). If omitted, auto-detect. */
      explicit?: string[];
      /** Additional file patterns to include beyond parser defaults */
      additionalPatterns?: string[];
      /** Use parser-core for parsing (default: true). Set false for legacy regex fallback. */
      useParserCore?: boolean;
    };
  }` |
| `project` | `{
    id: string;
    name: string;
    description?: string;
  }` |
| `ai` | `{
    /** AI provider to use (default: 'claude') */
    provider?: 'openai' | 'claude' | 'azure-responses';
    // Claude/Anthropic config
    azureEndpoint?: string;
    azureApiKey?: string;
    anthropicApiKey?: string;
    // OpenAI config
    openaiApiKey?: string;
    azureOpenaiEndpoint?: string;
    azureOpenaiApiKey?: string;
    azureOpenaiDeployment?: string;
    // Azure Responses API config (gpt-5.6-terra by default, overridable via AZURE_OPENAI_MODEL)
    azureResponsesEndpoint?: string;
    azureResponsesApiKey?: string;
    azureResponsesApiVersion?: string;
    // Per-stage model override (used with azure-responses provider)
    stageModels?: {
      analysis?: string;
      synthesis?: string;
      structure?: string;
      planning?: string;
      generation?: string;
      verification?: string;
      screenshots?: string;
    };
    // Shared config
    model?: string;
    maxTokens?: number;
  }` |
| `documentation` | `{
    targetAudience: 'beginner' | 'intermediate' | 'advanced';
    tone: 'formal' | 'friendly' | 'technical';
    language: string;
    maxDocuments: number;
    // User-suggested categories from project config (AI can add/remove based on codebase)
    suggestedCategories?: string[];
  }` |
| `output` | `{
    workDir: string;
    outputDir: string;
  }` |
| `options` | `{
    skipScreenshots?: boolean;
    skipUpload?: boolean;
    skipVerification?: boolean;
    resumeFromCheckpoint?: boolean;
    skipQualityGate?: boolean;
    /** Run screenshots in background (non-blocking). Default: true */
    asyncScreenshots?: boolean;
    /** Skip AI verification for docs that passed quality gate. Default: true */
    skipVerificationForPassingDocs?: boolean;
    /** Screenshots only — skip doc generation, read existing docs from DB */
    screenshotsOnly?: boolean;
    /** Use V4d structure generation — replaces Stages 4+5+6 with parser-based approach.
     *  Uses slim synthesis (1 AI call) + 3 parallel structure sessions.
     *  ~3 min, ~$0.50 vs current ~37 min, ~$8. */
    useV4dStructure?: boolean;
    /** Enable agent-powered verification — uses AI agent with code tools to verify
     *  generated docs against source code. More thorough than Stage 11's LLM-only check.
     *  Runs after Quality Gate, before Stage 11. Default: false (opt-in). */
    enableAgentVerification?: boolean;
    /** Use agent-writer for Stage 10 — AI agent explores source code AND writes docs
     *  in the same session. More accurate than GeneratorService because the agent reads
     *  actual code while writing. Requires Azure Responses API credentials.
     *  Default: false (opt-in). */
    useAgentWriter?: boolean;
  }` |
| `businessDomain` | `'ERP' | 'SaaS' | 'E-commerce' | 'CMS' | 'Generic'` |
| `businessContext` | `BusinessContext` |
| `contextSources` | `{ type: 'pdf' | 'url' | 'file' | 'text'; path: string; content?: string }[]` |
| `rateLimiter` | `{
    /** Max concurrent AI requests. Default: 5 for Azure, 30 for others */
    maxConcurrent?: number;
    /** Min delay between requests in ms. Default: 1000 for Azure, 25 for others */
    minDelayMs?: number;
  }` |
| `screenshots` | `{
    /** URL of the screenshot-worker microservice */
    workerUrl?: string;
    /** Site URL for screenshots (defaults to siteUrl from config) */
    siteUrl?: string;
    /** Login URL for authentication */
    loginUrl?: string;
    /** Login credentials */
    credentials?: {
      username: string;
      password: string;
      usernameSelector?: string;
      passwordSelector?: string;
      submitSelector?: string;
      successSelector?: string;
    };
    /** Viewport configuration */
    viewport?: {
      width: number;
      height: number;
    };
    /** Screenshot format */
    format?: 'png' | 'jpeg' | 'webp';
    /** Screenshot quality (for jpeg/webp) */
    quality?: number;
    /** Maximum concurrent capture sessions */
    maxConcurrency?: number;
    /** Azure blob storage container name */
    azureContainerName?: string;
    /** Whether to check for duplicate screenshots */
    checkDuplicates?: boolean;
    /** Frontend framework hint (e.g. 'angular', 'react', 'vue') — used for URL validation */
    framework?: string;
  }` |
| `onScreenshotsComplete` | `(stats: { captured: number; failed: number; replaced: number; totalPlaceholders: number }) => void` |
| `onScreenshotProgress` | `(progress: { captured: number; failed: number; total: number; currentUrl?: string }) => void` |
| `upload` | `{
    /** Prisma client for database access */
    prisma: any; // Using 'any' to avoid circular dependency with @prisma/client
    /** Organization ID for document ownership */
    organizationId: string;
    /** User ID who created the documents */
    createdById: string;
    /** Job ID for tracking which job created documents */
    jobId?: string;
    /** Target audience slug (e.g., 'user', 'developer') */
    audienceSlug?: string;
    /** Optional function to upload images to Azure via assets API */
    uploadImage?: (buffer: Buffer, filename: string, mimeType: string) => Promise<string>;
    /** Batch configuration */
    batch?: {
      maxRetries?: number;
      retryDelay?: number;
      maxConcurrency?: number;
      requestsPerSecond?: number;
      uploadScreenshotsFirst?: boolean;
    };
    /** When true, documents with groundingScore < 0.3 are excluded from upload. Default: false */
    skipUnverifiableContent?: boolean;
    /** DocVersion ID (Phase 1) — when set, upload operates in create-only mode */
    docVersionId?: string;
  }` |

<!-- source: interface-v2pipelineresult.md -->

# V2PipelineResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/orchestrator.ts` (line 292)

## Properties

| Property | Type |
|---|---|
| `success` | `boolean` |
| `stages` | `V2StageResult[]` |
| `totalDurationMs` | `number` |
| `error` | `string` |
| `metrics` | `import('./utils/pipeline-metrics').PipelineMetrics` |
| `output` | `{
    documentsGenerated: number;
    documentsVerified: number;
    categories: number;
    totalTokensUsed: number;
    // Screenshot stats
    screenshotsCaptured?: number;
    screenshotsUploaded?: number;
    screenshotsFailed?: number;
    // Upload stats (Stage-13)
    documentsUploaded?: number;
    categoriesCreated?: number;
    categoriesUpdated?: number;
    documentsOutdated?: number;
    // Route mappings from Stage 1 (persisted for background screenshots)
    routeMappings?: unknown;
    /** True when screenshots are running in the background (async mode) */
    backgroundScreenshots?: boolean;
  }` |

<!-- source: interface-v2progressupdate.md -->

# V2ProgressUpdate

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/orchestrator.ts` (line 280)

## Properties

| Property | Type |
|---|---|
| `stage` | `JobStage` |
| `progress` | `number` |
| `stageProgress` | `number` |
| `currentItem` | `string` |
| `message` | `string` |
| `elapsedMs` | `number` |
| `estimatedRemainingMs` | `number` |

<!-- source: interface-v2stageresult.md -->

# V2StageResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/orchestrator.ts` (line 320)

## Properties

| Property | Type |
|---|---|
| `stage` | `JobStage` |
| `status` | `'success' | 'failed' | 'skipped'` |
| `durationMs` | `number` |
| `details` | `Record<string, unknown>` |
| `error` | `string` |

<!-- source: interface-v4dstructureinput.md -->

# V4dStructureInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-06-structure/v4d-structure.service.ts` (line 30)

## Properties

| Property | Type |
|---|---|
| `interactionMap` | `any` |
| `entities` | `any[]` |
| `businessContext` | `BusinessContext` |
| `projectName` | `string` |
| `routeMappings` | `any` |
| `applicationProfile` | `{ domain: string; moduleAreas: string[]; description: string }` |

<!-- source: interface-validationfield.md -->

# ValidationField

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/validation-detector.ts` (line 48)

A field with validation rules

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `rules` | `ValidationRule[]` |
| `errorMessage` | `string` |

<!-- source: interface-validationresult-2.md -->

# ValidationResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/validators/validation-result.ts` (line 4)

Validation result interface

## Properties

| Property | Type |
|---|---|
| `valid` | `boolean` |
| `errors` | `string[]` |

<!-- source: interface-validationrule.md -->

# ValidationRule

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/validation-detector.ts` (line 58)

A single validation rule

## Properties

| Property | Type |
|---|---|
| `type` | `string` |
| `value` | `string | number` |
| `message` | `string` |

<!-- source: interface-variantchild.md -->

# VariantChild

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 49)

Individual variant within a variant section

## Properties

| Property | Type |
|---|---|
| `audienceSlug` | `string` |
| `content` | `ASTNode[]` |
| `startLine` | `number` |
| `endLine` | `number` |
| `startOffset` | `number` |
| `endOffset` | `number` |

<!-- source: interface-variantnode.md -->

# VariantNode

**Kind:** Interface

**Source:** `atloria-monorepo/packages/core/src/rendering/types.ts` (line 40)

Variant section node
Represents a VARIANT:AUDIENCE wrapper with multiple variants

## Properties

| Property | Type |
|---|---|
| `type` | `'variant_section'` |
| `variants` | `VariantChild[]` |
| `defaultVariant` | `VariantChild` |

<!-- source: interface-verificationcorrection.md -->

# VerificationCorrection

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/verifier-agent.service.ts` (line 48)

## Properties

| Property | Type |
|---|---|
| `wrong` | `string` |
| `correct` | `string` |
| `file` | `string` |

<!-- source: interface-verificationinput.md -->

# VerificationInput

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-11.types.ts` (line 17)

## Properties

| Property | Type |
|---|---|
| `documents` | `GeneratedDocument[]` |
| `entities` | `Entity[]` |

<!-- source: interface-verificationissue.md -->

# VerificationIssue

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-11.types.ts` (line 43)

## Properties

| Property | Type |
|---|---|
| `claimId` | `string` |
| `claim` | `string` |
| `severity` | `'critical' | 'major' | 'minor'` |
| `reason` | `string` |
| `suggestion` | `string` |
| `autoFixed` | `boolean` |

<!-- source: interface-verificationreport.md -->

# VerificationReport

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/verifier-agent.service.ts` (line 38)

## Properties

| Property | Type |
|---|---|
| `documentId` | `string` |
| `title` | `string` |
| `verified` | `string[]` |
| `unverified` | `string[]` |
| `corrections` | `VerificationCorrection[]` |
| `confidence` | `number` |

<!-- source: interface-verificationresponse.md -->

# VerificationResponse

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/openai-reviewer.service.ts` (line 23)

## Properties

| Property | Type |
|---|---|
| `verifications` | `ClaimVerificationResult[]` |
| `inputTokens` | `number` |
| `outputTokens` | `number` |

<!-- source: interface-verificationresult.md -->

# VerificationResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-11.types.ts` (line 22)

## Properties

| Property | Type |
|---|---|
| `reports` | `AccuracyReport[]` |
| `correctedDocuments` | `GeneratedDocument[]` |
| `tokenUsage` | `TokenUsage[]` |

<!-- source: interface-verifieragentconfig.md -->

# VerifierAgentConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/verifier-agent.service.ts` (line 25)

## Properties

| Property | Type |
|---|---|
| `repoPath` | `string` |
| `concurrency` | `number` |
| `routeDataMap` | `Map<string, any>` |
| `documentRouteMap` | `Map<string, string[]>` |
| `onProgress` | `(completed: number, total: number, title: string) => void` |

<!-- source: interface-verifieragentresult.md -->

# VerifierAgentResult

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-10-generation/verifier-agent.service.ts` (line 57)

## Properties

| Property | Type |
|---|---|
| `reports` | `VerificationReport[]` |
| `correctedDocuments` | `GeneratedDocument[]` |
| `tokenUsage` | `TokenUsage[]` |
| `stats` | `{
    totalDocuments: number;
    totalVerified: number;
    totalUnverified: number;
    totalCorrections: number;
    durationMs: number;
  }` |

<!-- source: interface-verifierserviceconfig.md -->

# VerifierServiceConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-11-verification/verifier.service.ts` (line 34)

## Properties

| Property | Type |
|---|---|
| `accuracyThreshold` | `number` |
| `maxClaimsPerDocument` | `number` |
| `enableAutoFix` | `boolean` |
| `batchSize` | `number` |

<!-- source: interface-viewport.md -->

# Viewport

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 44)

Viewport configuration

## Properties

| Property | Type |
|---|---|
| `width` | `number` |
| `height` | `number` |
| `deviceScaleFactor` | `number` |
| `isMobile` | `boolean` |
| `hasTouch` | `boolean` |

<!-- source: interface-viewport-2.md -->

# Viewport

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/stage-12.types.ts` (line 92)

Viewport configuration for screenshot

## Properties

| Property | Type |
|---|---|
| `width` | `number` |
| `height` | `number` |
| `deviceScaleFactor` | `number` |
| `isMobile` | `boolean` |
| `hasTouch` | `boolean` |

<!-- source: interface-voidemitter.md -->

# VoidEmitter

**Kind:** Interface

**Source:** `atloria-monorepo/packages/editor/src/utils/voidEmitter.ts` (line 8)

An emitter object that has a single subscription that will be executed.
The construct is used so that the lexical nodes can focus their React component editors.

## Properties

| Property | Type |
|---|---|
| `subscribe` | `(cb: () => void) => void` |

<!-- source: interface-vueprop.md -->

# VueProp

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/vue-detector.ts` (line 45)

Vue prop definition

## Properties

| Property | Type |
|---|---|
| `name` | `string` |
| `type` | `string` |
| `required` | `boolean` |
| `default` | `string` |

<!-- source: interface-waitfor.md -->

# WaitFor

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/screenshot-worker.types.ts` (line 32)

Wait condition for page readiness

## Properties

| Property | Type |
|---|---|
| `type` | `'selector' | 'timeout' | 'networkIdle' | 'loadState' | 'function'` |
| `selector` | `string` |
| `duration` | `number` |
| `state` | `'load' | 'domcontentloaded' | 'networkidle'` |
| `function` | `string` |
| `timeout` | `number` |

<!-- source: interface-websocketclient.md -->

# WebSocketClient

**Kind:** Interface

**Source:** `atloria-monorepo/packages/ui-react/src/types/api-client.ts` (line 24)

WebSocket client interface

<!-- source: interface-websocketconfig.md -->

# WebSocketConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/clients/WebSocketClient.ts` (line 31)

WebSocket client configuration

## Properties

| Property | Type |
|---|---|
| `autoReconnect` | `boolean` |
| `reconnectDelay` | `number` |
| `maxReconnectAttempts` | `number` |
| `enableLogging` | `boolean` |
| `heartbeatInterval` | `number` |

<!-- source: interface-websocketmessage.md -->

# WebSocketMessage

**Kind:** Interface

**Source:** `atloria-monorepo/packages/api-client/src/clients/WebSocketClient.ts` (line 14)

WebSocket message types

## Properties

| Property | Type |
|---|---|
| `type` | `string` |
| `channel` | `string` |
| `data` | `unknown` |

<!-- source: interface-workercaptureprogress.md -->

# WorkerCaptureProgress

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/worker-capturer.service.ts` (line 29)

Progress callback for capture operations

## Properties

| Property | Type |
|---|---|
| `completed` | `number` |
| `total` | `number` |
| `currentItem` | `string` |
| `jobId` | `string` |
| `status` | `string` |

<!-- source: interface-workercapturerconfig.md -->

# WorkerCapturerConfig

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/stages/stage-12-screenshots/worker-capturer.service.ts` (line 42)

Configuration for the worker capturer service

## Properties

| Property | Type |
|---|---|
| `workerUrl` | `string` |
| `siteUrl` | `string` |
| `projectId` | `string` |
| `organizationId` | `string` |
| `capturedBy` | `string` |
| `timeoutMs` | `number` |
| `pollIntervalMs` | `number` |
| `auth` | `AuthConfig` |
| `authHealthCheck` | `SessionHealthCheck` |
| `batchConfig` | `WorkerBatchConfig` |
| `name` | `string` |
| `description` | `string` |
| `repoPath` | `string` |
| `routeMappings` | `RouteMappingResult` |
| `aiAssisted` | `AIAssistedConfig` |

<!-- source: interface-workflowdocumentation-3.md -->

# WorkflowDocumentation

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/cross-language.types.ts` (line 176)

WorkflowDocumentation - Full workflow documentation for users

Generated from combining frontend screens with backend business logic.

## Properties

| Property | Type |
|---|---|
| `id` | `string` |
| `name` | `string` |
| `category` | `string` |
| `description` | `string` |
| `prerequisites` | `{
    roles: string[]; // ["Sales Rep", "Sales Manager"]
    permissions: string[]; // ["sales:orders:create"]
    priorSteps?: string[]; // ["Create a customer first"]
  }` |
| `steps` | `UserJourneyStep[]` |
| `stateMachine` | `{
    initialState: string; // "Draft"
    transitions: Array<{
      from: string; // "Draft"
      to: string; // "Submitted"
      action: string; // "Submit for approval"
      conditions?: string[]; // ["All required fields filled"]
    }>;
  }` |
| `relatedWorkflows` | `string[]` |

<!-- source: interface-workflowsequencespec.md -->

# WorkflowSequenceSpec

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/screenshot-spec.types.ts` (line 66)

Specification for a multi-step workflow screenshot sequence.
Each step is captured independently and presented as a numbered sequence.

## Properties

| Property | Type |
|---|---|
| `steps` | `WorkflowStep[]` |
| `presentation` | `'sequence' | 'composite'` |

<!-- source: interface-workflowstatedefinition.md -->

# WorkflowStateDefinition

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 151)

Workflow states for an entity type

## Properties

| Property | Type |
|---|---|
| `entityType` | `string` |
| `enumName` | `string` |
| `states` | `string[]` |
| `transitions` | `WorkflowTransition[]` |
| `hostComponent` | `string` |
| `sourceFile` | `string` |

<!-- source: interface-workflowstep-2.md -->

# WorkflowStep

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/screenshot-spec.types.ts` (line 76)

A single step in a workflow sequence capture.

## Properties

| Property | Type |
|---|---|
| `order` | `number` |
| `description` | `string` |
| `url` | `string` |
| `requiredState` | `RequiredState` |
| `actions` | `import('./stage-12.types').ScreenshotAction[]` |

<!-- source: interface-workflowtransition-2.md -->

# WorkflowTransition

**Kind:** Interface

**Source:** `atloria-monorepo/packages/doc-automation/src/v2/types/interaction-map.types.ts` (line 133)

A workflow state transition

## Properties

| Property | Type |
|---|---|
| `from` | `string` |
| `to` | `string` |
| `method` | `string` |
| `triggerLabel` | `string` |
| `requiresModal` | `boolean` |
| `modalName` | `string` |

<!-- source: explore-atloria-documentation-workspaces.md -->

# Explore Atloria Documentation Workspaces

Atloria brings your projects, generated documentation, source intelligence, and public documentation experiences together in one workspace. This page helps you understand where to look for each type of information so you can find the right documentation quickly.

## Overview

An Atloria workspace is the place where you organize and explore documentation for your organization’s projects. Start from the projects hub to see the projects available to you, then open a project to review its documentation, source-derived insights, and available exploration tools.

Projects are the central organizing unit in the workspace. They let you separate documentation for different products, services, or applications while keeping them accessible from a shared project list. Use the dashboard and project search when your organization has many projects or when you need to move quickly between work areas.

Within a project, Atloria can present documentation alongside source intelligence. Source intelligence helps you understand how parts of a product relate to one another, such as frontend, backend, database, API schema, configuration, documentation, and infrastructure areas. Depending on the project, you may also see options such as **Overview**, **Source**, **View Source**, **⚡ API Explorer**, and **Atloria Stack**.

> 📷 _Screenshot pending: The projects hub showing the project list, project search, and cross-project search options._

## Prerequisites

Before you begin, make sure that:

- You can sign in to Atloria and have access to your organization’s workspace.
- You have been given access to at least one project, if your organization restricts project visibility.
- You know the name of the project, document, or category you want to explore when using search.
- Your project has documentation available, either generated through Atloria or added through **Or import existing documentation**.
- You have the appropriate access level if you need to view source-related information or share public documentation.

## Step-by-Step Instructions

1. **Open the projects hub.**  
   Begin from the area labeled **Projects**. This is your starting point for finding the projects available in your workspace. The hub is designed to give you a single place to move between projects rather than requiring you to search through individual documentation pages.

2. **Find the project you want to explore.**  
   Use **Search projects...** to narrow the visible project list by project name. If you are not sure which project contains the information you need, use **Search across all projects...** instead. This broader search is useful when you know a document title, category, or topic but do not know where it belongs.

3. **Open the project dashboard.**  
   Select a project from the list. The project’s main area may include an entry such as **1. Dashboard Overview** or an **Overview** action. The dashboard gives you an at-a-glance starting point before you open a specific document or source view.

4. **Explore the project documentation.**  
   Look for documentation categories and documents within the project. You can use **Search documents, categories, projects...** to find content by its title or category. When documentation is not yet available, you may see **Generate Documentation →** to create documentation from the project, or **Or import existing documentation** to bring in documentation your team already maintains.

5. **Review source intelligence when you need implementation context.**  
   Select **Source** or **View Source** when you need to understand the material behind a documentation topic. These views help connect documentation to the project’s analyzed areas. For example, a project may organize information across frontend, backend, database, API schema, configuration, documentation, and infrastructure topics.

6. **Use specialized exploration views where available.**  
   Choose **⚡ API Explorer** to focus on API-related information. Select **Atloria Stack** when you want a broader view of the technologies and areas identified in the project. These options may not appear for every project, because the available views depend on the project’s content and analysis.

7. **Return to the project list when you are finished.**  
   Use **← Back to Projects** or **&larr; Back to Projects** to return to the projects hub. This keeps navigation simple when you need to compare documentation across multiple projects.

8. **Open a public portal when documentation is shared externally.**  
   Documentation marked **Public** can be made available through a public documentation portal. A public portal is intended for readers who need documentation without working inside the full organization workspace. Public readers can navigate available documentation and, where enabled, search for information.

> 📷 _Screenshot pending: A project documentation view showing Overview, Source, View Source, API Explorer, Atloria Stack, and document search._

## Tips and Best Practices

Use the narrowest search first. If you know the project name, start with **Search projects...**. If you only know a feature name, document title, or category, use **Search across all projects...** or **Search documents, categories, projects...**. This reduces the amount of irrelevant information in your results.

Start with **Overview** before opening **Source**. The overview is usually the best place to understand the purpose and scope of a project or documentation area. Move to **Source** or **View Source** when you need more context about how the documented areas connect.

Use the project’s categorized information to understand scope. Atloria can distinguish areas such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. Reviewing these areas helps you identify whether you are looking at user-facing behavior, service behavior, data-related information, or deployment and configuration information.

Generate or import documentation intentionally. Choose **Generate Documentation →** when you want Atloria to create documentation from the project’s available intelligence. Choose **Or import existing documentation** when your organization already has approved material that should be included in the workspace.

Before sharing content publicly, confirm that it is intended for external readers. The **Public** designation is useful for customer, partner, or developer-facing documentation, but internal operational details should remain in the appropriate private project workspace.

## Related Pages

- [Find Projects and Documentation](#)
- [Generate Documentation](#)
- [Import Existing Documentation](#)
- [Use Source Intelligence](#)
- [Explore APIs with API Explorer](#)
- [Manage Public Documentation Portals](#)

## Troubleshooting

### I cannot find a project

First, use **Search projects...** and enter part of the project name. If the project still does not appear, try **Search across all projects...** in case the content is indexed under a different project name. If no results are available, you may not have access to that project; contact your organization’s Atloria administrator.

### I can see a project but cannot find its documentation

Open the project and use **Search documents, categories, projects...**. If the project has no documentation results, it may not have been generated or imported yet. Look for **Generate Documentation →** or **Or import existing documentation**, or ask the project owner whether documentation is available.

### I do not see Source, API Explorer, or Atloria Stack

These options are available only when the project contains the relevant analyzed information. Start with **Overview** to confirm that you are in the correct project. If the expected view is still unavailable, the project may need additional source analysis or your access level may limit what you can view.

<!-- source: choose-your-atloria-role.md -->

# Choose Your Atloria Role

Atloria provides different documentation workflows for administrators, writers, engineers, managers, and readers. Understanding your role helps you focus on the screens and actions that are relevant to your work while respecting your organization’s access controls.

## Overview

Your Atloria role determines which areas of the documentation hub you can use and what you can do there. Access is governed through **👤 Role-Based Access Control (RBAC)**, so the options available to you may differ from those available to coworkers.

Most users begin from an **Overview** screen or **📊 Overview** area, where they can orient themselves within the available documentation and project information. Depending on your permissions, you may also see items such as **1. Dashboard Overview**, **Atloria Stack**, **Infrastructure Overview**, or **Architecture Overview**.

Roles support different stages of the documentation lifecycle:

- **Administrators** control access and organization-level setup.
- **Writers** create and maintain documentation content.
- **Engineers** contribute technical context and validate documentation against the product.
- **Managers** review documentation coverage, quality, and progress.
- **Readers** consume published documentation for guidance and reference.

Your assigned role may include more than one responsibility. For example, an engineering lead may have both engineering and management access, while a technical writer may also be able to review and publish content.

> 📷 _Screenshot pending: An Atloria Overview screen showing the documentation hub and role-relevant navigation options._

## Prerequisites

Before you begin using role-specific workflows, make sure you have:

- An active Atloria account.
- Access to your organization’s Atloria documentation hub.
- An assigned role or permission set from your Atloria administrator.
- A completed sign-in process, including any organization-required authorization steps.
- Permission to view the relevant project, audience, or documentation area.
- A clear understanding of whether you are expected to create, review, manage, or only read documentation.

If you have been asked to connect or authorize a service, look for the **Authorize Atloria** option. Only complete authorization when instructed by your organization or administrator.

## Step-by-Step Instructions

1. **Open the documentation hub.**

   After signing in, open the available **Overview** or **📊 Overview** area. This is your starting point for understanding what documentation and operational information you can access.

   You may see a welcome message such as **Welcome to your Documentation Hub**. Use this area to locate the project or content that applies to your work.

2. **Review the areas available to your account.**

   Look at the navigation and page titles you can open. Your available screens reflect the permissions assigned through **👤 Role-Based Access Control (RBAC)**.

   For example, you may be able to access:
   - **1. Dashboard Overview** for a summary of available information.
   - **Atloria Stack** for platform-oriented context.
   - **Infrastructure Overview** or **Architecture Overview** for technical reference material.
   - **Atloria Platform** for broader product information.

   If a screen is not visible, your current role may not include access to it.

3. **Identify your primary workflow.**

   Choose the workflow that best matches your responsibilities:

   - **Administrator:** Focus on user access, authorization, and governance. You may need to ensure that colleagues receive the right level of access and can enter the appropriate documentation areas.
   - **Writer:** Focus on preparing clear, accurate documentation for the intended audience. Use the documentation hub to locate existing material, identify gaps, and maintain content.
   - **Engineer:** Focus on technical accuracy. Review technical subjects such as **Architecture Overview**, **Infrastructure Overview**, and **Atloria Stack** when confirming that documentation reflects the product.
   - **Manager:** Focus on visibility and coverage. Use overview and dashboard information to understand progress, identify documentation gaps, and coordinate review work.
   - **Reader:** Focus on finding and using published guidance. Start with the overview content, then open the documentation topic that answers your question.

4. **Use role-appropriate information before taking action.**

   If you are an administrator, verify access requirements before asking users to begin work. If you are a writer or engineer, review available context before changing or validating documentation. If you are a manager, use overview information to prioritize the work that needs attention.

   Technical and operational reference topics may include titles such as **Atloria agent-core: What We Build On Top of @openai/agents** or **Atloria = SDK Loop + 4 Custom Layers**. These topics can be useful for technical reviewers, but readers should use them only when they need deeper platform context.

5. **Ask for access when your workflow is blocked.**

   If you cannot find the screen, project, or document needed for your role, do not assume it has been removed. Contact your Atloria administrator and explain what you need to do—for example, review architecture content, manage access, or read a specific document.

> 📷 _Screenshot pending: A permissions or access view showing how Role-Based Access Control determines the areas a user can open._

## Tips and Best Practices

- **Use the overview before searching for details.** Starting from **Overview** or **📊 Overview** helps you understand the available documentation context before opening individual topics.

- **Treat permissions as intentional.** If you cannot see a feature or page, it may be restricted to another role. Request access rather than sharing accounts or attempting to work around the restriction.

- **Match your review depth to your role.** Readers usually need task-focused documentation. Writers need content and audience context. Engineers may need architecture and infrastructure references. Managers should focus on coverage and status signals.

- **Use technical reference pages carefully.** Topics such as **Architecture Overview** and **Infrastructure Overview** support technical validation, but they may not be necessary for every documentation task.

- **Keep role responsibilities clear.** Writers can draft and improve explanations, engineers can verify technical correctness, managers can prioritize and approve work, and administrators can ensure that the right people have access.

## Related Pages

- [Overview](#overview)
- [1. Dashboard Overview](#step-by-step-instructions)
- [👤 Role-Based Access Control (RBAC)](#overview)
- [Architecture Overview](#step-by-step-instructions)
- [Infrastructure Overview](#step-by-step-instructions)
- [Welcome to your Documentation Hub](#prerequisites)

## Troubleshooting

### I cannot see the page or documentation area I need

Your role may not include permission to view that area. Confirm that you are signed in with the correct account, then contact your Atloria administrator with the name of the screen or documentation area you need.

### I see an overview, but I cannot find the expected workflow

Start with **Overview** or **📊 Overview** and review the available navigation. Some workflows may be represented by project-specific content rather than a separate role label. If the required area is still unavailable, ask an administrator to verify your RBAC assignment.

### I was asked to connect Atloria, but I do not see the option

The **Authorize Atloria** option may only be available to users with the appropriate authorization permissions. Contact your administrator or the person who asked you to complete the connection before proceeding.

<!-- source: navigate-the-atloria-interface.md -->

# Navigate the Atloria Interface

This page explains how to move between your projects, documents, technical documentation, settings, and published documentation in Atloria. Knowing where each area is helps you find information quickly and keep your documentation work organized.

## Overview

Atloria organizes your work around projects. The **Projects** area is your central hub for locating the project you want to work on, while **Documents** helps you browse and find documentation created for those projects. Use the available search fields when you know part of a project or document name and want to reach it faster.

Once you open a project, you can use **Overview** or **📊 Overview** to orient yourself, and select **Technical Docs** when you need technical documentation. The **Atloria Stack** area provides another project-focused view that may be useful when reviewing the project’s technical context.

Settings are available through **Settings** and are organized into **General Settings**, **Parser Settings**, and **Template Settings**. These areas let you review the configuration that affects how Atloria processes and presents your documentation.

When documentation is ready to share, select **View Your Documentation →** to open the public-facing documentation experience. Public documentation can be organized by project and audience, allowing readers to navigate the documentation intended for them.

> 📷 _Screenshot pending: Project navigation showing the Projects hub, search field, and project-level documentation options._

## Prerequisites

Before you begin, make sure that:

- You are signed in to Atloria.
- You have access to at least one project, or have been invited to one.
- You know the name of the project or document you want to find, if you plan to use search.
- You have the appropriate permissions to view project settings or technical documentation.
- You have a project with published documentation if you want to use **View Your Documentation →**.

## Step-by-Step Instructions

1. **Open the Projects hub.**

   Select **Projects** to view the list of projects available to you. You may also see this area identified as **1. Hub: All Projects**, which indicates that it is the main starting point for browsing your work.

   The Projects hub is the best place to start when you need to switch from one project to another or when you are unsure where a document belongs.

2. **Find a project by browsing or searching.**

   Review the available projects, or use the **Search projects...** field to narrow the list.

   Enter a recognizable word from the project name. As you refine your search, use the displayed results to select the project you need. If you need information that may span more than one project, use **Search across all projects...** instead.

3. **Return to the project list when needed.**

   When you are viewing a specific project, select **← Back to Projects** to return to the Projects hub.

   Use this control rather than relying on repeated browser navigation when you want to return to the complete project list and choose a different project.

4. **Open the project overview.**

   Within a project, select **Overview** or **📊 Overview** to see the project’s primary summary view.

   Start in the overview when you are learning a project or need a high-level orientation before opening its documentation. The overview gives you a consistent point of reference as you move between project areas.

5. **View technical documentation.**

   Select **Technical Docs** to open technical documentation associated with the current project.

   Use this area when you need material intended to explain the technical structure or behavior of the project. If **Atloria Stack** is available, select it when you want to review that project-focused technical view.

6. **Browse or search documents.**

   Select **Documents** to work with the documentation available to you. To locate a particular item, enter keywords in **Search documents...**.

   Searching is especially useful when a project contains many documents or when you know the document title but do not remember its location. Open the matching document from the results to read it.

7. **Open Settings.**

   Select **Settings** when you need to review or update configuration options. Settings may be presented as a numbered sequence:

   - **1. General Settings**
   - **2. Parser Settings**
   - **3. Template Settings**

   You may also see **General Settings** as a direct option. Start there for general configuration. Use **Parser Settings** for options related to how project content is processed, and use **Template Settings** for options that affect documentation templates and presentation.

8. **Open public documentation.**

   Select **View Your Documentation →** to open the public documentation for a project.

   In the public documentation area, readers can move through content organized for a project and, where available, select the appropriate audience and document. This is the view to use when you want to confirm what external or public readers will see.

> 📷 _Screenshot pending: Settings options and the View Your Documentation button used to open public documentation._

## Tips and Best Practices

- **Start with Projects when changing context.** The **Projects** hub is the clearest place to move between projects. Use **← Back to Projects** before selecting another project rather than searching through unrelated document views.

- **Choose the right search field.** Use **Search projects...** to locate a project, **Search documents...** to locate documentation, and **Search across all projects...** when the information might exist in any project you can access.

- **Use Overview before drilling into details.** Select **Overview** or **📊 Overview** first when you are unfamiliar with a project. This helps you confirm that you are in the correct project before opening **Technical Docs**, **Documents**, or **Settings**.

- **Keep configuration tasks separate from reading tasks.** Use **Documents** and **Technical Docs** to find and read content. Use **Settings** only when you need to manage the project’s configuration, including parser- or template-related options.

- **Verify published content from the public view.** Select **View Your Documentation →** when you need to check the documentation experience intended for readers. This is useful after documentation changes or when sharing documentation with others.

## Related Pages

- [Manage Projects](#)
- [Find and Review Documents](#)
- [Use Technical Docs](#)
- [Configure General Settings](#)
- [Configure Parser Settings](#)
- [Configure Template Settings](#)
- [Share Public Documentation](#)

## Troubleshooting

### I cannot find a project

Open **Projects** and use **Search projects...**. If the project does not appear, try **Search across all projects...**. If it is still unavailable, you may not have access to that project; contact the project owner or administrator.

### I found the project, but not the document

Select **Documents** and search using **Search documents...**. Try a distinctive word from the title rather than the complete title. If you are looking for technical material, check **Technical Docs** as well.

### I cannot see or change Settings

Select **Settings** and review the available options, such as **General Settings**, **Parser Settings**, and **Template Settings**. If the settings you need are not displayed or cannot be changed, your account may not have the required project permissions.

### View Your Documentation does not show the content I expected

Use **View Your Documentation →** from the relevant project, then confirm that you selected the correct project and audience. Return to **Documents** or **Technical Docs** to verify that you are working with the intended documentation content.

<!-- source: browse-a-published-documentation-portal.md -->

# Browse a Published Documentation Portal

A published documentation portal lets you explore documentation that a project has made available to its audiences. You can use the portal navigation to move between audiences, categories, collections, and individual documents without opening the project workspace.

## Overview

Published documentation is organized so you can find information at the level that is most useful to you. Start by selecting the appropriate project audience, then use the documentation navigation to browse the available categories and collections. Within a collection, you can open documents and follow their hierarchy to more specific topics.

This view is intended for readers of documentation rather than project editors. You can browse published content, open documents, and move between related sections. Project management actions, such as **Delete Project** or **Delete Documents**, are available in the project workspace and are not part of normal published-documentation browsing.

A project can make documentation available for different audiences. For example, an audience may contain its own set of categories, collections, and documents. If you cannot find a topic, confirm that you are viewing the audience intended for your role or use case.

> 📷 _Screenshot pending: A published documentation portal showing the audience area, Published Docs Nav, and document content._

## Prerequisites

Before you start, make sure that:

- You have the published documentation link for the project you want to read.
- The project owner has published documentation for at least one audience.
- You know which project audience is relevant to you.
- Your browser can access the portal link provided by your organization.
- If the documentation is restricted, you have any required access or sign-in permissions.

## Step-by-Step Instructions

1. Open the project’s published documentation link in your browser.

2. Select the audience that matches the documentation you need.

3. Review the available sections in the **Published Docs Nav**.

4. Select a category in the **Published Docs Nav** to display the content grouped under that category.

5. Select a collection to view the documents that belong to that collection.

6. Select a document title to open its published content.

7. Use the document hierarchy shown in the navigation to move to a parent, child, or related document.

8. Select another category when you need to switch to a different subject area.

9. Select another audience when the current audience does not contain the information you need.

10. Return to the project’s documentation entry point when you want to restart your browse path from the audience selection.

> 📷 _Screenshot pending: The Published Docs Nav expanded to show categories, collections, and nested documents._

## Tips and Best Practices

- Start with the audience first. Documentation can differ by audience, so browsing the correct audience prevents you from missing content that is published elsewhere in the same project.

- Use the hierarchy instead of opening documents at random. Categories provide broad groupings, collections organize related material, and document nesting helps you move from overview content to detailed instructions.

- Treat a collection as a reading path when one is available. Documents grouped in the same collection are typically related and may be easier to understand when read together.

- Check nearby entries in the **Published Docs Nav** after opening a document. A topic may have child documents with additional procedures, reference material, or related explanations.

- If a document link does not show the expected content, return to the audience level and confirm your selection. The same project may publish different document structures to different audiences.

- Do not use workspace-only options for reader tasks. Labels such as **Open Project Dashboard**, **Projects**, **Documents**, **Delete Project**, and **Delete Documents** belong to project administration areas. For published content, use **View Published Docs** or **🌐 View Published Docs** when starting from a project workspace.

- If you are viewing a project in the application and need the reader-facing portal, select **View Published Docs**. This opens the published experience rather than the editing and management workspace.

## Related Pages

- [Open a Project’s Published Documentation](#)
- [Choose a Documentation Audience](#)
- [Find Documents in a Published Portal](#)
- [Use Project Documentation in the Project Workspace](#)
- [Manage Published Documentation](#)

## Troubleshooting

### I cannot find the document I need

Select a different audience and review its categories and collections. Documentation can be published separately for each audience, so the topic may not appear in the audience you initially selected.

### The published portal does not show any documentation

Confirm that you opened the project’s published documentation link rather than the project workspace. From the workspace, select **View Published Docs** or **🌐 View Published Docs**. If the portal is still empty, the project may not yet have published content for that audience.

### I can see a category but not the expected document

Open the category and review all available collections and nested document entries in the **Published Docs Nav**. The document may be located under a collection or lower level of the hierarchy rather than directly under the category.

<!-- source: search-published-documentation.md -->

# Search Published Documentation

Use portal search to quickly find published user documentation, technical guides, and API references. Searching helps you reach the information you need without browsing through every documentation section.

## Overview

Published documentation is the documentation made available through the public documentation portal. You can use it to locate user-facing guides, technical content, and API reference material that has been published for viewing.

To begin a search, open the published documentation area by selecting **View Published Docs** or **🌐 View Published Docs**, depending on where you access documentation in Atloria. In the portal, select **Search** to open the documentation search experience.

The search field is labeled **Search docs...**. Enter words or phrases that describe the information you need, such as a feature name, integration topic, endpoint concept, or user task. Use specific terms when possible to narrow your results.

> 📷 _Screenshot pending: The published documentation portal showing the Search option and the View Published Docs entry point._

### Search terms at a glance

| If you need to find... | Try searching for... |
|---|---|
| Instructions for end users | A feature name or task, such as “user settings” or “export documentation” |
| Technical implementation details | A component, service, entity, or technical topic |
| API information | An API name, operation, resource, or related concept |
| Documentation for a particular project | The project name plus a specific feature or topic |
| A guide category | Terms such as “Guides,” “User Guides,” or “Technical” |

<dl>
  <dt><strong>Published documentation</strong></dt>
  <dd>Documentation that is available to view through the public documentation portal.</dd>

  <dt><strong>User documentation</strong></dt>
  <dd>Guides intended to help people use a product or feature.</dd>

  <dt><strong>Technical guides</strong></dt>
  <dd>Documentation that explains technical concepts, system details, or implementation-related information.</dd>

  <dt><strong>API references</strong></dt>
  <dd>Reference material for available APIs and their related resources.</dd>
</dl>

## Prerequisites

Before you start, make sure you have the following:

- Access to the Atloria published documentation portal.
- A published documentation site to search.
- A keyword, phrase, feature name, project name, or technical term related to the information you need.
- A stable internet connection so search results and documentation pages can load.
- If you are searching internal project documentation, access to the relevant project and its **Technical Docs** or **User Docs** area.

## Step-by-Step Instructions

1. **Open the published documentation portal.**

   From the available documentation navigation, select **View Published Docs** or **🌐 View Published Docs**.

   If you are working from a project, you may first see documentation options such as **User Docs** and **Technical Docs**. Select the appropriate area, then choose **View Published Docs** when it is available.

2. **Open search.**

   In the published documentation portal, select **Search**.

   The search interface opens and displays the **Search docs...** field.

   > 📷 _Screenshot pending: The documentation search interface with the Search docs... field ready for a query._

3. **Enter a search query.**

   Click the **Search docs...** field and type a word or phrase that matches the documentation you want to find.

   For example, you can search for:

   - A user task, such as “export”
   - A documentation type, such as “API”
   - A subject area, such as “authentication”
   - A project-specific feature or product term
   - A technical concept, such as “database” or “configuration”

4. **Review the matching documentation.**

   Look through the returned results for titles and topics that best match your query. Published content can include materials associated with **User Guides**, **Guides**, and **Technical** documentation.

   If the first search does not return the content you expected, revise your query using a more specific phrase. For example, search for a feature name instead of a broad category.

5. **Open the documentation you need.**

   Select a result to open its published documentation page. Review the page content and use the portal navigation to continue to related guides or references as needed.

6. **Search again when you need another topic.**

   Select **Search** again and replace the text in **Search docs...** with a new query. You can use the same search workflow to move between user documentation, technical guides, and API reference topics.

## Tips and Best Practices

- **Start with specific terms.** Search for the exact feature, capability, or project term you know. A search for “export documentation” is more likely to be useful than a search for “documentation.”

- **Use the documentation category as a clue.** If you want task instructions, look for results under **User Guides** or **Guides**. If you need system or implementation information, focus on **Technical** results.

- **Try alternate terminology.** Documentation may use a different term than the one you use day to day. If “login” does not help, try “authentication,” “access,” or the name of the relevant feature.

- **Search by project context when necessary.** When similar topics exist across multiple projects, include the project name or a distinguishing feature in your query.

- **Use published documentation for viewable content.** The published portal is intended for finding material that has been made available for viewing. If you need to work with project documentation directly, use the project’s **User Docs** or **Technical Docs** area instead.

- **Keep queries concise.** Begin with two to four meaningful words. If needed, add another term to make the query more precise.

## Related Pages

- [View Published Documentation](#)
- [Browse User Guides](#)
- [Use Technical Docs](#)
- [Read API References](#)
- [Export Documentation](#)
- [Search Across Projects](#)

## Troubleshooting

| Issue | What to do |
|---|---|
| You cannot find the **Search** option. | Return to the published documentation portal by selecting **View Published Docs** or **🌐 View Published Docs**. Confirm that you are viewing published documentation rather than only a project documentation workspace. |
| Your search returns no useful results. | Check spelling, use a shorter query, or try related terms. Replace broad words with a feature name, project name, technical concept, or documentation type such as “API” or “User Guides.” |
| You find a topic but need more technical detail. | Look for related content in **Technical** documentation or open the project’s **Technical Docs** area. If you need end-user instructions instead, look under **User Guides** or **Guides**. |

<!-- source: read-api-reference-content.md -->

# Read API Reference Content

Use the API Reference section in published technical documentation to understand available endpoints, request and response schemas, SDK guidance, and code examples. This helps you integrate with an API using the information that has been reviewed and made available to readers.

## Overview

Published documentation gives you a reader-focused view of technical content without requiring access to the documentation workspace. When documentation is ready for external or internal audiences, you can open it through **View Published Docs** or **🌐 View Published Docs** and navigate to **API Reference**.

The API Reference content is intended to help you answer practical integration questions, such as what an endpoint does, what information it accepts, what it returns, and how to use it in an application. Depending on the published documentation, you may find endpoint descriptions, schema details, SDK information, and code examples.

Use this page when you need to review an API before implementing an integration, verify the structure of data sent to or returned by an API, or copy an example into your own development environment. If documentation includes a schema download, you can also select **Download JSON Schema** for a machine-readable version of the documented schema.

> 📷 _Screenshot pending: Published documentation open to the API Reference section, showing endpoint content and available actions._

## Prerequisites

Before you begin, make sure that:

- You have access to the published documentation for the relevant project.
- The documentation has a **Published** or **3. Published Status** state.
- You know the API area, endpoint, schema, or SDK topic you need to review.
- Your browser allows you to download files if you plan to use **Download JSON Schema**.
- You have an appropriate development environment available if you plan to use copied code examples.

## Step-by-Step Instructions

1. **Open the published documentation.**  
   From the documentation area, select **View Published Docs**. In some locations, this action is shown as **🌐 View Published Docs**.

   The published documentation opens in its reader view. This view is designed for reading and using documentation that is already available to its intended audience.

2. **Confirm that you are reading published content.**  
   Look for the **Published** or **3. Published Status** indicator where it is shown. Published content is the version intended for readers; draft content may still be changing.

3. **Open the API Reference section.**  
   In the published documentation navigation, select **API Reference**.

   Review the section headings and endpoint entries to find the API capability you need. Start with the endpoint or operation that most closely matches your task, rather than reading unrelated entries.

4. **Read the endpoint information.**  
   For each relevant endpoint, review the available description and supporting details. Focus on:
   - The purpose of the endpoint
   - The data you need to provide
   - The expected returned data
   - Any schema information shown for the request or response
   - Available SDK guidance or examples

   Use the schema details to check field names, expected data types, and nesting before you build your request or consume a response.

5. **Review code examples.**  
   When code examples are included, use them as a starting point for your implementation. Compare the example values with your own environment and requirements before using them.

   To copy an example, select **Copy** next to the code block. Paste the copied content into your development environment, then replace any sample values with the values required for your organization.

6. **Use SDK information when it is provided.**  
   If the API Reference includes SDK-specific instructions or examples, select the SDK language or format that matches your application. Follow the example’s sequence carefully, including setup, request construction, and response handling where documented.

7. **Download the schema when needed.**  
   Select **Download JSON Schema** to save the available schema file. You can use the downloaded file for validation, tooling, or to compare the published structure with your implementation.

8. **Return to the documentation navigation when finished.**  
   Use the published documentation navigation to continue to another technical topic. If you need a broader introduction before using an endpoint, open the applicable **Technical** documentation section.

> 📷 _Screenshot pending: API Reference entry with schema details, a code example, and the Copy action._

## Tips and Best Practices

- **Use published content for implementation decisions.**  
  Read content marked **Published** when you need the version intended for use. Do not assume that unfinished or draft material reflects the final API behavior.

- **Read the description before copying an example.**  
  A code example shows one way to use an API, but the surrounding endpoint and schema information explains when that example applies.

- **Validate against the schema.**  
  If you download the JSON Schema, use it to verify that your request payloads and response handling match the documented structure. This is especially useful for nested objects and fields that may be optional or required.

- **Treat sample values as examples.**  
  Replace demonstration values, identifiers, and configuration details with values appropriate to your environment. Do not copy example data into a production workflow without reviewing it.

- **Keep copied examples traceable.**  
  When you use **Copy**, record the API Reference topic or endpoint that the example came from. This makes it easier to revisit the published guidance when the documentation is updated.

### API Reference terms

<dl>
  <dt>Endpoint</dt>
  <dd>A documented API operation that you can use to perform a specific task or retrieve information.</dd>

  <dt>Schema</dt>
  <dd>A structured description of data, including fields and their expected format.</dd>

  <dt>SDK</dt>
  <dd>A software development kit that provides language-specific tools or examples for working with an API.</dd>

  <dt>Code example</dt>
  <dd>A sample implementation that demonstrates how to call or use documented API functionality.</dd>

  <dt>JSON Schema</dt>
  <dd>A downloadable structured definition that can be used by compatible tools to validate JSON data.</dd>
</dl>

## Related Pages

- [View Published Documentation](#)
- [Navigate Technical Documentation](#)
- [Download JSON Schema](#)
- [Use Code Examples in Documentation](#)
- [Understand Documentation Publication Status](#)

## Troubleshooting

| Issue | What you can do |
|---|---|
| You cannot find **API Reference** in the published documentation. | Confirm that you opened the correct project’s **View Published Docs** page. The required API content may not be included in every published documentation set. |
| The information you need appears to be missing or incomplete. | Check whether the documentation is marked **Published** and review related **Technical** content. If the published material does not cover the needed endpoint, request an update from the documentation owner. |
| **Download JSON Schema** does not download a file. | Check your browser’s download permissions and pop-up or download blocking settings. Then try the action again. |
| A copied code example does not work as expected. | Review the endpoint description and schema again. Confirm that you replaced sample values and selected the SDK or example appropriate for your application. |

<!-- source: register-an-atloria-account.md -->

# Register an Atloria Account

Registering an Atloria account gives you access to the workspace where you can create projects, documents, and other content. This page explains how to start registration and complete the initial setup choices you may see after signing in.

## Overview

You need an Atloria account before you can begin using the application’s workspace features. Registration establishes your access to Atloria and takes you to the next available setup or onboarding screen.

After you register and sign in, Atloria may present setup options to help you configure your workspace. You can either select **Setup** to continue with configuration immediately or select **Skip setup** to continue without completing those options at that time.

The exact registration fields and final submission button can vary depending on how your organization provides access to Atloria. For example, your organization may direct you to a registration page, invite you by email, or require you to sign in through an approved identity provider.

> 📷 _Screenshot pending: Atloria registration screen showing the account details fields and the control used to submit registration._

## Prerequisites

Before you begin, make sure you have:

- An email address you can access.
- Permission to use Atloria in your organization.
- An invitation or registration link, if your organization requires one.
- The information required by your organization’s registration form.
- Access to your organization’s approved sign-in method, if single sign-on is required.

## Step-by-Step Instructions

1. Open the Atloria registration page provided by your organization.

2. Review the registration screen for the account information Atloria requests.

3. Enter your email address in the email field shown on the registration screen.

4. Enter the remaining required account details in the fields displayed.

5. Create a password if the registration screen asks you to create one.

6. Review any terms, privacy notice, or consent options displayed on the screen.

7. Select the registration or account-creation control shown on the page to submit your details.

8. Open your email inbox if Atloria asks you to verify your email address.

9. Select the verification link or button in the Atloria email message, if one is sent.

10. Return to Atloria after your email address has been verified.

11. Sign in using the credentials or organization-approved sign-in method available to you.

12. Select **Setup** if you want to configure your workspace immediately.

13. Select **Skip setup** if you want to enter Atloria without completing setup now.

> 📷 _Screenshot pending: Post-registration screen showing the Setup and Skip setup actions._

14. Select **Create project** when you are ready to begin organizing work in Atloria.

15. Select **Create Document** when you are ready to create a new document without first completing other setup tasks.

## Tips and Best Practices

- Use an email address that you monitor regularly. Atloria may send account verification or invitation messages to that address.
- Complete email verification as soon as possible. Until verification is complete, you may not be able to finish registration or access all available workspace features.
- Choose **Setup** when you are creating an account for a new team or workspace and want guidance through the initial configuration.
- Choose **Skip setup** when you need to enter Atloria quickly. You can continue with workspace activities such as **Create project** or **Create Document** when you are ready.
- If you do not see a standard registration form, check whether your organization requires an invitation or an approved organization sign-in method.
- Do not share your account credentials. Each person who uses Atloria should register or sign in with their own authorized account.

## Related Pages

- [Sign In to Atloria](#)
- [Reset Your Atloria Password](#)
- [Accept an Atloria Invitation](#)
- [Create a Project](#)
- [Create a Document](#)
- [Complete Workspace Setup](#)

## Troubleshooting

### You cannot find the registration page

Use the registration link provided by your organization, administrator, or Atloria invitation email. If you were not given a link, contact your organization’s Atloria administrator to confirm how new users receive access.

### You did not receive a verification email

Check your spam, junk, and filtered-email folders. Confirm that you entered the correct email address during registration. If the message is still missing, ask your Atloria administrator whether email verification is required and whether they can resend an invitation.

### You cannot complete registration with your work email

Your organization may use an approved sign-in method instead of direct registration, or it may restrict access to invited users. Return to the sign-in options available on the access screen, or contact your Atloria administrator for the correct access method.

<!-- source: sign-in-to-atloria.md -->

# Sign In to Atloria

This page explains how to access your existing Atloria account using the authentication method available to your organization. Signing in lets you continue setup, open your Atloria workspace, and use the features assigned to your account.

## Overview

Atloria supports organization-managed authentication. The sign-in experience you see can vary based on how your organization has configured access, such as a direct Atloria sign-in flow or an authorization flow managed by your identity provider.

If your organization uses an authorization-based connection, you may be asked to review an authorization screen before returning to Atloria. On that screen, the action to continue is labeled **Authorize Atloria**. This confirms that Atloria can use the authentication permissions approved by your organization.

After you sign in successfully, Atloria takes you to the next available screen for your account. If your workspace setup is not complete, you may see setup actions such as **Setup**, **Skip setup**, or **Finish setup**. These are separate from signing in and can be completed after you have access to your account.

> 📷 _Screenshot pending: Atloria sign-in screen showing the available authentication method or organization sign-in option._

## Prerequisites

Before you begin, make sure you have the following:

- An existing Atloria account or an invitation to an Atloria workspace.
- The sign-in link provided by your organization or Atloria administrator.
- Access to the email account or identity provider associated with your Atloria account.
- Permission to use your organization’s required authentication method.
- A supported web browser with cookies and pop-up windows enabled, if your organization’s sign-in provider opens an authorization window.

## Step-by-Step Instructions

1. Open the Atloria sign-in link provided by your organization.

2. Select the available sign-in or organization authentication option on the Atloria sign-in screen.

3. Enter the account details requested by your organization’s authentication provider.

4. Complete any additional verification requested by your organization, such as a security prompt or multi-factor authentication challenge.

5. Review the authorization screen if Atloria displays one.

6. Select **Authorize Atloria** to approve the sign-in connection and return to Atloria.

7. Wait for Atloria to complete the sign-in process.

8. Confirm that you have reached your Atloria workspace or the next account setup screen.

9. Select **Setup** if Atloria prompts you to continue configuring a new workspace.

10. Select **Skip setup** if you are permitted to postpone the available setup steps.

11. Select **Finish setup** when you have completed the setup items required for your workspace.

> 📷 _Screenshot pending: Authorization screen with the “Authorize Atloria” button used to complete an organization-managed sign-in._

## Tips and Best Practices

- Use the same work account that received your Atloria invitation. Signing in with a different identity-provider account may prevent Atloria from recognizing your workspace access.
- Select **Authorize Atloria** only after confirming that the authorization screen belongs to your organization’s approved sign-in process.
- Do not use **Skip setup** unless you understand which workspace configuration tasks will remain incomplete. Your administrator may require you to return and complete setup later.
- If you are setting up an authentication connection for your organization, use the **Authentication** area and follow the available **OAuth 2.0 Setup** guidance. This is typically an administrator task rather than a standard user sign-in step.
- If you see **← Authentication**, select it to return to the previous authentication configuration screen rather than restarting the entire sign-in process.
- Keep your browser session open until Atloria finishes redirecting you back from your organization’s authentication provider. Closing the tab early can interrupt the sign-in process.

## Related Pages

- [Set Up Authentication](#) — Configure organization authentication options in Atloria.
- [OAuth 2.0 Setup](#) — Review the organization authorization setup process.
- [Finish Workspace Setup](#) — Complete the remaining workspace setup steps after first access.
- [Accept an Atloria Invitation](#) — Join a workspace using an invitation link.
- [Reset Your Password](#) — Restore access if your organization uses a password-based sign-in method.

## Troubleshooting

### You cannot complete the authorization step

If **Authorize Atloria** is unavailable, disabled, or returns you to the same screen, close any extra Atloria tabs and start again from your organization’s sign-in link. If the issue continues, contact your Atloria administrator to confirm that your account is authorized for the organization’s authentication connection.

### You signed in but cannot see the expected workspace

Make sure you used the same email address or organization identity that received the Atloria invitation. If you have multiple work accounts, sign out of the identity provider, then repeat the sign-in process with the correct account.

### You are returned to the sign-in screen repeatedly

Enable cookies in your browser and allow any required pop-up or redirect window. Then restart the sign-in process. If your organization manages browser security settings, ask your IT administrator whether those settings are blocking the Atloria authentication flow.

<!-- source: reset-your-atloria-password.md -->

# Reset Your Atloria Password

If you cannot sign in because you do not know your password, use Atloria’s password-reset process to recover access to your account. Resetting your password helps you regain access without creating a new account or restarting your setup.

## Overview

The password-reset screen is intended for situations where your current password is unavailable or no longer accepted. You can begin the recovery process from the Atloria sign-in experience and follow the instructions shown on the password-reset screen.

During the process, Atloria uses the account details you provide to identify your sign-in account and guide you through setting a replacement password. When you finish, use the new password the next time you sign in.

This process is separate from workspace setup. Options such as **Setup**, **Skip setup**, **Finish setup**, and **Reset to Defaults** relate to configuring Atloria after you have access; they do not change your sign-in password.

> 📷 _Screenshot pending: Atloria password-reset screen showing the account recovery instructions and Reset action._

## Prerequisites

Before you begin, make sure you have:

- Access to the email inbox associated with your Atloria account.
- Your organization’s correct Atloria sign-in page.
- A secure device and browser that you trust.
- A new password ready to use, if the reset process asks you to create one.
- Access to any organization-required sign-in method, such as single sign-on, if your company uses it.

## Step-by-Step Instructions

1. Open the Atloria sign-in experience.

   If you are already on the sign-in screen, look for the option that starts password recovery. This opens the password-reset screen.

2. Review the instructions on the password-reset screen.

   Enter the account information requested on screen. Use the same email address or account identifier that you normally use to sign in to Atloria.

3. Select **Reset**.

   The **Reset** action submits your password-recovery request. Wait for the confirmation or next instruction displayed by Atloria before closing the page.

4. Check the inbox for the account you entered.

   Look for the Atloria password-reset message. If your organization filters external email, also check your spam, junk, quarantine, or security-filter folders.

5. Follow the instructions in the reset message.

   Complete the identity-verification and password-update steps provided in the message. Use a strong, unique password that you do not use for another service.

6. Return to Atloria and sign in with your new password.

   After the password change is complete, use the new password on the Atloria sign-in screen. If you are taken into onboarding after signing in, continue with **Get Started →**, **Setup**, or **Finish setup** as appropriate for your organization.

> 📷 _Screenshot pending: Confirmation shown after selecting Reset and submitting an Atloria password-recovery request._

## Tips and Best Practices

- Enter your account details carefully before selecting **Reset**. A small spelling error can send recovery instructions to the wrong place or prevent Atloria from locating your account.
- Use the newest password-reset message if you request more than one reset. Earlier messages may no longer be valid after a newer request is submitted.
- Do not use **Reset to Defaults** when you need to recover your password. That option is associated with setup or configuration, not sign-in recovery.
- Keep your reset message private. Do not forward password-reset instructions or share them with coworkers.
- If your organization signs in through a company identity provider, use the organization’s approved recovery process when Atloria directs you to it. Your Atloria password may be managed by your company rather than directly in Atloria.
- After you regain access, complete any unfinished onboarding using **Setup** or **Finish setup**. If you do not need to configure Atloria immediately, **Skip setup** may be available.

## Related Pages

- [Getting Started](#getting-started)
- [Set Up Your Atloria Workspace](#set-up-your-atloria-workspace)
- [Sign In to Atloria](#sign-in-to-atloria)
- [Complete OAuth 2.0 Setup](#oauth-2-0-setup)
- [Complete Webhook Setup](#webhook-setup)

## Troubleshooting

### I selected **Reset**, but I did not receive a password-reset message

**Problem:** You submitted a reset request, but no message arrives in your inbox.

**Cause:** The request may have been submitted with a different email address, the message may be delayed, or your organization’s email security controls may have filtered it.

**Solution:** Wait a few minutes, then check spam, junk, quarantine, and filtered-message folders. Confirm that you entered the same account details used for Atloria sign-in. If you still cannot find the message, submit a new request using the correct account details and contact your organization’s Atloria administrator or IT support team.

### My new password is not accepted when I try to sign in

**Problem:** You completed the reset process but cannot sign in.

**Cause:** The password may have been entered differently than intended, the reset may not have completed, or your organization may require single sign-on instead of an Atloria-managed password.

**Solution:** Carefully enter the new password again, checking keyboard layout and capitalization. If the issue continues, repeat the password-reset process and use the latest reset message. If your company uses single sign-on, return to the organization’s normal sign-in method and contact IT support if necessary.

### I cannot find the password-reset option

**Problem:** You are on an Atloria sign-in page but do not see a way to begin recovery.

**Cause:** Your organization may use a managed sign-in process, or you may be using a nonstandard or outdated sign-in link.

**Solution:** Use your organization’s approved Atloria sign-in page. If the page directs you to company authentication, recover your credentials through that provider. If you still need assistance, contact your Atloria administrator or IT support team.

<!-- source: create-your-first-documentation-project.md -->

# Create Your First Documentation Project

Create a project to organize documentation for a product, service, codebase, or knowledge domain. Your project becomes the focused workspace where you can review documentation, changes, versions, screenshots, and project analytics.

## Overview

Atloria uses projects to keep documentation work separated by subject. For example, you can create one project for a customer-facing product, another for an internal service, and another for a codebase that needs technical documentation.

The **Projects** area is your hub for viewing and managing all available projects. From there, you can search for an existing project, open a focused project workspace, or start a new one using **New Project**.

When your project is connected to source material, Atloria supports repository-based workflows. The new-project experience includes options associated with GitHub, GitLab, and Bitbucket, helping you begin with the source that best represents the product or codebase you want to document.

> 📷 _Screenshot pending: The Projects hub showing the project list, the Search projects field, and the New Project button._

## Prerequisites

Before you begin, make sure you have the following:

- Access to the **Projects** area in Atloria.
- A clear name or purpose for the project, such as a product name, service name, or knowledge domain.
- The location of the documentation source you want to use, if applicable.
- Access to the relevant repository if you plan to use GitHub, GitLab, or Bitbucket.
- Permission to create a project in your Atloria workspace.

## Step-by-Step Instructions

1. Open **Projects** from the Atloria application.

2. Review the existing project list to confirm that a project for your product, service, codebase, or knowledge domain does not already exist.

3. Use **Search projects...** to look for a project by name when the list contains multiple projects.

4. Select **New Project** to begin creating a project.

> 📷 _Screenshot pending: The New Project entry point in the Projects hub._

5. Choose the source option that matches the material you want to document.

6. Select the GitHub option if your documentation source is stored in GitHub.

7. Select the GitLab option if your documentation source is stored in GitLab.

8. Select the Bitbucket option if your documentation source is stored in Bitbucket.

9. Enter the requested project information in the fields shown by the new-project workflow.

10. Review the project information before continuing.

11. Complete the new-project workflow using the confirmation control shown on screen.

12. Select **Open Project Dashboard** when it is available to open your new project’s focused workspace.

> 📷 _Screenshot pending: A newly created project dashboard with project navigation and available documentation areas._

13. Select **View Your Documentation →** when it is available to open the documentation generated or collected for the project.

14. Select **← Back to Projects** when you want to return to the full list of projects.

## Tips and Best Practices

- **Create one project per documentation scope.** Keep separate projects for distinct products, services, or codebases. This makes it easier to search, review changes, and compare versions without mixing unrelated material.

- **Use a recognizable project purpose.** Before starting, decide whether the project represents a product, a service, a codebase, or a broader knowledge domain. This helps your team understand what belongs in the project.

- **Choose the correct repository provider.** If you are using a connected source, select the provider that hosts it: GitHub, GitLab, or Bitbucket. Choosing the correct option at the start helps ensure the project is based on the intended source.

- **Use the Projects hub for navigation.** The **Projects** screen is designed as the central place for managing project work. Use **Search projects...** when you need to locate a project quickly, especially as your workspace grows.

- **Use the focused project workspace after creation.** A project can include areas for changes, analytics, versions, version comparisons, review, and screenshots. Start from the project dashboard so you remain in the context of the correct project.

- **Avoid deleting active work.** The project interface includes **Delete Project**. Use this action carefully, particularly for projects that contain documentation history, version reviews, or screenshots.

## Related Pages

- [Manage Your Projects](#)
- [Open a Project Dashboard](#)
- [Search Across Projects](#)
- [Review Project Changes](#)
- [Work with Project Versions](#)
- [Compare Documentation Versions](#)
- [Review Project Screenshots](#)
- [View Project Analytics](#)

## Troubleshooting

### You cannot find the New Project option

Return to the **Projects** hub and look for **New Project**. If it is not available, you may not have permission to create projects in the current workspace. Contact your Atloria workspace administrator to request access.

### You are unsure whether to create a new project

Use **Search projects...** before creating a project. If a project already covers the same product, service, codebase, or knowledge domain, open that project instead of creating a duplicate.

### You selected the wrong source provider

If the project workflow asks you to choose a source, select the provider that hosts your source material: GitHub, GitLab, or Bitbucket. If you cannot continue with the selected provider, verify that you have access to the repository and restart the new-project workflow with the correct option.

<!-- source: invite-your-first-documentation-collaborators.md -->

# Invite Your First Documentation Collaborators

Invite writers, engineers, reviewers, and stakeholders so they can contribute to your project’s documentation work. Collaboration helps your documentation stay accurate as the project evolves.

## Overview

Atloria organizes documentation around projects. Before you invite anyone, open the project where the team will work. From the Projects area, you can locate a project, open its dashboard, and manage the people who need access to its documentation.

Invite collaborators when you are ready to share responsibility for documenting the product. For example, writers can create and refine documentation, engineers can verify technical details, reviewers can check proposed changes, and stakeholders can confirm that published information meets business needs.

Each invitation is intended for a specific person. The recipient receives an invitation link and uses it to join the project. Until the recipient accepts, plan your work as though the invitation is still pending.

> 📷 _Screenshot pending: The project collaboration area showing where you invite a new documentation collaborator._

## Prerequisites

Before you start, make sure that you have:

- Access to Atloria.
- Access to the project where you want collaborators to work.
- Permission to manage project members or send invitations.
- The email addresses of the writers, engineers, reviewers, or stakeholders you want to invite.
- A clear understanding of the access each person needs before you send the invitation.
- An active project listed in **Projects**.

## Step-by-Step Instructions

1. Open **Projects**.

2. Use **Search projects...** to find the project you want to share.

3. Select the project from the search results.

4. Click **Open Project Dashboard**.

5. Open the project’s collaboration or member-management area.

6. Select the option to invite a collaborator.

7. Enter the collaborator’s email address in the invitation form.

8. Select the appropriate project access level for the collaborator.

9. Review the email address before sending the invitation.

10. Send the invitation.

11. Repeat the invitation process for each additional writer, engineer, reviewer, or stakeholder.

12. Ask each recipient to open the invitation link they receive.

13. Confirm that each recipient has joined the project before assigning them documentation work.

> 📷 _Screenshot pending: The invitation form with an email field, access selection, and the control used to send an invitation._

## Tips and Best Practices

- Invite people to the specific project where they need to contribute. If you work with multiple projects, use **Search across all projects...** or **Search projects...** to make sure you open the correct one before sending invitations.

- Match access to the person’s responsibilities. Give writers and engineers the ability to contribute only when they need to make changes. Give reviewers and stakeholders the level of access needed to review and provide feedback without granting unnecessary project-management access.

- Use a work email address whenever possible. This helps recipients identify the invitation and reduces the chance that an invitation is missed or sent to an account they do not use for work.

- Tell recipients what they are being invited to do. For example, let a reviewer know which documentation area or change they should review after joining.

- Confirm membership before relying on someone to complete work. An invitation is not the same as an active collaborator until the recipient accepts it.

- Keep project membership current. If someone no longer needs access, review the project’s member-management area and remove or adjust access as appropriate.

- If you are starting a new initiative, you can return to **Projects** and select **New Project** or **Create project** before inviting the team. This keeps collaborators connected to the correct documentation workspace from the beginning.

## Related Pages

- [Create Your First Project](#)
- [Open a Project Dashboard](#)
- [Find a Project](#)
- [Review Documentation Changes](#)
- [Manage Project Access](#)
- [Export Documentation](#)

## Troubleshooting

### You cannot find the project to invite people to

Return to **Projects** and use **Search projects...**. If you manage many workspaces, use **Search across all projects...** to broaden your search. Confirm that you selected the intended project before opening **Open Project Dashboard**.

### You do not see an option to invite collaborators

You may not have permission to manage project members. Contact the project owner or an administrator and ask them to send the invitation or update your access.

### A collaborator did not receive the invitation

Verify that you entered the correct email address. Ask the recipient to check their spam or junk folder, then send a new invitation if needed. Also ask the recipient to use the account associated with the email address that received the invitation.

<!-- source: publish-your-first-documentation-page.md -->

# Publish Your First Documentation Page

This page explains how to review and publish the documentation generated for a project version in Atloria. Publishing makes the reviewed documentation available to readers through the published documentation experience.

## Overview

Atloria organizes documentation around projects and their versions. Before you publish, you review the documentation associated with a selected version to make sure it is ready for readers. The review area includes a **1 Review Summary** step and a **Back to Review** action, helping you return to the review process before publishing.

When a version is ready, use the **🚀 Publish Version 4** action shown for that version. After publication, Atloria marks the version as **Published** and provides **🌐 View Published Docs** so you can open the reader-facing documentation.

This workflow is intended for publishing documentation that Atloria has prepared for a project version. The available interface evidence shows version review and publication controls; it does not show a separate manual page editor with fields such as a page title or page body. Review the generated documentation carefully before using the publish action.

> 📷 _Screenshot pending: The Projects screen showing the project list and the Projects heading._

## Prerequisites

Before you start, make sure you have:

- Access to the **Projects** area.
- A project that contains a version ready for review.
- Permission to publish the selected project version.
- Documentation content available in the project version’s review area.
- Time to verify the content before readers can access it.

## Step-by-Step Instructions

1. Click **Projects** to open the list of projects available to you.

2. Select the project whose documentation you want to publish.

3. Open the project version that contains the documentation you want readers to see.

4. Open the version’s review area.

5. Select **1 Review Summary** to review the version’s documentation summary.

6. Review the displayed documentation content for accuracy, completeness, and reader readiness.

7. Click **Back to Review** if you need to return from a later review or publication screen to the review workflow.

8. Complete any required review checks for the selected version.

9. Click **🚀 Publish Version 4** to publish the version shown in the current screen.

10. Confirm the publication when Atloria asks you to proceed.

11. Verify that the version is labeled **Published** after the publication completes.

12. Click **🌐 View Published Docs** to open the documentation as your readers will see it.

> 📷 _Screenshot pending: The version review screen with the 1 Review Summary section and the Back to Review action._

13. Read through the published documentation in the reader view.

14. Click **4. Published Docs Nav** to check the navigation available to documentation readers.

15. Confirm that the published page is reachable from the reader-facing documentation navigation.

> 📷 _Screenshot pending: The published documentation reader showing the Published status, reader navigation, and the View Published Docs action._

## Tips and Best Practices

- Review before publishing. The **🚀 Publish Version 4** action publishes a version, so use **1 Review Summary** to verify the documentation before making it reader-facing.

- Treat publication as a version milestone. After you publish, the version displays the **Published** status. Make sure you are working in the intended version rather than reviewing an earlier or incomplete version.

- Check the reader experience after publishing. Clicking **🌐 View Published Docs** is the fastest way to verify what documentation readers can access.

- Use the published navigation as a final quality check. The **4. Published Docs Nav** area helps you confirm that readers can move through the documentation as expected.

- Return to review when needed. If you discover an issue while checking publication, use **Back to Review** to return to the review workflow rather than assuming the published reader view is the place to make changes.

- Start from the project hub when managing multiple projects. The **Projects** screen provides a central place to find the correct project. You can also use **Search projects...** when the list is long.

## Related Pages

- [Projects](#)
- [Review a Project Version](#)
- [View Published Documentation](#)
- [Compare Project Versions](#)
- [Project Analytics](#)

## Troubleshooting

### You cannot find the project to publish

Return to **Projects** and use **Search projects...** to locate the project. If the project is still unavailable, confirm that you have access to it or ask a project administrator to grant access.

### The publish action is not available

Make sure you are viewing a version that is ready for review and publication. Return to **1 Review Summary** and complete the required review process. If the version is already marked **Published**, you may be viewing a version that has already been released.

### The published documentation does not look correct

Click **🌐 View Published Docs** to confirm the reader-facing result, then select **Back to Review** to revisit the review workflow. Verify that you selected the intended project version before publishing.

<!-- source: explore-sample-projects.md -->

# Explore Sample Projects

Sample projects let you see how Atloria turns an application’s source into navigable analysis and AI-generated documentation. Use them to become familiar with the project workspace before working with your own projects.

## Overview

Sample projects provide a safe way to explore Atloria’s project-level views without changing your own source or documentation. From the Projects hub, you can search for a project, open it, and review the available actions for examining source, exploring APIs, and generating documentation.

When you open a sample project, Atloria can organize what it finds across areas such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. This helps you understand how different parts of an application are represented in Atloria and how they contribute to generated documentation.

Sample projects are also useful when you want to compare source analysis with the resulting documentation. You can inspect source information through **View Source**, explore available API information through **⚡ API Explorer**, and use **Generate Documentation →** when you are ready to create documentation from the project.

> 📷 _Screenshot pending: The Projects hub showing project search and available sample projects._

## Prerequisites

Before you begin, make sure that you have:

- Access to Atloria and the **Projects** area.
- A sample project available in your organization’s project list.
- Permission to view project source information if you plan to use **View Source**.
- A clear exploration goal, such as reviewing source analysis, checking API information, or generating documentation.

## Step-by-Step Instructions

1. Select **Projects** to open the project hub.

2. Enter a project name or keyword in the **Search projects...** field to narrow the project list.

3. Select the sample project that you want to explore.

4. Select **View Source** to review the source information available for the sample project.

5. Select **⚡ API Explorer** to examine the project’s available API-related information.

6. Select **Atloria Stack** to view the project through Atloria’s stack-oriented perspective.

7. Select **Generate Documentation →** when you want Atloria to create documentation based on the sample project.

8. Select **View Your Documentation →** after generation to open the resulting documentation.

9. Enter a keyword in **Search documents, categories, projects...** to locate a generated document, category, or project-related result.

10. Select **Export Documentation** if you need to take the generated documentation outside Atloria.

> 📷 _Screenshot pending: A sample project open in Atloria with the View Source, API Explorer, Atloria Stack, and Generate Documentation actions visible._

## Tips and Best Practices

- Start with a small, focused question. For example, use a sample project to understand how a frontend component relates to a backend service, rather than trying to review the entire project at once.

- Use **View Source** before generating documentation when you want to compare the underlying project information with the generated result. This makes it easier to understand what Atloria is documenting.

- Check **⚡ API Explorer** when the sample project includes APIs. API information may be useful for understanding how application areas connect and for validating generated API-focused documentation.

- Use **Atloria Stack** to explore the project by technical area. Atloria can identify areas such as frontend, backend, database, API schema, configuration, documentation, and infrastructure, which can help you focus your review.

- Use the search fields for their intended scope. **Search projects...** helps you find a project from the project hub, while **Search across all projects...** is useful when you need broader project-level searching. Use **Search documents, categories, projects...** when you are looking for documentation content or categories.

- Treat sample-project documentation as an example of the generation workflow. After reviewing it, you can apply the same process to your own project and compare the results with existing materials imported through **Or import existing documentation**.

## Related Pages

- [Getting Started](#)
- [Generate Documentation](#)
- [Explore Source Analysis](#)
- [Use API Explorer](#)
- [Search Projects and Documentation](#)
- [Export Documentation](#)

## Troubleshooting

### You cannot find a sample project

Select **Projects**, then use **Search projects...** with a broader keyword. If the sample project still does not appear, ask your Atloria administrator whether sample projects are available in your organization.

### The source or API views do not show the information you expected

Select **View Source** or **⚡ API Explorer** again after confirming that you opened the intended sample project. Some projects may emphasize different areas, such as frontend components, backend services, database structures, or API schemas.

### You generated documentation but cannot locate it

Select **View Your Documentation →**, then use **Search documents, categories, projects...** to search by a document title, category, or project keyword.

<!-- source: create-a-documentation-page.md -->

# Create a Documentation Page

This page explains how to start and save a new documentation page in Atloria. Creating a draft lets you capture a user guide, technical article, or internal documentation topic before it is ready to share.

## Overview

Atloria organizes documentation from the **Documents** area. You can use a new document to create content for different audiences, including end users, internal teams, and technical readers. Depending on your workspace, documentation may also be grouped under **User Guides** or **Technical Docs**.

When you begin a page, save it as a draft so that you can continue editing without publishing incomplete information. A saved draft is shown with the **Draft** status and can be reopened through **View Draft**.

Use this process when you need to document a new procedure, explain a feature, record internal guidance, or prepare content for a documentation collection.

> 📷 _Screenshot pending: The Documents area showing the Search documents... field and options for creating or managing documentation._

## Prerequisites

Before you start, make sure that you have:

- Access to the Atloria workspace that contains your documentation.
- Permission to open **Documents** and create or edit draft content.
- The topic, title, and main instructions you want to include.
- Any supporting information needed for the page, such as process details, user-facing labels, or links to related documentation.
- A clear idea of whether the page belongs with **User Guides** or **Technical Docs**.

## Step-by-Step Instructions

1. Open **Documents** from the main application navigation.

2. Review the document list to confirm that a page for the same topic does not already exist.

3. Use the **Search documents...** field to look for an existing document with a similar title.

4. Select **Quick Create** to start creating a new item.

5. Enter a clear title for the documentation page when the new-document screen opens.

6. Write a short introduction that tells readers what the page teaches and why they should use it.

7. Add the main instructions in the page editor.

8. Put each task action in its own numbered instruction so readers can follow the procedure in order.

9. Use the exact labels that readers see in Atloria, such as **Documents**, **User Guides**, or **Technical Docs**, when your instructions tell them where to go.

10. Add supporting details that explain what the reader should expect after completing an important action.

11. Include links or references to related documentation topics when readers may need additional guidance.

12. Select **Save as Draft** to save the unfinished page.

13. Confirm that the page is marked **Draft** after it is saved.

14. Select **View Draft** to reopen the saved page and review it as a reader would see it.

> 📷 _Screenshot pending: A documentation page in the editor with the Save as Draft button and Draft status visible._

15. Return to the editor and revise the content if the draft needs corrections.

16. Save the page again with **Save as Draft** after making changes.

17. Use the **3. Draft Ready** indicator, when available in your workspace, to confirm that the draft has reached the ready-for-review stage.

## Tips and Best Practices

- Give each page one focused purpose. For example, create one page for creating a maintenance request and a separate page for creating a payment rather than combining unrelated procedures.
- Start with the reader’s goal. A title such as “Create a Maintenance Request” is easier to find and understand than a broad title such as “Maintenance.”
- Use the same wording that appears on screen. If readers need to select **View Draft**, write **View Draft** rather than “open the preview.”
- Save early and often with **Save as Draft**. This protects your work while you are still researching, writing, or waiting for review.
- Keep draft content accurate before moving it forward. The **Draft** state is useful for incomplete content, but readers should still be able to understand the page’s purpose and next steps.
- Add practical context around actions. Tell readers what changes after they select a button, what information they need to enter, or when they should stop and ask for help.
- Use **User Guides** for reader-oriented procedures and **Technical Docs** for content intended for technical audiences. Choose the location that best matches the people who will use the page.
- Use **Search documents...** before creating a page. This helps prevent duplicate articles and makes it easier to update an existing guide instead of creating a competing version.

## Related Pages

- [Browse Documents](#)
- [Search for a Document](#)
- [Edit a Draft Document](#)
- [Organize Content in User Guides](#)
- [Work with Technical Docs](#)
- [View and Review a Draft](#)

## Troubleshooting

### You cannot find the option to create a page

Open **Documents** first, then look for **Quick Create**. If **Quick Create** is not available, you may not have permission to create documentation in the current workspace. Contact your workspace administrator for access.

### Your new page does not appear in the document list

Use **Search documents...** and search for the title you entered. If you saved the page with **Save as Draft**, look for it as a **Draft** and select **View Draft** to reopen it.

### You are unsure whether to create a new page or update an existing one

Search the current documentation before selecting **Quick Create**. If a related page already exists, update that page when the new information belongs to the same task. Create a separate page when the reader has a distinct goal or must follow a different procedure.

<!-- source: organize-documents-into-categories.md -->

# Organize Documents into Categories

Organizing documents into categories helps you keep large documentation libraries easy to browse and maintain. This page explains how to prepare and manage document organization using the Documents workspace, including planning category, collection, and nested hierarchy structures.

## Overview

Categories provide a way to group related documents so that readers and authors can find information more quickly. For example, you might organize content into top-level categories such as **User Guides**, **Administration**, and **Release Notes**, then add more specific groups beneath them.

Collections are useful when documents belong together for a particular purpose, project, or audience. A collection can contain documents from one area of your library without requiring you to duplicate the documents themselves. Plan collections around the way your users look for information—for example, “New User Onboarding” or “Project Documentation.”

Nested hierarchies let you represent a logical structure with parent and child categories. Use a shallow, consistent structure where possible. Readers should be able to understand where a document belongs from the category names alone.

> 📷 _Screenshot pending: Documents workspace showing category, collection, and hierarchy organization controls_

## Prerequisites

Before you begin, make sure that you have:

- Access to the **Documents** area.
- At least one existing document, or permission to create a document using **Create New Document**.
- A planned naming convention for categories and collections.
- Agreement on which categories are top-level categories and which are nested beneath a parent.
- Permission to manage the documentation library for the selected project, if your organization uses project-specific documents.

## Step-by-Step Instructions

1. Open **Documents** from the application navigation.

2. If prompted, select the project whose documents you want to organize.

3. Review the existing document list before creating or changing organizational groups.

4. Use the **Search documents...** field to find a document by its title when you need to check its current placement.

5. Use the **Search documents, categories, projects...** field when you need to locate content across documents, existing categories, or projects.

6. Identify the top-level category that best describes the document’s main purpose.

7. Create a category for a major subject area only when an appropriate category does not already exist.

8. Name the category using a clear, reader-facing label, such as **User Guides**.

9. Add the document to the category that matches its primary subject.

10. Create a collection when you need to group documents for a shared audience, workflow, or initiative.

11. Name the collection after the use case it supports, rather than after an internal team or temporary project name.

12. Add relevant documents to the collection without creating unnecessary duplicate categories.

13. Create a nested category under a parent category when the parent contains several distinct subtopics.

14. Place the most general information in the parent category.

15. Place more specific information in child categories beneath the appropriate parent.

16. Keep documents at the same hierarchy level when they serve the same reader need.

17. Review the category structure after adding documents to confirm that document titles are easy to find and understand.

18. Create a new document with **Create New Document** when content is missing from the planned hierarchy.

19. Complete the document creation process by selecting **Create Document**.

20. Return to **Documents** after creating the document and place it within the appropriate category or collection.

> 📷 _Screenshot pending: Documents screen showing the Search documents field and category management area_

## Tips and Best Practices

- Use categories for stable subjects. Categories such as **User Guides** or **Documents** can remain useful as your library grows.
- Use collections for cross-cutting groups. For example, a collection can gather onboarding materials from several categories.
- Avoid placing one document in multiple similar categories unless readers genuinely need to find it in more than one location.
- Keep nested structures short. A reader should not have to open many levels of categories to reach a document.
- Use consistent naming. Choose either singular or plural category names and apply that choice throughout the library.
- Review search results after reorganizing. The **Search documents...** field helps you verify that documents remain easy to locate by name.
- Create documents before organizing them when possible. The **Create New Document** action is the starting point for new content, while **Or import existing documentation** supports bringing existing material into the library.
- Avoid using categories as a substitute for document titles. Each document should still have a specific, descriptive title that makes sense in search results.
- Revisit categories as your library expands. A category that begins with a few documents may eventually need child categories or separate collections.

## Related Pages

- [Create a New Document](#)
- [Import Existing Documentation](#)
- [Search for Documents](#)
- [Manage Project Documentation](#)
- [Export Documentation](#)

## Troubleshooting

### You cannot find a document to organize

1. Open **Documents**.

2. Enter the document title in **Search documents...**.

3. If you do not know the exact title, use **Search documents, categories, projects...** to broaden the search.

4. Confirm that you are viewing the correct project if the application asks you to select a project.

### You are unsure whether to use a category or a collection

1. Create or use a category when the documents share a common subject.

2. Create or use a collection when the documents are assembled for a particular audience, program, or workflow.

3. Use a nested category when the subject area needs a more detailed parent-and-child structure.

### A category structure is becoming difficult to browse

1. Review category names for duplicates or overlapping topics.

2. Combine categories that describe the same subject.

3. Move highly specific subjects into child categories.

4. Keep the most frequently used documents close to the top-level categories that readers are most likely to browse.

<!-- source: edit-and-format-documentation.md -->

# Edit and Format Documentation

Use the **Editor** to revise existing documentation and apply consistent formatting that makes content easier to scan and understand. Clear structure helps readers find instructions, requirements, and important details quickly.

## Overview

Atloria lets you manage documentation from the **Documents** area. When a document needs updated wording, corrected information, or clearer organization, you can open it in the **Editor** by selecting **Edit**.

Formatting is especially useful when a document contains multiple procedures, long explanations, or lists of requirements. Use the Editor toolbar to apply the appropriate formatting to selected content so headings, paragraphs, and other content types are visually distinct.

After you finish editing, return to the document list with **← Back to Documents**. From there, you can continue managing documents, search for another document, or use **Export Documentation** when you need an exported version.

> 📷 _Screenshot pending: The Documents screen showing the Search documents... field and the Edit action for a document._

## Prerequisites

Before you begin, make sure you have:

- Access to the Atloria **Documents** area.
- A project selected, if prompted by **Select a project to view documents**.
- An existing document that you are permitted to edit.
- The revised text, links, or other information you want to add.
- A plan for the document structure, such as which sections should become headings or lists.

## Step-by-Step Instructions

1. Select **Documents** from the application navigation.

2. Select a project if the page displays **Select a project to view documents**.

3. Enter a title or keyword in the **Search documents...** field to find the document you want to revise.

4. Select **Edit** for the document you want to change.

5. Select the content in the **Editor** that you want to revise.

6. Type the replacement text directly over the selected content.

7. Place the cursor where you want to add new content.

8. Type the new content in the Editor.

9. Select the text that should be formatted as a section heading.

10. Select the appropriate heading control from the Editor toolbar.

11. Select the text that should remain standard paragraph content.

12. Select the paragraph formatting control from the Editor toolbar.

13. Select a group of related items that readers should scan individually.

14. Select the appropriate list formatting control from the Editor toolbar.

15. Select the text that needs a different emphasis or presentation.

16. Select the relevant formatting control in the Editor toolbar.

17. Review the edited section in the Editor to confirm that headings, paragraphs, and lists are visually distinct.

18. Select **← Back to Documents** when you are finished editing.

> 📷 _Screenshot pending: The Editor with document content selected and the formatting toolbar available above the editing area._

## Tips and Best Practices

- Use headings to divide a document into meaningful sections. A reader should be able to understand the document’s structure by scanning its headings.

- Keep each heading focused on one topic. For example, separate prerequisites, instructions, and troubleshooting rather than placing them in a single long section.

- Use standard paragraphs for explanations and context. Use lists when readers need to review several related items, such as required access, materials, or outcomes.

- Format only the text that needs formatting. Select the exact words, line, or group of items before using an Editor toolbar control. This helps prevent nearby content from receiving an unintended format.

- Keep instruction steps short and action-oriented. Start each step with a clear action, such as “Select,” “Enter,” or “Review.”

- Review the document after every substantial revision. Check that a heading is not being used as ordinary body text and that a list does not include unrelated paragraphs.

- Use the **Search documents...** field instead of manually browsing a long document list when you know part of the document title or a relevant keyword.

- Use **Edit Description** when the document’s description needs updating separately from its main content. Keep the description concise so users can identify the document from the **Documents** list.

- Select **Export Documentation** only after reviewing your changes. Exported documentation is easier to use when the on-screen version is already well organized and readable.

## Related Pages

- [Manage Documents](#)  
- [Create a New Document](#)  
- [Export Documentation](#)  
- [Edit Description](#)  
- [Compare Document Versions](#)  
- [Edit Configuration](#)  

## Troubleshooting

### You cannot find the document you need to edit

Enter a distinctive word from the document title or content in **Search documents...**. If no documents appear, confirm that you selected the correct project when Atloria displays **Select a project to view documents**.

### The formatting change affects the wrong text

Select the affected content again, then use the appropriate Editor toolbar control only after confirming the selection includes the intended text. Review nearby headings and paragraphs to make sure they were not changed unintentionally.

### You are unsure whether you are editing the document content or its description

Use **Edit** to revise the document in the **Editor**. Use **Edit Description** when you only need to change the document’s descriptive summary or list-facing description.

<!-- source: translate-a-documentation-page.md -->

# Translate a Documentation Page

You can create a translated version of an existing document so readers can use the same guidance in another language. Keeping translations current helps ensure that each audience receives accurate, consistent documentation.

## Overview

Atloria organizes your authored content in **Documents**. From a document’s translation area, you can create a language-specific version of an existing page and return later to maintain it as the original content changes.

Use translations when the same document must be available to readers in more than one language. Start with a completed source document whenever possible so that you do not need to repeat translation work after major content changes.

A translated document is tied to the document you selected. Before you begin, confirm that you have opened the correct source page, including the correct version of its title, instructions, and links.

> 📷 _Screenshot pending: The Documents screen showing the document list and the Search documents... field._

## Prerequisites

Before creating or maintaining a translation, make sure that you have:

- Access to the **Documents** area.
- An existing document to translate.
- The target language required by your organization.
- The approved translated text, terminology, and product names for that language.
- Permission to edit the selected document.
- Reviewed the source document for recent updates before revising its translation.

## Step-by-Step Instructions

1. Select **Documents** from the application navigation.

2. Enter the document title or a keyword in the **Search documents...** field.

3. Open the document that you want to translate.

4. Open the document’s translation screen.

5. Select the target language for the translated version.

6. Create the translated version when the translation screen prompts you to do so.

7. Enter the translated document title in the title field shown for the translated version.

8. Replace the source-language body text with the approved translated text.

9. Translate headings while preserving their original order and structure.

10. Review links in the translated content and update any link text that should appear in the target language.

11. Review button names, menu names, and field names against the application interface before translating them.

12. Save the translated version using the save action displayed on the translation screen.

13. Reopen the translated version from **Documents** to confirm that the saved content appears correctly.

> 📷 _Screenshot pending: The translation screen with the target-language selection, translated title, translated content, and save action._

## Tips and Best Practices

- **Begin with the current source document.** Before translating, check the original document for changes to procedures, titles, screenshots, or linked pages. Translating an outdated source can produce instructions that no longer match the product.

- **Keep user interface labels accurate.** When a procedure tells readers to select a control, use the label that they see in the application. For example, retain labels such as **Documents** and **Search documents...** exactly as displayed unless your organization provides an approved localized interface term.

- **Preserve the task flow.** Keep numbered steps in the same order as the source document. Readers should be able to complete the same task in the translated version without needing to compare it with the original.

- **Use approved terminology consistently.** Use the same translation for recurring terms throughout the page. This is especially important for product areas, document types, and actions that appear across multiple user guides.

- **Review links and references.** A translated page may need translated link text, translated destination pages, or both. Do not leave a link pointing to content that is unavailable or inappropriate for the target-language audience.

- **Maintain translations after source changes.** When the original document is revised, revisit each translated version and update the affected headings, steps, notes, and links. Recheck the whole procedure when a change affects the sequence of actions.

- **Validate reader-facing formatting.** Confirm that lists, numbered procedures, warnings, and headings remain readable in the target language. Some languages require longer text, which can affect how instructions and screenshots are presented.

## Related Pages

- [Manage Documents](#)
- [Create a Documentation Page](#)
- [Edit a Documentation Page](#)
- [Search Documents](#)
- [Review Document Versions](#)
- [Publish Documentation](#)

## Troubleshooting

### You cannot find the document to translate

Open **Documents** and use the **Search documents...** field with a distinctive word from the document title. If the document still does not appear, confirm that you have access to the correct project or ask an administrator to verify your document permissions.

### You do not see a translation option for the document

Confirm that you opened an existing document rather than a new, unsaved page. If the translation option is still unavailable, verify that your role allows you to edit the document and create translated versions.

### The translated version does not match the source document

Compare the translated version with the current source document section by section. Update missing headings, changed steps, interface labels, and links, then save the translation again.

<!-- source: open-a-document-by-slug.md -->

# Open a Document by Slug

A document slug is the unique identifier Atloria uses to locate a specific documentation page within a project and audience. Opening a document by slug helps you go directly to the intended page when you receive a shared documentation link.

## Overview

Atloria organizes published documentation by project, audience, and document. The document slug identifies the individual document within that structure. When you open a shared documentation address, Atloria uses the document slug to display the matching page.

You may need to open a document by slug when a colleague sends you a direct link, when you are reviewing a published User Guide, or when you need to confirm that a specific document is available to its intended audience. A valid link opens the document directly instead of requiring you to browse through the full document list.

If you are already working in the document management area, you can also use **Documents**, **User Guides**, and **Search documents...** to locate the same document manually.

> 📷 _Screenshot pending: A published Atloria documentation page opened from a shared link, showing the document content and its position within the project and audience._

## Prerequisites

Before you start, make sure you have:

- A link that includes the document slug for the page you want to open.
- Access to the Atloria project that contains the document.
- Access to the intended documentation audience, if the document is audience-specific.
- A supported web browser and an active internet connection.
- Permission to view the published documentation, if the project is restricted.

## Step-by-Step Instructions

1. **Copy the shared documentation link** that contains the document slug.

2. **Paste the link into your browser’s address bar.**

3. **Press Enter** to open the documentation page.

4. **Review the document page** to confirm that the displayed title and content match the document you intended to open.

5. **Use the documentation navigation** to move to another page in the same published manual if needed.

6. **Select User Guides** if you need to return to the broader collection of user-facing documentation.

7. **Select Documents** if you need to view the document list for the project.

8. **Enter a keyword in Search documents...** if you need to find the document without using its shared link.

9. **Select Open** beside the matching document to open it from the document list.

10. **Select ← Back to Documents** when you want to leave the open document and return to the list.

> 📷 _Screenshot pending: The Documents area showing the “Search documents...” field and an “Open” action for a matching document._

## Tips and Best Practices

- Keep the complete shared link intact. The project, audience, and document identifier work together to open the correct published page. Removing or changing part of the link can prevent Atloria from finding the document.

- Treat the document slug as an identifier, not necessarily as the document’s full title. The slug may be shorter or formatted differently from the title shown on the page.

- Use a direct link when you need to send someone to one specific document. This is more reliable than asking them to browse manually through **Documents** or **User Guides**.

- Use **Search documents...** when you do not have the direct link. Search can help you locate a document by recognizable words from its title or content, then you can select **Open**.

- Confirm that you are viewing the correct audience version before relying on the content. A project can present documentation for different audiences, so similarly named documents may appear in more than one context.

- If you are documenting or sharing a process, use the published document link rather than a link to an internal document-management view. This helps recipients open the reader-facing page directly.

## Related Pages

- [Browse Documents](#)
- [Search for a Document](#)
- [Create New Document](#)
- [Create Document](#)
- [Export Documentation](#)
- [Open Project Dashboard](#)

## Troubleshooting

### The link does not open a document

Check that you copied the entire link, including the final document-specific portion. Ask the sender to resend the link if it was truncated in a message, email, or document.

### Atloria opens a different document than expected

Verify the project and audience associated with the shared link. If the document title is similar to another page, return to **Documents**, use **Search documents...**, and select **Open** for the correct result.

### You cannot view the document

Your access may be limited to a different project or audience, or the document may no longer be available in the published documentation. Contact the project owner and provide the shared link so they can confirm the document’s availability and your access.

<!-- source: access-a-shared-document-with-a-token.md -->

# Access a Shared Document with a Token

A shared-document token lets you open documentation that has been shared with you through a secure link. This page explains how to use the token link and what to do if you cannot view the document.

## Overview

When someone shares documentation with you, they may provide a link that includes a unique access token. The token identifies the shared access invitation, so you can open the document without first navigating through the main **Documents** area.

Use a token link when you receive documentation from a colleague, project owner, or documentation author and need to review the shared content. The link is intended for the recipient it was shared with, so you should treat it as confidential.

After you open the link successfully, you can read the shared document in your browser. Depending on how the document was shared, you may be asked to sign in or accept access before the document is displayed.

> 📷 _Screenshot pending: A shared-document access link opened in a browser, showing the shared documentation access screen._

## Prerequisites

Before you begin, make sure you have the following:

- A complete shared-document link containing the token provided by the document owner.
- A supported web browser with an active internet connection.
- Access to the email account or message where the link was sent, if the link was delivered through an invitation.
- Any required Atloria sign-in credentials, if your organization requires authentication before viewing shared documentation.
- Permission from the document owner to access the shared content.

## Step-by-Step Instructions

1. Locate the shared-document link in the email, chat message, ticket, or other message sent by the document owner.

2. Check that the link is complete before opening it, including the token portion at the end of the address.

3. Click the shared-document link.

4. Wait for the shared-document access screen to load in your browser.

5. Sign in when prompted by the access screen.

6. Confirm that you are using the account that the document owner intended to grant access to.

7. Follow any on-screen access or invitation prompt shown after you sign in.

8. Select the available confirmation or continue option if the screen asks you to accept the shared access.

9. Review the document once it opens.

10. Use the document title, headings, and visible content to confirm that you opened the expected shared documentation.

11. Return to the shared link if you need to reopen the document later.

12. Contact the document owner if the link does not open the expected document or if you no longer have access.

> 📷 _Screenshot pending: A shared document displayed after successful token-based access, with the document content visible._

## Tips and Best Practices

- Keep the token link private. Anyone who receives the link may be able to attempt access to the shared document.

- Open the link directly instead of searching for the document in **Documents**. The main document area includes options such as **Search documents...**, **Create New Document**, and **Export Documentation**, but a shared token link is the appropriate starting point for content shared with you.

- Do not modify, shorten, or remove any part of the link. The token is part of the access information, and an incomplete link may not work.

- Verify the sender before opening an unexpected link. If you did not expect documentation to be shared with you, ask the sender to confirm that the link is legitimate.

- If you already use Atloria, make sure you are signed in to the correct account before opening the link. Access may differ between personal, organization, or project accounts.

- Use the browser’s normal bookmark feature only if your organization permits saving links to shared documents. Remember that a bookmark preserves the tokenized link.

- If you need to find documents that belong to your own workspace rather than a shared link, use **Documents** and the **Search documents...** field.

## Related Pages

- [View and Search Documents](#)
- [Create a New Document](#)
- [Import Existing Documentation](#)
- [Export Documentation](#)
- [Manage Document Access and Sharing](#)

## Troubleshooting

### The link does not open

1. Copy the entire link from the original message.

2. Paste the link into your browser’s address bar.

3. Check that no characters were omitted or replaced when copying the link.

4. Ask the document owner to send a new shared-document link if the problem continues.

### You are prompted to sign in but cannot view the document

1. Sign out of any unintended Atloria account.

2. Sign in with the account that received the shared-document invitation.

3. Open the token link again.

4. Ask the document owner to confirm that your account has been granted access.

### The document is unavailable or no longer accessible

1. Refresh the browser page once.

2. Reopen the original token link.

3. Confirm with the document owner that the document is still shared and available.

4. Request a replacement link if the previous token is no longer valid or access has been changed.

<!-- source: use-document-authoring-quick-actions.md -->

# Use Document Authoring Quick Actions

Quick Actions help you begin common document-authoring work without first browsing through the full document list. Use them when you want to create a document quickly or move directly to document management tasks for a project.

## Overview

Quick Actions are available from your project dashboard and provide a fast starting point for document work. Instead of navigating through **Documents** and locating the appropriate command, you can use the **Quick Create** action to begin creating a new document.

This feature is especially useful when you are working within a specific project and need to capture documentation immediately. After you start the creation process, you can enter the document information and use the document workspace to continue authoring.

Quick Actions complement the main **Documents** area. Use Quick Actions for a fast entry point, and use **Documents** when you need to search, review, delete, export, or manage multiple documents.

> 📷 _Screenshot pending: Project dashboard showing the Quick Actions area and the Quick Create option._

## Prerequisites

Before you begin, make sure that:

- You are signed in to Atloria.
- You can access the project where you want to create documentation.
- You have selected or opened the relevant project.
- You know whether you want to create a new document or work with an existing one.
- You have the document title and basic content ready, if your organization requires these details when creating documentation.

## Step-by-Step Instructions

1. Open the project dashboard for the project where you want to author documentation.

2. Locate the **Quick Actions** area on the dashboard.

3. Select **Quick Create** to start a new document.

4. Enter the requested document details on the new-document screen.

5. Select **Create Document** to create the document.

6. Add or revise the document content in the document editing workspace.

7. Select **Documents** when you want to return to the project’s document collection.

> 📷 _Screenshot pending: New-document screen reached from Quick Create, showing the Create Document action._

## Tips and Best Practices

- Use **Quick Create** when you already know that you need a new document. It reduces the number of navigation steps compared with opening the document collection first.

- Use a clear, specific document title when you create the document. A descriptive title makes the document easier to locate later through **Search documents...**.

- If you are not ready to create a document from scratch, look for **Or import existing documentation** on the new-document screen. This option is useful when content already exists outside Atloria.

- Use **Documents** rather than Quick Actions when you need to manage existing content. The document area includes actions such as **Delete Documents** and **Export Documentation**.

- Use the document search field when your project contains many documents. Depending on where you are working, you may see **Search documents...** or **Search documents, categories, projects...**.

- Confirm that you are working in the intended project before using **Quick Create**. The documents you create should be associated with the project you have opened.

- If you need to leave the new-document screen without creating a document, use **← Back to Documents** to return to the document list.

## Related Pages

- [Create a New Document](#)
- [Manage Documents](#)
- [Search Documents](#)
- [Import Existing Documentation](#)
- [Export Documentation](#)
- [Delete Documents](#)

## Troubleshooting

### You cannot find Quick Actions

1. Open the relevant project dashboard.

2. Look for the dashboard area that contains **Quick Actions**.

3. Select **Documents** if you need to create or manage documents and the Quick Actions area is not available on your current screen.

### You do not see documents after selecting Documents

1. Check whether a project has been selected.

2. Select the project you want to work in.

3. Review the message **Select a project to view documents** if it appears.

### You created the wrong document or need to change it

1. Open **Documents**.

2. Locate the document by using **Search documents...**.

3. Open the document to edit its content, or use **Delete Documents** if you need to remove it.

<!-- source: return-to-recent-documents.md -->

# Return to Recent Documents

Recent Documents helps you quickly reopen documentation you worked on recently, so you can continue authoring without searching through the full document list. Use it when you know you opened a document before but do not want to locate it again manually.

> 📷 _Screenshot pending: The dashboard showing the Recent section with recently opened documents._

## Overview

When you work across multiple projects or documentation topics, finding the right document again can take time. The **Recent** area provides a shortcut to documentation you have opened recently, helping you return to your active work more efficiently.

Use Recent Documents when you are continuing an edit, reviewing an existing guide, comparing document versions, or preparing a translation. Instead of starting from the complete **Documents** list, select the document from **Recent** and continue where you left off.

If the document you need is not shown in **Recent**, use the main **Documents** area. You can search using **Search documents...** or, where available, **Search documents, categories, projects...** to locate documents by name, category, or project.

## Prerequisites

Before you begin, make sure that:

- You are signed in to Atloria.
- You have access to the relevant project and its documents.
- You have opened the document previously if you expect it to appear under **Recent**.
- You know the document name, category, or project in case you need to use document search instead.
- You have permission to view or edit the document you want to reopen.

## Step-by-Step Instructions

1. Open the Atloria dashboard or the project workspace where you manage documentation.

2. Look for the section labeled **Recent**.

   The Recent area is intended for returning to documentation you accessed recently. Review the displayed document entries and identify the document you want to continue working on.

3. Select the document you want to reopen.

   Atloria opens the selected document so you can continue your work. Depending on your task and permissions, you can review the document or proceed to editing.

4. Continue with the appropriate document task.

   For example, you can:
   - Update the document content.
   - Return to the document list by selecting **← Back to Documents**.
   - Use document comparison when you need to review differences.
   - Open translation work when the document needs another language version.
   - Export the finished content using **Export Documentation**, when that option is available.

5. If the document is not listed under **Recent**, open **Documents**.

   Use **Search documents...** to search the document list. If your workspace provides the broader search field, use **Search documents, categories, projects...** to narrow your search by document, category, or project.

6. If no existing document matches your needs, select **Create New Document**.

   You can then choose **Create Document** to start authoring. If you are bringing in existing material, select **Or import existing documentation** instead.

> 📷 _Screenshot pending: The Recent section and the Documents page search field used when a document is not listed._

## Tips and Best Practices

- Use **Recent** for short-term continuity. It is most useful when you are returning to documentation you opened during your current or recent work.
- Use **Documents** for complete discovery. The Recent area is a shortcut, not a replacement for the full document list.
- Search before creating a new document. Enter a title or keyword in **Search documents...** to avoid creating duplicate documentation.
- Use the broader **Search documents, categories, projects...** field when you are unsure which project contains the document.
- Confirm the document before editing. Documents with similar titles can exist in different categories or projects, so check that you opened the intended item.
- Return to the document list with **← Back to Documents** when you need to switch between several documents rather than relying only on Recent.
- Use **Recently Updated** when your goal is to find the latest changes rather than the documents you personally opened most recently.

## Related Pages

- [Documents](#documents) — Find, search, and manage all available documentation.
- [Create New Document](#create-new-document) — Start a new documentation item.
- [Edit a Document](#edit-a-document) — Update document content after reopening it.
- [Compare Documents](#compare-documents) — Review document differences.
- [Translate a Document](#translate-a-document) — Create or manage translated documentation.
- [Export Documentation](#export-documentation) — Export completed documentation.

## Troubleshooting

### The document I need is not shown in Recent

**Problem:** You cannot find the document you want in the **Recent** section.

**Cause:** The document may not have been opened recently, or other recently accessed documents may be displayed instead.

**Solution:** Select **Documents** and search using **Search documents...**. If available, use **Search documents, categories, projects...** to search across document names, categories, and projects. Open the correct document from the results.

### I can see Recent, but I cannot find a document from another project

**Problem:** A document you expect to work on is not available in the current project context.

**Cause:** The document may belong to a different project, or you may not currently have access to that project.

**Solution:** Switch to the correct project and check its documents. Use the document search fields to search by project or document name. If you still cannot locate it, confirm that you have access to the project containing the document.

### I opened the wrong document from Recent

**Problem:** You selected a document with a similar name but it is not the one you intended to update.

**Cause:** Multiple documents can have similar titles, especially when documentation is organized across categories or projects.

**Solution:** Select **← Back to Documents**, then use **Search documents...** or **Search documents, categories, projects...** to locate the correct document. Review the document’s project and category before continuing your edits.

<!-- source: return-to-a-previous-view.md -->

# Return to a Previous View

This page explains how to use the Back button and related return links to go back to the document, review, or project view you were working from. Returning to the correct view helps you continue your work without reopening the project from the Projects list.

## Overview

Atloria provides return controls in document-authoring and project-review areas so you can move back to the relevant parent view. Depending on where you are, the control returns you to a project-level screen, such as **Projects**, or to the review screen that you opened before viewing a change or document detail.

For example, when you are reviewing a specific change, you may use **Back to Review** to return to the review summary. When you have finished working in a project and need to choose another project, use **← Back to Projects** to return to the **Projects** list.

The available return option depends on the screen you opened. Use the return control shown in the current view rather than relying on a general browser back action when you want to return to the related Atloria project or document workspace.

> 📷 _Screenshot pending: The ← Back to Projects link displayed above a project-level workspace._

> 📷 _Screenshot pending: The Back to Review action shown from a change or diff-related view._

## Prerequisites

Before you begin, make sure that you have:

- Signed in to Atloria.
- Opened a project from the **Projects** area.
- Navigated to a document, review, change, version, comparison, screenshot, analytics, or technical documentation view.
- Saved any changes required by the screen before leaving it.
- Identified the return control displayed on the current screen, such as **← Back to Projects** or **Back to Review**.

## Step-by-Step Instructions

1. Open the document, review, or project detail view that you want to leave.

2. Look near the top of the current screen for a return action.

3. Click **← Back to Projects** when you want to return to the **Projects** list.

4. Click **Back to Review** when you are viewing a change or diff-related detail and want to return to its review screen.

5. Click **Open Project Dashboard** when it is available and you want to return to the main dashboard for the current project.

6. Click **Projects** if the current screen provides that navigation option and you need to choose a different project.

7. Select the document-authoring area you need after returning to the project, such as **📋 User Manuals**, **📊 Overview**, or **User Docs**.

8. Click **View Draft** when you need to reopen a draft document after returning to its related project or documentation area.

9. Click **View Your Documentation →** or **🌐 View Published Docs** when you need to move from the project workspace to the documentation view that was generated or published.

10. Click **Back to Review** again if you opened a full diff by selecting **🔍 View Full Diff** or **Open Diff Viewer** and need to resume the review workflow.

## Tips and Best Practices

- Use the return action shown within Atloria whenever possible. A contextual option such as **Back to Review** is intended to take you back to the related review flow, rather than to an unrelated screen you visited earlier.

- Use **← Back to Projects** when you are finished with the current project. This returns you to the project selection area, where you can open another project.

- Return to the project dashboard before switching to another project when you need access to project-level areas such as **📊 Overview**, **📋 User Manuals**, analytics, versions, changes, or technical documentation.

- If you are reviewing a change, return to the review screen before opening another diff. This helps you keep the current change context and avoid losing track of which review item you were evaluating.

- Save or complete any required edits before using a return control. Returning to a project or review view may remove the current detail view from your screen.

- Choose the navigation option that matches your goal:
  - Select **Back to Review** to continue reviewing the same item.
  - Select **Open Project Dashboard** to work elsewhere in the same project.
  - Select **← Back to Projects** to leave the current project and select another one.
  - Select **View Draft** to return to a document draft.

## Related Pages

- [Open a Project Dashboard](#)
- [View and Review Project Changes](#)
- [Use the Diff Viewer](#)
- [Manage Project Versions](#)
- [Create and View User Manuals](#)
- [View Published Documentation](#)

## Troubleshooting

### You cannot find a return control

Look at the top area of the screen for a labeled action. The available label depends on the view you opened. For example, project-level views may show **← Back to Projects**, while review-related detail views may show **Back to Review**.

### You returned to the project but cannot find the document you were viewing

Open **📋 User Manuals** or **User Docs**, then select **View Draft** if you need to continue working with a draft. If you were viewing published output, select **🌐 View Published Docs** instead.

### You opened a full diff and need to resume the review

Click **Back to Review**. If you opened the diff using **🔍 View Full Diff** or **Open Diff Viewer**, this returns you to the review context for that item.

<!-- source: generate-documentation-with-ai.md -->

# Generate Documentation with AI

You can generate a documentation draft using your project context and the scope you choose. This helps you create a focused starting point that you can review, save, and refine before publishing.

## Overview

AI-generated documentation uses the information available for your selected project to prepare a draft. Use it when you need a first version of user-facing documentation without starting from a blank page.

Start from the **Projects** area, open the project you want to document, and use the documentation generation action available for that project. The generation process creates a draft rather than immediately replacing your existing documentation, so you can review the result before deciding what to keep.

Your draft moves through a simple lifecycle:

- **Draft:** The generated content is available for review and editing.
- **Saved as Draft:** You have stored the draft for later work.
- **Regenerated:** A new AI-generated version is created from the current project context and selected scope. Review the new version before using it in place of an earlier draft.

> 📷 _Screenshot pending: The Projects hub showing available projects and the project selection area._

## Prerequisites

Before you begin, make sure you have:

- Access to the **Projects** area.
- A project selected that contains the context you want the AI to use.
- A clear documentation topic or scope in mind.
- Permission to view and update documentation for the project.
- Time to review the generated **Draft** before sharing or publishing it.

## Step-by-Step Instructions

1. Click **Projects** to open the list of available projects.

2. Select the project whose context you want to use for the documentation draft.

3. Open the project’s documentation area and locate **User Docs**.

4. Choose the documentation scope you want the AI to cover using the available scope selection controls.

5. Click **✦ Regenerate AI docs** to generate a new AI documentation draft.

6. Wait for the generation process to finish until the **3. Draft Ready** state is displayed.

7. Click **View Draft** to open the generated documentation.

> 📷 _Screenshot pending: The documentation generation screen showing the “3. Draft Ready” state and the “View Draft” action._

8. Review the draft to confirm that it covers the selected scope and uses the correct project terminology.

9. Click **Save as Draft** to retain the reviewed version for later editing.

10. Click **Generate More** if you need to create documentation for another topic or scope.

11. Click **↻ Re-generate** if you need a fresh draft for the same documentation area.

12. Click **Regenerate** when you want to replace the current generated result with a newly generated version.

13. Click **View Your Documentation →** when you are ready to open the documentation that has been created for the project.

> 📷 _Screenshot pending: A generated User Docs draft open for review, with Save as Draft and regeneration actions available._

## Tips and Best Practices

- Select a focused scope before generating. A narrowly defined topic generally produces a more useful draft than a broad request covering many unrelated areas.

- Review every generated draft before saving it. AI generation creates a starting point, so you should verify instructions, terminology, and any project-specific behavior.

- Use **Save as Draft** after reviewing a version you may want to return to. This lets you preserve the draft while you continue planning or validating the content.

- Use **↻ Re-generate** or **Regenerate** when the output does not match your intended topic. Regeneration is useful after you change the selected scope or when the project context has changed.

- Generate one focused document at a time. For example, create a separate draft for a task such as “How to create a maintenance request” rather than combining unrelated procedures in one page.

- Use **Generate More** after completing the current draft to create additional documentation topics from the same project.

- If you are unsure whether you are working in the correct project, use **← Back to Projects** and select the appropriate project before generating again.

## Related Pages

- [Manage Projects](#)
- [View User Docs](#)
- [Review and Save Documentation Drafts](#)
- [Regenerate AI Documentation](#)
- [Project Changes](#)
- [Technical Documentation](#)

## Troubleshooting

### The generated draft does not cover the topic you expected

Return to the documentation generation area and adjust the scope selection. Then click **✦ Regenerate AI docs** or **↻ Re-generate** to create a new draft. Review the new **Draft** before saving it.

### You cannot find the project you want to document

Click **← Back to Projects** to return to the project list. Select the correct project, then reopen **User Docs** and start the generation process again.

### You generated a draft but cannot see the content

Confirm that the screen shows **3. Draft Ready**. Then click **View Draft**. If the draft still does not meet your needs, use **Regenerate** to create another version and review it before selecting **Save as Draft**.

<!-- source: generate-documentation-from-source-context.md -->

# Generate Documentation from Source Context

You can use Atloria to generate documentation from the source context that has been analyzed for your project. This helps you create up-to-date technical content that reflects the project’s components, relationships, data layers, and configuration.

## Overview

Atloria organizes analyzed project context into documentation-oriented categories, such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. When you generate documentation, Atloria uses this available context to produce a documentation version based on the current project information.

Use this feature when you need to create an initial set of technical documentation, refresh content after the project changes, or produce another generated version for review. The generated content can describe how parts of the product relate to one another, such as components that render other components, services that call APIs, or code that depends on another service.

The **Technical Docs** area is intended for technical content created from project-source context. If you need end-user instructions instead, use the **User Docs** or **User Guides** area where available.

> 📷 _Screenshot pending: The Technical Docs screen showing source context and documentation generation actions._

## Prerequisites

Before you begin, make sure that:

- You can open the relevant project in Atloria.
- Your project source has been analyzed so that source context is available.
- You have access to the project’s **Technical Docs** area.
- You know whether you are creating technical documentation or end-user documentation.
- You have reviewed the available source context if you need to verify what Atloria will use for generation.
- You are ready to review generated content before sharing it with others.

## Step-by-Step Instructions

1. Open the project for which you want to create documentation.

2. Select **Technical Docs** to open the project’s technical documentation workspace.

3. Click **View Source** if you want to inspect the source context before generating documentation.

4. Review the available source information to confirm that it represents the parts of the project you want documented.

5. Return to the documentation workspace after reviewing the source context.

6. Select the available documentation style using the style selector, if a style option is shown.

7. Click **Generate More** to create additional documentation from the available source context.

8. Wait for Atloria to finish creating the generated documentation version.

9. Review the generated documentation for accuracy, completeness, and terminology that matches your organization’s standards.

10. Click **Regenerate Docs** if you want Atloria to create a replacement documentation result using the current source context.

11. Click **↻ Re-generate** when you want to refresh an existing generated result.

12. Click **✦ Regenerate AI docs** when you want to regenerate AI-produced documentation from the project information.

13. Click **Source** when you need to return to the source-oriented view while reviewing generated content.

14. Select **User Docs** or **User Guides** if the content should be rewritten as instructions for product users rather than technical documentation.

> 📷 _Screenshot pending: The source review view opened from the View Source action before documentation is generated._

## Tips and Best Practices

- Generate technical documentation only after the relevant project context has been analyzed. Atloria can use information across frontend, backend, database, API schema, configuration, documentation, and infrastructure areas, so more complete source context generally produces more useful results.

- Review source context before generation when the documentation must cover a specific feature or system area. Selecting **View Source** helps you validate that the material available to Atloria includes the items you expect.

- Use regeneration deliberately. **Regenerate Docs**, **↻ Re-generate**, and **✦ Regenerate AI docs** can create a new result from the current project context. Review the new version carefully, especially after source changes or analysis updates.

- Keep technical and user-facing content separate. Use **Technical Docs** for implementation-oriented material, such as component relationships, services, APIs, data access, and configuration. Use **User Docs** or **User Guides** for task-focused instructions written for people using the product.

- Check relationship descriptions for clarity. Generated content may describe relationships such as one component rendering another, a component using a hook or context, a service calling an API, or a repository querying a model. Confirm that these descriptions are useful for your intended readers.

- Treat generated content as a draft for review. Ensure names, product terminology, security guidance, and operational instructions meet your team’s publishing standards before distributing the documentation.

## Related Pages

- [View Technical Documentation](#)
- [Review Source Context](#)
- [Regenerate AI Documentation](#)
- [Create User Documentation](#)
- [Use User Guides](#)

## Troubleshooting

### The generated documentation does not cover the area I expected

1. Click **View Source**.

2. Confirm that the required project area is present in the available source context.

3. Return to **Technical Docs**.

4. Click **Regenerate Docs** after the project context has been updated or reanalyzed.

### I generated technical content, but I need end-user instructions

1. Open **User Docs** or **User Guides**.

2. Create or generate content in the user-focused documentation area.

3. Write the content as tasks users can complete, rather than as descriptions of technical relationships.

### The regenerated content differs from the previous version

1. Review the current source context by clicking **View Source**.

2. Check whether the project analysis or available source information has changed.

3. Use **↻ Re-generate** only after confirming that the current context is the version you want documented.

<!-- source: refresh-generated-documentation.md -->

# Refresh Generated Documentation

When product information changes, you can request an updated version of your AI-generated documentation. Refreshing your documentation helps keep User Guides and User Manuals aligned with the current product experience.

## Overview

Atloria generates documentation based on the product information available during the generation process. When your product screens, workflows, terminology, or documentation requirements change, you should review the generated content and request updates rather than continuing to use an outdated version.

Use this process when you need to revise generated User Guides, User Manuals, or other generated documentation. For example, you may need an update after adding a product surface, changing a user flow, or correcting content that no longer reflects how users interact with the product.

The update process begins from your documentation area. You can review the current generated documentation, submit a change request, monitor the generation status, and save the updated result when it is ready.

> 📷 _Screenshot pending: The documentation area showing generated documentation and available actions._

## Prerequisites

Before you request updated documentation, make sure you have the following:

- Access to the relevant project and its documentation workspace.
- Documentation that has already been generated, indicated by the **Generated** status or available generated content.
- A clear list of product changes that affect the documentation.
- The ability to describe the requested updates using **✎ Request Changes**.
- Time to wait for the **4. Generation Running** stage to finish before reviewing the refreshed content.

## Step-by-Step Instructions

1. Open the project that contains the documentation you want to update.

2. Select **User Docs** to open the project’s documentation area.

3. Select **User Guides** if you are updating end-user guidance.

4. Select **📋 User Manuals** if you are updating manual-style documentation for users.

5. Review the currently **Generated** documentation before requesting changes.

6. Identify the sections that no longer match the product, such as changed user flows, renamed product areas, or newly available product surfaces.

7. Select **✎ Request Changes**.

8. Enter a clear description of the product information that has changed.

9. Specify which documentation content should be updated, such as a User Guide, a User Manual, or a particular workflow.

10. Include the current user-facing terms in your request so the refreshed documentation uses the correct labels.

11. Submit the change request to begin the update process.

12. Select **Generation** to view the documentation generation progress.

13. Confirm that the status shows **4. Generation Running** while Atloria is preparing the updated documentation.

14. Wait for generation to complete before reviewing the refreshed content.

15. Select **User Docs** again after generation finishes.

16. Open the updated **User Guides** or **📋 User Manuals** content.

17. Review the refreshed documentation for accuracy, completeness, and user-facing terminology.

18. Select **Save Changes** after you finish reviewing or editing the updated documentation.

> 📷 _Screenshot pending: The generated documentation view with the “✎ Request Changes” action available._

## Tips and Best Practices

- Request updates whenever product behavior changes, not only when text labels change. A revised workflow can affect several documentation sections even when the screen names remain the same.

- Describe changes from the user’s perspective. For example, explain that users now select a different menu item, see a new status, or follow a revised sequence of actions.

- Include exact visible labels in your request. If the product uses labels such as **User Docs**, **User Guides**, or **Product**, use those terms so the regenerated content matches the interface.

- Review both documentation types when applicable. Atloria can present **User Manuals** and other documentation side by side, so a change that affects end users may require updates in more than one documentation area.

- Use the generation status to avoid reviewing too early. While **4. Generation Running** is displayed, the updated content is still being prepared.

- Do not use **■ Cancel Generation** unless you need to stop the current update. If you cancel generation, review your requested changes before starting a new request.

- Save any edits you make after reviewing the refreshed documentation. Select **Save Changes** so your accepted updates are retained.

> 📷 _Screenshot pending: The Generation view displaying the “4. Generation Running” status and the “■ Cancel Generation” action._

## Related Pages

- [Generate Documentation](#)
- [Request Changes to Generated Documentation](#)
- [Review User Guides](#)
- [Manage User Manuals](#)
- [Export Documentation](#)

## Troubleshooting

### The updated documentation is not available yet

Check **Generation** and look for **4. Generation Running**. The refreshed documentation is not ready for review until the generation process finishes. Return to **User Docs** after the running status is no longer displayed.

### You need to stop an update request

Select **■ Cancel Generation** from the generation view. After cancelling, review the product changes you want documented and submit a new request using **✎ Request Changes** when you are ready.

### The refreshed documentation still does not reflect the product change

Select **✎ Request Changes** again and provide more specific information. Include the affected documentation type, the changed product area, the exact user-facing labels, and the expected user workflow. Then monitor **Generation** and review the new generated result.

<!-- source: create-technical-documentation.md -->

# Create Technical Documentation

You can create technical documentation for a project to explain its architecture, behavior, and implementation details. Keeping this documentation current helps engineering teams understand how the project is organized and how its parts work together.

## Overview

Technical documentation is intended for readers who need a deeper understanding of a project than a user guide provides. Use it to describe technical areas such as application architecture, component relationships, data handling, APIs, configuration, and infrastructure.

From your project’s documentation area, you can work with **Technical Docs** alongside other documentation types, including **User Docs** and **User Manuals**. You can also use **Architecture Diagram** when a visual representation will make the technical guide easier to understand.

Create a technical guide when you need to record how a feature works, explain why a design decision was made, or provide implementation guidance for future maintenance. For example, you might document how frontend components interact with backend services, how database entities are related, or how an API schema supports a workflow.

> 📷 _Screenshot pending: The project documentation area showing the Technical Docs option and related documentation sections._

## Prerequisites

Before you start, make sure you have:

- Access to the project you want to document.
- Permission to create or update project documentation.
- A clear topic for the guide, such as architecture, behavior, configuration, or implementation.
- Relevant project information, diagrams, or examples to include in the guide.
- An understanding of whether the content belongs in **Technical Docs**, **User Docs**, or **📋 User Manuals**.

## Step-by-Step Instructions

1. Open the project that contains the feature, service, or workflow you want to document.

2. Select **Technical Docs** from the project documentation options.

3. Review the available technical documentation areas before creating content.

4. Select **Create Manually** to begin a new technical guide.

> 📷 _Screenshot pending: The Technical Docs area with the Create Manually action available._

5. Enter a clear title that identifies the technical topic you are documenting.

6. Write an overview that explains the purpose of the feature or system.

7. Describe the architecture by explaining the major areas involved and how they relate to one another.

8. Select **Architecture Diagram** if you need to review or include a visual view of the project architecture.

9. Document the feature’s behavior by explaining what triggers it, what happens during processing, and what outcome users or systems should expect.

10. Describe implementation considerations that a technical reader needs to know, such as dependencies, configuration requirements, supported integrations, or data relationships.

11. Organize the guide into sections so readers can distinguish architecture details from behavior and implementation guidance.

12. Add practical examples when they help explain a technical workflow or relationship.

13. Select **Rewrite** if you want to revise the wording of existing content.

14. Select **AI: Rewrite** when you want assistance improving clarity, structure, or readability.

15. Review the rewritten content to ensure technical terms, project-specific names, and intended meaning remain accurate.

16. Add related documentation references, such as **Architecture**, **Guides**, or **User Guides**, when those resources provide useful context.

17. Select **Export Documentation** if you need a copy of the completed documentation for sharing, review, or offline use.

## Tips and Best Practices

- Create one focused guide for each technical topic. For example, document architecture separately from deployment configuration or API behavior. This makes guides easier to maintain and easier for readers to find.

- Start with the reader’s goal. Explain what the feature or area is responsible for before describing its technical details.

- Use **Architecture Diagram** when text alone does not clearly show relationships between parts of the project. Diagrams are especially useful for explaining how frontend, backend, database, API schema, configuration, documentation, and infrastructure areas connect.

- Describe relationships in plain language. For example, explain which component renders another component, which component uses a hook, or which service provides information to another area.

- Keep behavior descriptions chronological. Explain what starts the process, what intermediate actions occur, and what result is produced.

- Include implementation details only when they help readers maintain, troubleshoot, extend, or safely change the project. Avoid adding background information that does not affect technical decisions.

- Use **Rewrite** or **AI: Rewrite** to improve a draft, but always confirm that the revised text still reflects the project’s actual behavior.

- Keep technical guides distinct from end-user instructions. Use **User Docs** or **📋 User Manuals** for tasks that explain what business users see and do in the application.

## Related Pages

- [Architecture Diagram](#architecture-diagram) — Use visual diagrams to explain project structure and relationships.
- [User Docs](#user-docs) — Create documentation for end-user tasks and workflows.
- [📋 User Manuals](#user-manuals) — Organize procedural manuals for application users.
- [Export Documentation](#export-documentation) — Share or retain a copy of completed documentation.
- [Guides](#guides) — Review other available project guidance.

## Troubleshooting

### You cannot find the option to create a guide

Open the project documentation area and select **Technical Docs**. If **Create Manually** is not available, verify that you have permission to create or edit documentation for the project.

### The guide contains information that belongs in a user manual

Move user-facing steps, screen instructions, and business-process guidance to **User Docs** or **📋 User Manuals**. Keep **Technical Docs** focused on architecture, behavior, relationships, configuration, and implementation details.

### A rewritten draft changes the intended technical meaning

Use **Rewrite** or **AI: Rewrite** as a starting point only. Review the revised content, restore project-specific terminology where needed, and verify that descriptions of architecture and behavior are still correct before sharing or exporting the documentation.

<!-- source: document-api-capabilities.md -->

# Document API Capabilities

This page explains how to create and review API documentation in Atloria’s Technical Docs area. Clear API documentation helps your technical teams understand available endpoints, required inputs, returned outputs, and possible errors before they integrate with an application.

## Overview

Atloria organizes generated technical content by project. When you open **Technical Docs** for a project, you can review the available documentation and generate API reference content from the project’s analyzed application structure.

API documentation is most useful after a project has been parsed successfully. Atloria’s analysis progresses through categories such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. API details are available when the project contains identifiable API schema or backend information.

The generated API reference is intended to help you document:

- Available API endpoints and their purpose
- Request inputs, including parameters and body data when detected
- Response outputs and returned data structures
- Error conditions and response details when available in the analyzed project
- Relationships between API implementations and the components or services that call them

> 📷 _Screenshot pending: The Technical Docs area for a selected project, showing available documentation categories and API reference content._

## Prerequisites

Before you begin, make sure you have:

- Access to the relevant Atloria project.
- A project that has completed parsing successfully, or completed with warnings that you have reviewed.
- API-related source material in the project, such as backend implementations or API schema definitions.
- Permission to view the project’s **Technical Docs**.
- A selected project; if no project is selected, Atloria displays **Select a project to view documents**.

## Step-by-Step Instructions

1. Open **Documents** from the main application navigation.

2. Select the project that contains the API you want to document.

3. Open **Technical Docs** for the selected project.

4. Confirm that the project analysis has completed before generating documentation.

5. Review any parse warnings before continuing if the analysis completed with warnings.

6. Select the API reference area in the Technical Docs navigation or documentation tree.

7. Choose the documentation style using the available style selector.

8. Click the generation button in the API reference reader to create or refresh the API documentation.

9. Review each documented endpoint to confirm that its purpose and available request inputs are understandable.

10. Review the output section for each endpoint to confirm that returned data is represented correctly.

11. Review the documented errors for each endpoint to identify expected failure conditions and error responses.

12. Use the documentation tree to move between related backend, API schema, and implementation information.

13. Click **Export Documentation** when you are ready to share the completed documentation outside Atloria.

> 📷 _Screenshot pending: The API reference reader showing generated endpoint documentation, request inputs, outputs, errors, style selection, and the generation control._

## Tips and Best Practices

- Generate API documentation after parsing is complete. API reference quality depends on Atloria being able to identify backend and API schema information during project analysis.

- Review documentation when parsing completes with warnings. A warning does not necessarily prevent documentation from being created, but it can mean some source information was unavailable or could not be fully interpreted.

- Use the documentation tree to validate context. An endpoint may be connected to services, database queries, models, or user-interface components. Reviewing those relationships can help you explain why an endpoint exists and how it is used.

- Use a consistent documentation style for the project. The style selector helps keep generated reference material consistent when you generate documentation for multiple API areas.

- Regenerate the API reference after major application changes. If endpoints, input fields, response structures, or error handling change in the project, refresh the documentation so readers are not relying on outdated information.

- Review generated content before exporting it. Confirm that endpoint names, inputs, outputs, and errors are meaningful to the intended technical audience.

- Keep API documentation focused on what consumers need to use the API. Describe the expected request information, successful output, and known error behavior for each endpoint.

## Related Pages

- [Technical Docs](#technical-docs) — Open and manage technical documentation for a project.
- [Documents](#documents) — Find project documentation and return to the document list.
- [Export Documentation](#export-documentation) — Export completed documentation for sharing or review.
- [User Guides](#user-guides) — Create end-user documentation for user-facing workflows.
- [Create Manually](#create-manually) — Add documentation manually when generated material needs additional explanation.

## Troubleshooting

### You see “Select a project to view documents”

Select a project before opening **Technical Docs**. Atloria cannot display project-specific API documentation until a project is selected.

### API documentation is incomplete or does not include expected endpoints

Check whether the project parsing completed successfully. If parsing completed with warnings, review the affected areas and generate the API reference again after the project analysis has been updated.

### The generated documentation does not reflect recent API changes

Return to **Technical Docs**, open the API reference reader, and use the generation button again. Then review the refreshed endpoint inputs, outputs, and errors before selecting **Export Documentation**.

<!-- source: add-code-snippets-and-sdks.md -->

# Add Code Snippets and SDKs

You can use code examples and client SDK guidance to make your technical documentation easier for developers to adopt. This page explains how to add examples and show developers how to initialize a client in Atloria’s Technical Docs workspace.

## Overview

Code snippets help readers understand how to use an API or integration without translating general descriptions into implementation steps on their own. Use examples when you need to demonstrate a request, a response, a configuration value, or a typical integration flow.

Client SDK guidance helps readers start using an SDK consistently. In particular, an **Initialize Client** section gives developers a clear starting point before they use other operations or examples. Add SDK guidance when your documentation supports one or more client libraries or when setup details are required before a developer can make a first request.

In Atloria, you work with these materials from **Technical Docs**. You can add examples to improve generated or existing documentation, then review the resulting documentation in the docs view or published documentation view.

> 📷 _Screenshot pending: The Technical Docs workspace showing documentation actions, including Add examples._

## Prerequisites

Before you start, make sure that:

- You can open the relevant project in Atloria.
- You have access to **Technical Docs** for the project.
- You know which API, feature, or workflow the example should explain.
- You have a safe, representative code sample that does not include production credentials, private keys, or customer data.
- You know the client initialization details that developers need, such as the required configuration values and authentication approach.
- You have reviewed the existing documentation so that your example does not duplicate or contradict it.

## Step-by-Step Instructions

1. Open the project that contains the documentation you want to improve.

2. Select **Technical Docs** from the project documentation options.

3. Locate the documentation page or API area where developers need an implementation example.

4. Select **Add examples**.

5. Add an example that demonstrates one focused developer task.

6. Keep the example aligned with the behavior described in the surrounding documentation.

7. Include only the values a developer needs to understand the example.

8. Remove any real credentials, tokens, private URLs, or customer-specific identifiers from the example.

9. Add explanatory text before or after the example to state when a developer should use it.

10. Add an **Initialize Client** example when developers must configure a client before calling the API.

11. Show the initialization values that readers must provide in the client setup guidance.

12. Explain any required authentication or environment configuration alongside the initialization guidance.

13. Review the example and SDK guidance in the documentation view.

14. Select **View Docs** to check how the content reads as part of the technical documentation.

15. Select **View Published Docs** when you need to verify the reader-facing published experience.

> 📷 _Screenshot pending: A Technical Docs page showing an Initialize Client section and a related code example._

## Tips and Best Practices

- Use one example for one outcome. For example, keep client initialization separate from a later example that performs an operation. This lets readers copy the setup they need without sorting through unrelated code.

- Start SDK guidance with **Initialize Client**. Developers should see client setup before examples that depend on an initialized client.

- Choose realistic placeholder values. A placeholder should make the expected format clear without exposing sensitive information. For example, use a clearly fictional token or endpoint rather than a value copied from a live environment.

- Explain what a snippet demonstrates. A short sentence such as “Use this example to initialize the client before making API calls” helps readers decide whether the snippet applies to their situation.

- Keep examples consistent with the technical documentation. If an API name, required value, or documented behavior changes, update the related example and SDK guidance at the same time.

- Use **Add examples** to supplement documentation where readers need practical implementation help. Do not add examples simply to repeat information already clear in the API documentation.

- If documentation has been regenerated, review your examples afterward. You can use **Regenerate Docs** or **✦ Regenerate AI docs** when appropriate, then confirm that your developer guidance remains accurate and visible.

- Use **Search docs...** to find existing guidance before adding a new snippet. This helps you avoid maintaining multiple examples for the same setup task.

## Related Pages

- [Technical Docs](#) — Work with technical documentation for a project.
- [API Docs](#) — Review API-focused documentation and endpoint guidance.
- [Generate Docs](#) — Generate documentation when project documentation needs to be created or refreshed.
- [View Published Docs](#) — Review the published reader experience.
- [User Manuals](#) — Create end-user instructions for workflows outside technical implementation.

## Troubleshooting

### The **Add examples** action is not available

Confirm that you opened **Technical Docs** for the correct project. If you can view documentation but cannot add content, ask a project administrator to confirm your documentation access.

### Developers cannot use the SDK example

Check that the **Initialize Client** guidance appears before examples that require the client. Verify that required setup details, authentication information, and configuration placeholders are clearly identified.

### The example does not appear in published documentation

Open **View Docs** first to confirm the example is present in the documentation view. Then select **View Published Docs** to check the published version. If the content was recently regenerated, review the regenerated documentation and add the example again if needed.

<!-- source: use-the-client-sdks-section.md -->

# Use the Client SDKs Section

The **Client SDKs** section helps you find the information needed to start using an API from a supported client environment. Use it when you are reading **API Reference** documentation and need guidance before making your first API request.

## Overview

In your project’s **Technical Docs** area, the **API Reference** documentation can include a Client SDKs section. This section presents client SDK information alongside the API reference so you can move from understanding an endpoint to initializing a client for your application.

The section is most useful when you need to connect an application to an API rather than review API operations alone. Look for the **Initialize Client** or **Initialize the Client** action when you are ready to begin setup.

Client SDK information is part of technical documentation. If you are looking for task-focused help for business users instead, use **📋 User Manuals** or **User Guides** where available.

> 📷 _Screenshot pending: API Reference documentation showing the Client SDKs section and the Initialize Client action._

### Terms used on this page

<dl>
  <dt><strong>Technical Docs</strong></dt>
  <dd>Documentation for technical implementation and system reference material.</dd>

  <dt><strong>API Reference</strong></dt>
  <dd>The area of Technical Docs where you review API-related information, including client SDK guidance when it is available.</dd>

  <dt><strong>Client SDK</strong></dt>
  <dd>A client library or integration resource that helps your application work with an API.</dd>

  <dt><strong>Initialize Client</strong></dt>
  <dd>An on-screen action that begins the client setup guidance or displays initialization information.</dd>
</dl>

## Prerequisites

Before you use the Client SDKs section, make sure that:

- You have access to the relevant project in Atloria.
- You can open the project’s **Technical Docs** area.
- API documentation is available or has been generated for the project.
- You are viewing **API Reference**, rather than only **User Guides** or **📋 User Manuals**.
- You know which application or environment you want to connect to the API.
- You have the connection details, credentials, or configuration values required by your organization, if applicable.

> **Note:** If API reference content is not available yet, use **Generate Documentation →** or **Generate section** where those actions are available to create or update documentation content.

## Step-by-Step Instructions

1. **Open your project’s documentation area.**  
   From your project, select **Technical Docs**. This opens the technical documentation workspace for the project.

2. **Open the API reference.**  
   Select **API Reference** to view API-focused documentation. The API Reference view is where client SDK information is presented when it is included in your documentation.

3. **Locate the Client SDKs section.**  
   Review the API Reference content for the section that introduces client SDK information. Use this section to understand the available client setup information before you begin integration work.

4. **Start client setup.**  
   Select **Initialize Client**. In some documentation content, the same action may be shown as **Initialize the Client**. Follow the displayed initialization guidance for the client environment you are using.

5. **Review the setup details before continuing.**  
   Confirm that the client information matches the application you are configuring. Pay particular attention to any values you must supply from your organization, such as environment-specific connection settings or access credentials.

6. **Continue to the relevant API content.**  
   After reviewing client initialization information, continue using **API Reference** to find the API operations your application needs. The client setup step prepares you to use those operations from your chosen client environment.

7. **Generate or refresh documentation if information is missing.**  
   If the expected client SDK details do not appear, select **Generate section** to generate the current section, or select **Generate Documentation →** to generate documentation more broadly. If you already maintain documentation elsewhere, select **Or import existing documentation** instead.

> 📷 _Screenshot pending: The Initialize Client action within API Reference documentation._

### What to select

| Your goal | Where to go | Action to use |
|---|---|---|
| Find client SDK setup information | **Technical Docs** → **API Reference** | Locate the Client SDKs section |
| Begin setup guidance | Client SDKs section | **Initialize Client** or **Initialize the Client** |
| Create missing documentation content | Technical Docs | **Generate section** |
| Generate documentation more broadly | Technical Docs | **Generate Documentation →** |
| Bring in documentation you already have | Technical Docs | **Or import existing documentation** |
| Read end-user guidance instead of API material | **📋 User Manuals** or **User Guides** | Open the applicable guide |

## Tips and Best Practices

- **Start in API Reference for integration work.**  
  The Client SDKs section is intended for API-related implementation information. Use **API Reference** rather than **User Guides** when you need to initialize a client or work with API operations.

- **Treat client initialization as an early setup step.**  
  Review the Client SDKs section before attempting to use individual API operations. This helps you identify the required setup information first.

- **Use the label shown in your documentation.**  
  Depending on the content being displayed, you may see **Initialize Client** or **Initialize the Client**. Both labels indicate the client initialization step.

- **Keep technical and end-user documentation separate.**  
  Use **Technical Docs** for API reference and client SDK information. Use **📋 User Manuals** for user-facing procedures and help content. This keeps your audience in the right documentation type.

- **Generate only what you need when possible.**  
  If only the Client SDKs information is missing or outdated, use **Generate section** rather than regenerating all documentation. Use **Generate Documentation →** when you need a broader refresh.

- **Import existing material when it is authoritative.**  
  If your organization already has approved SDK or integration guidance, choose **Or import existing documentation** so the technical documentation can reflect that material.

## Related Pages

- [Open Technical Docs](#) — Access the project’s technical documentation workspace.
- [Use API Reference](#) — Review API operations and related reference information.
- [Generate Documentation](#) — Create or refresh documentation using **Generate Documentation →**.
- [Generate a Documentation Section](#) — Update a specific area using **Generate section**.
- [Import Existing Documentation](#) — Use **Or import existing documentation** to bring in existing content.
- [Use User Manuals](#) — Find user-facing procedures under **📋 User Manuals**.
- [Use User Guides](#) — Access task-oriented guidance through **User Guides**.

## Troubleshooting

| Issue | Possible cause | What to do |
|---|---|---|
| You cannot find the Client SDKs section. | You may be viewing a different documentation type or the API reference content has not been generated. | Open **Technical Docs**, then select **API Reference**. If the section is still unavailable, use **Generate section** or **Generate Documentation →**. |
| You see **User Guides** or **📋 User Manuals**, but not API client information. | You are in end-user documentation rather than technical API documentation. | Return to **Technical Docs** and open **API Reference**. |
| The **Initialize Client** action is not shown. | The documentation may use the alternate label, or the client SDK content may not be present. | Look for **Initialize the Client**. If neither action appears, generate or import the relevant documentation content. |

> 📷 _Screenshot pending: Technical Docs showing Generate section, Generate Documentation, and Or import existing documentation actions._

<!-- source: use-the-code-snippets-section.md -->

# Use the Code Snippets Section

The Code Snippets section helps you add reusable code examples to technical documentation. Use it when readers need a practical example alongside an explanation, such as a component usage pattern, configuration example, or integration sample.

## Overview

Code examples make technical documentation easier to apply. Instead of asking readers to translate a written description into their own implementation, you can provide a snippet they can review, copy, and adapt to their project.

In Atloria, you work with code examples from the project’s **Technical Docs** area. The available actions, including **Add code examples**, let you add examples where they are most useful in the documentation. Use snippets to support explanations of application features, technical entities, relationships, and generated documentation sections.

The Code Snippets section is most valuable when the example is reusable. Keep each example focused on one task so readers can understand what it demonstrates without having to remove unrelated code.

> 📷 _Screenshot pending: The Technical Docs area showing the Add code examples action._

## Prerequisites

Before adding code examples, make sure you have the following:

- Access to the relevant project in Atloria.
- A technical documentation area available through **Technical Docs**.
- A code example that supports the topic being documented.
- A clear purpose for the example, such as demonstrating a UI component, a service interaction, a data model query, or an API implementation.
- Any surrounding explanation needed to help readers understand when to use the example.

## Step-by-Step Instructions

1. Open the project that contains the documentation you want to update.

2. Select **Technical Docs** from the project documentation options.

3. Open the technical documentation topic or section where the code example belongs.

4. Select **Add code examples**.

5. Add an example that demonstrates one specific task or concept.

6. Place the example near the explanation it supports.

7. Review the example to confirm that it matches the terminology used in the surrounding technical documentation.

8. Add a short explanation before or after the example to tell readers what the code demonstrates.

9. Use the example to clarify relevant relationships, such as when one component **RENDERS** another component, when a component **USES HOOK**, or when a service **CALLS API** functionality.

10. Select **Generate section** if you are generating or completing the surrounding documentation section.

11. Review the generated section to make sure the code example remains relevant to the topic.

12. Repeat **Add code examples** for other technical topics that need their own focused examples.

> 📷 _Screenshot pending: A technical documentation section with the Add code examples and Generate section actions._

## Tips and Best Practices

- Use one example for one purpose. For example, do not combine component rendering, state management, API calls, and configuration setup in a single snippet unless all are necessary to understand the same workflow.

- Add examples where readers need them. A snippet is most useful immediately after the explanation of the feature, entity, or relationship it illustrates.

- Match the example to the documentation category. For frontend documentation, show a focused component or hook example. For backend documentation, use an example that supports a service, API implementation, or model query. For configuration documentation, show only the configuration needed for the documented outcome.

- Keep examples reusable. Avoid details that are specific to an unrelated feature or temporary scenario. Readers should be able to adapt the example without first removing large amounts of unrelated content.

- Explain relationship context. When an example shows one technical entity interacting with another, describe the relationship in plain language. For example, explain that a component renders another component, a component uses a hook, or a service depends on another service.

- Review examples after generating documentation. Generated technical content can provide surrounding context, but you should confirm that each code example still supports the section’s final topic and wording.

- Use **Add code examples** instead of relying only on descriptive text when implementation details are important. Written explanations describe intent; snippets show the practical structure readers can reuse.

## Related Pages

- [Technical Docs](#)
- [Generate Technical Documentation](#)
- [Use the User Docs Section](#)
- [Export Documentation](#)
- [Import Existing Documentation](#)

## Troubleshooting

### You cannot find the **Add code examples** action

Open the project’s **Technical Docs** area first. The code-example action is intended for technical documentation rather than general user documentation. If you are viewing **User Docs** or **📋 User Manuals**, switch to **Technical Docs**.

### The example does not fit the generated section

Review the topic of the section before keeping the example. If the snippet demonstrates a different feature or relationship, move it to a more relevant section or create a separate section with **Generate section**.

### Readers do not understand why the code example is included

Add a short explanation that identifies the task the example solves and the relationship it demonstrates. For example, state whether the example shows a component rendering another component, a hook being used, or a service calling an API.

<!-- source: open-documentation-by-version-id.md -->

# Open Documentation by Version ID

This page explains how to open a specific published technical documentation version using its version ID. Selecting the correct version helps you review the documentation that matches the release you need.

## Overview

Atloria keeps technical documentation organized by project and version. A version ID identifies one specific documentation version, so the version you open can be different from the newest version available for the project.

You may need to open documentation by version ID when a teammate shares a version-specific link, when you are checking a previously published release, or when you need to compare the published content with another version. The documentation opens only when the selected version is available as **Published**.

From the project workspace, you can use **Technical Docs** to view documentation and **Versions** to manage or locate individual versions. The version-specific view ensures that you are reading the intended release rather than automatically viewing another version.

> 📷 _Screenshot pending: Technical Docs area showing published documentation and version-specific access options._

## Prerequisites

Before you begin, make sure you have:

- Access to the relevant Atloria project.
- The version ID or a version-specific link from a teammate or project record.
- A version that has been published and displays the **Published** status.
- Permission to view the project’s technical documentation.
- An active browser session in Atloria.

## Step-by-Step Instructions

1. Open the project that contains the documentation version you need.

2. Select **Technical Docs** from the project navigation.

3. Review the available documentation area for a version marked **Published**.

4. Select **Versions** if you need to locate or confirm the version before opening its documentation.

5. Find the version that matches the version ID you were given.

6. Select **Open** for the matching version.

7. Select **🌐 View Published Docs** when you want to open the published documentation for that version.

8. Confirm that the documentation content shown belongs to the version you selected.

9. Use **Open Diff Viewer** if you need to compare the selected version with another documentation version.

10. Select **🕒 Go to Version Manager** if you need to return to the version list and choose a different version.

> 📷 _Screenshot pending: Version Manager showing a Published version with the Open and View Published Docs actions._

## Tips and Best Practices

- Verify the version ID before you open the documentation. Similar version numbers can represent different documentation snapshots, and selecting the wrong one can lead to reviewing outdated or unintended content.

- Look for the **Published** status before relying on the content for release, customer, or operational decisions. Published documentation is the version intended for viewing outside the generation and review workflow.

- Use **Versions** when you need to confirm which version is current or when a shared version-specific link does not show the documentation you expected.

- Use **Open Diff Viewer** when you need to understand what changed between versions. This is especially useful before sharing documentation with users or stakeholders.

- Do not assume that the latest generated version is the version you need. Actions such as **⚡ Generate Next Version** and **🚀 Publish Version 4** indicate that generation and publishing are separate activities. Open the version identified by the version ID, not simply the newest version listed.

- If you are working with AI-generated versions, use **Use V4 AI Version** or **Use All V4 AI Versions** only when those options match your team’s documentation workflow. These actions affect which generated version you work from; they do not replace checking the version you intend to open.

## Related Pages

- [View Technical Documentation](#)
- [Manage Documentation Versions](#)
- [Compare Documentation Versions](#)
- [Publish a Documentation Version](#)
- [Generate the Next Documentation Version](#)
- [Open User Manuals](#)

## Troubleshooting

### The version does not open

Confirm that you selected the exact version ID provided to you. Return to **Versions**, locate the matching entry, and select **Open** again. If the version is not listed, ask the project owner to confirm the ID and your project access.

### I can see the version, but I cannot view published documentation

Check whether the version displays **Published**. If it has not been published, **🌐 View Published Docs** may not provide the published documentation you need. Ask an authorized team member to publish the correct version.

### The documentation is not the version I expected

Return to **🕒 Go to Version Manager** and compare the selected version with the version ID you received. If needed, select **Open Diff Viewer** to compare it with another version and identify the differences.

<!-- source: configure-a-publishing-audience-by-slug.md -->

# Configure a Publishing Audience by Slug

This page explains how the audience slug in a published documentation link determines which audience’s documentation visitors see. Using the correct audience slug helps you direct each group—such as customers, administrators, or technical users—to the intended documentation experience.

## Overview

When you publish documentation, Atloria uses the audience slug in the public documentation address to identify the audience being viewed. The audience slug is the audience-specific part of the published link. It appears after the main documentation or project identifier and before an individual document name, when a document is opened.

This audience selection is especially important when the same project has documentation for different readers. For example, you may publish **User Guides** for end users and **Technical Docs** for developers. Each published audience should use its own audience slug so that visitors open the correct collection of content.

You normally use an audience slug when sharing a documentation link, adding a link to a help center, or verifying that publishing has been configured for the right reader group. If the audience slug is wrong or missing, visitors may see a different audience’s documentation, a higher-level documentation page, or no matching published content.

> 📷 _Screenshot pending: The Publishing area showing published documentation options and an audience-specific public link._

## Prerequisites

Before you configure or use an audience slug, make sure you have the following:

- Access to the relevant Atloria project.
- Documentation created for the audience you want to publish.
- Permission to view or manage the project’s publishing settings.
- A published documentation collection, or content ready to publish.
- The intended audience name and its assigned slug.
- A browser window available to test the published documentation link.

## Step-by-Step Instructions

1. Open the Atloria project that contains the documentation you want to publish.

2. Select **Technical Docs** if you are working with developer-facing or technical documentation.

3. Select **User Guides** if you are working with end-user documentation or help-center content.

4. Open the **Publishing** area for the documentation type you selected.

5. Review the published audience options shown in the Publishing area.

6. Identify the audience you want visitors to see when they open the shared link.

7. Locate the audience slug associated with that audience in the publishing details or published link.

8. Copy the published documentation link for the selected audience.

9. Confirm that the audience slug appears in the copied link between the main documentation identifier and any individual document identifier.

10. Open the copied link in a new browser tab.

11. Verify that the documentation displayed in the new tab is written for the intended audience.

12. Open an individual document from the audience’s documentation list.

13. Confirm that the audience slug remains part of the address when the individual document opens.

14. Share the audience-specific link with the intended readers.

15. Return to **Publishing** if the link opens the wrong documentation collection.

16. Select the correct audience’s published link before copying or distributing it again.

> 📷 _Screenshot pending: A published documentation link with the audience slug visually identified between the main documentation identifier and the document name._

## Tips and Best Practices

Use one stable, recognizable slug per audience. A short identifier based on the audience’s purpose is easier to recognize when you review or share links. For example, ensure that the slug clearly distinguishes a user-focused audience from a technical audience rather than relying on similarly named audiences.

Always test the complete published link after copying it. The audience slug is part of the audience selection, so a link that stops before the audience portion may open a general documentation page instead of the intended audience’s content.

Keep audience links separate when you publish multiple documentation types. **User Guides** and **Technical Docs** may serve different readers even when they describe the same product or project. Share the audience-specific link that matches the reader’s needs.

When linking directly to a specific document, verify both the audience and the document after opening the link. An individual document link includes the audience context, so the same document name can lead to different content depending on the audience slug in the published address.

Use the **Publishing** area as the source for links you distribute. This reduces the chance of manually editing a link and accidentally removing or changing the audience slug.

If you are preparing documentation for a new project, use **Configure →** to complete available project setup tasks before distributing publishing links. You can also use **Generate Documentation →** when documentation still needs to be generated before publishing.

## Related Pages

- [Publish Technical Documentation](#)
- [Create and Organize User Guides](#)
- [Generate Documentation](#)
- [Export Documentation](#)
- [Configure CI/CD](#)
- [Manage Documentation Styles](#)

## Troubleshooting

### The link opens the wrong documentation audience

Return to **Publishing** and copy the link for the intended audience again. Compare the audience slug in the new link with the link you previously shared. Do not reuse a link copied from another audience’s publishing entry.

### The link opens a general documentation page instead of a specific audience

Check whether the audience slug is present in the link. A general documentation address may not include the audience-specific segment. Copy the complete published link from the audience’s Publishing entry and test it in a new browser tab.

### An individual document does not appear for the selected audience

Open the audience’s main published documentation link first and verify that the document is listed there. If it is not available, review the audience’s published documentation and confirm that the document belongs to the intended **User Guides** or **Technical Docs** collection before sharing a direct link.

<!-- source: capture-product-screenshots.md -->

# Capture Product Screenshots

You can capture screenshots from supported product experiences to use in user-facing documentation. Keeping screenshots current helps your documentation reflect what users actually see in the product.

## Overview

Screenshot capture is part of Atloria’s visual documentation workflow. Use it when you need current images for a user guide, help center article, or other documentation created from your product’s screens.

You can manage screenshots from the enterprise screenshot area or from a specific project version. The project-version view is useful when documentation must match a particular released version, while the enterprise view helps you manage screenshots across broader documentation work.

The available actions support both first-time captures and updates. Use **Capture** to create a screenshot, use **Recapture** to replace an existing screenshot, and use **3. Bulk Recapture** when several existing screenshots need to be refreshed.

> 📷 _Screenshot pending: The User Docs area showing the Manage Screenshots action._

## Prerequisites

Before you begin, make sure you have the following:

- Access to **User Docs** and the **Manage Screenshots →** action.
- Access to the enterprise screenshot area or to the appropriate project and version.
- A supported product experience available for capture.
- The correct product state prepared before capture, including the page, data, and user permissions you want the screenshot to show.
- A decision about whether you need a new image (**Capture**) or an updated replacement (**Recapture**).
- Any required documentation context, such as the relevant **User Flow** or user guide topic.

## Step-by-Step Instructions

1. Open **User Docs**.

2. Select **Manage Screenshots →**.

3. Open the screenshot area for the documentation scope you need.

   You can work at the enterprise level when you are managing screenshots broadly, or from a specific project version when the image must match that version of the product.

4. Select **Capture**.

   Use **Capture** when you need to create a new screenshot from a supported product experience.

5. Navigate through the supported product experience until the screen you want to document is displayed.

   Prepare the screen carefully before capturing it. For example, show the correct user state, page content, and visible controls that the documentation needs to explain.

6. Complete the capture from the capture experience.

   Keep the captured screen focused on the task the reader must perform. Avoid capturing unrelated navigation, temporary messages, or data that does not support the documentation step.

> 📷 _Screenshot pending: The screenshot capture experience with the Capture action and a supported product screen ready to capture._

7. Return to the screenshot management area after completing the capture.

8. Review the captured screenshot in the context of the documentation work it supports.

   Confirm that the image shows the expected product state and that it can be used with the relevant user-facing instructions.

9. Select **Recapture** when an existing screenshot is no longer accurate.

   Use this action when the same documentation image needs to reflect a changed product screen, updated wording, or a different product state.

10. Select **3. Bulk Recapture** when multiple screenshots need to be updated.

    Use bulk recapture for a coordinated refresh, such as after a product interface update affects several screenshots in the same documentation area.

11. Continue with **Generate Documentation →** when your screenshots are ready to be included in generated documentation.

## Tips and Best Practices

- Use **Capture** for new documentation images and **Recapture** for replacements. This distinction helps you avoid treating an update as an unrelated new capture.

- Capture screenshots from the correct documentation scope. When documentation is tied to a particular project version, manage the screenshot from that version so the image remains aligned with the intended release.

- Prepare the screen before you capture it. A screenshot should show the exact state a reader needs, such as the relevant page, visible action, and expected content.

- Keep screenshots task-focused. If an instruction tells users to select **Capture**, make sure the **Capture** action is visible in the accompanying image when practical.

- Use **3. Bulk Recapture** for planned updates affecting multiple images. This is more appropriate than refreshing screenshots one at a time when a shared interface change affects a group of documentation pages.

- Review screenshots before generating documentation. An outdated image can make otherwise accurate instructions difficult to follow.

- Coordinate screenshot updates with documentation updates. If a product change affects labels, visible steps, or a **User Flow**, update both the text and the related screenshots together.

## Related Pages

- [User Guides](#)
- [User Flow](#)
- [Generate Documentation](#)
- [Export Documentation](#)
- [Documentation Templates](#)
- [User Manuals](#)

## Troubleshooting

### You cannot find the screenshot management area

Open **User Docs** and look for **Manage Screenshots →**. If the action is not available, verify that you have access to the relevant documentation area, project, or version.

### The screenshot does not match the product screen you intended to document

Use **Recapture** to replace the existing image. Before recapturing, return the supported product experience to the exact page and state that the documentation describes.

### Several screenshots are outdated after a product update

Use **3. Bulk Recapture** to refresh multiple affected images. Review the related user guide steps after the refresh to ensure the written instructions still match the updated screens.

<!-- source: manage-screenshot-versions.md -->

# Manage Screenshot Versions

You can review and manage screenshots associated with different documentation versions and product changes. Keeping screenshots aligned with the correct version helps ensure that your user documentation shows the current product experience.

## Overview

Screenshot versions let you review visual documentation as your product changes. When a new version is available, you can open its screenshot area to see the images associated with that version and determine whether they are appropriate for the documentation you plan to publish.

Use this feature when you are reviewing a documentation version, comparing versions, or preparing a version for publication. For example, after product changes have been captured, you can review the screenshots for the affected version and return to the review workflow to save your decisions.

The screenshot management area is connected to the broader version review process. You can move between the version manager, version comparison, review screens, and screenshot management without leaving the project’s documentation workflow.

> 📷 _Screenshot pending: The version management area showing available documentation versions and actions for reviewing or comparing them._

## Prerequisites

Before you manage screenshot versions, make sure you have:

- Access to the project whose documentation versions you need to review.
- A documentation version available in the version manager.
- Screenshots or product changes available for the version you want to inspect.
- Permission to review and save documentation changes.
- A clear understanding of which product version should be reflected in the published documentation.

## Step-by-Step Instructions

1. Open the project that contains the documentation version you want to review.

2. Select **Versions** to open the project’s version management area.

3. Select **Manage all versions →** if you are viewing a summary and need to open the full list of available versions.

4. Identify the version you want to review by checking the available version information in the version manager.

5. Select **Compare Versions** when you need to evaluate differences between documentation versions before reviewing their screenshots.

6. Select the version you want to inspect in the comparison or version management view.

7. Open the screenshot management option for the selected version.

8. Review the screenshots associated with the version and confirm that they represent the expected product state.

> 📷 _Screenshot pending: The screenshot management view for a selected documentation version, showing the screenshots available for review._

9. Select **Use All V4 AI Versions** when you want to apply the available V4 AI-generated screenshot versions across the current review context.

10. Select **📋 User Manuals** if you need to return to the documentation manual area while reviewing how screenshots will support end-user content.

11. Select **1 Review Summary** to return to the review summary and check the overall status of the documentation review.

12. Select **Back to Review** after you finish examining the screenshots and want to continue the version review workflow.

13. Select **Save Changes** to preserve the changes or selections you made during review.

14. Select **Review & Publish** when the screenshots and documentation are ready for final review and publication.

15. Select **View Your Documentation →** to verify how the documentation appears to readers after completing the review process.

## Tips and Best Practices

- Review screenshots in the context of a specific documentation version. A screenshot can be accurate for one product version but misleading for another version after a product change.

- Use **Compare Versions** before making decisions when you need to understand what changed between versions. This helps you focus your screenshot review on areas affected by product updates.

- Review product changes alongside screenshots. If a product change affects a screen, button, field, or workflow, confirm that the related screenshot still reflects the updated user experience.

- Use **Back to Review** instead of leaving the workflow abruptly. Returning through the review action keeps you oriented in the version review process and makes it easier to complete the remaining review tasks.

- Save your work frequently with **Save Changes**. This is especially important when you review several screenshots or move between version comparison and review screens.

- Use **Use All V4 AI Versions** only when you want the V4 AI-generated versions applied broadly. Review the resulting screenshots before publication to make sure they are appropriate for your documentation audience.

- Complete screenshot review before selecting **Review & Publish**. Published documentation should show screenshots that match the product version your readers will use.

## Related Pages

- [Review Documentation Versions](#)
- [Compare Documentation Versions](#)
- [Review Product Changes](#)
- [Review and Publish Documentation](#)
- [Create User Manuals](#)

## Troubleshooting

### You cannot find the version you need

Select **Versions** and then select **Manage all versions →** to view the complete set of available versions. If the version is still unavailable, confirm that you are in the correct project and that the version has been created or made available for review.

### The screenshots do not appear to match the product changes

Select **Compare Versions** to review version differences, then return to the screenshot management view for the affected version. Check whether the related product change requires an updated screenshot before you continue to **Review & Publish**.

### Your review changes are not visible after you leave the screen

Select **Save Changes** before selecting **Back to Review**, opening another version, or leaving the workflow. After saving, use **1 Review Summary** to confirm that your review work is reflected in the documentation review process.

<!-- source: add-screenshots-to-documentation.md -->

# Add Screenshots to Documentation

Screenshots help you explain product interfaces, user tasks, and important product states visually. Use the screenshot management area to add visual assets that make your documentation easier to follow.

## Overview

Visual documentation combines written instructions with images of the screens your readers use. A well-placed screenshot can help users recognize the correct page, confirm that they completed a step, or understand what information they need to enter before continuing.

You can manage screenshots from the documentation area by selecting **Manage Screenshots →**. Screenshot management is available for enterprise documentation and for individual project versions, so you can keep images aligned with the documentation they support.

Use screenshots when written labels alone may not be enough. For example, include an image when you need to show a complex page layout, identify a feature location, distinguish between product states, or guide a new user through a multi-step **User Flow**.

> 📷 _Screenshot pending: The documentation area showing the Manage Screenshots → action._

## Prerequisites

Before you begin, make sure you have the following:

- Access to the relevant enterprise documentation area or project version.
- Documentation that needs a visual explanation, such as a **User Guide** or **User Manual**.
- Screenshot image files that accurately represent the current product interface.
- Permission to update the documentation workspace, if your organization limits editing access.
- A clear understanding of the task or screen state that each image should explain.
- Finalized product content where possible, so screenshots do not show temporary, outdated, or incomplete interfaces.

## Step-by-Step Instructions

1. Open the documentation workspace where you want to manage visual assets.

2. Select **User Docs** to work with end-user documentation.

3. Select **📋 User Manuals** if you are preparing screenshots for a user manual or help-center style guide.

4. Select **Manage Screenshots →** to open the screenshot management area.

> 📷 _Screenshot pending: The screenshot management area opened from Manage Screenshots →._

5. Choose the documentation scope that matches the content you are updating.

6. Select the relevant project version if the screenshots are specific to a particular version of a project.

7. Add the screenshot image that represents the interface, task, or product state you want to explain.

8. Review the added image to confirm that the visible screen matches the current product experience.

9. Associate the screenshot with the documentation content it supports.

10. Use the screenshot near the instruction or explanation where readers need visual confirmation.

11. Repeat the process for each additional screen in the user journey.

12. Open **View Your Documentation →** to review how the completed documentation reads for end users.

13. Check that each screenshot appears next to the correct instruction and supports the surrounding text.

14. Update or replace any image that shows an old label, incomplete state, or unrelated product area.

15. Select **Export Documentation** when you need to distribute the completed documentation outside the workspace.

## Tips and Best Practices

Use screenshots to clarify, not to replace, written instructions. Your readers should still be able to follow the task from the numbered steps, field names, and button labels. The image should confirm what they are looking for rather than force them to infer the action.

Capture the state that matters. If you are documenting a task with a meaningful beginning and end, consider using images for the key stages: the starting screen, the screen where the user makes the main change, and the completed result. This is especially helpful for a **User Flow** that spans several pages.

Keep screenshots focused on the user’s task. Avoid including unrelated browser tabs, personal information, development-only content, or large empty areas. If the important action is a small portion of a busy page, make sure the relevant area is clearly visible.

Use the exact labels readers see in the product. For example, if your instructions tell users to select **Manage Screenshots →**, the corresponding image should visibly include that action. Consistent wording makes it easier for readers to connect the text to the interface.

Review screenshots whenever the interface changes. Documentation is most useful when its images match the current product. If a button label, layout, or workflow changes, replace the affected screenshot before publishing or exporting the documentation.

Keep user-manual images appropriate for end users. The documentation workspace supports different documentation styles, including user-facing manuals and other documentation types. When preparing content for **User Guides** or **📋 User Manuals**, show the actions and outcomes that a business user needs, rather than internal implementation details.

## Related Pages

- [Generate Documentation](#generate-documentation)  
- [View Your Documentation](#view-your-documentation)  
- [Export Documentation](#export-documentation)  
- [User Guides](#user-guides)  
- [User Manuals](#user-manuals)  
- [Documentation Templates](#documentation-templates)  

## Troubleshooting

### You cannot find the screenshot management area

Return to the documentation workspace and look for **Manage Screenshots →**. If the action is unavailable, confirm that you are in the correct enterprise documentation area or project version and that you have permission to edit documentation.

### The screenshot does not match the written instructions

Compare the image with the current product screen and the exact labels in your steps. Replace the image if it shows an earlier interface, a different project version, or a different user state than the one described.

### Readers cannot tell what the screenshot is showing

Place the screenshot directly after the relevant numbered instruction and make the written instruction specific. Refer to visible labels such as **User Docs**, **📋 User Manuals**, **Manage Screenshots →**, or **View Your Documentation →** so readers know exactly what to locate.

<!-- source: request-a-documentation-review.md -->

# Request a Documentation Review

Request a review when you need contributors to examine a document version and provide feedback before it is published. This process helps you ensure that the version selected for review is the correct one and that reviewers return to the appropriate review workspace.

## Overview

Atloria supports documentation work through document lists, version management, and a review workspace. You can begin from **Documents** to locate the document, then use **Versions** or **Go to Version Manager** to choose the version that should be reviewed.

A review request should be based on a specific version rather than an earlier draft by default. Before you involve contributors, confirm that the selected version contains the changes you want them to evaluate. If you are working with AI-generated versions, the available actions include **Use V4 AI Version**, **Use All V4 AI Versions**, and **Generate Next Version**.

The review area is accessed from the selected version. After contributors have provided their feedback, you can return to the review process by selecting **Back to Review** and continue toward **Review & Publish** when the version is ready.

> 📷 _Screenshot pending: The Documents page showing the Search documents field and available document entries._

## Prerequisites

Before requesting a documentation review, make sure you have the following:

- Access to the Atloria workspace that contains the document.
- A document available in **Documents**.
- A version selected or created in **Versions**.
- The names or contact details of the contributors who should review the content, if your workspace presents reviewer-selection options.
- A completed draft that is ready for feedback.
- Any required internal approval to share the document with contributors.

## Step-by-Step Instructions

1. Select **Documents** from the main application navigation.

2. Enter a document title or keyword in the **Search documents...** field to find the document you want reviewed.

3. Open the document that you want to send for feedback.

4. Select **Versions** to view the document’s available versions.

5. Review the version list and identify the version that contains the content contributors should assess.

6. Select **Go to Version Manager** if you need to manage or confirm the document version before beginning the review.

7. Select **Use V4 AI Version** if you want to use one available AI-generated version as the basis for review.

8. Select **Use All V4 AI Versions** only when you want all available V4 AI versions included in your version-selection workflow.

9. Select **Generate Next Version** if the current version still needs another generated revision before you request feedback.

10. Open the selected version’s review area.

11. Use the reviewer or contributor controls shown in the review area to add the people who should provide feedback.

12. Use the review-request action shown on the screen to send the selected version to those contributors.

13. Review the confirmation displayed after sending the request to verify that the intended version and contributors were included.

14. Select **Back to Review** when you need to return to the review workspace after checking version details or related content.

> 📷 _Screenshot pending: The selected document version open in the review workspace, with reviewer selection and the action used to send a review request._

## Tips and Best Practices

- Review the version before you invite contributors. Contributors should evaluate a stable version, not a draft you expect to replace immediately.

- Use **Versions** to distinguish between earlier work and the version currently intended for review. This reduces the risk of feedback being submitted against outdated content.

- If you use **Generate Next Version**, wait until the new version is available and then confirm that it is the version you want reviewed. Generating a newer version after sending a request can create uncertainty about which content reviewers should comment on.

- Use **Use V4 AI Version** when one AI-generated version is the appropriate starting point. Use **Use All V4 AI Versions** only when your review process requires consideration of every available V4 AI version.

- Tell contributors what kind of feedback you need, such as accuracy, completeness, clarity, terminology, or readiness for publication. A focused request usually produces more useful comments.

- Keep review and publication separate. Requesting feedback does not mean the document is ready to publish. Complete the feedback cycle first, then proceed to **Review & Publish** when the content is finalized.

- Avoid using **Delete Documents** while a document is in an active review cycle. Deleting the document can prevent you and contributors from accessing the version under review.

## Related Pages

- [Manage Document Versions](#)
- [Compare Document Versions](#)
- [Generate the Next Documentation Version](#)
- [Review and Publish Documentation](#)
- [Search and Manage Documents](#)

## Troubleshooting

### You cannot find the document to review

1. Select **Documents**.

2. Enter relevant words from the document title in **Search documents...**.

3. Check that you are searching in the correct workspace or project.

### You selected the wrong version

1. Return to **Versions**.

2. Identify the correct version in the version list.

3. Open the correct version’s review area.

4. Send a new review request only after confirming the selected version is correct.

### You need to make changes after requesting review

1. Return to the document or version management area.

2. Update or generate the version that requires changes.

3. Confirm whether contributors should review the existing version or the updated version.

4. Send a new request for the updated version when contributors need to evaluate the changes.

<!-- source: respond-to-review-feedback.md -->

# Respond to Review Feedback

Use the review workspace to address comments, suggestions, and requested documentation updates before publication. Responding to feedback helps you keep documentation accurate and lets reviewers confirm that their concerns have been handled.

## Overview

When documentation is being reviewed, reviewers can leave feedback for you to consider. The review area shows a summary of the review and a **Comments** panel, such as **Comments (3)**, so you can see how much feedback requires attention.

You may need to respond to feedback when a reviewer has requested clearer wording, corrections, missing content, or other documentation changes. After you update the documentation, use **Save Changes** so that your work is retained for the review process.

If you need to leave the current screen to make an update, use **Back to Review** to return to the review context afterward. The review workspace is intended to help you move between reviewer feedback and the documentation you are revising.

> 📷 _Screenshot pending: Review screen showing the Review Summary and Comments panel with reviewer feedback._

## Prerequisites

Before you start, make sure that:

- You have access to the relevant project and its documentation review.
- A review has been created and contains reviewer feedback.
- You can open the review workspace from the project’s documentation area.
- You know which documentation content the feedback applies to.
- You are ready to save your documentation updates using **Save Changes**.

## Step-by-Step Instructions

1. Open the project documentation review from the project workspace.

2. Select **Review & Publish** to enter the review area.

3. Review the information shown in **1 Review Summary** to understand the current review context.

4. Select **Comments** to open the reviewer feedback panel.

5. Review the comment count shown beside **Comments**, such as **Comments (3)**, to understand how many comments are available.

6. Select a comment in the **Comments** panel to read the reviewer’s feedback.

7. Identify the documentation section or wording that the selected comment refers to.

8. Use **Back to Review** if you need to return to the review workspace after viewing or editing documentation content elsewhere.

9. Update the documentation content to address the reviewer’s requested change.

10. Select **Save Changes** to save the documentation updates.

11. Return to **Comments** to review the next item of feedback.

12. Repeat the update and save process for each remaining comment that requires a documentation change.

13. Select **Preview** to check how the updated documentation will appear to readers.

14. Select **View Your Documentation →** when you want to review the documentation outside the editing context.

> 📷 _Screenshot pending: Documentation review workspace highlighting the Save Changes button after feedback has been addressed._

## Tips and Best Practices

- Read the full comment before making changes. A reviewer may be requesting a wording change, additional explanation, or a correction to a specific documentation section.
- Work through comments one at a time. This makes it easier to confirm that every item in **Comments** has been considered.
- Save regularly with **Save Changes**. Saving after each completed update reduces the risk of losing revisions when you move between review and documentation screens.
- Use **Preview** after making substantial edits. Previewing helps you verify that the final reader-facing documentation is clear and formatted as expected.
- Use **1 Review Summary** to keep the feedback in context. The summary can help you avoid making changes that do not match the scope of the current review.
- If a reviewer requests a change that affects more than one documentation page, update each affected page before considering the feedback fully addressed.
- Use **Share Preview Link** when your team needs to review the revised documentation in a preview before it is published.
- Do not treat a requested change as complete until the relevant documentation has been updated and the update has been saved.

## Related Pages

- [Review and Publish Documentation](#)
- [Preview Documentation](#)
- [Save Documentation Changes](#)
- [Share a Preview Link](#)
- [Request Documentation Changes](#)
- [Export Documentation](#)

## Troubleshooting

### You cannot find reviewer feedback

Select **Comments** in the review workspace. Check the count next to the label, such as **Comments (3)**. If no comments are shown, confirm that you opened the correct project review and that feedback has been submitted.

### Your documentation update is not retained

Select **Save Changes** after editing the documentation. If you leave the screen without saving, your latest revisions may not be included in the review.

### You are unsure whether an update looks correct

Select **Preview** after saving your changes. Review the reader-facing result, then return to the review workspace with **Back to Review** if you need to make further updates.

<!-- source: compare-document-versions.md -->

# Compare Document Versions

Use **Compare Versions** to review how one document revision differs from another before you approve or publish changes. Comparing revisions helps you confirm that the content, wording, and intended updates are correct.

## Overview

Documents can have multiple saved versions. The comparison workspace lets you review two versions together instead of opening each version separately. This is useful when you need to validate edits made during review, confirm that requested changes were applied, or decide whether the latest revision is ready for approval.

You can begin from the document area or from a project’s version-management area. Look for **Versions**, **Compare Versions**, or **Compare** depending on the screen you are viewing. Use **Manage all versions →** when you need to see the broader list of available revisions before choosing versions to compare.

> 📷 _Screenshot pending: The Versions screen showing available document revisions and the Compare Versions action._

The comparison process is intended for review before publishing. After you finish reviewing the differences, return to the review workflow with **Back to Review** or save any permitted updates using **Save Changes**.

## Prerequisites

Before you start, make sure that:

- You can access the document or project that contains the revisions you need to review.
- At least two versions of the document are available.
- You know which version is the baseline and which version contains the proposed changes.
- You have reviewed any related change request or review summary, if your team uses them.
- You have permission to review the document and, if applicable, approve or publish it.

## Step-by-Step Instructions

1. Open **Documents** from the application navigation.

2. Find the document whose revision history you want to review.

3. Select the document to open its document workspace.

4. Click **Versions** to view the document’s available revisions.

5. Click **Compare Versions** to open the version comparison workspace.

> 📷 _Screenshot pending: The Compare Versions workspace with controls for choosing two document revisions._

6. Select the earlier or currently approved revision as the version you want to use as the comparison baseline.

7. Select the newer revision that contains the changes you want to review.

8. Click **Compare** to display the differences between the selected versions.

9. Review each difference shown in the comparison results.

10. Check whether the newer version includes all expected edits from the related review or change request.

11. Confirm that no unintended wording, formatting, or content changes were introduced.

12. Click **Back to Review** when you need to return to the document review workflow.

13. Click **Save Changes** if the screen allows you to save updates you made during the review process.

14. Open **Review & Publish** when you are ready to continue toward publishing the reviewed document.

## Tips and Best Practices

- Compare versions before approving substantial edits. This gives you a clear checkpoint between the prior revision and the proposed revision.

- Use the earliest relevant version as your baseline. For example, if a document has several rounds of edits, compare the revision before the current review cycle with the latest revision rather than comparing unrelated versions.

- Review the document’s **1 Review Summary** before comparing versions when it is available. The summary can help you understand what reviewers expected to change, so you can verify those changes in the comparison.

- Use **Manage all versions →** when the version you need is not immediately visible. This is especially helpful for documents with multiple saved revisions.

- Treat comparison as a review activity, not as final publication. After you confirm the changes, continue through **Review & Publish** according to your organization’s approval process.

- Save only intentional changes. If you use **Save Changes**, verify that you are saving updates you made deliberately and not preserving temporary review notes or incomplete edits.

- If you are reviewing content generated from several draft revisions, compare the final candidate against the last accepted version. This keeps the approval decision focused on the changes that will actually be published.

## Related Pages

- [Manage Document Versions](#) — View and organize all available document revisions.
- [Review and Publish Documents](#) — Complete the review process and publish an approved document.
- [Review Change Requests](#) — Review requested document updates before validating a revised version.
- [Create and Edit Documents](#) — Update document content and save a new revision.
- [Search Documents](#) — Find a document from the **Documents** area.

## Troubleshooting

### You cannot find the comparison option

Open the document’s **Versions** area and look for **Compare Versions** or **Compare**. If the document has only one available version, there is nothing to compare yet. Create or save another revision before attempting a comparison.

### The version you need is not listed

Select **Manage all versions →** to view the full version list. Confirm that you are working in the correct document or project and that the intended revision was saved successfully.

### You are not ready to approve the changes

Click **Back to Review** and continue reviewing the document or its related change request. Do not proceed to **Review & Publish** until you have confirmed that the comparison contains only expected changes.

<!-- source: open-a-review-request-by-id.md -->

# Open a Review Request by ID

A review request ID identifies one specific documentation review request in Atloria. Use the ID when a teammate sends you a review link or asks you to open and review a particular documentation change.

## Overview

Each documentation review request has its own identifier. This identifier, referred to as the review request ID, makes sure you open the correct request rather than a different review for the same project.

You will typically receive the ID as part of a shared review link from a teammate, project owner, or documentation workflow. Opening the shared link takes you directly to the associated review request, where you can inspect the review summary, open the diff viewer, preview documentation, or request changes.

The review request ID is especially useful when multiple documentation updates are being reviewed at the same time. Before you begin reviewing, confirm that the request content and project context match the work you expect to review.

> 📷 _Screenshot pending: A shared Atloria review request link showing the review request ID used to identify a specific request._

## Prerequisites

Before you open a review request, make sure you have:

- Access to the Atloria project that contains the documentation review.
- A valid Atloria sign-in session.
- The complete review link or the review request ID provided by the person who created the request.
- Permission to view the project’s documentation review content.
- A supported web browser.

## Step-by-Step Instructions

1. **Locate the review request link that was shared with you.**

   Look in the message, task, email, or collaboration tool where the request was sent. The link contains the review request ID that points to the specific review.

2. **Copy the complete review request link.**

   Copy the entire link rather than only a portion of it. Keeping the complete link ensures that Atloria can identify both the correct project and the correct review request.

3. **Open your web browser.**

   Use the browser in which you normally access Atloria.

4. **Paste the complete review request link into the browser’s address bar.**

   Do not change the review request ID unless you were given a replacement link or ID by an authorized teammate.

5. **Open the link.**

   Atloria opens the documentation review associated with that review request ID.

6. **Confirm the review summary.**

   On the review page, select or review **1 Review Summary** to verify that you are viewing the expected documentation update.

7. **Open the change details.**

   Select **Open Diff Viewer** to compare the documentation changes included in the request.

8. **Return to the review page when needed.**

   Select **Back to Review** after viewing changes in the diff viewer.

9. **Preview the documentation output.**

   Select **Preview** when you need to see how the reviewed documentation will appear to readers.

10. **Request an update if the content needs revision.**

    Select **✎ Request Changes** when the documentation requires corrections before it can proceed through review.

> 📷 _Screenshot pending: The documentation review page with the “1 Review Summary” section and “Open Diff Viewer” action._

## Tips and Best Practices

- **Use the complete shared link whenever possible.** The review request ID identifies the review, but the complete link also preserves the project context needed to open it correctly.

- **Verify the request before commenting or requesting changes.** Open **1 Review Summary** and check the reviewed content before taking action. This helps prevent feedback from being added to the wrong request.

- **Use the diff viewer for detailed review.** Select **Open Diff Viewer** when you need to see exactly what changed between documentation versions. This is more reliable than reviewing a preview alone.

- **Use Preview to check reader-facing results.** The **Preview** option helps you assess formatting and presentation, while the diff viewer helps you assess individual changes.

- **Request changes only for actionable issues.** Select **✎ Request Changes** when you can identify what needs to be corrected or clarified. Include clear feedback so the documentation author can update the request efficiently.

- **Keep the review link private.** A review request link may provide access to project documentation details. Share it only with collaborators who should review the request.

## Related Pages

- [Review Documentation Changes](#)
- [Use the Diff Viewer](#)
- [Request Changes in a Documentation Review](#)
- [Preview Documentation Before Publishing](#)
- [Review and Publish Documentation](#)

## Troubleshooting

### The review request does not open

Confirm that you copied and pasted the complete shared link. If the link was shortened, cut off, or modified, ask the request owner to send a new link.

### You are asked to sign in or cannot view the request

Sign in to the Atloria account that has access to the relevant project. If you are signed in but still cannot view the review, contact the project owner and request review access.

### The opened review is not the one you expected

Check the review content in **1 Review Summary** and compare it with the request you were asked to review. If it does not match, return to the original message and use the correct shared link or ask the sender to confirm the review request ID.

<!-- source: open-a-collaboration-ticket-by-id.md -->

# Open a Collaboration Ticket by ID

This page explains how a ticket ID identifies a collaboration ticket connected to documentation work. Using the correct ID helps you open the intended ticket and continue review or documentation discussions in the right context.

## Overview

A collaboration ticket is identified by a unique ticket ID. In links and references, this identifier may be shown as `[ticketId]`, which represents a placeholder for the actual ID of the ticket you need to open. Do not enter the square brackets; use the ticket ID value provided to you.

You may receive a ticket ID from a teammate, a review request, a project discussion, or a documentation task. Opening the ticket lets you view the collaboration item associated with that ID and continue work from the correct documentation or review context.

A ticket ID identifies one specific ticket, not an entire project, documentation set, or review. If you are working across multiple reviews, confirm the ID before opening it so you do not add comments or make decisions in the wrong ticket.

> 📷 _Screenshot pending: Collaboration ticket page showing the ticket identifier and available actions._

## Prerequisites

Before you begin, make sure you have:

- Access to the Atloria workspace that contains the collaboration ticket.
- The complete ticket ID, supplied by a teammate, task assignment, link, or review request.
- Permission to view the related documentation or review work.
- An active Atloria session.
- The correct project or workspace context when your organization uses more than one workspace.

## Step-by-Step Instructions

1. **Locate the ticket ID in the collaboration request or documentation task.**  
   Copy the ID exactly as provided. If the ID is represented as `[ticketId]`, copy the value that replaces the placeholder, not the text `[ticketId]` itself.

2. **Open the ticket link provided with the ID.**  
   Use the link from the task, message, or review request whenever one is available. This is the most reliable way to open the ticket associated with the supplied ID.

3. **Sign in to Atloria if prompted.**  
   After you sign in, Atloria opens the ticket if your account has access to the related workspace and documentation work.

4. **Select `Open` when Atloria displays an available ticket action.**  
   The `Open` action takes you into the selected collaboration ticket. Confirm that you are opening the item associated with the ID you received.

5. **Verify the ticket identifier on the ticket page.**  
   Compare the displayed ticket information with the ID in your request. If the identifier does not match, return to the original request and open the correct ticket link or ID.

6. **Review the ticket’s documentation context.**  
   Read the ticket details, discussion, and any linked review information before taking action. This helps you understand whether the ticket relates to documentation changes, a review decision, or a request for follow-up.

7. **Return to the review when the ticket directs you to review work.**  
   Select `Back to Review` to continue in the associated review area. If you need to inspect changes, select `Open Diff Viewer` from the review interface.

> 📷 _Screenshot pending: Opening a collaboration ticket and confirming that the displayed ticket ID matches the requested ID._

## Tips and Best Practices

- **Treat `[ticketId]` as a placeholder.** The brackets indicate that a real ticket ID belongs in that position. Do not search for or enter the bracketed text unless your organization specifically uses it as part of an example.

- **Use the original ticket link when possible.** A link supplied in a review request or documentation task preserves the correct ticket context and reduces the chance of opening a similarly named item.

- **Verify before commenting or approving.** Check the ticket information after opening it, especially when you work on several documentation reviews at once. A correct ticket ID is important because each ticket can represent different collaboration work.

- **Keep review and ticket work connected.** When the ticket relates to a review, use `Back to Review` to return to the review summary and use `Open Diff Viewer` when you need to examine documentation changes in detail.

- **Do not assume that a ticket ID is a project ID.** A project can contain multiple reviews and collaboration tickets. Use the ticket ID to identify the individual item you need to open.

- **Share the ID and context together.** When sending a ticket to another user, include the ticket link and a short description of the documentation work. This helps the recipient confirm that they opened the intended ticket.

## Related Pages

- [Review Documentation Changes](#)
- [Use the Review Summary](#)
- [Open the Diff Viewer](#)
- [Return to a Review with Back to Review](#)
- [Create and Manage User Documentation](#)

## Troubleshooting

### The ticket does not open

Confirm that you copied the complete ticket ID or used the complete link provided in the request. If you received only `[ticketId]`, ask the requester for the actual ticket ID value.

### You opened a ticket, but it is not the expected one

Compare the displayed ticket information with the ID and context from the original request. Select `Back to Review` if you need to return to the associated review, then reopen the correct ticket from the original link.

### You cannot view the ticket

Your account may not have access to the workspace, documentation work, or review connected to the ticket. Ask the ticket owner, project administrator, or workspace administrator to confirm your access before trying again.

<!-- source: ticketid-linking-review-work-to-tickets.md -->

# [ticketId]: Linking Review Work to Tickets

This page explains how the ticket identifier, shown as `[ticketId]`, connects documentation review work with the ticket that requires follow-up. Using the same ticket reference helps you keep review decisions, corrections, and publishing work organized.

## Overview

During documentation review, you may need to return to a specific ticket to clarify requested changes, confirm scope, or record follow-up work. The `[ticketId]` identifies that ticket so you can distinguish it from other review items and keep related work together.

Use the ticket reference when you are reviewing generated documentation, discussing requested edits, or preparing items for publication. It provides a consistent way to connect the review context with the issue that prompted the work.

The review area includes a **1 Review Summary** section and a **Back to Review** action. These controls help you move between the review information and the active review workspace without losing the context of the ticket you are working on.

> 📷 _Screenshot pending: Review Summary showing the ticket context used to identify related documentation review work._

## Prerequisites

Before you begin, make sure that:

- You have access to the workspace containing the documentation review.
- You know the ticket identifier you need to review, such as the value represented by `[ticketId]`.
- The relevant documentation has been generated or imported for review.
- You have permission to view the review workspace and the related ticket.
- You are ready to record any changes or follow-up work associated with the ticket.

## Step-by-Step Instructions

1. Open the workspace that contains the documentation review work.

2. Select **Review & Publish** to enter the review area.

3. Locate the **1 Review Summary** section.

4. Identify the ticket reference shown for the review item.

5. Compare the displayed ticket reference with the `[ticketId]` you were asked to review.

6. Open the related ticket in your organization’s ticket workspace.

7. Confirm that the ticket’s request matches the documentation work shown in the review.

8. Review the documentation content associated with the ticket.

9. Select **Preview** when you need to check how the documentation will appear to readers.

10. Select **Back to Review** to return from the summary or preview context to the active review workspace.

11. Record the review outcome in the related ticket according to your team’s process.

12. Return to **Review & Publish** when the documentation is ready for the next review or publishing decision.

> 📷 _Screenshot pending: The Back to Review action used to return to the active documentation review after checking ticket-related information._

## Tips and Best Practices

- Use the ticket identifier as the primary reference in review discussions. This reduces confusion when several documentation reviews are active at the same time.

- Check the ticket reference before making changes. A similar document title or feature name may appear in more than one review, while the ticket identifier provides the clearest connection to the requested work.

- Use **1 Review Summary** to orient yourself before reviewing detailed content. The summary is useful when you need to confirm what work is being reviewed and why it is connected to a particular ticket.

- Use **Preview** before marking work as ready for follow-up or publication. Reviewing the reader-facing presentation can reveal formatting or wording issues that are not obvious while editing.

- Use **Back to Review** rather than starting over from the workspace navigation when you are moving between review information and the working review. This helps preserve your current review context.

- Keep ticket follow-up specific. When you record an outcome, identify whether the work is ready to publish, needs documentation changes, or requires additional clarification from the ticket owner.

- If the ticket requires broader documentation work, use the available documentation workflow options such as **Generate Documentation →** or **Or import existing documentation** before beginning the review cycle.

## Related Pages

- [Review & Publish Documentation](#) — Review documentation and prepare it for publication.
- [Using the Review Summary](#) — Understand the information presented in **1 Review Summary**.
- [Previewing Documentation](#) — Use **Preview** to inspect reader-facing output.
- [Generating Documentation](#) — Start documentation generation with **Generate Documentation →**.
- [Exporting Documentation](#) — Use **Export Documentation** when you need to share or retain documentation outside the workspace.
- [User Guides](#) — Access user-focused documentation from **User Guides** or **📋 User Manuals**.

## Troubleshooting

### The ticket reference does not match the work you expected

Return to **1 Review Summary** and verify the ticket identifier before continuing. If the identifier still does not match, stop the review and confirm with the ticket owner which review item should be used.

### You cannot return to the review workspace

Select **Back to Review**. If the action is unavailable or does not open the expected review, return to the workspace and select **Review & Publish** again. Confirm that you opened the correct project and review item.

### You need to show the documentation to someone who cannot access the review

Select **Preview** to inspect the current output. If your workspace provides it, use **Share Preview Link** to share the preview with the appropriate reviewer. Keep the `[ticketId]` in your message so recipients can associate the preview with the correct follow-up work.

<!-- source: identify-stale-documentation.md -->

# Identify Stale Documentation

This page explains how to find documentation that may no longer reflect your project’s analyzed sources. Reviewing documentation freshness helps you prioritize updates after source changes and keep user-facing guidance reliable.

## Overview

Documentation can become stale when the project source changes but the corresponding explanations, guides, or reference material have not been reviewed. For example, a changed frontend component, backend service, database entity, API schema, configuration setting, or infrastructure definition may affect documentation that describes how the project works.

Atloria organizes project information around individual projects. From the **Projects** area, you can open a focused project workspace and review its documentation alongside project changes and version history. Use this workflow when a new analysis has been completed, when project changes are introduced, or before you export documentation for others to use.

Freshness review is a comparison task: you identify what changed in the analyzed project sources, locate the documentation covering that area, and decide whether the documentation still matches. Documentation is not automatically “correct” simply because it exists; you should confirm that its terminology, described behavior, and scope remain aligned with the current project.

> 📷 _Screenshot pending: A project workspace showing where to review documentation together with project changes and versions._

## Prerequisites

Before you begin, make sure you have:

- Access to the Atloria **Projects** area.
- A project that has already been added and analyzed.
- Permission to open the project’s documentation, change history, and versions.
- An understanding of the source change or release you want to review.
- Access to the project’s existing documentation so you can compare it with the analyzed project information.

## Step-by-Step Instructions

1. Open the project list.

   Select **Projects** from the application navigation. If you are already working inside a project, select **← Back to Projects** or **&larr; Back to Projects** to return to the list.

   The project list is your starting point for finding the project whose documentation you need to assess. If your organization has many projects, use **Search projects...** to narrow the list. You can also use **Search across all projects...** when you need to locate a project or related information more broadly.

2. Open the project you want to review.

   Select the relevant project to enter its focused project workspace. This workspace brings together the project’s analyzed information, documentation, changes, and version history.

   If you have not yet added the project, select **New Project** and then **Create project** before continuing. A project must be available in Atloria before you can review documentation against its analyzed sources.

   > 📷 _Screenshot pending: The Projects list with the project search field and a selected project opening its focused workspace._

3. Review recent project changes.

   In the project workspace, open the project’s changes area. Review the available changes to understand which part of the project was affected and whether the change is likely to alter documentation.

   Pay particular attention to changes involving these analyzed categories:

   - **FRONTEND** changes may affect screens, user flows, visible labels, or component behavior.
   - **BACKEND** changes may affect workflows, business rules, processing behavior, or integrations.
   - **DATABASE** changes may affect stored data, fields, entity descriptions, or reporting.
   - **API SCHEMA** changes may affect API reference material and integration guidance.
   - **CONFIG** changes may affect setup, environment, feature availability, or operational instructions.
   - **DOCUMENTATION** changes may indicate that documentation has already been updated or requires review.
   - **INFRASTRUCTURE** changes may affect deployment, hosting, or operational documentation.

   A change is a freshness signal, not automatically proof that a document is outdated. Use it to determine which documentation topics need inspection.

4. Compare versions when you need a broader view.

   Open the project’s versions area and select the versions you need to compare. Comparing versions is especially useful after a release, a large analysis update, or a period with multiple changes.

   Start with the newest version and compare it with the earlier version that the documentation was based on. Look for newly introduced areas, removed behavior, renamed concepts, or changed relationships between project entities.

   For example, documentation may require review when a component now renders another component differently, or when a component begins using a hook or another dependency that changes the behavior described in the documentation.

5. Open the project documentation.

   From the focused project workspace, open the documentation area. Use **User Guides** when you need to review user-facing guidance. If your project includes generated or technical documentation, review the relevant material for the changed project area as well.

   Read the document with the change information in mind. Check whether the documentation still accurately describes:

   - What the feature, screen, process, or integration does.
   - The names of user-visible actions and terms.
   - The sequence of steps users must perform.
   - The data, configuration, or dependencies involved.
   - Any limitations, prerequisites, or outcomes described.

6. Mark the documentation that needs follow-up.

   Record each document that no longer matches the analyzed source information. Include the document title, affected topic, related project change or version, and the reason it needs review.

   A useful review note is specific. For example: “Update the user guide because the frontend workflow changed,” rather than “Documentation may be stale.” Specific notes help the document owner understand what to verify.

7. Recheck documentation before sharing it.

   After updates are made, revisit the related project change or version comparison and confirm that the revised document covers the current behavior. When the documentation is ready to share, use **Export Documentation** if you need a copy outside Atloria.

> 📷 _Screenshot pending: A project’s changes or version comparison shown alongside the User Guides documentation area._

## Tips and Best Practices

- Review documentation after every meaningful analysis update. Small changes can still affect field names, navigation steps, setup instructions, or expected outcomes.
- Start with the highest-impact categories. Changes in **API SCHEMA**, **DATABASE**, and **CONFIG** often affect multiple documents, while **FRONTEND** changes commonly affect user instructions and screenshots.
- Treat renamed concepts as potential documentation issues. A document can be misleading even when the underlying feature still works if it uses old names or describes an outdated relationship.
- Use version comparison for release reviews. It provides a more complete freshness check than reviewing one isolated change.
- Review **User Guides** from the reader’s perspective. Confirm that the documented steps still match what users see and do in the application.
- Do not export documentation until you have completed the freshness review. **Export Documentation** distributes the current content; it does not by itself verify that the content matches the latest analyzed project sources.

## Related Pages

- [Manage Projects](#)
- [Review Project Changes](#)
- [Compare Project Versions](#)
- [Use User Guides](#)
- [Export Documentation](#)

## Troubleshooting

### I cannot find the project I need to review

Return to **Projects** and use **Search projects...**. If you need to search more broadly, use **Search across all projects...**. If the project is not available, confirm that it has been created and analyzed before attempting a documentation freshness review.

### I can see documentation, but I do not know what may be stale

Open the project’s changes area or compare versions first. Use the affected category—such as **FRONTEND**, **BACKEND**, **DATABASE**, or **API SCHEMA**—to identify the documentation most likely to require review.

### The documentation looks correct, but I am unsure whether it reflects the latest analysis

Check the project’s latest version and compare it with the version or change set you used for the documentation review. If newer changes exist, repeat the comparison before sharing or using **Export Documentation**.

<!-- source: prioritize-documentation-updates.md -->

# Prioritize Documentation Updates

Use change and freshness information to identify documentation that is most likely to need attention. This helps you focus maintenance work on updates that reflect recent product changes and keep User Guides reliable.

## Overview

Documentation can become outdated when the underlying product changes, even if the documentation itself has not been edited. Atloria helps you review project changes and the project changelog so you can decide which documentation updates should be handled first.

Use this process when you are planning a documentation maintenance session, reviewing a new change, or preparing documentation for export. Start with the most recent or highest-impact changes, then compare them with the affected User Guides. This approach helps you avoid spending time updating documentation that is still current.

The **Change** area is useful for reviewing individual changes in detail. The **Changelog** provides a broader record of project updates. Together, these views help you establish which documentation areas deserve priority.

> 📷 _Screenshot pending: The project Change area showing available changes to review._

## Prerequisites

Before you begin, make sure you have:

- Access to the relevant project in Atloria.
- Permission to view the project’s **Change** area and **Changelog**.
- An understanding of which **User Guides** belong to the project.
- A maintenance goal, such as reviewing recent changes, preparing a release, or improving outdated documentation.
- Any available context from the team that made the product change.

## Step-by-Step Instructions

1. Open the project that contains the documentation you want to maintain.

2. Select **Change** to open the project’s change history.

3. Review the available changes and identify the newest changes first.

4. Open a change that appears likely to affect user-facing behavior, workflows, configuration, or screens.

5. Read the change details and note which documentation topics may be affected.

6. Select **← Previous Change** when you need to compare the current change with the prior recorded change.

7. Select **Change branch** if you need to review changes associated with a different branch.

8. Open the project **Changelog** to review the broader sequence of documented updates.

9. Select **View Changelog** when it is available from the project documentation area.

10. Compare the changes in the **Changelog** with the topics covered by your **User Guides**.

11. Identify User Guides that describe behavior affected by a recent change.

12. Open the affected **User Guides** and review whether their instructions still match the current product behavior.

13. Prioritize guides that describe changed workflows before guides that cover unchanged areas.

14. Prioritize guides that have not been reviewed recently when they relate to a changed feature.

15. Select **Save Changes** after you update documentation settings or changelog-related information.

16. Select **Export Documentation** only after you have reviewed and updated the highest-priority documentation.

> 📷 _Screenshot pending: The Changelog view used to compare recent changes with documentation topics._

## Tips and Best Practices

- Start with changes that affect the user interface. A changed screen, button, workflow, or configuration option can make step-by-step instructions inaccurate quickly.

- Review changes in context. A single change may affect multiple documentation topics, such as a User Guide, an onboarding procedure, and a troubleshooting page.

- Use the **Changelog** for planning and the individual **Change** view for detail. The changelog helps you see what has changed over time, while a specific change helps you understand what needs to be updated.

- Treat documentation freshness as a prioritization signal, not the only decision factor. A recently edited guide may still need updates if the product changed after the guide was reviewed.

- Focus first on documentation that users depend on to complete common or high-impact tasks. For example, prioritize guides for core workflows before less frequently used reference material.

- Review documentation after changes move across product areas. Changes can involve frontend behavior, backend behavior, configuration, API-related behavior, documentation, or infrastructure. User-facing documentation is most likely to need updates when a change alters what users see or do.

- Keep change notes specific when possible. When reviewing a change, record the affected guide name and the section that needs review. This makes it easier to divide maintenance work across the team.

- Use **View Your Documentation →** to return to the documentation area after reviewing changes and deciding what to update.

## Related Pages

- [Review Project Changes](#)
- [Use the Changelog](#)
- [Update User Guides](#)
- [Export Documentation](#)
- [Request Documentation Changes](#)
- [Configure Changelog Settings](#)

## Troubleshooting

### You cannot find the changes that should be reviewed

Select **Change branch** and confirm that you are viewing the branch associated with the work you need to document. Changes may differ between branches.

### A change does not clearly identify the affected documentation

Review the related **Changelog** entries and compare the change with existing **User Guides**. Focus on guides that describe the same workflow, screen, or user action.

### You are unsure whether a guide needs an update

Prioritize the guide for review if the change affects what users see, the order of a task, an available option, or an expected result. If the guide still matches the current behavior after review, no update is necessary.

### Your updated documentation is not ready to share

Confirm that you selected **Save Changes** before using **Export Documentation**. Review the changed guide one more time to ensure its instructions reflect the current workflow.

<!-- source: complete-documentation-update-requests.md -->

# Complete Documentation Update Requests

This page explains how to review a documentation change request and complete the documentation updates it requires. Keeping request-related documentation current helps your users find accurate guidance after product changes.

## Overview

Documentation update requests help you connect a requested change with the documentation that needs review or revision. You can use the change request area to review the request, return to its review stage when more information is needed, and open your documentation workspace to make updates.

The workflow includes a review summary and a completion stage. On screen, these stages are identified as **1 Review Summary** and **4. Complete**. Use the review summary to understand the requested change before you edit documentation.

When the request is ready to finish, use **4. Complete** or **Skip to Complete**. If the documentation is not ready, you can return to review by selecting **Back to Review** or request additional updates with **✎ Request Changes**.

> 📷 _Screenshot pending: A documentation change request showing the 1 Review Summary stage, Back to Review, and request actions._

## Prerequisites

Before you start, make sure you have:

- Access to the relevant project and its change requests.
- A documentation update request that you are responsible for reviewing.
- The information needed to understand the product change and its user impact.
- Permission to edit and save documentation changes.
- A clear understanding of which user guides, manuals, or changelog entries may be affected.

## Step-by-Step Instructions

1. Open the project that contains the documentation update request.

2. Go to the project’s change request area.

3. Select the change request you need to complete.

4. Review the information in **1 Review Summary**.

5. Select **Back to Review** if you need to revisit the request before completing it.

6. Select **✎ Request Changes** if the request does not contain enough information to update the documentation accurately.

7. Select **View Your Documentation →** to open the documentation workspace for the request.

8. Review the affected content in **User Guides**, **User Docs**, or **📋 User Manuals**, as applicable.

9. Update the documentation so that it reflects the requested product change.

10. Select **Preview** to check how your updated documentation will appear to readers.

11. Select **Save Changes** to save the documentation update.

12. Select **View Changelog** if the change also requires a changelog review or update.

13. Select **Review & Publish** when the documentation is ready for final review or publication.

14. Select **4. Complete** to finish the documentation update request.

15. Select **Skip to Complete** only when the request can be completed without additional steps in the workflow.

> 📷 _Screenshot pending: Documentation editing view showing the Preview and Save Changes actions._

## Tips and Best Practices

- Review the request before editing. Start with **1 Review Summary** so that your documentation addresses the actual requested change rather than an assumed change.

- Update all affected documentation locations. A change may affect a user guide, a user manual, and a changelog entry. Check **User Guides**, **User Docs**, and **📋 User Manuals** when determining the scope of the update.

- Use **Preview** before saving. Previewing helps you catch formatting, wording, and content issues before readers see the updated documentation.

- Save your work regularly. Select **Save Changes** after making a meaningful set of revisions so that your updates are retained.

- Request clarification instead of guessing. If the request lacks details about expected user behavior, select **✎ Request Changes** and explain what information is needed.

- Use the completion controls carefully. **4. Complete** indicates that the request is finished. Use **Back to Review** when you discover that more review or documentation work is required.

- Check the changelog when appropriate. Select **View Changelog** when the update represents a notable user-facing change that should be recorded for users or stakeholders.

## Related Pages

- [Review Documentation Changes](#)
- [Create a Maintenance Request](#)
- [Preview and Save Documentation](#)
- [Review and Publish Documentation](#)
- [View Documentation Changelog](#)
- [Export Documentation](#)

## Troubleshooting

### You cannot determine what documentation needs to be updated

Return to **1 Review Summary** and review the request details again. If the expected documentation impact is still unclear, select **✎ Request Changes** and ask for clarification before editing.

### Your edits are not visible after you finish updating content

Select **Save Changes** after making your updates. Then select **Preview** to confirm that the saved content appears as expected.

### You completed the request too early

Select **Back to Review** if the request still needs documentation work or review. Complete the outstanding updates, save your changes, and then select **4. Complete** when the request is ready to close.

<!-- source: apply-a-documentation-template.md -->

# Apply a Documentation Template

Documentation templates help you create content that follows a consistent structure and presentation. Use a template when you want new documentation to match the standards used across your Atloria project.

## Overview

Templates provide a repeatable starting point for documentation. Instead of building every document from a blank page, you can use a template to guide the organization and formatting of your content.

You may need a template when creating user guides, publishing documentation, or preparing content for export. Templates are especially useful when multiple people create documentation, because they help keep headings, sections, and document layouts consistent.

In Atloria, template-related options are available as part of the documentation and publishing workflow. You can create a new document, open the editor, and use the available template settings to align your document with the appropriate format.

> 📷 _Screenshot pending: The documentation creation workflow showing the Create New Document and Create & Open Editor actions._

## Prerequisites

Before you begin, make sure you have:

- Access to the project where you want to create or update documentation.
- Permission to create or edit documentation content.
- A clear understanding of the document type you need to create, such as a user guide or publishing-related document.
- The template or documentation standard your organization expects you to use.
- Any required source material, such as existing documentation that you want to update or import.

## Step-by-Step Instructions

1. Open the documentation area for your project.

2. Select **User Docs** if you are working with project documentation intended for end users.

3. Select **Create New Document** to start a new documentation item.

4. Select **Create & Open Editor** to create the document and open it for editing.

5. Review the available document structure before adding your content.

6. Select **5. Templates** when it is available in your documentation workflow.

7. Choose the template that matches the type of documentation you are creating.

8. Confirm that the template includes the sections your document requires.

9. Enter a clear title for the document.

10. Add content to each template section in the order presented.

11. Use the editor toolbar to apply consistent formatting to headings, text, lists, and links.

12. Select the link tool when you need to add a reference to another document or resource.

13. Review your document for empty template sections before continuing.

14. Select **Publishing** when the document is ready for the publishing workflow.

15. Select **Export Documentation** if you need to create an exported copy of the completed documentation.

> 📷 _Screenshot pending: The template selection area showing the available documentation templates._

## Tips and Best Practices

- Start with a template before writing content whenever consistency is important. Applying a template at the beginning reduces reformatting later.

- Use the template sections as a checklist. If a section does not apply, confirm whether your organization expects it to remain in the document before removing it.

- Keep the title specific. A title such as “Create Payment” or “How to create a maintenance request” helps readers understand the purpose of the document before opening it.

- Use the editor’s formatting controls instead of manually recreating formatting with repeated spaces or symbols. This helps preserve a consistent presentation.

- Add links using the editor’s link control when referring readers to related documentation. Links are easier to maintain and use than copied web addresses in body text.

- Review template settings before publishing. The **3. Template Settings** step may be available as part of your documentation workflow and can help you verify that the selected structure is appropriate.

- If you already have content outside Atloria, consider **Or import existing documentation** rather than copying content manually. Review imported content carefully to ensure it follows the selected template.

- Use **Create Manually** only when you intentionally need a document structure that is not provided by an available template.

## Related Pages

- [Create a New Document](#)
- [Use the Documentation Editor](#)
- [Configure Template Settings](#)
- [Publish Documentation](#)
- [Export Documentation](#)
- [Import Existing Documentation](#)
- [Create User Guides](#)

## Troubleshooting

### You cannot find the template options

Open the document creation workflow and look for **5. Templates** or **3. Template Settings**. If neither option is available, your project may use a predefined document structure or your access may not include template configuration.

### The template does not match the document you need to create

Return to the template selection step before adding significant content. Select a template that better matches the document’s purpose, such as a user guide or publishing document. If no available template is suitable, use **Create Manually** only if your organization permits a custom structure.

### Your document does not look consistent after applying a template

Review each heading, list, and link in the editor. Apply formatting through the available toolbar controls, and check that required template sections have not been removed or renamed unintentionally.

<!-- source: preview-published-documentation.md -->

# Preview Published Documentation

Preview your published documentation to confirm that external readers can access the correct project content. This review helps you verify the reader-facing experience before sharing the documentation with customers, teammates, or other stakeholders.

## Overview

Published documentation is the external, reader-facing version of your project’s user guides and manuals. Unlike the internal project workspace, this view is designed for people who need to read the documentation rather than manage the project.

Use the published preview when you want to confirm that your documentation is available after publication, check how readers move between sections, or validate that the expected user-facing content appears. You can open the published view from the project’s review area by selecting **🌐 View Published Docs**.

The published documentation experience may include navigation entries such as **User Docs**, **📋 User Manuals**, and **User Guides**. These entries help external readers find the type of documentation they need. Return to the project workspace when you need to make changes, review project information, or manage publication.

> 📷 _Screenshot pending: The published documentation view showing reader-facing navigation and documentation content._

## Prerequisites

Before you start, make sure that:

- You can access the **Projects** area.
- You have selected the correct project from the project list.
- Your project documentation has been published and is shown as **Published**.
- You can access the project review area, where **1 Review Summary** is available.
- You know which user guide or manual you want to check as an external reader.

## Step-by-Step Instructions

1. Select **Projects** to open the list of available projects.

2. Use the **Search projects...** field if you need to locate a specific project.

3. Select the project you want to review.

4. Confirm that the project is marked **Published** before opening its external documentation.

5. Open **1 Review Summary** in the selected project.

6. Select **🌐 View Published Docs** to open the reader-facing documentation preview.

> 📷 _Screenshot pending: The Review Summary area with the 🌐 View Published Docs action highlighted._

7. Review the opening page to confirm that the expected published documentation is displayed.

8. Select **User Docs** to review the primary documentation available to external readers.

9. Select **📋 User Manuals** to check the available manual content.

10. Select **User Guides** to confirm that guide content is organized for readers.

11. Open a documentation item and verify that its title, text, and navigation appear as expected.

12. Select **Back to Review** when you want to return to the project review area.

13. Select **← Back to Projects** when you want to leave the current project and return to the project list.

## Tips and Best Practices

- Preview documentation only after confirming that the project is **Published**. This helps you review the same reader-facing version that external users are expected to see.

- Start your review from **1 Review Summary**. The **🌐 View Published Docs** action is the clearest way to move from internal project review to the external documentation experience.

- Check more than the first page. Open **User Docs**, **📋 User Manuals**, and **User Guides** so you can confirm that readers can find content through the published navigation.

- Review the published view as a reader would. Focus on whether page names are understandable, manuals are easy to locate, and the intended documentation appears in the correct section.

- Use **Back to Review** instead of relying on your browser’s back button when you want to continue working with the project review. This keeps you in the project workflow.

- If you manage multiple projects, return to **Projects** and use **Search projects...** to avoid previewing the wrong project’s documentation.

## Related Pages

- [Manage Projects](#)
- [Review Project Documentation](#)
- [Publish Documentation](#)
- [Use User Manuals](#)
- [Navigate User Guides](#)

## Troubleshooting

### The **🌐 View Published Docs** action is not available

Return to the project and verify that it is marked **Published**. If the project is not published, complete the required publication process before attempting to preview the external documentation.

### The published page does not show the documentation you expected

Select **Back to Review** and confirm that you opened the correct project. Then use **🌐 View Published Docs** again and review the entries under **User Docs**, **📋 User Manuals**, and **User Guides**.

### You cannot find the project you need

Select **Projects** and enter the project name in **Search projects...**. Open the matching project, then go to **1 Review Summary** to access its published documentation preview.

<!-- source: publish-documentation-to-an-audience.md -->

# Publish Documentation to an Audience

Publishing makes approved documentation available to the people who need it, such as end users or technical teams. This page explains how to publish a documentation version and confirm that the correct audience can view it.

## Overview

Atloria supports separate documentation experiences for different audiences. **User Docs** is intended for user-facing guides and manuals, while **Technical Docs** is intended for technical documentation. Publishing lets you make the appropriate approved content available through the published documentation experience.

Before documentation is available to readers, it must be approved and published. During the publishing process, you review the documentation version, choose the audience experience that applies to the content, and use the publishing controls to make that version live.

After publishing, the documentation is marked **Published** and you can use **View Published Docs** to check the reader-facing result. If you later need to remove the content from reader access, use **Unpublish**.

> 📷 _Screenshot pending: Documentation publishing area showing Review & Publish, Publish Version 4, View Published Docs, and Unpublish controls._

## Prerequisites

Before you start, make sure that:

- You have access to the project that contains the documentation.
- The documentation content has been generated, imported, or written.
- The documentation is ready for review.
- The version you want to release has been approved, or you have permission to use **✓ Approve & Publish**.
- You know whether the documentation is intended for the **User Docs** or **Technical Docs** audience.
- You have reviewed the documentation for accuracy, audience-appropriate language, and complete navigation.

## Step-by-Step Instructions

1. Open the project that contains the documentation you want to publish.

2. Select **User Docs** when you are publishing guides, manuals, or other end-user documentation.

3. Select **Technical Docs** when you are publishing technical documentation for developers or other technical readers.

4. Open **Review & Publish** to review the documentation before making it available to readers.

5. Select the documentation audience that matches your content, such as **User Guides** for user-facing material or **Technical** for technical material.

6. Review the documentation version shown in the publishing area.

7. Select **Publish Version 4** to publish the displayed version when that is the version you intend to release.

8. Select **✓ Approve & Publish** if the version still requires approval and you are authorized to approve it.

9. Select **Publish** to make the approved documentation available to the selected audience.

10. Confirm that the documentation shows the **Published** status.

11. Select **View Published Docs** to open the reader-facing published documentation.

12. Review the published page as a reader to confirm that the correct content and audience experience are displayed.

> 📷 _Screenshot pending: Published documentation opened through the View Published Docs action, showing the reader-facing audience experience._

## Tips and Best Practices

- Publish user-facing content through **User Docs** and technical reference material through **Technical Docs**. Keeping these audiences separate helps readers find documentation written for their needs.

- Use **Review & Publish** before every release. This gives you an opportunity to verify that the documentation is complete and appropriate before readers can access it.

- Use the version-specific button, such as **Publish Version 4**, carefully. Confirm that the displayed version is the release you want to make live before selecting it.

- Check the published result with **View Published Docs** immediately after publishing. This is the best way to verify the reader experience, including the selected audience and visible documentation content.

- If your documentation has not yet been created in Atloria, use **Or import existing documentation** before beginning the review and publishing process.

- If you need to distribute documentation outside the published reader experience, consider **Export Documentation** after confirming that the correct version is published.

- Use **Unpublish** only when the published documentation should no longer be available to readers. After unpublishing, verify that readers can no longer access the version you removed.

## Related Pages

- [Create User Manuals](#)
- [Generate Technical Documentation](#)
- [Review Documentation Before Publishing](#)
- [Manage Published Documentation](#)
- [Export Documentation](#)
- [Brand Your Published Documentation](#)

## Troubleshooting

### The Publish button is not available

The documentation may not be ready for release or may still need approval. Open **Review & Publish**, review the version, and use **✓ Approve & Publish** if you have the required permission.

### The wrong documentation is visible to readers

Check whether you published through **User Docs** or **Technical Docs**. Open **View Published Docs** to confirm the reader-facing result. If the wrong version or audience is live, use **Unpublish**, then return to the correct documentation area and publish the intended version.

### I need to remove documentation from public reader access

Open the published documentation controls and select **Unpublish**. Then use **View Published Docs** or the published documentation navigation to confirm that the removed version is no longer presented as **Published**.

<!-- source: use-branding-context-for-public-documentation.md -->

# Use Branding Context for Public Documentation

Branding Context keeps your Public Documentation aligned with your organization’s published identity. This page explains how to review your publishing settings and confirm that visitors see the intended branded documentation experience.

## Overview

When you publish documentation for external readers, the Public version should present a consistent identity across the documentation site. Branding Context applies the branding configuration available for your documentation publishing setup to the public-facing experience, rather than requiring readers to configure anything themselves.

You typically use this process before sharing documentation with customers, partners, or other external audiences. Review it whenever you update publishing settings, prepare a new public documentation release, or notice that the public view does not reflect the identity you expect.

Branding is applied to the Public documentation view. Your internal workspace navigation, such as **User Docs**, **User Guides**, and **Settings**, remains available to authorized users separately from what public readers see.

> 📷 _Screenshot pending: A public documentation page showing the organization’s applied branding._

## Prerequisites

Before you begin, make sure that:

- You can access the documentation workspace.
- You have access to **Settings** and **Publishing** for the relevant documentation.
- Your documentation has content ready to share publicly.
- You know which documentation set you want to review in the Public view.
- You have confirmed any organization-approved branding requirements with your documentation or marketing team.
- You can use **View Your Documentation →** to open the published documentation view when it is available.

## Step-by-Step Instructions

1. Open **User Docs** from your documentation workspace.

2. Select **User Guides** to open the documentation area you want to publish.

3. Select **Settings** for the documentation you are preparing for external readers.

4. Select **Publishing** to review the publishing configuration.

5. Select **2. Publish Settings** to review the settings that control the published documentation experience.

> 📷 _Screenshot pending: The Publish Settings screen with the branding controls and public publishing options._

6. Review the branding options available on the **Publish Settings** screen.

7. Select the approved branding values for your public documentation.

8. Review the **Public** publishing option to confirm that the documentation is intended for external access.

9. Return to the documentation area after reviewing the publishing configuration.

10. Select **View Your Documentation →** to open the documentation as readers will see it.

11. Review the public documentation header and visible identity elements.

12. Confirm that the public documentation uses the branding you selected in the publishing configuration.

13. Return to **Publishing** if the public view does not match your expected branding.

14. Update the available branding selection in **2. Publish Settings**.

15. Open **View Your Documentation →** again to verify the updated public presentation.

Branding Context applies the configured branding consistently to the Public documentation experience. You do not need to add branding separately to every guide or page when the publishing configuration is set correctly.

## Tips and Best Practices

- Review the Public documentation view after every branding-related change. The public view is the most reliable way to confirm what external readers will experience.

- Use one approved branding configuration for related documentation. Consistent branding helps readers recognize that multiple guides belong to the same organization and documentation set.

- Check your publishing configuration before announcing a new documentation link. A guide can be complete while its public presentation still needs review.

- Keep internal and public workflows separate. Use **Settings** and **Publishing** to manage the published experience, then use **View Your Documentation →** to validate the reader-facing result.

- Review public branding after making broader documentation changes, such as importing existing content through **Or import existing documentation** or generating new content with **Generate Documentation →**.

- Do not rely only on the editing workspace when validating public appearance. Internal screens may include workspace navigation and controls that public readers do not see.

- If your organization has multiple documentation collections, review each collection’s **Publishing** settings independently. Public branding should be verified for the specific documentation visitors will open.

## Related Pages

- [Publish Documentation](#)
- [Configure Publish Settings](#)
- [View Your Documentation](#)
- [Manage User Guides](#)
- [Generate Documentation](#)
- [Export Documentation](#)

## Troubleshooting

### The public documentation does not show the expected branding

1. Open **Settings**.

2. Select **Publishing**.

3. Select **2. Publish Settings**.

4. Review the available branding configuration.

5. Select **View Your Documentation →** after updating the configuration.

If the public view still does not match, confirm that you are reviewing the correct documentation set and its associated publishing settings.

### I cannot find branding options

1. Open **Settings**.

2. Select **Publishing**.

3. Select **2. Publish Settings**.

If branding controls are not available, you may not have access to the required publishing settings. Ask the documentation owner or workspace administrator to review your permissions and the publishing configuration.

### The documentation is not available to external readers

1. Open **Settings**.

2. Select **Publishing**.

3. Review the **Public** publishing option.

4. Confirm that the documentation is configured for the intended audience.

Then select **View Your Documentation →** to verify the reader-facing result.

<!-- source: use-public-documentation-search.md -->

# Use Public Documentation Search

Public Documentation Search helps you find published documentation without opening each page manually. Use it when you are viewing a public documentation site and need to quickly locate a guide, publishing topic, or other published document.

## Overview

Public Documentation Search is available from the published documentation experience. It searches documentation that has been made available to visitors, helping you move directly to relevant content instead of browsing through categories such as **User Guides** or **Publishing**.

This search is intended for readers of published documentation. Content must be in the **Published** state before it can be found through the public documentation search. Draft or unpublished material is not part of the public search experience.

You may encounter the public documentation area after selecting **View Published Docs** or **🌐 View Published Docs**. From there, use the search control to look across the available published documentation.

> 📷 _Screenshot pending: The published documentation page showing the View Published Docs option and the Search control._

## Prerequisites

Before you start, make sure that:

- You have opened the public documentation site by selecting **View Published Docs** or **🌐 View Published Docs**.
- The documentation you need has been published and is available to public visitors.
- You know one or more words related to the document you want to find, such as its title, subject, or feature name.
- You have access to a browser and an internet connection.

## Step-by-Step Instructions

1. Click **View Published Docs** to open the public version of the documentation.

2. Click **Search** to open the public documentation search window.

3. Click the **Search docs...** field.

4. Type a word or phrase that describes the documentation you need.

5. Review the matching published documentation shown by the search window.

6. Click the document result that best matches your search.

7. Read the selected published documentation page.

> 📷 _Screenshot pending: The Public Documentation Search window with the Search docs... field and matching published documentation results._

8. Click **Search** again when you want to start a new search.

9. Click the **Search docs...** field to replace your previous search text.

10. Type a more specific word or phrase to narrow the matching documents.

11. Click a different result if the first document does not answer your question.

## Tips and Best Practices

- Use specific terms whenever possible. For example, search for **Publishing** when you need publishing-related instructions instead of entering a broad term that may match many documents.

- Search with words that are likely to appear in the document title or main topic. If you are looking for a manual, try the product area or task name rather than a full sentence.

- Confirm that you are in the public documentation area before searching. The **Search docs...** field is for published documentation, while other search fields, such as **Search across all projects...**, **Search projects...**, **Search documents...**, or **Search entities...**, may be used in other areas of the application for different types of information.

- If you cannot find a document, try a shorter search phrase. Then add another relevant term if the result list is too broad.

- Use the navigation categories, such as **User Guides** and **Publishing**, when you know the general area but do not know the exact document name.

- Remember that public search is limited to content marked **Published**. If a document is still being prepared, it will not appear to public visitors until it is published.

## Related Pages

- [View Published Documentation](#)
- [Publish Documentation](#)
- [Browse User Guides](#)
- [Search and Filter Documentation](#)
- [Export Documentation](#)

## Troubleshooting

### No matching documentation appears

Check the spelling of your search terms and try a shorter or more general phrase. For example, search for **Publishing** instead of a long sentence describing the issue.

### A document you expect is missing

Public Documentation Search shows published content. Ask the documentation owner to confirm that the document is marked **Published** and is available in the public documentation site.

### You see a different search field

Make sure you opened **View Published Docs** before searching. Fields such as **Search across all projects...**, **Search projects...**, and **Search entities...** search other application areas rather than the published documentation available to visitors.

<!-- source: embed-product-tours-in-public-documentation.md -->

# Embed Product Tours in Public Documentation

You can use a TourEmbed to place an interactive product tour inside your published documentation. This helps readers learn by following a guided experience directly from your public docs.

## Overview

A TourEmbed connects a product tour to documentation that your audience can access through your public documentation site. Use it when written instructions alone are not enough—for example, when readers need to see a workflow, understand where controls appear, or follow a sequence of actions in your product.

You typically add or update tours while preparing documentation for publication. Start from your project’s documentation area, confirm that the content is intended for a public audience, and then review the published result before sharing it with readers.

Public documentation is separate from your internal editing workspace. The **View Published Docs** option lets you check the reader-facing version, while publishing and version-management options help you make sure the correct documentation release is available.

> 📷 _Screenshot pending: TourEmbed configuration area for adding a product tour to a documentation page_

## Prerequisites

Before you begin, make sure you have the following:

- Access to the project that contains the documentation you want to publish.
- A product tour that is ready to be embedded.
- A documentation page or guide where the tour should appear.
- Permission to manage documentation publishing settings.
- A version that is ready to be marked **Published**.
- Access to the public documentation preview through **View Published Docs**.
- Any required branding decisions completed before you share the page publicly.

## Step-by-Step Instructions

1. Open your project’s documentation workspace.

2. Select **User Docs** to work with customer-facing documentation.

3. Select **📋 User Manuals** if you need to locate or organize the manual that will contain the tour.

4. Open the documentation page where you want readers to see the product tour.

5. Add a **TourEmbed** to the page content.

6. Select the product tour that matches the workflow described by the page.

7. Position the TourEmbed near the instructions or explanation that introduces the workflow.

8. Save your documentation changes.

9. Select **Publishing** to review the publishing options for the documentation.

10. Confirm that the documentation is configured for a **Public** audience.

11. Select **Published** when the documentation version is ready for readers.

12. Select **View Published Docs** to open the public version of your documentation.

13. Navigate to the page that contains the TourEmbed.

14. Open the embedded product tour as a reader would.

15. Complete or advance through the tour to confirm that it appears in the correct location and supports the page instructions.

16. Return to the documentation workspace if you need to adjust the page content or the selected tour.

17. Select **Manage all versions →** if you need to verify that the correct documentation version is the one available publicly.

> 📷 _Screenshot pending: Public documentation page showing an embedded product tour in the reader-facing view_

## Tips and Best Practices

- Embed one tour for one clear learning goal. For example, use a tour that teaches a specific task rather than trying to cover an entire product area in a single embed.

- Place the TourEmbed after a short explanation of what readers will learn. Readers should understand why they should start the tour before they interact with it.

- Keep the surrounding written instructions useful on their own. Some readers may prefer to read the steps first, while others may use the tour as a guided walkthrough.

- Review the public version, not only the editing view. Select **View Published Docs** after publishing so you can verify the reader experience.

- Use the same terminology in the documentation page and the tour. If the page tells readers to select a feature or menu item, the tour should guide them using the same name.

- Check the documentation version before sharing a public link. If you maintain multiple versions, use **Manage all versions →** or **🕘 Go to Version Manager** to confirm that the version containing your TourEmbed is the version readers can access.

- Consider your documentation navigation. Readers may enter through **User Guides**, **Publishing**, or search rather than through the page you expect. Make the page title and introductory text clear enough for readers who arrive directly at the embedded tour.

- Manage images and visual references separately from product tours. Select **Manage Screenshots →** when you need to update screenshots that support the same instructions.

## Related Pages

- [Publish Documentation](#)
- [Manage Documentation Versions](#)
- [Configure Public Documentation Branding](#)
- [Manage Screenshots](#)
- [View Published Documentation](#)
- [Create User Guides](#)

## Troubleshooting

### The tour does not appear in public documentation

Confirm that you saved the documentation page after adding the TourEmbed. Then select **View Published Docs** and open the exact page that you updated. If the page is not publicly available, check that the documentation version is marked **Published** and configured as **Public**.

### Readers see an older version of the page

Open **Manage all versions →** or **🕘 Go to Version Manager** and verify which documentation version is currently published. Make sure the version containing the TourEmbed is the published version, then review the page again through **View Published Docs**.

### The embedded tour does not match the written instructions

Return to the documentation page and review the selected TourEmbed. Choose a tour that follows the same workflow described in the page, then save your changes and test the public page again. Keep button names, feature names, and task order consistent between the written content and the tour.

<!-- source: publish-documentation-for-an-audience-by-slug.md -->

# Publish Documentation for an Audience by Slug

This page explains how an audience slug identifies an audience-specific public documentation experience. Using the correct audience slug helps you share documentation that opens in the intended public context for a particular audience.

## Overview

When you publish documentation, Atloria provides a public documentation experience that can be viewed outside the workspace. An **audience slug** is the identifying part of that public experience that distinguishes one audience’s documentation view from another.

You typically need an audience-specific public link when your organization publishes different documentation experiences for separate groups, such as customers, partners, administrators, or internal teams. The audience slug helps ensure that readers enter the correct public documentation context before they open a specific document.

Publishing is separate from sharing. First, you use the publishing controls to make the documentation available publicly. Then, you use **View Published Docs** to confirm the public experience and obtain the appropriate audience-specific location to share. A document must show a published state before external readers can access it.

> 📷 _Screenshot pending: Public documentation view showing an audience-specific documentation experience._

## Prerequisites

Before you begin, make sure you have the following:

- Access to the documentation workspace that contains the content you want to publish.
- Documentation that is ready for external readers.
- Permission to publish or approve documentation.
- The intended audience slug or the approved audience-specific public location supplied by your documentation administrator.
- At least one document or guide organized under the appropriate public documentation category, such as **User Guides** or **Publishing**.
- A reviewer’s approval, if your organization requires a review process before publishing.

## Step-by-Step Instructions

1. Open **User Docs** from your documentation workspace.

2. Select **📋 User Manuals** to view the manuals and guides available for publishing.

3. Open the documentation collection that contains the content you want the audience to see.

4. Select **User Guides** if the documentation is organized as a user-facing guide.

5. Select **Publishing** to work with publishing-related documentation content.

6. Review the document titles and content that will be visible to the audience.

7. Select **Review & Publish** when the documentation is ready for final review.

8. Confirm that the documentation status is ready to be published.

9. Select **✓ Approve & Publish** if your workspace uses an approval step.

10. Select **Publish** to make the approved documentation publicly available.

11. Select **🚀 Publish Version 4** when you are publishing the version identified by that button.

12. Check for the **Published** status after the publishing action completes.

13. Select **🌐 View Published Docs** to open the public documentation experience.

> 📷 _Screenshot pending: The publishing area with the Published status and the View Published Docs button._

14. Verify that the public page displays the documentation intended for the audience.

15. Confirm that the audience identifier in the public documentation location matches the audience slug you were given.

16. Open a document from the public documentation view to confirm that audience-specific readers can access the expected content.

17. Copy the audience-specific public documentation location only after you have verified the correct audience experience.

18. Share the verified public location with the intended audience.

19. Select **Unpublish** if you need to remove the published documentation from public access.

## Tips and Best Practices

- Treat the audience slug as an audience identifier, not as a document title. It identifies the public documentation experience for a group of readers, while individual document names identify the content within that experience.

- Verify the public view after every publish. Selecting **View Published Docs** is the most reliable way to confirm what external readers will see.

- Use the **Published** status as your confirmation that the current version is available publicly. Do not distribute a public location before this status appears.

- Follow your organization’s review process. If **Review & Publish** and **✓ Approve & Publish** are available, complete those actions before using **Publish**. This helps prevent unreviewed content from being exposed to an audience.

- Keep audience links separate when communicating with different reader groups. Sending the wrong audience-specific public location may lead readers into a documentation experience that does not match their needs.

- Test more than the landing page. After opening **View Published Docs**, open at least one guide or document and confirm that navigation, content, and branding appear as expected for that audience.

- Publish the correct version. When the workspace shows **Publish Version 4**, make sure Version 4 is the version you intend to make public. Published content should reflect the latest approved material for that audience.

- Use **Unpublish** promptly if content was published for the wrong audience or includes information that should not be public. Review and republish only after correcting the issue.

## Related Pages

- [Review Documentation Before Publishing](#)
- [Approve and Publish Documentation](#)
- [View Published Documentation](#)
- [Unpublish Public Documentation](#)
- [Organize User Guides for Public Readers](#)
- [Manage Documentation Branding](#)

## Troubleshooting

### The public documentation does not show the expected audience content

Select **🌐 View Published Docs** again and confirm that you opened the audience-specific public documentation location. Verify the audience slug with your documentation administrator before sharing the link.

### The documentation is not available publicly

Return to the publishing area and check whether the content shows **Published**. If it is not published, complete **Review & Publish**, use **✓ Approve & Publish** when required, and then select **Publish**.

### You published the wrong content or version

Select **Unpublish** to remove the public version. Update or select the correct documentation, complete the required review steps, and publish again. Before sharing the replacement location, use **View Published Docs** to verify the audience experience.

<!-- source: publish-documentation-versions-by-id.md -->

# Publish Documentation Versions by ID

This page explains how a documentation version ID identifies the specific version you publish. Using the correct version ID helps you open, review, publish, and share the intended documentation version without confusing it with another draft or generated version.

## Overview

Documentation can exist in multiple versions for the same project. The version ID is the identifier associated with one specific version in the **Versions** area. It distinguishes that version from all other versions, including earlier published versions and newly generated versions.

You typically use a version ID when you need to work with a particular version rather than the project’s documentation in general. For example, you may open one version for review, verify its screenshots, publish it, or return to it later through the Version Manager.

After you publish a version, its status changes to **Published**. The published version is the one shown when you select **View Published Docs**. If you publish a newer version later, ensure you are working with that version’s ID and review context before selecting the publish action.

> 📷 _Screenshot pending: The Versions screen showing multiple documentation versions and their individual status._

## Prerequisites

Before you begin, make sure that:

- You can access the project whose documentation you want to publish.
- A documentation version has already been created and is listed in **Versions**.
- You know which version you intend to publish, such as the version labeled **Version 4**.
- The version’s content has been reviewed and is ready for publication.
- You have access to the **Review & Publish** area.
- Any required project branding or publishing settings have been completed.

## Step-by-Step Instructions

1. Open the project that contains the documentation version you want to publish.

2. Select **Versions** to open the project’s Version Manager.

3. Locate the documentation version you want to work with in the version list.

4. Confirm the version’s identifying details so that you are selecting the intended version ID rather than another available version.

5. Select the version to open its version-specific workspace.

6. Select **Review & Publish** to review the selected version before publication.

7. Review the documentation content shown for the selected version ID.

8. Select the screenshots area if you need to confirm that the version contains the correct visual evidence.

9. Return to **Review & Publish** after completing your review.

10. Select **🚀 Publish Version 4** when Version 4 is the version you intend to make public.

11. Confirm the publication when the application asks you to proceed.

12. Check that the version status is displayed as **Published**.

13. Select **🌐 View Published Docs** to open the documentation that is publicly available for the published version.

> 📷 _Screenshot pending: The Review & Publish screen with the selected version context and the Publish Version action._

## Tips and Best Practices

- Work from **Versions** whenever you need to distinguish between multiple documentation versions. This is the central place to choose the version that corresponds to the ID you intend to publish.

- Verify the selected version before clicking **🚀 Publish Version 4**. The button label identifies the version being published, so do not use it until you have confirmed that the displayed version is the correct one.

- Use **Review & Publish** as your final checkpoint. Review the content in the context of the selected version, rather than assuming that content from a different version will be included.

- Use the screenshots area to validate version-specific images before publishing. Screenshots can differ between versions, especially after documentation is regenerated or updated.

- After publication, use **🌐 View Published Docs** to confirm the reader-facing result. This helps you verify that the version marked **Published** is available as expected.

- If a newer documentation version is available, do not assume it replaces an earlier version automatically. Open the new version from **Versions**, review its version context, and publish it deliberately.

- If you need to stop making a published version available, use **Unpublish**. Confirm that you are acting on the correct published version before removing it from public view.

## Related Pages

- [Manage Documentation Versions](#) — Create, view, and organize documentation versions from **Versions**.
- [Review Documentation Before Publishing](#) — Use **Review & Publish** to validate content before release.
- [View Published Documentation](#) — Open reader-facing documentation with **View Published Docs**.
- [Unpublish Documentation](#) — Remove a currently **Published** version from public availability.
- [Configure Publishing and Branding](#) — Prepare documentation presentation and publishing settings.

## Troubleshooting

### I cannot tell which version I am about to publish

Return to **Versions** and select the intended version again. Then open **Review & Publish** and verify that the page is showing the expected version context before selecting **🚀 Publish Version 4**.

### The version does not show as Published

Refresh the version list and check the version’s status. If it is not marked **Published**, return to **Review & Publish** for that same version and complete the publish confirmation. Also confirm that you selected the publish action for the intended version.

### View Published Docs does not show the documentation I expected

Go back to **Versions** and check which version is marked **Published**. If a different version was published, open the correct version by its version ID, review it, and publish that version.

<!-- source: use-published-documentation-slugs.md -->

# Use Published Documentation Slugs

Published documentation slugs identify your public documentation site in its web address and navigation. Understanding how the slug works helps you open the correct published site and share links that lead readers to the right audience and document.

## Overview

When documentation is published, Atloria organizes the public experience around a published documentation slug. This slug is the first identifying part of your published documentation address. It establishes which published documentation collection a visitor is viewing before they move to a specific audience or document.

Your published documentation navigation can contain multiple levels. Readers first arrive at the published documentation collection, then select an audience area when available, and then open an individual document. Each level is reflected in the address shown in the browser, which makes links easier to share and helps readers return to the same location.

You typically use published documentation slugs after your documentation reaches the **Published** status. From the documentation workspace, the **View Published Docs** action opens the public-facing documentation using the applicable slug. You can then copy the address from your browser to share the collection, a specific audience section, or an individual published document.

> 📷 _Screenshot pending: The documentation workspace showing the Published status and the View Published Docs action._

## Prerequisites

Before you begin, make sure that:

- Your documentation is available with the **Published** status.
- You have access to the documentation workspace for the relevant project.
- You know whether you want to share the full published documentation site, an audience section, or one document.
- Your browser allows you to view the public documentation site.
- You have published content available under the relevant **User Guides** or other audience navigation area.

## Step-by-Step Instructions

1. Open the project that contains the documentation you want to share.

2. Select **User Docs** to open the project’s documentation area.

3. Confirm that the documentation is marked **Published**.

4. Click **View Published Docs** to open the public documentation site.

5. Review the browser address after the published documentation site opens.

6. Identify the first documentation-specific part of the address, which is the published documentation slug.

7. Keep the published documentation slug unchanged when you want to link readers to the main public documentation collection.

8. Select an audience section, such as **User Guides**, when you want to direct readers to documentation for a particular audience.

9. Review the browser address after opening the audience section.

10. Copy the browser address when you want to share a link to that audience section.

11. Select a document from the audience navigation when you want to share one specific published page.

12. Review the browser address after the document opens.

13. Copy the browser address when you want to share the individual document.

14. Use the browser’s Back control or the published documentation back navigation to return to the previous public documentation level.

15. Return to the documentation workspace when you need to review publication status or make further documentation changes.

> 📷 _Screenshot pending: A published documentation site showing the collection level, an audience section such as User Guides, and an individual document in navigation._

## Tips and Best Practices

- Share the broadest link that meets the reader’s need. Use the main published documentation link for general audiences, an audience-level link for role-specific readers, and a document-level link for a direct task or policy reference.

- Use **View Published Docs** instead of manually assembling a public documentation address. This ensures you start from the correct published documentation collection and its current slug.

- Check the **Published** status before distributing links externally. A link is most useful when the intended content is available to readers in the published experience.

- Treat the slug as the identity of the published documentation collection. Audience and document selections provide deeper navigation beneath that collection, so a copied address may represent a different level depending on where you are when you copy it.

- Test a copied link in a separate browser window or private browsing session before sending it to a large audience. This helps you confirm that the link opens at the intended collection, audience, or document level.

- If you are preparing user-facing help content, begin from **📋 User Manuals** or **User Docs** and use **View Published Docs** to verify the public result. If you are managing broader publishing activities, use the relevant **Publishing** area before checking the published site.

## Related Pages

- [Publish Documentation](#) — Learn how documentation becomes available with the **Published** status.
- [View Published Documentation](#) — Learn how to open and review the public documentation experience.
- [Organize User Guides](#) — Learn how audience-level navigation, including **User Guides**, helps readers find content.
- [Export Documentation](#) — Learn when to use **Export Documentation** for documentation outside the published site.
- [Generate Documentation](#) — Learn how to start documentation creation with **Generate Documentation →**.

## Troubleshooting

### **View Published Docs** does not open the expected documentation site

Return to the documentation workspace and confirm that you are in the correct project. Then select **View Published Docs** again. The action opens the published documentation associated with the current documentation collection.

### The link opens a different level than expected

Check where you copied the address. A link copied from the main published site opens the collection level, while a link copied after selecting **User Guides** or another audience opens that audience level. A link copied from an individual document opens that specific document.

### Readers cannot find the document from a shared main link

Share a more specific link. Open the appropriate audience section, select the document, and copy the browser address only after the document is displayed.

<!-- source: link-to-a-published-document-by-slug.md -->

# Link to a Published Document by Slug

This page explains how a document slug identifies one published document in its public documentation link. Using the correct slug helps you share a direct, reliable link to the exact document your audience needs.

## Overview

When you publish documentation, Atloria provides a public documentation area where readers can browse content by project and audience. Each individual published document is identified in its public web address by a **document slug**.

The document slug is the document-specific part of the public link. In the published documentation structure, it appears after the project and audience portions of the address. This allows Atloria to open the correct document when someone selects or uses the link.

You typically need a document slug when you want to share a direct link in an email, internal portal, support response, onboarding guide, or another document. Rather than asking readers to browse through the published documentation manually, you can give them the address for the exact published page.

> 📷 _Screenshot pending: A published document open in the public documentation area, with the document-specific slug visible in the browser address._

## Prerequisites

Before you start, make sure you have:

- Access to the project that contains the document.
- A document that is available as **Published**.
- Access to **Documents** in Atloria.
- The correct audience selected in the public documentation area, if your project uses audiences.
- Permission to open **View Published Docs**.

## Step-by-Step Instructions

1. Select **Documents** from the Atloria navigation.

2. Select your project if you see the message **Select a project to view documents**.

3. Locate the document you want to share.

4. Confirm that the document is marked **Published**.

5. Select **View Published Docs** to open the project’s public documentation area.

> 📷 _Screenshot pending: The Documents area showing the View Published Docs action used to open public documentation._

6. Select the appropriate audience section, such as **User Guides**, when the public documentation area displays audience choices.

7. Select the published document you want to link to.

8. Check that the document content and title match the page you intend to share.

9. Copy the address from your browser’s address bar.

10. Paste the copied address into the destination where you want to share the document.

The copied public address includes the document slug. Atloria uses that slug, together with the selected project and audience, to identify the individual published document. If you share the complete address, recipients can open the same document directly without first navigating through the documentation lists.

## Tips and Best Practices

- Share the complete public address rather than copying only the document slug. The complete address includes the project and audience context required to open the correct document.

- Open the document from **View Published Docs** before copying its address. This confirms that you are using the reader-facing published link rather than a working link from the **Documents** area.

- Verify the document’s **Published** status before distributing the link. A document that is not published may not be available to readers in the public documentation area.

- Choose the correct audience before opening the document. The same project can organize published content into audience sections, and the public address reflects the audience path used to reach the document.

- Test an important link after pasting it into its final destination. This is especially useful when linking from an email, a user guide, or an external knowledge base.

- Use a descriptive document title so readers can recognize the document after they open the slug-based link. The slug identifies the page in the address, while the visible title helps readers confirm they reached the intended content.

## Related Pages

- [Create a New Document](#)
- [Publish Documentation](#)
- [View Published Documentation](#)
- [Organize Documents for User Guides](#)
- [Export Documentation](#)

## Troubleshooting

### The document does not appear in View Published Docs

Return to **Documents** and verify that the document is marked **Published**. Only documents available in the published documentation area can be opened and shared through a public document link.

### The link opens the wrong documentation section

Open **View Published Docs** again and select the intended audience, such as **User Guides**, before opening the document. Copy the address only after you have opened the correct published page.

### Recipients cannot find the document from the link

Confirm that you copied the entire browser address, not only the final document slug. The project, audience, and document slug portions work together to identify the published document.

<!-- source: analyze-documentation-performance.md -->

# Analyze Documentation Performance

Use Atloria analytics to monitor how people engage with your project documentation and to identify where documentation is helping reduce support demand. This helps you prioritize improvements based on observed activity and engagement outcomes.

## Overview

Documentation performance analysis gives you a project-level view of documentation activity alongside engagement-focused analytics. Use it when you need to understand whether users are finding and using the guidance your team publishes, or when you want to assess documentation’s contribution to support deflection.

From the **Projects** area, you can open a focused project workspace and review its available project views. Analytics are available for individual projects, and Atloria also provides enterprise analytics views for broader monitoring across work.

The analytics experience includes dashboard-style cards for documentation-related outcomes. These include a deflection-focused view and an agent-traffic-focused view, helping you evaluate documentation engagement in the context of support activity. If you need to work with the results outside Atloria, use **Export CSV** to download available analytics data.

> 📷 _Screenshot pending: The project analytics view showing documentation performance cards and available export controls._

## Prerequisites

Before you begin, make sure that:

- You can access the **Projects** page.
- You have access to the project whose documentation activity you want to review.
- The project contains documentation or user-facing guidance to analyze.
- You have permission to view project analytics and export data, if you plan to use **Export CSV**.
- You know whether you are reviewing one project or need a broader enterprise-level view.

## Step-by-Step Instructions

1. Select **Projects** to open the list of available projects.

2. Search for the required project by entering its name in the **Search projects...** field.

3. Open the selected project to enter its focused project workspace.

4. Select the project’s analytics view to open documentation performance reporting.

> 📷 _Screenshot pending: A focused project workspace with the analytics view selected._

5. Review the documentation performance cards displayed on the analytics screen.

6. Check the deflection-focused card to assess documentation-related support deflection outcomes.

7. Check the agent-traffic-focused card to assess changes or patterns in support-agent traffic.

8. Compare the values shown across the available cards to identify whether documentation engagement aligns with lower support demand.

9. Select **Export CSV** when you need an offline copy of the available analytics data.

10. Save the exported CSV file in a location where your team can review or share it.

11. Select **&larr; Back to Projects** when you are finished reviewing the project.

> 📷 _Screenshot pending: The analytics screen with the Export CSV action available for downloading performance data._

## Tips and Best Practices

- Review analytics for one focused project before comparing results across projects. Project-level analysis makes it easier to connect the observed activity to a specific documentation set.

- Consider deflection and agent traffic together. A deflection-oriented result is more meaningful when reviewed alongside agent-traffic patterns, rather than in isolation.

- Export data regularly when you need to compare reporting periods, prepare stakeholder updates, or combine Atloria results with other reporting tools. Use **Export CSV** to create a shareable snapshot of the currently available analytics data.

- Start from **Projects** and use **Search projects...** rather than manually browsing when your organization maintains many projects. This reduces the chance of reviewing the wrong project.

- Use the focused project analytics view for documentation decisions. Broader analytics can be useful for organization-wide monitoring, but project-level reporting is the better place to evaluate a particular project’s documentation activity and engagement outcomes.

- Treat analytics as a signal for investigation. If agent traffic remains high, review the project’s **User Guides** and other documentation content to determine whether key questions are covered clearly and can be found easily.

## Related Pages

- [Manage Projects](#) — Create, find, and open projects from **Projects**.
- [Create a New Project](#) — Use **New Project** and **Create project** to add a project before documentation and analytics work begins.
- [Manage User Guides](#) — Review and maintain content available through **User Guides**.
- [View Technical Documentation](#) — Work with the project’s technical documentation.
- [Export Analytics Data](#) — Learn more about downloading data with **Export CSV**.
- [Monitor Enterprise Analytics](#) — Review analytics across a broader set of projects.

## Troubleshooting

### You cannot find the project to analyze

Enter a more specific name in **Search projects...**. If the project still does not appear, return to **Projects** and confirm that you have access to the correct workspace or project.

### You do not see analytics information for the project

Confirm that you opened the focused project workspace rather than remaining on the **Projects** list. If the analytics view is still unavailable, the project may not have reportable documentation activity yet, or your account may not have analytics access.

### The exported file does not answer the question you are investigating

Return to the analytics view and review the on-screen deflection and agent-traffic cards before exporting again. Use the exported CSV as a reporting snapshot, and pair it with the displayed analytics context when interpreting documentation performance.

<!-- source: compare-documentation-versions-for-changes.md -->

# Compare Documentation Versions for Changes

Comparing documentation versions helps you understand how a project has changed over time. You can use this view to review updates to product behavior and documentation before sharing, exporting, or publishing information.

## Overview

Each project can contain multiple versions that represent different points in the project’s history. The **Versions** area lets you move from the project workspace into version-specific work, including reviewing a version and comparing versions.

Use version comparison when you need to answer questions such as:

- What documentation changed between two project versions?
- Which product areas were updated or added?
- Does the latest version reflect the expected changes before you use it for downstream work?
- Which version should you review before creating an export or updating user-facing documentation?

Comparing versions is especially useful when a project has progressed through several updates. Rather than reviewing each version separately, you can focus on the differences between a baseline version and a newer version. This helps you identify meaningful changes while keeping your review centered on the project’s documented evolution.

> 📷 _Screenshot pending: The Versions area for a project, showing the available versions to review or compare._

## Prerequisites

Before you start, make sure that:

- You have access to the relevant project from **Projects**.
- The project has at least two available versions to compare.
- You know which version you want to use as the baseline and which newer version you want to review.
- You have reviewed any project context needed to interpret the changes, such as recent product updates or documentation requests.
- You are working in the correct project. Use **Search projects...** or **Search across all projects...** if you need help locating it.

## Step-by-Step Instructions

1. Open the project you want to review.

   From **Projects**, select the project that contains the versions you need. If you are already inside another project, use **&larr; Back to Projects** to return to the project list.

   The project workspace keeps version work associated with the correct project, so confirm the project before continuing.

2. Open **Versions** from the project navigation.

   In the project’s sidebar, select **Versions**. This opens the area where you can work with the versions available for the active project.

   If your organization uses multiple AI-generated versions, you may also see **Use All V4 AI Versions**. Use this option only when you intend to work with the complete set of available V4 AI versions rather than a limited selection.

3. Start a comparison from the Versions area.

   Choose the option that opens the comparison workspace for the project. The comparison workspace is designed to place version changes in context so you can review what differs between project states.

   Select the two versions you want to compare using the version selection controls shown on screen. Choose an earlier version as your baseline and a later version as the version under review whenever possible. This makes the direction of change easier to understand.

4. Review the displayed differences.

   Examine the comparison results for changes in documentation and product-related content. Focus first on additions, removals, and revisions that affect how users understand or use the product.

   When reviewing a change, consider:
   - Whether the newer version adds a new capability or clarifies an existing one.
   - Whether an earlier instruction is no longer accurate.
   - Whether a product change requires updates to user guides or related documentation.
   - Whether the change affects information that should be included in an export.

   > 📷 _Screenshot pending: The project version comparison workspace with two selected versions and the resulting documentation changes._

5. Open a version for a closer review when needed.

   If a comparison identifies a change that needs more context, open the relevant version’s review area. Reviewing the version itself helps you understand the full documentation state rather than only the difference shown in the comparison.

   You can also review available version screenshots when visual confirmation is needed. This is useful when a documentation update describes an interface, workflow, or product behavior that may have changed visually.

6. Record or act on your findings.

   After you identify the relevant changes, use them to guide your next task. For example, you may update user-facing content, confirm that documentation is current, or prepare information for an export.

   If you make configuration changes elsewhere in the project, select **Save Changes** before leaving that screen. Saving ensures that your follow-up work uses the intended project settings.

## Tips and Best Practices

- Compare versions in chronological order. Using an older version as the baseline and a newer version as the comparison target makes additions and revisions easier to interpret.
- Review documentation changes alongside product changes. A small wording change may reflect a larger change in user workflow, availability, or expected behavior.
- Use the comparison before exporting information. If you plan to use **Export CSV**, first confirm that you are working from the version state that contains the changes you need.
- Keep your review focused on meaningful differences. Do not treat every change as equally important; prioritize updates that affect user instructions, product capabilities, or project decisions.
- If several versions exist, compare adjacent versions first. After you understand each individual update, compare a broader range when you need to assess cumulative change.
- Use a version’s review and screenshot areas to validate unclear results. A comparison tells you that something changed; version review provides the context needed to decide why it changed and what action to take.

## Related Pages

- [Manage Project Versions](#)
- [Review a Documentation Version](#)
- [View Version Screenshots](#)
- [Export Project Analytics](#)
- [Open and Manage Projects](#)
- [Update Project Documentation](#)

## Troubleshooting

### You cannot compare versions

Confirm that the active project has at least two available versions. If only one version exists, create or wait for an additional project version before attempting a comparison.

### You are reviewing the wrong project

Select **&larr; Back to Projects**, then use **Search projects...** to locate and open the correct project. Check the active project before returning to **Versions**.

### The comparison does not provide enough context

Open the relevant version for a detailed review, and check its available screenshots if the change relates to the user interface. This helps you confirm whether the difference reflects a documentation-only update or a change in the product experience.

<!-- source: export-documentation-reporting-data.md -->

# Export Documentation Reporting Data

You can export documentation results into shareable files for stakeholders, audits, and operational reporting. This page explains how to create a CSV or JSON export from your documentation results.

## Overview

Documentation reporting exports let you take the results shown in Atloria and use them outside the application. Use an export when stakeholders need a spreadsheet-friendly summary, when an operations team needs to combine documentation data with another reporting source, or when you need to retain a point-in-time record.

Atloria provides export actions for both CSV and JSON formats. Choose **Export CSV** when recipients will review the data in spreadsheet software. Choose **Export JSON** when the export will be consumed by another reporting, analysis, or data-processing tool.

Exporting does not change the documentation results displayed in Atloria. It creates a file based on the results available when you start the export. If your documentation has changed since a prior export, create a new export so your reporting file reflects the current results.

> 📷 _Screenshot pending: Documentation results area showing the Export Documentation action and available export formats._

## Prerequisites

Before you start, make sure you have the following:

- Access to the project’s Analytics area.
- Documentation results available to review.
- Permission to view the documentation results you want to report on.
- A clear reporting purpose, such as stakeholder review, operational analysis, or archival.
- Spreadsheet software for CSV files, if you plan to open the export in a spreadsheet.
- A compatible reporting or data-analysis tool for JSON files, if you plan to process structured data.

## Step-by-Step Instructions

1. Open the project where you want to report on documentation results.

2. Open the project’s **Analytics** area.

3. Select **View Results** to display the available documentation results.

4. Review the displayed results before exporting them.

5. Select **Export Documentation**.

> 📷 _Screenshot pending: Export Documentation options showing Export CSV and Export JSON actions._

6. Select **📄 Export CSV** to download the results in CSV format.

7. Open the downloaded CSV file in your preferred spreadsheet application.

8. Select **📄 Export JSON** instead when you need a structured JSON file for a reporting system or data workflow.

9. Save the downloaded export using a filename that identifies the project and reporting date.

10. Share the exported file with the intended stakeholders through your organization’s approved sharing process.

## Tips and Best Practices

- Use **📄 Export CSV** for stakeholder-ready reporting. CSV files are typically the easiest format to review, filter, sort, and incorporate into spreadsheet-based status reports.

- Use **📄 Export JSON** when the recipient needs structured data rather than a spreadsheet. JSON is a better choice for operational workflows that import, transform, or analyze documentation results in another system.

- Review results through **View Results** before you export. This helps you confirm that the output represents the documentation results you intend to report, rather than exporting without checking the current information.

- Create a fresh export whenever documentation results are regenerated or updated. An existing downloaded file does not update automatically after changes are made in Atloria.

- Use a consistent naming convention for exported files. For example, include the project name, report purpose, and export date so stakeholders can distinguish current reporting from older snapshots.

- Keep the exported format aligned with the audience. A project sponsor may prefer CSV for quick review, while an operations or analytics team may request JSON for downstream processing.

- If you are exporting results to support documentation review, distinguish the report’s purpose clearly. Atloria can be used for different documentation needs, including **User Guides** and **User Manuals**, so label the exported file according to the audience and document type it supports.

## Related Pages

- [View Documentation Results](#) — Review the available documentation output before creating an export.
- [Generate Documentation](#) — Create or refresh documentation before reporting on it.
- [User Guides](#) — Learn how to work with documentation intended for end users.
- [User Manuals](#) — Learn how to access and manage manual-oriented documentation.
- [Analytics Overview](#) — Understand the reporting information available in the project Analytics area.

## Troubleshooting

### The export actions are not available

Confirm that you opened **View Results** and that documentation results are available. If you cannot see **Export Documentation**, verify that you have access to the project and its Analytics area.

### I exported the wrong format

Create a new export using the appropriate option. Select **📄 Export CSV** for spreadsheet review, or select **📄 Export JSON** for structured reporting and data-processing workflows.

### The exported file does not include recent documentation changes

Return to **View Results** and verify that the current results are displayed. If documentation was recently generated or updated, create a new export using **Export Documentation** so the downloaded file reflects the latest available results.

<!-- source: connect-an-external-integration.md -->

# Connect an External Integration

Connect an enabled integration to link Atloria with your project system. After connecting, you can verify that Atloria can communicate with the external system before you rely on the integration for project work.

## Overview

External integrations help you use Atloria alongside the project systems your organization already uses. Use this process when an administrator has enabled an integration for your workspace and you need to connect it to a specific project environment.

The connection process includes two important checks: configuring the enabled integration and testing the connection. The **Test Connection** action lets you confirm that the integration can reach the external project system before you continue working.

After an integration is connected, the available action may change to **Disconnect**. Use **Disconnect** only when you need to remove the existing connection; disconnecting may stop Atloria from exchanging information with that external project system.

> 📷 _Screenshot pending: Enabled integration connection area showing connection controls and the Test Connection action._

## Prerequisites

Before you start, make sure you have the following:

- Access to the Atloria project where you want to use the integration.
- An integration that has been enabled for your organization or workspace.
- The connection details required by your external project system, such as the approved account, workspace, project, or authorization information.
- Permission to connect the selected external system. Your organization may require an administrator to grant this permission.
- A stable network connection so you can complete the connection test.
- The correct project selected in Atloria. You can use **Projects** or **Open Project Dashboard** to confirm that you are working in the intended project.

## Step-by-Step Instructions

1. Open **Projects**.

2. Select the project that you want to connect to the external system.

3. Click **Open Project Dashboard**.

4. Open the area where enabled integrations are available for the current project.

5. Select the enabled integration that you want to connect.

6. Enter or approve the connection information requested by the integration.

7. Complete any authorization prompts presented by the external project system.

8. Click **Test Connection**.

9. Review the result displayed after the connection test completes.

10. Return to the project dashboard after the test confirms that the integration can connect successfully.

> 📷 _Screenshot pending: The integration configuration view with the Test Connection button and a successful connection result._

## Tips and Best Practices

- Confirm the active project before you connect. Atloria provides **Projects** and **Open Project Dashboard** so you can open the correct project context before configuring an integration.

- Use **Test Connection** immediately after you enter or update connection information. Testing before you leave the integration setup helps you identify incorrect access details, expired authorization, or external-system availability issues early.

- Connect only integrations that your organization has enabled and approved. If you cannot find the integration you need, contact the person who manages Atloria integrations for your organization.

- Treat **Disconnect** as a removal action. Use it when you intentionally need to end the existing integration connection, such as when a project changes external systems or when access should no longer be available.

- If you manage multiple projects, repeat the connection process in each project that needs its own external-system connection. Do not assume that opening a different project in **Projects** uses the same connection settings.

- Keep your external-system permissions current. A connection can require attention later if the account used to authorize it loses access to the target project or workspace.

## Related Pages

- [Projects](#) — Find and open the project where you want to configure an integration.
- [Open Project Dashboard](#) — Work from the selected project’s dashboard.
- [Manage Project Access](#) — Confirm that you have the permissions needed to connect external systems.
- [Disconnect an External Integration](#) — Remove an existing connection when it is no longer needed.
- [Troubleshoot Integration Connections](#) — Resolve authorization and connection-test problems.

## Troubleshooting

### The integration is not available

Only enabled integrations can be connected. Return to the project’s integration area and confirm that the integration is listed. If it is not listed, ask your Atloria administrator whether the integration has been enabled for your organization and whether it is available for the selected project.

### The connection test does not succeed

Click **Test Connection** again after confirming that the connection details and external-system authorization are correct. Verify that the account you used has permission to access the intended external project, workspace, or repository. If the issue continues, check whether your organization’s network or the external system is temporarily unavailable.

### You need to change an existing connection

If the integration already shows **Disconnect**, review whether you need to remove the current connection before reconnecting it with different access details. Disconnect only when you intend to stop the current link, then return to the enabled integration and complete the connection process again.

<!-- source: resolve-integration-issues.md -->

# Resolve Integration Issues

Use the Integrations and Issues areas to investigate problems that prevent Atloria from using connected source repositories for documentation work. Resolving these issues helps keep generated User Guides, User Manuals, and other documentation aligned with the connected project.

## Overview

Atloria integrations connect your workspace to supported source-control providers, including GitHub, GitLab, and Bitbucket. When an integration has a connection, access, or repository-related problem, documentation work may be incomplete or unable to proceed as expected.

You typically need to investigate an integration issue when documentation generation does not reflect recent project content, an expected source is unavailable, or an issue appears in the workspace’s issue list. Start in **Settings → Integrations** to review the provider connection, then use **Issues** to review and resolve the specific item that is affecting your work.

The Issues area helps you distinguish between work that still needs attention and items that have already been addressed. If the workspace shows **4 All Resolved**, it indicates that the currently listed issues have been resolved; review integration settings if your documentation concern remains.

> 📷 _Screenshot pending: The Settings → Integrations screen showing available GitHub, GitLab, and Bitbucket connections._

## Prerequisites

Before you begin, make sure you have:

- Access to the relevant Atloria workspace.
- Permission to open **Settings → Integrations**.
- Access to the source-control account used by your organization, such as GitHub, GitLab, or Bitbucket.
- The ability to identify the affected documentation work, such as a **User Guide** or **User Manual**.
- Details about the problem, such as the affected repository, the documentation output that appears incomplete, or the issue you want to review.
- Access to the **Issues** area if your workspace uses issue-based resolution.

## Step-by-Step Instructions

1. **Open the workspace where the documentation issue occurs.**

   Use the **Workspace** area or the workspace sidebar to open the workspace associated with the affected documentation. Confirm that you are investigating the correct project before changing any integration settings.

2. **Open the Integrations settings.**

   Select **Settings → Integrations**. This opens the integration management screen, where you can review the available source-control providers.

   The screen includes provider options for:
   - **GitHub**
   - **GitLab**
   - **Bitbucket**

   Review the provider that your documentation work depends on.

3. **Identify the affected provider connection.**

   Determine which connected provider contains the source material for the documentation you are investigating. For example, if the missing documentation should be based on a GitHub project, review the GitHub integration rather than GitLab or Bitbucket.

   Check whether the connection appears available and whether it is the expected provider for the workspace. If you cannot confirm the correct connection, verify the source with the person who set up the documentation project.

4. **Open the Issues area.**

   Navigate to **Issues** in the workspace settings. Use the issues list to find items related to the integration or documentation work you are investigating.

   If an issue list includes resolved items, use the available issue status information to focus on items that still need action. Do not assume an issue is active simply because it exists in the history.

> 📷 _Screenshot pending: The Issues screen showing the list of integration or documentation-related issues and their resolution state._

5. **Open the relevant issue.**

   Select the issue that best matches the problem you are seeing. Review the issue details and compare them with the documentation impact you identified—for example, a missing source, outdated documentation result, or unavailable integration.

   If several issues are present, investigate the one that is most directly tied to the affected provider or documentation task.

6. **Resolve the issue when the underlying problem has been addressed.**

   After confirming that the integration problem is corrected, select **Resolve** for the issue. Use this action only after you have verified that the issue no longer affects the documentation work.

   Resolving an issue updates its status in the Issues area. A resolved status means the workspace no longer treats that specific issue as requiring attention; it does not by itself prove that every documentation output has been regenerated or reviewed.

7. **Verify the documentation result.**

   Return to the documentation area and review the affected output, such as **User Guides** or **📋 User Manuals**. If needed, use **Generate Documentation →** to create updated documentation after the integration issue is resolved.

   Review the resulting content for the expected project information. If you plan to distribute the result, use **Export Documentation** only after you confirm that the updated documentation is complete.

## Tips and Best Practices

- **Check the provider before resolving the issue.** Atloria supports GitHub, GitLab, and Bitbucket. Confirm which provider contains the project source so you do not investigate the wrong connection.

- **Treat issue resolution as a confirmation step.** Select **Resolve** after the connection or source-access concern has been corrected. If the underlying issue remains, resolving it can make follow-up harder for other workspace members.

- **Review documentation after integration changes.** A corrected connection may make new or updated project information available for documentation work. Review the relevant **User Guides** or **📋 User Manuals** and generate documentation again when appropriate.

- **Keep documentation types distinct.** If your workspace produces both user-facing manuals and technical documentation, verify the correct output. User manuals should focus on what end users see and do, while technical documentation may describe different information for implementation teams.

- **Use the issue history for context.** Even when the workspace indicates **All Resolved**, previous issues can help explain why a documentation result was incomplete or delayed.

## Related Pages

- [Manage Integrations](#)
- [Review Workspace Issues](#)
- [Generate Documentation](#)
- [Create User Guides](#)
- [Export Documentation](#)

## Troubleshooting

### The expected source-control provider is not available

**Problem:** You cannot find the provider that contains the project source needed for documentation work.

**Cause:** The workspace may not have the expected GitHub, GitLab, or Bitbucket integration available, or you may be viewing the wrong workspace.

**Solution:** Return to **Workspace** and confirm the correct workspace is open. Then go to **Settings → Integrations** and review the available provider options. If the required provider is not available, contact the workspace administrator or the person responsible for integration setup.

### An issue is marked resolved, but documentation still looks incomplete

**Problem:** The Issues area shows **All Resolved**, but the User Guide or User Manual does not include expected content.

**Cause:** Resolving an issue records that the specific issue was addressed; it does not automatically confirm that updated documentation has been generated and reviewed.

**Solution:** Review the relevant documentation output, then select **Generate Documentation →** if updated content is needed. Check the generated result before using **Export Documentation**.

### You are unsure whether to select Resolve

**Problem:** You found an issue but cannot tell whether it is safe to resolve.

**Cause:** The issue may describe a symptom rather than the underlying integration problem, or the provider connection may not yet be verified.

**Solution:** First review **Settings → Integrations**, confirm the affected provider is available, and verify that the documentation work can proceed. Select **Resolve** only after the issue no longer affects the workspace’s documentation activity.

<!-- source: use-webhook-events-in-workflows.md -->

# Use Webhook Events in Workflows

Webhook events let you use changes in an Atloria project to support documentation updates and operational workflows in connected systems. You can use project activity as a signal for teams or tools that need to review, publish, or act on updated project information.

## Overview

Use webhook events when your team needs an external workflow to respond to activity in a project. For example, a project update can notify a documentation team to review user guidance, create an operational task for a release team, or begin an internal approval process.

Start from the project workspace so you can select the project whose activity should support the workflow. The **Projects** area provides access to all available projects, while the focused project workspace provides project-specific areas such as changes, versions, analytics, and technical documentation.

Webhook-based workflows are most useful when the same work happens repeatedly after project events. Instead of relying on a team member to notice a change manually, you can use the event to begin a consistent process in your connected workflow tool.

> 📷 _Screenshot pending: The Projects screen, including the Search projects... field and project list._

## Prerequisites

Before you begin, make sure you have:

- Access to the **Projects** area.
- Access to the project that will produce the events.
- The destination details for the workflow you want to notify, such as the receiving system and its webhook address.
- Permission to create or manage integrations for your organization.
- A clear list of the project activities that should trigger the workflow.
- A plan for the person or team that will respond when the event is received.

## Step-by-Step Instructions

1. Open **Projects** from the application navigation.

2. Use the **Search projects...** field to find the project you want to use for the workflow.

3. Select the project from the results to open its focused project workspace.

4. Confirm that you are working in the intended project before setting up any event-based process.

5. Review the project areas that are relevant to your workflow, such as changes, versions, or technical documentation.

6. Open the project’s integration or webhook configuration screen, if it is available to your organization.

7. Add the receiving webhook destination provided by your workflow or operational system.

8. Choose the project event or events that should notify the destination.

9. Save the webhook configuration.

10. Perform or identify a project activity that matches one of the selected events.

11. Check the receiving workflow system to confirm that it received the event.

12. Verify that the receiving workflow created the expected documentation or operational action.

> 📷 _Screenshot pending: Webhook configuration screen showing the destination field, available project events, and save action._

## Tips and Best Practices

- Use a separate workflow for documentation work and operational work when they have different owners. This makes it easier to route each event to the correct team.

- Select only the events that require action. Sending every project event can create unnecessary notifications and make important updates harder to find.

- Align each event with a clear outcome. For example, an event associated with a project change can begin a documentation review, while an event associated with a version can begin a release-readiness checklist.

- Use the project workspace to validate the source activity. The project includes dedicated areas for changes, versions, analytics, and technical documentation, which can help you confirm why a workflow was triggered.

- Keep the workflow destination current. If the responsible team changes tools or ownership, update the webhook destination so project events continue to reach the correct process.

- Test with a low-impact project activity before relying on the workflow for a production process. Confirm both that the event is delivered and that the receiving system handles it as expected.

- Document who owns the workflow after it is triggered. A webhook can start a process, but your organization should still define who reviews the event, updates documentation, or resolves operational follow-up.

## Related Pages

- [Manage Projects](#)
- [Review Project Changes](#)
- [Work with Project Versions](#)
- [Use Technical Documentation](#)
- [Manage Integrations](#)

## Troubleshooting

### The workflow does not receive an event

Confirm that the webhook destination is correct and that the selected project event matches the activity you performed. Then repeat the activity and check whether the receiving system records a new event.

### The wrong team receives notifications

Review the webhook destination and the event selections. If documentation and operational actions are being sent to the same destination, separate them into workflows with different owners and purposes.

### You cannot find webhook configuration

Confirm that you are in the correct project and that you have the required integration-management permissions. If your organization does not expose webhook settings in the project workspace, contact an administrator to configure or enable the required integration.

<!-- source: view-your-organization-plan.md -->

# View Your Organization Plan

This page explains how to locate organization plan information and confirm which service capabilities are available to you. Reviewing your plan helps you understand what your organization can use before you request access, begin a project, or contact your administrator.

## Overview

Your organization plan determines the services and capabilities that are available to your organization. Depending on your organization’s setup, plan information may include the plan name, enabled services, usage limits, billing status, renewal information, or access restrictions.

The available UI evidence does not identify a dedicated **Plan**, **Billing**, **Subscription**, or **Organization Settings** screen in the captured application screens. Because those screen names and controls have not been verified, this guide does not assume a specific menu path or button label for viewing plan details.

If your organization provides a plan page, use it to review the services that are currently enabled. If you cannot find plan information in your workspace, your organization administrator or billing contact may manage this information outside of the areas available to you.

> 📷 _Screenshot pending: The organization plan screen showing the current plan name, service capabilities, status, and any usage or billing information._

## Prerequisites

Before you begin, make sure you have the following:

- Access to your organization’s Atloria workspace.
- Permission to view organization-level information, if your organization restricts plan or billing details.
- The name of your organization, if you belong to more than one organization.
- Contact information for your organization administrator or billing owner.
- Access to internal guidance, such as **📋 User Manuals** or **User Guides**, if your organization publishes plan-management instructions there.

## Step-by-Step Instructions

1. Sign in to Atloria using your organization account.

2. Open the organization workspace that you want to review.

3. Look for an organization-level area that contains plan, billing, subscription, account, or service information.

4. Select the plan-related option when it is available in your organization workspace.

5. Review the current plan name displayed on the plan screen.

6. Review the list of enabled services or capabilities displayed for the plan.

7. Check whether the plan screen shows any usage limits, renewal dates, billing status, or account restrictions.

8. Confirm that the capability you need is listed as available before attempting to use it.

9. Open **📋 User Manuals** if you need organization-specific instructions for a service capability.

10. Select **User Guides** to review available end-user guidance for enabled services.

11. Contact your organization administrator if the plan screen is unavailable or does not show the capability you expected.

> 📷 _Screenshot pending: A plan details view with the enabled service capabilities highlighted for review._

## Tips and Best Practices

- Review plan information before planning work that depends on a particular service. This can prevent delays caused by unavailable capabilities or organization-level restrictions.

- Treat the displayed plan information as the current source of truth for your organization. Access can differ between organizations, even when individual users have similar roles.

- If you are comparing enabled capabilities with available guidance, use **📋 User Manuals** and **User Guides** to find instructions for the services your organization can access.

- Do not assume that a capability is available because another organization uses it. Plan availability may vary based on your organization’s subscription and administrative configuration.

- If plan information is visible but you cannot use a listed capability, check whether your user account requires additional permission. Plan availability and individual user access are not always the same.

- Record the plan name and the capability you need when contacting support or an administrator. This helps them verify whether the issue is related to the organization plan, user permissions, or service configuration.

## Related Pages

- [User Guides](#) — Find instructions for using available Atloria features.
- [User Manuals](#) — Review organization-provided manuals through **📋 User Manuals**.
- [View Your Documentation](#) — Use **View Your Documentation →** when documentation is available for your workspace.
- [View Published Docs](#) — Use **🌐 View Published Docs** to review published documentation where available.
- [User Management](#) — Review user access when a service is available to the organization but unavailable to a specific user.

## Troubleshooting

### You cannot find a plan or billing option

Your workspace may not expose organization plan information to your account. Open **📋 User Manuals** or **User Guides** to check for local instructions, then contact your organization administrator to request the current plan details.

### A capability is not listed on the plan screen

The capability may not be included in your organization’s current plan, or it may require separate enablement. Note the capability name and ask your billing owner or administrator whether it can be added.

### A capability appears available, but you cannot use it

Your organization plan may include the capability, while your individual account lacks permission to access it. Ask an administrator to verify your user access and any required role assignments.

<!-- source: track-documentation-usage.md -->

# Track Documentation Usage

This page explains how to review documentation-related usage information that may affect your organization’s plan limits. Monitoring usage helps you understand when documentation activity may require changes to your plan or billing arrangements.

## Overview

Documentation usage is relevant when your organization creates, reviews, previews, publishes, exports, or shares documentation. These activities can help you understand how actively your team is using Atloria’s documentation features and whether your current plan remains appropriate.

You may need to review usage before discussing plan changes, investigating a billing question, or planning a large documentation initiative. For example, a team preparing to generate and publish documentation for several projects may want to review its usage and billing information first.

Atloria groups billing-related information under **Billing**. Documentation work is available through areas such as **User Docs**, **📋 User Manuals**, and **Review & Publish**. Use these areas together to understand both your organization’s documentation activity and the plan information that applies to it.

> 📷 _Screenshot pending: Billing area showing organization usage information and plan-limit details._

## Prerequisites

Before you start, make sure you have the following:

- Access to your organization’s Atloria workspace.
- Permission to view **Billing** information for the organization.
- At least one documentation project or documentation version, if you want to compare usage information with recent documentation activity.
- A clear understanding of the activity you want to review, such as generated documentation, exports, previews, or published user manuals.
- Access to the relevant project review area if you need to verify documentation status.

## Step-by-Step Instructions

1. Open your Atloria workspace.

2. Select **Billing** from the available navigation options.

3. Review the organization’s usage information displayed in the **Billing** area.

4. Identify any usage values that are presented alongside plan-limit information.

5. Compare the displayed usage with the limit or allowance shown for your organization’s current plan.

6. Note any usage category that is close to its displayed limit.

7. Open the documentation area you want to review, such as **User Docs** or **📋 User Manuals**.

8. Select the relevant documentation project.

9. Open the project version that you want to examine.

10. Select **Review & Publish** to view the documentation review workflow.

11. Review the information in **1 Review Summary** to confirm the scope of the documentation version.

12. Select **Preview** if you need to inspect the documentation before it is shared or published.

13. Review the documentation content in the preview.

14. Close the preview when you have finished checking it.

15. Select **Export Documentation** only when you need to create an exported copy of the documentation.

16. Return to the review area by selecting **Back to Review**.

17. Use **Share Preview Link** only when you need to provide preview access to another person.

18. Return to **Billing** to review the usage information again after completing your documentation activity.

> 📷 _Screenshot pending: Review & Publish area with the “1 Review Summary,” “Preview,” “Export Documentation,” and “Share Preview Link” actions._

## Tips and Best Practices

- Review usage before a large documentation effort. If you plan to use **Generate Documentation →** across multiple projects, check **Billing** first so you can identify plan-limit considerations before beginning.

- Use **Preview** for routine content checks. Previewing lets you inspect documentation without immediately exporting it. This is useful when you are still reviewing wording, organization, or completeness.

- Review documentation status before sharing or exporting. Start with **1 Review Summary**, then use **Preview** to validate the material. This helps prevent distributing documentation that still needs review.

- Keep user-facing documentation organized. Use **📋 User Manuals** for end-user documentation and follow the **Review & Publish** process before distributing it. This makes it easier to connect your organization’s documentation activity with the work being performed.

- Export only when needed. **Export Documentation** is appropriate when you need a separate copy for distribution, archival, or offline review. Avoid repeated exports while content is still changing.

- Check billing again after major work. If your team has generated, reviewed, exported, or shared a substantial amount of documentation, return to **Billing** to review the updated organization information.

- Use the correct documentation type. Atloria distinguishes user-facing manuals from other documentation work. When preparing content for end users, use the **📋 User Manuals** area and verify the content through **Review & Publish**.

## Related Pages

- [Generate Documentation](#)  
- [Review and Publish Documentation](#)  
- [Preview Documentation](#)  
- [Export Documentation](#)  
- [Share a Preview Link](#)  
- [Manage Billing](#)  
- [Create User Manuals](#)  

## Troubleshooting

### You cannot find usage information

Open **Billing** and confirm that you are viewing the organization’s billing area rather than an individual project’s documentation screen. If **Billing** is unavailable, ask an organization administrator to confirm that you have permission to view billing and plan information.

### You cannot tell which documentation activity relates to usage

Open **📋 User Manuals** or **User Docs**, select the relevant project version, and use **1 Review Summary** to identify the documentation work completed for that version. Then return to **Billing** to compare that activity with the organization-level usage information.

### You are unsure whether to export or share documentation

Select **Preview** first to review the documentation. Use **Share Preview Link** when another person needs access to the preview, and use **Export Documentation** when you need a separate exported copy.

<!-- source: request-billing-assistance.md -->

# Request Billing Assistance

Use the billing assistance options in Atloria to let your organization administrator or support team know about a billing question, plan need, or account concern. Providing clear details helps the team understand your request and respond with the right next steps.

## Overview

Billing assistance is intended for situations where you need help with your organization’s commercial or account-related needs. For example, you may need clarification about billing, plans, credits, enterprise arrangements, or another payment-related concern that requires attention from an administrator or support team.

In Atloria, start by locating the **Billing** option and then use the available support experience to describe what you need. The application includes support-oriented areas such as **Support Agent** and **🤖 AI Support**, which can help direct your question or capture information for the team.

When you submit a billing request, include enough context for the recipient to identify the affected organization, understand the issue, and determine whether follow-up is needed. If you are reporting a discrepancy or unexpected charge, include relevant dates, amounts, and any reference information available to you—without sharing sensitive payment details in open notes.

> 📷 _Screenshot pending: The Billing option and the available support entry points for requesting billing help._

## Prerequisites

Before requesting billing assistance, make sure you have:

- Access to the Atloria workspace for the organization you are asking about.
- The details of your billing question, such as the affected plan, credit usage, invoice period, or account concern.
- Any relevant dates, amounts, or business context that will help the support team investigate.
- Permission to discuss the organization’s billing information, if your organization limits billing access to administrators or finance contacts.
- A clear description of the outcome you need, such as an explanation, a correction, plan guidance, or contact with an organization administrator.

## Step-by-Step Instructions

1. **Open the billing area.**  
   From your available Atloria navigation, select **Billing**. Use this area when your question concerns plans, credits, enterprise arrangements, or other billing needs rather than general product usage.

2. **Choose a support option.**  
   Look for the support experience available in your workspace. Depending on your access, you may see **Support Agent** or **🤖 AI Support**. Select the option that lets you ask for help or communicate your request.

   If you need assistance from a person responsible for your organization’s account, clearly state that your request is for an organization administrator or billing support team.

3. **Describe the billing need.**  
   In the notes area, enter the details of your request. When the field displays **Add any notes for the team...**, use it to explain the situation in plain language.

   Include:
   - The organization or workspace affected
   - The billing period or date involved
   - The plan, credits, or enterprise topic you are asking about
   - The specific question or action you need
   - Any important reference details that the team should review

   For example, you might write: “Please help us understand the credit usage shown for this billing period and confirm which plan applies to our organization.”

4. **Request changes or follow-up when needed.**  
   If the support experience offers **✎ Request Changes**, use it when you need the team to review or correct something rather than simply answer a question. Be specific about what you believe should change and why.

5. **Review your message before sending.**  
   Check that your request is understandable to someone who may not know your current work. Avoid including passwords, full payment card numbers, or other confidential payment credentials.

6. **Share the request with the appropriate people.**  
   If your organization needs internal visibility, use **Share with Team** when it is available. This helps relevant colleagues review the request and provide context before or during follow-up.

7. **Monitor the support conversation.**  
   Return to the support area, such as **6. Support Chat**, to review responses or answer follow-up questions. Respond promptly if the support team asks for clarification, as missing details can delay resolution.

> 📷 _Screenshot pending: A billing support request showing the “Add any notes for the team...” field and available follow-up options._

## Tips and Best Practices

Write one focused request for each billing issue. For example, keep a question about plan eligibility separate from a question about a specific charge. This makes it easier for the support team to identify the correct owner and provide a complete answer.

State the desired outcome near the beginning of your notes. Instead of only saying that billing “looks wrong,” explain what you need: confirmation of a plan, an explanation of credits, review of an invoice period, or a requested change.

Use **✎ Request Changes** only when you are asking the team to modify or correct something. For general questions or guidance, describe the question in the support request without framing it as a change request.

When you use **Share with Team**, make sure the people included are appropriate for billing-related information. Your team can add useful business context, but billing discussions may contain information that should only be visible to authorized colleagues.

## Related Pages

- [Billing](#)  
- [Support Agent](#)  
- [Support Chat](#)  
- [Share with Team](#)  
- [User Guides](#)  

## Troubleshooting

### I cannot find the **Billing** option

Your available navigation may depend on your organization access. Confirm that you are in the correct Atloria workspace and ask an organization administrator whether you have access to billing-related areas.

### I do not see a way to contact the support team

Look for **Support Agent**, **🤖 AI Support**, or **6. Support Chat** in your workspace. If none of these options are available, contact your organization administrator and ask them to submit the billing request or provide the appropriate support contact.

### My request needs more information after I submit it

Return to the support conversation and provide the requested details in **Add any notes for the team...**. Include the relevant billing period, organization context, and the exact outcome you need so the team can continue reviewing your request.

<!-- source: complete-single-sign-on.md -->

# Complete Single Sign On

Complete the single sign-on (SSO) process to securely sign in through your organization’s identity provider and open your Atloria workspace. This process confirms your access and finishes any remaining workspace setup.

## Overview

Single sign-on lets you access Atloria using the account managed by your organization, rather than creating or entering a separate Atloria password. Your organization may use SSO to apply its own sign-in, multi-factor authentication, and access policies before allowing you into Atloria.

You typically complete this process after selecting an Atloria sign-in option provided by your organization or after following an invitation link. During the flow, your organization may ask you to confirm that Atloria can use your approved identity to sign you in. When this confirmation is required, you will see the **Authorize Atloria** option.

The final stage is shown as **4. Complete** in the setup flow. At this stage, you may need to select **Finish setup** before entering your workspace. Once complete, the workspace is available from the **Workspace** option.

> 📷 _Screenshot pending: The Atloria single sign-on completion screen showing the final setup stage._

## Prerequisites

Before you start, make sure you have the following:

- An Atloria workspace that is configured for your organization’s sign-in process.
- An active account with your organization’s identity provider.
- Permission to access the Atloria workspace.
- Access to the email address or device used for your organization’s sign-in and verification requirements.
- A supported browser with pop-ups and redirects allowed for the sign-in process, if your organization requires them.
- Your invitation link, if you were invited to a workspace.

## Step-by-Step Instructions

1. **Start the Atloria sign-in process.**  
   Open the Atloria sign-in link supplied by your organization, workspace administrator, or invitation email.

2. **Sign in with your organization account.**  
   Complete the sign-in prompts displayed by your organization’s identity provider, including any required verification step.

3. **Select `Authorize Atloria` when it appears.**  
   Review the authorization request and select **Authorize Atloria** to allow the sign-in process to continue.

4. **Wait for Atloria to return you to the completion screen.**  
   After authorization succeeds, your browser returns to Atloria and displays the final part of the setup flow.

5. **Select `4. Complete`.**  
   Choose **4. Complete** if the setup flow displays its stages and you need to open the final stage.

6. **Select `Finish setup`.**  
   Click **Finish setup** to confirm the remaining SSO setup step and complete access to Atloria.

7. **Select `Workspace`.**  
   Open **Workspace** after setup is complete to enter your Atloria workspace.

> 📷 _Screenshot pending: The authorization prompt with the Authorize Atloria option._

## Tips and Best Practices

- Use the account assigned by your organization. If you have more than one work account, verify that you selected the account associated with the correct Atloria workspace before authorizing access.

- Complete the flow in the same browser window. Opening the authorization page in a different browser, private window, or device can interrupt the return to the Atloria completion screen.

- Do not use **Skip to Complete** unless your administrator has instructed you to do so. This option may move you to the final setup stage, but it does not replace any sign-in or authorization requirement imposed by your organization.

- If you are returning to Atloria after an interrupted sign-in, begin again from the organization-provided link rather than repeatedly refreshing the completion screen. This helps ensure that the current sign-in session is used.

- Look for the completion state before expecting workspace access. The sign-in process is not fully finished until you have completed the **4. Complete** stage and selected **Finish setup**, when that option is presented.

- Keep your organization’s verification method available. Your identity provider may require multi-factor authentication, such as an authenticator prompt, security key, or verification code, before it returns you to Atloria.

> 📷 _Screenshot pending: The final completion stage with the Finish setup action and Workspace option._

## Related Pages

- [Sign In to Atloria](#)
- [Join a Workspace Using an Invitation](#)
- [Workspace Sidebar](#)
- [Security](#)
- [Privacy](#)
- [Infrastructure Security](#)
- [Application Security](#)

## Troubleshooting

### You do not see **Authorize Atloria**

Your organization may not require an authorization confirmation, or you may have already approved Atloria previously. Continue with the sign-in prompts shown by your organization. If the flow stops without returning to Atloria, start again from the sign-in link provided by your administrator.

### You complete sign-in but do not reach **4. Complete**

Close the extra sign-in tabs and return to the original browser tab where you started. If you still do not reach the completion stage, restart the sign-in process in the same browser and ensure that redirects are not blocked.

### You select **Finish setup** but cannot access **Workspace**

Your account may not yet have workspace access, or you may have signed in with a different organization account. Sign out, repeat the process using the correct account, and contact your workspace administrator if **Workspace** remains unavailable.

<!-- source: review-atloria-privacy-information.md -->

# Review Atloria Privacy Information

This page explains how to find and review Atloria’s privacy information before using your account or working in a workspace. Reviewing this information helps you understand the privacy terms that apply when you access Atloria and use its workspace features.

## Overview

Atloria provides a **Privacy** page within its user documentation and security information. You can use this page to review the privacy information that applies to your use of Atloria, including use of your account and participation in a workspace.

Privacy information is especially important when you are deciding whether to join a workspace, share information with collaborators, or use Atloria for work that may involve organizational data. Review the information before you begin working so you understand the terms that apply to your use of the service.

The privacy information is separate from the product’s security guidance. The **Security** area helps you locate information about how Atloria approaches protection of its environment and application, while **Privacy** is the appropriate place to review privacy-related terms and practices.

> 📷 _Screenshot pending: The Atloria Privacy page displayed from the Security section of User Docs._

## Prerequisites

Before you start, make sure that you have:

- Access to Atloria’s public documentation or user manual area.
- A web browser that can display Atloria documentation pages.
- Enough time to read the privacy information relevant to your intended account and workspace use.
- Any internal approval requirements from your organization, if your organization requires privacy or legal review before adopting a service.
- Access to the workspace invitation or account-registration process, if you are reviewing privacy information before joining Atloria.

## Step-by-Step Instructions

1. Open the Atloria documentation area.

   Look for **User Docs** or **📋 User Manuals**. These options take you to Atloria’s user-facing documentation, where you can review guidance organized by topic.

2. Open the security documentation category.

   Select **Security**. This category groups information related to security and privacy so that you can distinguish privacy information from other operational guidance.

3. Select **Privacy**.

   In the Security area, click **Privacy** to open Atloria’s privacy information. Read the page in full before you create an account, accept an invitation, or begin using a workspace for sensitive work.

4. Review the information in the context of your intended use.

   As you read, consider the type of work you plan to perform in Atloria. For example, determine whether you will use a personal account, participate in an organization’s workspace, or share information with other workspace members. This helps you identify the parts of the privacy information that are most relevant to you.

5. Review security guidance when you need additional context.

   Return to **Security** if you also need to understand Atloria’s security posture. You may see options such as **🔐 Infrastructure Security** and **🛡️ Application Security**. These topics provide security context, but they do not replace reviewing the **Privacy** information.

6. Review terms separately, when needed.

   Privacy information and service terms address related but distinct topics. If you need to understand the broader conditions for using Atloria, review the Terms of Service in addition to the Privacy page. Do not assume that reading one page covers the other.

7. Continue with account or workspace access only after your review.

   If you are joining through an authorization or invitation flow, complete the privacy review before selecting an action such as **Authorize Atloria**. If you have questions or your organization requires approval, pause the onboarding process and contact the appropriate administrator or reviewer.

> 📷 _Screenshot pending: The User Docs navigation showing Security and Privacy, with Infrastructure Security and Application Security available as related topics._

## Tips and Best Practices

- **Review privacy information before sharing workspace content.** If you expect to add organizational, customer, or internal project information to a workspace, read the Privacy page before you upload, enter, or share that information.

- **Treat workspace use as collaborative use.** Information you work with in a workspace may be relevant to other authorized workspace members. Consider your organization’s own data-handling rules in addition to Atloria’s privacy information.

- **Use the correct documentation topic.** Select **Privacy** for privacy terms and practices. Use **🔐 Infrastructure Security** or **🛡️ Application Security** when your question is about security controls or the security architecture rather than privacy.

- **Review information again when your use changes.** Revisit the Privacy page if you move from evaluating Atloria to active use, join a new workspace, begin collaborating with a new group, or plan to use Atloria for a different type of information.

- **Keep privacy review separate from publishing decisions.** Actions such as **Review & Publish**, **Preview**, and **Share Preview Link** relate to reviewing or sharing content. Before using sharing features, make sure you understand whether the information you plan to share is appropriate for the intended audience.

## Related Pages

- [Security](#) — Start here to browse Atloria’s security and privacy documentation.
- [Infrastructure Security](#) — Review information available under **🔐 Infrastructure Security**.
- [Application Security](#) — Review information available under **🛡️ Application Security**.
- [Terms of Service](#) — Review the terms that apply to use of Atloria alongside the privacy information.
- [Authorize Atloria](#) — Continue with authorization only after you have completed any required privacy review.

## Troubleshooting

### I cannot find the Privacy page

Start from **User Docs** or **📋 User Manuals**, then select **Security** and **Privacy**. If your current screen does not show documentation navigation, return to the main documentation area before looking for the Security category.

### I need security details, not privacy information

Open **Security** and choose the topic that matches your question. Select **🔐 Infrastructure Security** for infrastructure-focused information or **🛡️ Application Security** for application-focused information. Keep the **Privacy** page open if you need to compare privacy and security considerations.

### My organization requires approval before I use Atloria

Do not proceed with workspace access or select **Authorize Atloria** until your required internal reviewer has completed their review. Provide them with the Privacy page and, if requested, the related security and Terms of Service pages.

<!-- source: secure-your-atloria-account.md -->

# Secure Your Atloria Account

This page explains how to use Atloria’s sign-in, password reset, invitation, and privacy resources safely. Following these practices helps protect your workspace access and the information available to you in Atloria.

## Overview

Your Atloria account is your personal access point to the workspace and its documentation. You use the sign-in experience to access Atloria, the password reset experience if you cannot sign in, and an invitation link when you are joining a workspace for the first time.

Keep your sign-in details private and use a strong, unique password for Atloria. Because workspace content may include internal processes, user guides, security material, and other business information, do not share your account credentials or use another person’s account.

Atloria also provides security- and privacy-related documentation. You can review the **Security**, **Privacy**, **🔐 Infrastructure Security**, and **🛡️ Application Security** materials when you need to understand the organization’s published security and privacy information.

> 📷 _Screenshot pending: The Atloria sign-in screen, showing the available sign-in fields and actions._

## Prerequisites

Before you begin, make sure you have:

- An active Atloria account or a valid workspace invitation.
- Access to the email address associated with your Atloria account.
- A private, trusted device and browser.
- A secure internet connection.
- A password manager, if your organization permits one, to create and store a unique password.
- The correct Atloria workspace invitation link if you are a new user.

## Step-by-Step Instructions

### Sign in safely

1. Open the Atloria sign-in screen.

2. Confirm that you are using the expected Atloria sign-in page before entering any account information.

3. Enter the email address associated with your Atloria account.

4. Enter your Atloria password.

5. Review the information you entered for typing errors.

6. Complete the sign-in action shown on the screen.

7. Close the browser window or sign out when you finish using Atloria on a shared or public device.

8. Do not save your password in a browser that is shared with other people.

### Join a workspace from an invitation

1. Open the invitation link you received from your workspace administrator.

2. Confirm that the invitation is intended for you before continuing.

3. Follow the on-screen invitation steps to create or connect your Atloria account.

4. Use your own work email address when the invitation process asks for an email address.

5. Create a password that you do not use for another service.

6. Complete the account setup steps shown on the screen.

7. Return to the Atloria sign-in screen after setup is complete.

8. Sign in with the account you just created or connected.

> 📷 _Screenshot pending: The Atloria workspace invitation screen, showing the invitation acceptance and account setup actions._

### Reset a forgotten password

1. Open the Atloria password reset screen.

2. Enter the email address associated with your Atloria account.

3. Submit the password reset request using the action shown on the screen.

4. Open the inbox for the email address you submitted.

5. Look for the Atloria password reset message.

6. Check your spam, junk, or filtered folders if you do not see the message in your inbox.

7. Open the reset link only after confirming that the message is an expected Atloria password reset email.

8. Create a new password that is unique to Atloria.

9. Store the new password in your approved password manager.

10. Return to the sign-in screen and sign in with your new password.

### Review security and privacy information

1. Open **User Docs** from the available documentation area.

2. Select **📋 User Manuals** to view user-facing guidance.

3. Select **Security** when you need general security information.

4. Select **Privacy** when you need to review privacy-related information.

5. Select **🔐 Infrastructure Security** when you need information about infrastructure security.

6. Select **🛡️ Application Security** when you need information about application security.

7. Review the relevant material before sharing workspace information with others.

> 📷 _Screenshot pending: The User Docs area with Security, Privacy, Infrastructure Security, and Application Security documentation options._

## Tips and Best Practices

- **Use a unique password.** Do not reuse your Atloria password for email, collaboration tools, personal sites, or other business systems. A unique password limits the impact if another service is compromised.

- **Use a password manager.** A password manager can generate and store a long, unique password without requiring you to memorize it. Follow your organization’s approved password-manager policy.

- **Protect invitation links.** Treat a workspace invitation link as sensitive. Do not forward it to another person, post it in a public channel, or include it in a support request unless your administrator specifically asks for it through an approved process.

- **Verify password reset requests.** Request a reset only when you need one. If you receive an unexpected password reset message, do not use its link. Instead, open Atloria directly and review your account access through the normal sign-in process.

- **Use your own account.** Each person should use their own Atloria account. Shared accounts make it harder to maintain appropriate workspace access and may expose information to people who should not see it.

- **Be cautious on shared devices.** Avoid signing in on public computers. If you must use a shared device, do not save credentials, do not leave the session open, and close the browser after you finish.

- **Review published guidance.** Use the **Security** and **Privacy** documentation areas when you need to understand Atloria’s security and privacy materials. For more specific topics, review **🔐 Infrastructure Security** and **🛡️ Application Security**.

## Related Pages

- [Security](#security)  
- [Privacy](#privacy)  
- [🔐 Infrastructure Security](#infrastructure-security)  
- [🛡️ Application Security](#application-security)  
- [User Guides](#user-guides)  
- [Workspace](#workspace)  

## Troubleshooting

### I cannot sign in

1. Confirm that you are entering the email address associated with your Atloria account.

2. Re-enter your password carefully.

3. Check whether your browser has filled in an outdated saved password.

4. Use the password reset screen if you do not know your current password.

### I did not receive a password reset message

1. Confirm that you submitted the email address used for your Atloria account.

2. Check your spam, junk, and filtered email folders.

3. Wait a short time and check your inbox again.

4. Submit a new reset request if the first request did not arrive.

5. Contact your workspace administrator if you still cannot access the account.

### My invitation link does not work

1. Confirm that you opened the complete invitation link you received.

2. Make sure you are using the email address intended for the invitation.

3. Ask the workspace administrator to confirm that the invitation is still valid.

4. Request a new invitation if the original invitation cannot be used.

<!-- source: manage-your-profile.md -->

# Manage Your Profile

This page explains how to locate and review the profile-related settings available for your Atloria account. Keeping your profile information current helps ensure your account is recognizable and your personal settings are accurate.

## Overview

Atloria provides a **Settings** entry point for account and application configuration. From this area, you can review the settings that are available to your account and look for profile-related options.

The available evidence confirms that profile information can be displayed with an avatar and optional account statistics. The profile display may show a loading indicator while your information is being retrieved, followed by your avatar and any available statistics.

Profile editing fields, such as a display name, email address, password, or avatar upload control, are not confirmed in the available interface evidence. If your organization has enabled these controls, use the labels and save options shown in your own Settings screen.

> 📷 _Screenshot pending: The Atloria Settings area showing available profile-related options._

## Prerequisites

Before you begin, make sure that you have:

- An active Atloria account.
- Access to the Atloria workspace where you want to review your settings.
- Permission to change account settings, if your organization restricts profile management.
- Any updated information you plan to enter, such as an approved profile image or organization-required account details.

## Step-by-Step Instructions

1. Open Atloria and sign in to your account.

2. Select **Settings** from the available navigation options.

3. Wait for the Settings screen to finish loading.

4. Look for the profile or account section available in your Settings screen.

5. Review the profile information currently displayed for your account.

6. Check whether an avatar is shown with your profile information.

7. Wait if a loading indicator appears before the profile information is displayed.

8. Select the available edit control for the profile item you want to change, if your screen provides one.

9. Update the value in the profile field that opens.

10. Select the save or confirm control shown in your screen to apply the change.

11. Review the displayed profile information after saving to confirm that your update appears correctly.

> 📷 _Screenshot pending: A user profile display with an avatar and profile statistics after profile information has loaded._

## Tips and Best Practices

- Review your displayed avatar after making changes. Atloria’s profile display supports an image and can use a fallback when an image is not available.
- Allow the profile area to finish loading before deciding that information is missing. A loading indicator can appear while profile information is being retrieved.
- Confirm changes immediately after saving. Check that the updated value is visible in the profile display rather than assuming the change was applied.
- Use information that complies with your organization’s identity and privacy policies. For example, use an approved profile image if your organization requires one.
- Do not share account credentials through profile fields or profile images.
- If you do not see an edit option in **Settings**, your account may be limited to viewing profile information. Contact your Atloria administrator for help with account changes.
- Review privacy information when deciding what personal details to include in your profile. Atloria provides a **Privacy** area for privacy-related information.

## Related Pages

- [Privacy](../privacy) — Review Atloria privacy information.
- [Security](../security) — Learn about security-related guidance.
- [Infrastructure Security](../infrastructure-security) — Review infrastructure security information.
- [Application Security](../application-security) — Review application security information.
- [General Settings](../general-settings) — Learn about other settings available in Atloria.

## Troubleshooting

### The profile information is still loading

Wait for the loading indicator to disappear before taking further action. If the profile does not appear after waiting, refresh the screen and sign in again. Contact your Atloria administrator if the issue continues.

### I cannot find an option to edit my profile

Select **Settings** and review all sections available to your account. The available interface evidence confirms profile display capabilities, but does not confirm that every user can edit profile details. Your administrator may manage profile information or restrict editing permissions.

### My updated information does not appear

Return to the profile display after selecting the save or confirm control. If the previous information remains visible, refresh the screen and check again. If the change still does not appear, contact your Atloria administrator and provide the profile item you attempted to update.

<!-- source: switch-between-organizations.md -->

# Switch Between Organizations

You can switch between organizations when you have access to more than one workspace in Atloria. Changing organizations lets you view the projects, collaboration context, and resources that belong to the organization you select.

## Overview

Organizations separate work for different teams, departments, customers, or business units. Each organization can contain its own set of projects, so switching organizations helps you keep your work focused on the correct workspace.

You may need to switch organizations when you cannot find an expected project in the current project list, when you work with multiple teams, or when you need to return to a project in another organization. Your access determines which organizations are available to you.

After you switch, Atloria updates the workspace context. The **Projects** area then shows the projects available in the organization you selected. If you open a project, the project dashboard and its related areas—such as changes, analytics, versions, and technical documentation—apply to that organization’s project.

> 📷 _Screenshot pending: The Workspace area with the current organization selector and available organizations._

## Prerequisites

Before you switch organizations, make sure that:

- You are signed in to Atloria.
- Your account has been granted access to at least two organizations.
- You know the organization you want to use.
- You have saved any unfinished work before changing to another organization.
- You can access the **Workspace** area or the **Projects** page.

## Step-by-Step Instructions

1. Open the **Workspace** area from the main navigation.

2. Locate the control that displays your current organization in the workspace navigation.

3. Select the current organization control to open the list of organizations available to your account.

4. Select the organization you want to work in.

5. Wait for the workspace context to update.

6. Select **Projects** to review the projects available in the newly selected organization.

7. Use the **Search projects...** field to find a project within the selected organization.

8. Select a project from the list to open it.

9. Select **Open Project Dashboard** when you want to work from the project’s main dashboard.

> 📷 _Screenshot pending: The organization list opened from the workspace navigation, with an organization ready to be selected._

## Tips and Best Practices

- Confirm the active organization before you create or manage a project. A project created from **New Project** is associated with the organization that is active at the time you start.
- If you cannot find a project, switch organizations before assuming that the project was deleted or that you do not have access. Projects are organized by workspace context.
- Use **Search projects...** after switching organizations to narrow the current organization’s project list.
- Use **Search across all projects...** when available if you need to look beyond the project list currently in view. Review the organization context before opening or updating a result.
- Return to **Projects** or use **← Back to Projects** when you need to verify which organization’s project list you are viewing.
- If you work in several organizations, pause briefly after switching and confirm that the expected projects appear before creating a new project or making changes.
- Organization switching changes the workspace you are viewing; it does not automatically grant access to organizations or projects that your account is not authorized to use.

## Related Pages

- [View and Manage Projects](#)
- [Create a New Project](#)
- [Open a Project Dashboard](#)
- [Search Projects](#)
- [Project Access and Permissions](#)

## Troubleshooting

### The organization I need is not listed

Your account may not have access to that organization. Contact the organization administrator and ask them to confirm that you have been added to the correct organization.

### I switched organizations, but I cannot find my project

Select **Projects** and check the project list for the active organization. Use **Search projects...** to search within that list. If the project still does not appear, switch to the other organizations available to you or confirm your project access with an administrator.

### The workspace does not appear to change after I select an organization

Wait for the page to finish updating, then select **Projects** again. If the previous projects are still shown, refresh the page and repeat the switch. If the problem continues, sign out and sign back in before contacting support.

<!-- source: create-a-documentation-project.md -->

# Create a Documentation Project

Create a documentation project to give Atloria a focused workspace for analyzing a repository and organizing its generated technical documentation. A project helps you keep documentation, versions, changes, screenshots, and analytics tied to the correct application.

## Overview

A project is the central container for documentation work in Atloria. From the **Projects** area, you can open a focused project workspace and access project-specific areas such as documentation, version reviews, change history, screenshots, and analytics.

Create a separate project when you need documentation for a new application, repository, service, or documentation initiative. Keeping each codebase in its own project makes it easier to search, review, and manage documentation without mixing content from unrelated work.

After you create a project, Atloria provides a project dashboard. From there, you can use **View Your Documentation →** to open the documentation experience or **Open Project Dashboard** to return to the project’s main workspace.

> 📷 _Screenshot pending: The Projects hub showing the Workspace area, project search, and options for opening or creating a project._

## Prerequisites

Before you begin, make sure you have the following:

- Access to the **Workspace** and **Projects** areas.
- Permission to create or manage projects in your organization.
- The repository or application source you want to document.
- The repository location or connection details, if your organization connects projects to a source repository.
- A clear documentation purpose, such as documenting a customer-facing application, an internal service, or a technical API.

If you are connecting a repository, prepare the correct repository source. Atloria’s project setup supports recognizable source-provider options represented by GitHub, GitLab, and Bitbucket icons.

## Step-by-Step Instructions

1. Select **Workspace** to open your organization’s shared workspace.

2. Select **Projects** to open the hub that lists the projects available to you.

3. Review the project list to confirm that a project does not already exist for the application you want to document.

4. Enter a project name in **Search projects...** if you need to look for an existing project before creating another one.

5. Start the **New Project** flow from the Projects hub.

> 📷 _Screenshot pending: The New Project entry point in the Projects hub._

6. Select the repository source option that matches where your application is hosted.

7. Provide the repository or application information requested in the project setup flow.

8. Describe the documentation purpose when the setup flow asks for project details.

   Use a purpose that identifies both the audience and the intended outcome. For example, describe whether the project is intended for user guides, technical reference material, onboarding documentation, or ongoing maintenance documentation.

9. Confirm the project details to create the project.

10. Select **Open Project Dashboard** after creation to enter the focused project workspace.

11. Select **View Your Documentation →** when you are ready to review the documentation associated with the new project.

## Tips and Best Practices

- Create one project per distinct application or repository. This keeps project versions, detected changes, screenshots, and analytics meaningful and easier to review.

- Use a specific documentation purpose. A clear purpose helps your team understand why the project exists and what type of documentation should be maintained there. For example, “Internal technical reference for the billing service” is more useful than “Documentation.”

- Check **Search projects...** before creating a new project. This can prevent duplicate projects for the same codebase.

- Use the project workspace for project-specific work. The focused project area includes documentation-related destinations for technical documentation, versions, changes, screenshots, and analytics.

- Return to the full list by selecting **← Back to Projects** when you need to switch between projects.

- Plan for the documentation scope to evolve. Atloria can organize analyzed information across categories such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. A project provides one place to review these different parts of your application.

> 📷 _Screenshot pending: A focused project dashboard with options to view documentation and navigate to project-specific areas._

## Related Pages

- [Workspace Sidebar](#)
- [Project Sidebar](#)
- [Open a Project Dashboard](#)
- [View Project Documentation](#)
- [Review Project Changes](#)
- [Compare Project Versions](#)
- [Manage Project Screenshots](#)
- [Delete a Project](#)

## Troubleshooting

1. **You cannot find the option to start a new project.**  
   Select **Projects** from **Workspace** and verify that you are in the projects hub. If the option is still unavailable, ask an organization administrator to confirm that you have permission to create projects.

2. **You are unsure whether the project already exists.**  
   Use **Search projects...** before beginning the **New Project** flow. Search using the application name, repository name, or a recognizable part of the project name.

3. **You created a project but cannot find its documentation.**  
   Open the project from the **Projects** list, then select **View Your Documentation →**. If you need to return to the project list, select **← Back to Projects**.

<!-- source: find-project-documentation.md -->

# Find Project Documentation

This page explains how to locate a project, open its dashboard, and find documentation and recent activity. Use these steps when you need to review a project’s documents or understand what has changed recently.

## Overview

Atloria provides a **Projects** workspace where you can browse the projects you can access. From this workspace, you can search for a specific project or use **Search across all projects...** when you need to look more broadly.

After you open a project, its dashboard gives you a focused view of that project. You can use the project navigation to find **Documents**, review **User Guides**, and check **Activity** for recent project events.

Use the workspace-level project list when you are not sure which project contains the documentation you need. Use the project dashboard when you already know the project and want to review its documentation, changes, versions, analytics, or recent activity.

> 📷 _Screenshot pending: The Projects workspace showing the project search field and available projects._

## Prerequisites

Before you begin, make sure you have:

- Access to the Atloria workspace.
- Permission to view the project you want to open.
- The project name, or enough information to identify it in search.
- Access to the relevant documentation area, such as **Documents** or **User Guides**, if your organization restricts documentation access.

## Step-by-Step Instructions

1. Select **Workspace** to return to your main workspace navigation.

2. Select **Projects** to open the list of projects available to you.

3. Click the **Search projects...** field to search within the project list.

4. Enter the project name or a distinguishing keyword in **Search projects...**.

5. Select the project you want to review from the filtered results.

6. Select **Open Project Dashboard** to open the focused dashboard for that project.

7. Select **Documents** to view documentation associated with the selected project.

8. Select **User Guides** when you need end-user guidance rather than technical project material.

9. Select **Activity** to review recent project dashboard activity.

10. Select **View Your Documentation →** when it is available to open the documentation view presented for the current project or workspace.

> 📷 _Screenshot pending: A project dashboard with Documents, User Guides, and Activity navigation options._

### Search across projects

Use a broader search when the correct project is unknown or when you need to locate information across multiple projects.

1. Return to the **Projects** workspace.

2. Click **Search across all projects...**.

3. Enter a project name, document-related term, or other identifying keyword.

4. Select the relevant project from the search results.

5. Select **Open Project Dashboard** to continue reviewing that project’s documentation and activity.

### Return to the project list

1. Select **← Back to Projects** from a project page.

2. Use **Search projects...** to locate another project.

> 📷 _Screenshot pending: The project Activity view showing recent project dashboard events._

## Tips and Best Practices

- Start with **Search projects...** when you know the project name. This keeps your search focused on the projects shown in the current workspace.
- Use **Search across all projects...** when you are unsure where a document belongs or when you work across several projects.
- Open the project dashboard before looking for project-specific materials. The dashboard is the central place to move between documentation and project information.
- Check **Activity** when documentation appears to be missing, outdated, or recently changed. Activity can help you identify recent work in the project.
- Choose **User Guides** for instructions intended for people using the product or workspace. Use **Documents** when you need the project’s broader documentation collection.
- If you are reviewing a project over time, also look for project areas related to changes, versions, analytics, and technical documentation from the project dashboard navigation.

## Related Pages

- [Browse Projects](#)
- [Open a Project Dashboard](#)
- [Review Project Activity](#)
- [View User Guides](#)
- [Review Project Changes and Versions](#)
- [Access Technical Documentation](#)

## Troubleshooting

### You cannot find a project in the project list

Use **Search projects...** and enter a shorter or more distinctive part of the project name. If the project still does not appear, confirm that you have been granted access to that project.

### You found the project, but cannot see its documentation

Open the project with **Open Project Dashboard**, then look for **Documents** or **User Guides**. If these options are unavailable or do not show the expected material, your access may be limited for that project.

### You are not sure whether you are viewing the correct project

Select **Activity** and review recent project activity for context. If the activity does not match the work or documentation you expect, select **← Back to Projects** and search for a different project.

<!-- source: accept-an-organization-invitation.md -->

# Accept an Organization Invitation

An organization invitation lets you join an Atloria workspace that another user has invited you to access. Accepting the invitation gives you access to the organization and the projects that your assigned permissions allow.

## Overview

When an administrator or teammate invites you to an Atloria organization, they send you a unique invitation link. Open this link to review and accept the invitation.

After you accept, Atloria adds your account to the organization. You can then use the **Workspace** area to view available projects and open a project dashboard when you have access.

Your invitation link is specific to you and the organization that sent it. Use the link from the invitation message rather than attempting to locate the organization through **Projects** or workspace search.

> 📷 _Screenshot pending: Organization invitation page opened from an invitation link._

## Prerequisites

Before you begin, make sure you have the following:

- An invitation link sent by an Atloria organization administrator or teammate.
- Access to the email inbox or messaging channel where you received the invitation.
- An Atloria account, or the ability to create one if the invitation flow asks you to sign in or register.
- The correct account credentials if you already use Atloria.
- A supported web browser with access to the internet.

## Step-by-Step Instructions

1. Open the invitation message that you received from the organization.

2. Select the invitation link in the message.

3. Review the organization invitation page that opens in your browser.

4. Confirm that you are using the Atloria account you want to join to the organization.

5. Sign in if the invitation page asks you to authenticate.

6. Complete account registration if you do not yet have an Atloria account and the invitation flow presents a registration option.

7. Review the invitation details shown on the page before confirming your membership.

8. Select the on-screen control that confirms or accepts the invitation.

9. Wait for Atloria to finish adding your account to the organization.

10. Open **Workspace** after the invitation is accepted.

11. Select **Projects** to view the projects available to you in the organization.

12. Select **Open Project Dashboard** for a project you need to work in.

> 📷 _Screenshot pending: Workspace and Projects view after an organization invitation has been accepted._

## Tips and Best Practices

- Use the invitation link promptly. If the link no longer works, ask the person who invited you to send a new invitation.
- Sign in with the account that should permanently belong to the organization. If you have separate personal and work accounts, verify which account is active before you accept.
- Do not rely on **Search across all projects...** or **Search projects...** to find an organization before you have accepted its invitation. These search options help you find projects that are already available to your account.
- After joining, use **Workspace** as your starting point for organization-level access and **Projects** to move into a specific project.
- Your available projects may be limited by the access assigned to you. If you join successfully but cannot find an expected project, contact an organization administrator.
- Keep the invitation message until you have confirmed that you can access the required workspace and projects.

## Related Pages

- [Sign In to Atloria](#)
- [Create an Atloria Account](#)
- [Navigate the Workspace](#)
- [View and Open Projects](#)
- [Request Access to a Project](#)
- [Manage Organization Members](#)

## Troubleshooting

### The invitation link does not open

Copy the complete link from the invitation message and paste it into your browser’s address bar. If it still does not open, ask the sender to verify the invitation and send a replacement link.

### You are signed in to the wrong account

Sign out of the current Atloria account, then reopen the invitation link and sign in with the account you intend to use for the organization. Accepting with the wrong account can prevent your expected work account from receiving access.

### You accepted the invitation but cannot see a project

Open **Workspace**, then select **Projects**. If the project is not listed, your organization membership may be active but your project access may not yet be assigned. Contact the organization administrator and ask them to confirm your access to the specific project.

<!-- source: invite-project-collaborators.md -->

# Invite Project Collaborators

Invite the people who help create, review, maintain, and support your project. Adding the right collaborators gives writers, reviewers, engineers, and support contributors access to the project work they need without requiring them to locate the project on their own.

## Overview

Project collaboration begins from the project area in Atloria. You can use the **Projects** workspace to find the relevant project, then open its dashboard before managing access.

An invitation gives a collaborator a link to join the project. After you send the invitation, the recipient opens the invitation link and completes the access process in Atloria. Use invitations when you need to add a new contributor, bring in a reviewer for a specific release, or give a support contributor access to help with project documentation.

Before you invite someone, decide what they need to do in the project. For example, writers may need to work on user guides, reviewers may need to review project changes and versions, engineers may need access to technical documentation, and support contributors may need access to support-related project information. Only invite people who need access to the project.

> 📷 _Screenshot pending: The Projects workspace showing the project list and the Open Project Dashboard action._

## Prerequisites

Before you start, make sure you have:

- Access to the Atloria **Workspace** and the **Projects** area.
- Permission to manage access for the project you want to share.
- The correct project selected from the project list.
- The collaborator’s current email address or approved organization identity.
- A clear understanding of the access the collaborator requires, such as writing, reviewing, engineering, or support work.
- Approval from your organization’s project owner or access administrator, if your organization requires it.

## Step-by-Step Instructions

1. Select **Projects** from the **Workspace** navigation.

2. Use **Search projects...** to locate the project when it is not immediately visible in the project list.

3. Select the project you want to share.

4. Click **Open Project Dashboard** to open the selected project.

5. Open the project’s access or collaborator management area.

   > 📷 _Screenshot pending: The project dashboard with the collaborator or project-access management area open._

6. Start a new collaborator invitation from the access management area.

7. Enter the collaborator’s email address or organization-approved account identity in the invitation form.

8. Select the access option that matches the collaborator’s intended work.

9. Confirm the project name shown in the invitation before you send it.

10. Add an optional message that explains why you are inviting the person and what work you expect them to perform.

11. Send the invitation.

12. Tell the collaborator to open the invitation link they receive and sign in to Atloria with the intended account.

13. Return to the project’s access management area to confirm that the collaborator has joined the project.

14. Remove or change the collaborator’s access when their project work is complete.

## Tips and Best Practices

- Invite people to the correct project. If you work across several projects, start from **Projects** and verify the project dashboard before sending an invitation.

- Use **Search across all projects...** when you need to find project-related information beyond the current project, and use **Search projects...** when your goal is simply to locate a project from the project list.

- Match access to the contributor’s task. For example, invite writers when they need to work on **User Guides**, reviewers when they need to inspect changes or versions, engineers when they need project technical documentation, and support contributors when they need to assist with project support work.

- Keep invitations limited to active contributors. Review project access regularly, especially after a release, documentation handoff, contractor engagement, or support escalation ends.

- Ask recipients to use the same Atloria account they expect to use for future project work. This helps avoid access being associated with an unintended account.

- Do not share invitation links in public channels. Treat an invitation link as project-access information and send it only to the intended recipient.

- If you are no longer working in the project, use **← Back to Projects** to return to the project list before selecting another project.

## Related Pages

- [Manage Projects](#)
- [Open a Project Dashboard](#)
- [Review Project Changes](#)
- [Review Project Versions](#)
- [Work with User Guides](#)
- [Use Technical Documentation](#)
- [Remove Project Access](#)

## Troubleshooting

### I cannot find the project I need to share

Go to **Projects** and use **Search projects...**. If you still cannot find the project, confirm that you are in the correct **Workspace** and that you have access to the project.

### I cannot manage collaborators or send an invitation

You may not have permission to manage project access. Contact the project owner or your organization’s access administrator and ask them to send the invitation or update your permissions.

### The collaborator cannot use the invitation

Ask the collaborator to open the invitation link while signed in with the account they intend to use for Atloria. If the invitation is no longer valid or was sent to the wrong identity, send a new invitation from the project’s access management area.

<!-- source: view-your-project-access.md -->

# View Your Project Access

Use the Projects area to see which projects are available to your account. Reviewing your available projects helps you confirm that you can access the correct workspace before opening documentation, reviews, versions, or project analytics.

## Overview

Atloria organizes your work around a **Workspace** and its available **Projects**. The Workspace provides the starting point for navigating your account’s project access, while the Projects list shows the projects you can open.

You may need to review your access when you join a new organization, receive an invitation to a project, cannot find expected work, or need to confirm which project to use. Only projects available to your account appear in the Projects area.

After you open a project, the project navigation can provide access to areas such as **Overview**, changes, versions, analytics, technical documentation, and user manuals. The options you see can vary by project and by your assigned access.

> 📷 _Screenshot pending: The Workspace view with the Projects area used to review available project access._

## Prerequisites

Before you start, make sure that:

- You are signed in to Atloria.
- You have access to at least one Workspace.
- You have been granted access to one or more projects, if you expect projects to appear.
- You know the name of the organization or project you are looking for, if applicable.
- You have received any required project invitation from your workspace administrator.

## Step-by-Step Instructions

1. Open Atloria and go to the **Workspace** area.

2. Select **Projects** to open the list of projects available to your account.

3. Review the project names shown in the Projects list.

4. Confirm that the project you need is listed.

5. Select a project name to open that project.

6. Select **Overview** to confirm that you opened the intended project.

7. Select **← Back to Projects** when you want to return to your available project list.

8. Repeat the selection process for each project you need to review.

> 📷 _Screenshot pending: The Projects list showing the projects currently available to the signed-in user._

## Tips and Best Practices

- Start from **Workspace** when you need to check your overall project access. This helps you return to the full list instead of remaining inside one project.
- Use **← Back to Projects** after reviewing a project. This is the quickest way to compare the projects available to you.
- Open **Overview** after selecting a project to verify that you are in the correct project before working in other areas.
- Treat the Projects list as your current access list. If a project does not appear there, do not assume you can open it through a direct link.
- If you work across several teams, verify the project name carefully before viewing project-specific information such as changes, versions, analytics, or documentation.
- Access can differ between projects. Seeing one project in the list does not necessarily mean that you have access to every project in the same workspace or organization.
- If you are asked to review project documentation, open the correct project first, then use **User Docs** or **📋 User Manuals** where those options are available.

## Related Pages

- [Navigate the Workspace](#)
- [Open a Project Overview](#)
- [View Project Changes](#)
- [Review Project Versions](#)
- [View Project Analytics](#)
- [Access Technical Documentation](#)
- [Use User Manuals](#)

## Troubleshooting

### A project I expect is not listed

Return to **Workspace**, select **Projects**, and check the list again. If the project is still missing, ask your workspace or project administrator to confirm that your account has been added to the project.

### I can see a project but cannot find the information I need

Open the project and select **Overview** first. Then use the project navigation to locate the relevant area, such as changes, versions, analytics, or documentation. The available options may depend on your access to that project.

### I opened the wrong project

Select **← Back to Projects**. Then select the correct project from the Projects list and use **Overview** to confirm that you are in the intended project.

<!-- source: understand-the-project-header.md -->

# Understand the Project Header

The Project Header helps you identify the project you are working in and move quickly between project-level areas. Use it whenever you need to confirm your current project, return to the project list, open the dashboard, or manage available project actions.

## Overview

When you open a project from **Projects**, the Project Header provides the context for the workspace you are viewing. It keeps project navigation and important project actions available while you work in areas such as changes, analytics, versions, technical documentation, and workspace content.

The header is especially useful when you work with multiple projects. Rather than returning to the main project list every time you need to switch context, you can use the project’s navigation options to stay oriented and move to the relevant project area. If you need to leave the current project, **← Back to Projects** returns you to the full list of available projects.

Project-level actions are grouped under **Actions**. This keeps impactful tasks separate from day-to-day navigation. For example, you can use **Open Project Dashboard** to return to the project’s main dashboard, while **Delete Project** is available when a project is no longer needed.

> 📷 _Screenshot pending: The Project Header showing the current project context, the Back to Projects link, and the Actions menu._

## Prerequisites

Before using the Project Header, make sure you have:

- Access to the **Workspace** where the project is located.
- Access to the **Projects** area.
- At least one project you can open.
- The appropriate permissions for any actions you need to perform, especially deleting a project.
- A clear understanding of whether you are working in the active project or need to select a different project first.

## Step-by-Step Instructions

1. **Open the Projects area.**

   In your workspace, select **Projects**. This opens the project hub, where you can view and locate the projects available to you.

   If you have many projects, use the **Search projects...** field to narrow the list. When you need to search beyond the current project list, use **Search across all projects...** where available.

   > 📷 _Screenshot pending: The Projects area with the Search projects field and project list._

2. **Select the project you want to work in.**

   Choose the project from the list. The selected project becomes your current project context and opens its project workspace.

   When moving between projects, verify that you have opened the intended project before making changes. This is particularly important if several projects have similar names or purposes.

3. **Review the Project Header.**

   At the top of the project workspace, use the Project Header to confirm that you are working within the correct project. The header remains your starting point for project navigation and actions.

   The header provides access to the project’s main workspace areas, including project views such as changes, analytics, versions, and technical documentation. Use these areas according to the work you need to complete:
   
   - Use project changes to review project updates.
   - Use analytics to view project-related insights.
   - Use versions to review and compare available project versions.
   - Use technical documentation when you need project documentation content.

4. **Return to the complete project list when needed.**

   Click **← Back to Projects** to leave the current project workspace and return to **Projects**.

   Use this option when you want to:
   
   - Open a different project.
   - Search for a project.
   - Create a new project.
   - Confirm which projects are available in the workspace.

5. **Open the project dashboard.**

   Select **Actions** in the Project Header, then choose **Open Project Dashboard**.

   The project dashboard is the main starting point for the currently selected project. Use it when you want to return to the project’s central view after working in a more focused area, such as a version review or technical documentation page.

   > 📷 _Screenshot pending: The Actions menu expanded with Open Project Dashboard and Delete Project options._

6. **Create a project from the project hub, if required.**

   From **Projects**, select **New Project**. Complete the project creation process, then select **Create project** to add it to the workspace.

   After the project is created, open it from the project list. Its Project Header will provide the same navigation and action options as other projects you can access.

7. **Delete a project only when you are certain it is no longer needed.**

   In the current project’s header, select **Actions**, then select **Delete Project**.

   Review the confirmation prompt carefully. To proceed, select **I understand, delete**. This confirmation step is designed to prevent accidental removal of a project.

   If you are unsure whether the project is still in use, return to the project dashboard or review its changes, versions, and documentation before confirming deletion.

## Tips and Best Practices

- **Use the Project Header as your context check.** Before reviewing changes, versions, or documentation, confirm that you are in the correct project. This reduces the risk of reviewing or managing the wrong project.

- **Use the project dashboard as your reset point.** If you have navigated deeply into a project area and need a high-level starting point, choose **Actions** and then **Open Project Dashboard**.

- **Use search before creating a new project.** Search with **Search projects...** or **Search across all projects...** first. This helps prevent duplicate projects when an existing project already covers the same work.

- **Treat deletion as a final action.** The **Delete Project** option is intentionally separated under **Actions** and requires the **I understand, delete** confirmation. Review the project and confirm that it is obsolete before proceeding.

- **Keep navigation and actions distinct.** Use the project navigation areas to view and work with project information. Use **Actions** for project-wide tasks, such as opening the dashboard or deleting the project.

- **Return to Projects when switching work.** Click **← Back to Projects** instead of relying on browser navigation when you want to deliberately change projects. This gives you access to the full project list and search tools.

## Related Pages

- [Workspace Sidebar](#)
- [Project Sidebar](#)
- [Manage Projects](#)
- [Create a New Project](#)
- [Use the Project Dashboard](#)
- [Review Project Changes](#)
- [Explore Project Analytics](#)
- [Compare Project Versions](#)
- [View Technical Documentation](#)

## Troubleshooting

### I cannot find the project I need

Return to **Projects** using **← Back to Projects**. Use **Search projects...** to search the current list. If the project may not be visible in the current list, use **Search across all projects...** where available. If it still does not appear, verify that you have access to the correct workspace and project.

### I selected Open Project Dashboard but do not see the information I expected

Make sure you opened the correct project first. Use **← Back to Projects**, locate the intended project, and open it again. Then select **Actions** and choose **Open Project Dashboard**.

### I cannot delete a project, or I do not see Delete Project

Open **Actions** in the Project Header and look for **Delete Project**. If the option is unavailable, you may not have permission to delete the project. Contact your workspace administrator or project owner for access. If the confirmation prompt appears, select **I understand, delete** only after you have confirmed that deletion is appropriate.

<!-- source: use-project-quick-actions.md -->

# Use Project Quick Actions

Project Quick Actions help you move from the project list to the work area you need without searching through multiple screens. Use them when you want to open a project’s dashboard quickly or return to the full Projects hub.

## Overview

Atloria organizes project work around two navigation contexts: **Workspace** and an individual project. In the Workspace context, you can review and search all available projects. After you select a project, you can use its focused navigation and quick actions to continue working in that project.

The **Quick Start** area provides an **Actions** section for common project navigation. The available action shown is **Open Project Dashboard**, which takes you to the selected project’s main dashboard. This is useful when you have already identified the project you need and want to begin reviewing its project-specific information.

You can also use **← Back to Projects** to leave the focused project view and return to the central **Projects** list. From there, **Search projects...** helps you locate a project by name, while **Search across all projects...** supports broader workspace searching.

> 📷 _Screenshot pending: The Quick Start area showing the Actions heading and Open Project Dashboard action for a selected project._

## Prerequisites

Before you begin, make sure that:

- You can sign in to Atloria and access the **Workspace**.
- You have access to at least one project in the **Projects** list.
- You know which project you want to open.
- You are viewing either the **Projects** workspace or a focused project area.
- If you need to create a project first, you can use **New Project** and **Create project**.

## Step-by-Step Instructions

1. Select **Workspace** in the sidebar to open the workspace-level navigation.

2. Select **Projects** to display the full list of projects available to you.

   > 📷 _Screenshot pending: The Workspace sidebar with Projects selected and the project list visible._

3. Enter a project name in the **Search projects...** field to narrow the project list.

4. Select the project you want to work with to open its focused project area.

5. Locate the **Quick Start** section on the selected project’s screen.

6. Select **Actions** to view the project actions available from Quick Start.

7. Select **Open Project Dashboard** to open the dashboard for the current project.

   > 📷 _Screenshot pending: The Actions section in Quick Start with Open Project Dashboard available for the active project._

8. Review the dashboard information for the selected project before navigating to other project areas.

9. Select **← Back to Projects** when you need to return to the central project list.

10. Enter a broader term in **Search across all projects...** when you need to find information beyond the currently selected project.

## Tips and Best Practices

- Confirm that you are working in the correct project before selecting **Open Project Dashboard**. Quick actions apply to the active project, not to every project in the workspace.

- Use **Search projects...** when you know the project name and only need to locate a project from the **Projects** list. This is the fastest way to move into a specific project before using Quick Start.

- Use **Search across all projects...** when your search is not limited to one project. This is helpful when you are unsure which project contains the information you need.

- Treat **← Back to Projects** as your reset point. If you have opened the wrong project or need to switch context, return to the project list and select the appropriate project there.

- If you are starting new work rather than opening existing work, select **New Project** and then use **Create project**. Create the project first so it can appear in your project workspace and be available for project navigation.

- Use the sidebar labels to understand your current location. **1. Workspace Sidebar** refers to workspace-wide navigation, while **2. Project Sidebar** refers to navigation within the currently active project.

## Related Pages

- [Workspace Sidebar](#)
- [Project Sidebar](#)
- [Manage Projects](#)
- [Create a New Project](#)
- [Use Project Dashboard](#)
- [Search Across Projects](#)
- [User Guides](#)
- [User Manuals](#)

## Troubleshooting

### You cannot find the project you need

Use **Search projects...** from the **Projects** screen and enter part of the project name. If you still cannot find it, use **Search across all projects...** to search more broadly. If the project is not available, you may not have access to it or it may not have been created yet.

### The dashboard opens for the wrong project

Select **← Back to Projects** to return to the project list. Then select the correct project before opening **Quick Start**, choosing **Actions**, and selecting **Open Project Dashboard**.

### You do not see an option to open a project dashboard

First confirm that you have selected an active project rather than remaining in the general **Workspace** view. The **Open Project Dashboard** action is used from the focused project context.

<!-- source: access-recent-project-documents.md -->

# Access Recent Project Documents

Recent Documents helps you quickly return to project documentation you opened recently, without navigating through the full project structure again. Use it when you need to resume reading, compare information, or move between several project documents during your workday.

## Overview

When you work across multiple projects and documentation areas, finding the same page repeatedly can interrupt your workflow. Recent Documents keeps your recently opened documentation within reach so that you can return to it from your workspace instead of starting again from the Projects list.

This feature is especially useful after you have opened documentation from a project’s **Documents** area, including **User Guides** and other available documentation. Rather than using **&larr; Back to Projects**, searching for the project again, and reopening the document, you can select it from your recent list.

Recent Documents reflects documents that you have opened. If you have not opened a document yet, there may be no items to return to. Open the documentation you need first, then use the workspace navigation to return to it later.

> 📷 _Screenshot pending: Recent Documents area in the workspace, showing documentation items that were opened recently._

## Prerequisites

Before you begin, make sure that:

- You can access the **Projects** workspace.
- You have access to at least one project.
- You have opened one or more project documentation pages.
- The project and its documentation are still available to you.
- You know whether you need documentation from the workspace level or from a specific active project.

## Step-by-Step Instructions

1. Open the workspace and select **Projects**.

   Use **Projects** to view the projects available to you. If you are already working in a project, use **&larr; Back to Projects** when you need to return to the complete project list.

2. Locate the project whose documentation you want to open.

   You can use **Search projects...** to narrow the list when you know the project name. If your workspace provides a wider search option, **Search across all projects...** can help you find content across projects.

   > 📷 _Screenshot pending: Projects workspace with the “Search projects...” field and project list._

3. Open the project.

   Select **Open Project Dashboard** for the project you need. The dashboard becomes your focused project workspace.

4. Go to the project’s documentation.

   In the project navigation, select **Documents**. Depending on the documentation you need, select **User Guides** or another available documentation area.

5. Open a document.

   Select the documentation item you want to read. After you open it, it becomes available as a recently opened document for quick return later.

6. Return to the workspace navigation.

   When you need to reopen the document later, use the workspace sidebar or project sidebar to locate **Recent Documents**. Select the document name from the recent list.

7. Confirm that the correct document opens.

   Check the document title and the active project context before continuing. If you opened a similarly named document from another project, return to **Projects** and choose the correct project before reopening its documentation.

8. Use Recent Documents to switch between active work.

   Repeat the process for other recently opened documents. This is useful when you are reviewing a project’s **User Guides**, comparing documentation between projects, or moving between project work and workspace-level navigation.

## Tips and Best Practices

- Open the documents you expect to revisit before starting a review session. Recent Documents is most helpful after you have established your working set of documentation.

- Use **Search projects...** when you need to find a specific project first. This reduces the chance of opening a document from the wrong project.

- Use **Search across all projects...** when you do not know which project contains the document. Once you open the correct document, you can use Recent Documents to return to it more quickly.

- Confirm the active project before acting on documentation content. Projects can contain similarly named documents, so the project context matters as much as the document title.

- Use **&larr; Back to Projects** when your recent list does not contain the document you need. Recent Documents is for returning to items you opened; it is not a replacement for browsing all project documentation.

- Keep project access current. If a project is deleted or your access changes, its documents may no longer be available from the recent list.

## Related Pages

- [Navigate the Workspace Sidebar](#)
- [Use the Project Sidebar](#)
- [Find and Open Projects](#)
- [Access Project Documents](#)
- [Search Across Projects](#)
- [Open Project Dashboard](#)

## Troubleshooting

### A document does not appear in Recent Documents

**Problem:** You cannot find a document you expected to see in Recent Documents.

**Cause:** The document may not have been opened in your current workspace activity, or you may have opened a different document with a similar name.

**Solution:** Go to **Projects**, use **Search projects...** to locate the correct project, select **Open Project Dashboard**, and open the item from **Documents** or **User Guides**. Then return to the workspace sidebar and check Recent Documents again.

### The recent document opens for the wrong project

**Problem:** You selected a recent item, but the content is not from the project you intended to review.

**Cause:** Multiple projects can contain similarly named documentation, and a recent item represents the document you opened previously.

**Solution:** Verify the active project context. If it is incorrect, select **&larr; Back to Projects**, locate the intended project, select **Open Project Dashboard**, and open the correct item from **Documents**. Use the recent list only after confirming the project and document title.

### A recent document is no longer available

**Problem:** A document you previously opened cannot be accessed from Recent Documents.

**Cause:** The project may have been removed, the document may no longer be available, or your project access may have changed.

**Solution:** Return to **Projects** and search for the project using **Search projects...**. If the project is not listed or you cannot open its dashboard, contact your workspace administrator to confirm your access. If the project is available, open **Documents** and check whether the document has been moved or replaced.

<!-- source: access-a-project-by-id.md -->

# Access a Project by ID

You can use a project identifier in a project link to open a specific Atloria project directly. This is useful when a teammate shares a project URL with you or when you need to return to a known project without searching through the full project list.

## Overview

Atloria organizes work into projects that you can access from the **Projects** area. From there, you can search available projects, select a project, and use **Open Project Dashboard** to enter its workspace.

A project ID is used as part of a project’s direct link. When you open a link that includes a project identifier, Atloria takes you to the corresponding project area if the project exists and you have access. This makes project links practical for sharing a specific project with colleagues, bookmarks, and references in internal documentation.

The project link identifies the project, but it does not override access controls. If you receive a project link from another person, you must still be permitted to view that project before you can use its dashboard or related content.

> 📷 _Screenshot pending: The Projects area showing the “Search projects...” field and available project entries._

## Prerequisites

Before you begin, make sure that you have:

- An Atloria account that can sign in to the relevant workspace.
- Permission to access the project you want to open.
- A project link or project identifier supplied by a teammate, project owner, or internal reference.
- A supported web browser with access to your Atloria environment.
- The project’s current link if you are opening it from a bookmark or shared message.

## Step-by-Step Instructions

1. Sign in to Atloria using your organization’s normal sign-in method.

2. Open the workspace where the project is located.

3. Select **Projects** from the workspace navigation.

4. Review the project list to locate projects that are available to you.

5. Enter a project name or identifying text in the **Search projects...** field if you need to narrow the list.

6. Select the project entry that matches the project you need to access.

7. Click **Open Project Dashboard** to open the selected project.

8. Use **← Back to Projects** when you need to leave the current project and return to the project list.

9. Open a shared project link directly in your browser when another user provides one.

10. Confirm that the opened page displays the expected project context before you begin working.

> 📷 _Screenshot pending: A selected project with the “Open Project Dashboard” action visible._

### Open a Project from a Shared Identifier

1. Copy the complete project link provided by the person sharing the project.

2. Paste the complete link into your browser’s address bar.

3. Press Enter to open the project.

4. Sign in if Atloria prompts you to authenticate.

5. Verify that the project page opens and that the project content is the one you expected.

6. Use the project’s visible navigation to move between its available sections.

7. Return to **Projects** if you need to open a different project.

A shared link may also point to a specific audience or document within a project. In that case, opening the link takes you directly to that shared location instead of only opening the general project area.

## Tips and Best Practices

- Share the complete project link rather than only copying part of the identifier. A complete link preserves the project destination and may also retain the intended audience or document location.

- Use **Search projects...** when you know the project name but do not have a direct link. This is usually faster and reduces the chance of opening a similarly named project.

- Confirm the active project before making changes. When you work across multiple projects, use **← Back to Projects** to switch deliberately instead of relying on browser tabs alone.

- Use **Open Project Dashboard** after selecting a project from the list. This action provides a clear transition from the all-projects view to the focused project workspace.

- Treat project links as access references, not as permission grants. A link can identify where a project is located, but you still need the appropriate workspace and project access.

- Keep bookmarks current. If a project is renamed, reorganized, or access settings change, an older bookmark may no longer take you to the location you expect.

- Be careful when sharing project links outside your team. Send links only to people who should know that the project exists and who are expected to have access.

> 📷 _Screenshot pending: The focused project view, including the “← Back to Projects” navigation option._

## Related Pages

- [Browse Projects](#) — Learn how to use the **Projects** area and **Search projects...** field.
- [Open the Project Dashboard](#) — Learn what you can do after selecting **Open Project Dashboard**.
- [Create a New Project](#) — Use **New Project** and **Create project** to start a project.
- [Manage Project Actions](#) — Learn about options available from **Actions**, including **Delete Project**.
- [Share Project Content](#) — Learn how project, audience, and document links can be used for collaboration.

## Troubleshooting

### The shared project link does not open the expected project

Make sure you copied the entire link, including all text after the project identifier. Ask the sender to resend the link if it was truncated by a chat tool, email client, or document.

### You can open Atloria but cannot access the linked project

Your account may not have permission for that project or its workspace. Return to **Projects** and check whether the project appears in your available list. If it does not, ask the project owner or workspace administrator to confirm your access.

### You cannot find the project in the project list

Use **Search projects...** with the project’s known name. If search does not return the project, verify that you are in the correct workspace and that the project has not been deleted or renamed. If necessary, request an updated project link from the person who shared it.

<!-- source: navigate-to-a-project-by-slug.md -->

# Navigate to a Project by Slug

A project slug is the project-specific part of an Atloria link. It helps Atloria open the correct project workspace, and it also provides the starting point for project-level User Guides and individual documents.

## Overview

Atloria uses a project slug to identify which project you are viewing. In a project URL, the slug appears immediately after the project portion of the address. The placeholder `[slugId]` means “the slug for the project you want to open”; you do not type the square brackets when using a real link.

For example, a project link opens the project dashboard first. From that project location, Atloria can also open more specific content, such as a User Guide audience or an individual document. This structure keeps content grouped under the correct project.

Use project navigation by slug when a colleague shares a direct project link, when you bookmark a project, or when you need to confirm that you are working in the intended project before opening its documentation.

> 📷 _Screenshot pending: A browser showing an Atloria project link with the project-specific slug highlighted._

## Prerequisites

Before you begin, make sure you have:

- Access to Atloria.
- Permission to view the project you want to open.
- The project’s direct link or its slug from a colleague, bookmark, or approved workspace reference.
- An active Atloria session if the project requires you to sign in.
- The project name available if you plan to locate it through **Projects** instead of using a direct link.

## Step-by-Step Instructions

### Open a project from a direct link

1. Copy the Atloria project link that contains the project slug.

2. Paste the project link into your browser’s address bar.

3. Press **Enter** to open the project.

4. Confirm that the project dashboard opens for the intended project.

5. Select **User Guides** if you want to view documentation associated with that project.

> 📷 _Screenshot pending: The project dashboard with the User Guides option visible after opening a project by its slug._

### Open a project from the Atloria workspace

1. Select **Workspace** to return to your workspace area.

2. Select **Projects** to view available projects.

3. Enter the project name in **Search projects...**.

4. Select the matching project from the results.

5. Select **Actions** for the selected project.

6. Select **Open Project Dashboard**.

7. Verify that the dashboard belongs to the project you intended to open.

8. Select **&larr; Back to Projects** when you need to return to the project list.

### Use the project slug to open more specific content

1. Open the project link that contains the project slug.

2. Select **User Guides** to move from the project dashboard to its documentation area.

3. Select the audience or documentation section you need.

4. Select the individual document you want to read.

The project slug remains the project identifier as you move deeper into project content. A project-level link opens the main project area, while more detailed links can open a specific audience and then a specific document within that same project.

## Tips and Best Practices

- Treat the project slug as part of the project’s identity in Atloria. If two project names are similar, use the shared direct link to avoid opening the wrong project.

- Do not type `[slugId]` literally into a link. The brackets indicate a variable project value in URL examples. A real project link contains the project’s actual slug in that position.

- Bookmark direct project links that you use frequently. This can be faster than searching through **Projects**, especially when you regularly work in one focused project.

- Start at the project dashboard when you are unsure where a shared document belongs. From there, select **User Guides** to stay within the documentation for that project.

- Use **Search projects...** when you know the project name but do not have its direct link. Use the broader **Search across all projects...** option when you need to search beyond the current project list or context.

- Check the active project before you create or manage content. The workspace can show an **Active Project** and provide **New Project** options, so confirming the current project helps prevent work from being placed in the wrong location.

- Be careful with project-level actions. **Delete Project** is a project action, not a navigation option. Use **Open Project Dashboard** when your goal is simply to view or work in a project.

## Related Pages

- [Find a Project from the Workspace](#)
- [Use the Projects List](#)
- [Open the Project Dashboard](#)
- [Browse User Guides in a Project](#)
- [Search Across All Projects](#)
- [Create a New Project](#)

## Troubleshooting

### The project link does not open the expected project

Check that the link includes the correct project slug. If the link was copied manually, request a new direct link from the project owner or open **Projects** and use **Search projects...** to locate the project by name.

### You can open Atloria but cannot find the project

Select **Projects** and search using **Search projects...**. If the project still does not appear, you may not have access to it, or the project name may differ from the name you were given. Contact the project owner or workspace administrator for confirmation.

### A shared link opens the project but not the intended document

Open the project dashboard first, then select **User Guides** and navigate to the needed audience or document. A project link identifies the project; more specific links are needed to open a particular document directly.

<!-- source: start-a-project-source-analysis.md -->

# Start a Project Source Analysis

You can start a source analysis from a project workspace to prepare a connected codebase for documentation work. The analysis organizes the project’s source information so you can review relevant application areas before creating or updating documentation.

## Overview

Source analysis helps Atloria examine the connected project source and identify the parts that are useful for documentation. This can include user-interface areas, backend services, data-related elements, API definitions, configuration, documentation files, and infrastructure-related content.

Use this process when you have added a project and want Atloria to build context from its source before you work on technical documentation, user manuals, version reviews, or change documentation. Starting from the project workspace keeps the analysis associated with the correct project.

As analysis progresses, Atloria may process source content by category. Categories can include **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**. A completed analysis can finish successfully with no errors, or it can complete with warnings that you should review before relying on the results.

> 📷 _Screenshot pending: The Projects hub showing the project search field and available projects._

## Prerequisites

Before you start, make sure you have the following:

- Access to Atloria and permission to open the relevant project.
- A project that is already available in the **Projects** area.
- A connected project source or codebase associated with that project.
- The correct project selected, especially if you manage multiple projects.
- Time for source processing to complete before you begin documentation work.
- Access to the project’s **Source** area from the project sidebar.

## Step-by-Step Instructions

1. Open **Projects** from the Atloria application.

2. Use the **Search projects...** field if you need to locate a specific project.

3. Select the project whose source you want to analyze.

4. Confirm that you are in the focused project workspace rather than the all-projects hub.

5. Select **Source** in the project sidebar.

> 📷 _Screenshot pending: A focused project workspace with the Source item visible in the project sidebar._

6. Review the source information displayed for the connected project.

7. Start the available source analysis action in the **Source** area.

8. Wait while Atloria processes the project source.

9. Review the displayed processing status when the analysis finishes.

10. Continue to the project’s documentation area after the analysis reports completion.

If you need to leave the project workspace, select **← Back to Projects** to return to the project list. You can then select another project and repeat the process for its connected source.

## Tips and Best Practices

- Analyze one project at a time. This helps ensure that the documentation context you review belongs to the correct source and product area.

- Start analysis before generating or reviewing technical documentation. Source context is most useful when it is prepared before you open the project’s documentation workspace.

- Use the project sidebar to stay within the same project. After selecting **Source**, you can move to related project areas—such as analytics, versions, changes, or technical documentation—without switching projects.

- Allow the analysis to finish before treating its results as complete. A successful result indicates that processing completed with no errors. A completed result with warnings means the analysis finished, but some source details may need attention.

- Review the analysis broadly. Atloria can organize information across frontend, backend, database, API schema, configuration, documentation, and infrastructure categories. Do not assume that documentation-relevant behavior exists only in the frontend.

- Use source analysis as preparation, not as a substitute for review. When documenting a user workflow, confirm the visible labels, screens, and lifecycle behavior in the relevant project information before publishing documentation.

- If your project is hosted through a supported source provider, make sure the project connection is current before starting. Atloria presents supported source-provider options during project connection, including GitHub, GitLab, and Bitbucket.

## Related Pages

- [Manage Projects](#)
- [Connect a Project Source](#)
- [Use the Project Sidebar](#)
- [Review Project Changes](#)
- [Review Project Versions](#)
- [Create Technical Documentation](#)
- [View Project Analytics](#)

## Troubleshooting

### The project does not appear in Projects

1. Open **Projects**.

2. Enter part of the project name in **Search projects...**.

3. Confirm that you have access to the project.

4. If the project still does not appear, verify that the project has been added to Atloria and that you are using the correct account or workspace.

### You cannot find the Source area

1. Open the relevant project from **Projects**.

2. Confirm that you are in the focused project workspace.

3. Look for **Source** in the project sidebar.

4. If **Source** is unavailable, confirm that the project has a connected source and that your access level permits you to view it.

### The analysis completes with warnings

1. Wait until the displayed status shows that processing has completed.

2. Review the warning information available in the project’s source results.

3. Check that the connected source is complete and current.

4. Use the completed analysis carefully, and verify affected documentation details before publishing them.

<!-- source: monitor-source-analysis-progress.md -->

# Monitor Source Analysis Progress

Use the project’s progress view to check whether Atloria has finished analyzing your source and to review the project information detected during analysis. Monitoring this status helps you know when the project is ready for review and when follow-up may be needed.

## Overview

After you add or open a project, Atloria analyzes its source to identify project information and prepare it for downstream work, such as reviewing changes, comparing versions, viewing screenshots, and using technical documentation.

You can monitor this work from the project area. Select **View Progress** when it is available, then use the displayed **Status** to determine whether analysis is waiting, running, complete, partially complete, skipped, or unsuccessful.

Analysis status is especially important before you rely on detected source information. A successful result indicates that processing completed without errors. A partial result means Atloria completed the analysis but reported warnings, so you should review the detected information before treating it as complete.

> 📷 _Screenshot pending: The project progress view showing the Status indicator and analysis results._

### Analysis status reference

| Status | What it means | What you should do |
|---|---|---|
| **QUEUED** | Analysis is waiting to begin. | Keep the project open or return later and check **View Progress** again. |
| **IN PROGRESS** | Atloria is currently analyzing the project source. | Wait for processing to finish. Avoid assuming detected information is final while this status is shown. |
| **SUCCESS** | Analysis completed successfully with no errors. | Review the detected project information and continue to the relevant project workspace. |
| **PARTIAL** | Analysis completed with warnings. Some information may be incomplete. | Review the available results carefully and identify whether the missing or incomplete information affects your next task. |
| **FAILED** | Analysis did not complete successfully. | Review the project setup and try the analysis again if that option is available. Contact your administrator or support team if the issue persists. |
| **SKIPPED** | Analysis was not performed. | Confirm whether analysis is required for the task you want to complete, then restart or request analysis as appropriate. |

### Key terms

<dl>
  <dt><strong>Source analysis</strong></dt>
  <dd>The process Atloria uses to inspect your project source and identify project information for use throughout the project workspace.</dd>

  <dt><strong>Detected project information</strong></dt>
  <dd>Information Atloria identifies from the analyzed source, such as the project’s available source-related context and items prepared for review.</dd>

  <dt><strong>Project workspace</strong></dt>
  <dd>The focused area for one project, where you can access project actions, changes, versions, analytics, screenshots, and technical documentation.</dd>
</dl>

## Prerequisites

Before monitoring source analysis progress, make sure you have:

- Access to the **Projects** area.
- A project that has been added or opened in Atloria.
- Permission to view the selected project.
- A project selected from the project list, using **Search projects...** if needed.
- Enough time for analysis to complete if the project shows **QUEUED** or **IN PROGRESS**.

If you manage multiple projects, use **Search across all projects...** from the broader project hub to locate the correct project before opening its focused workspace.

## Step-by-Step Instructions

1. **Open the Projects area.**

   Select **Projects** to view the projects you can access. If you are already inside a project and need to choose another one, select **← Back to Projects**.

   > 📷 _Screenshot pending: The Projects list with Search projects... and a selected project._

2. **Find and open the project.**

   Use **Search projects...** to narrow the visible project list. If you are working from the all-projects hub, use **Search across all projects...** instead.

   Select the project you want to monitor. This opens the focused project area, identified in the project navigation as **1. Active Project** or **2. Focused Project**.

3. **Open progress monitoring.**

   Select **View Progress**. Atloria displays the current analysis state for the selected project.

   Look for the **Status** label. The value beside or below it tells you whether the analysis is queued, in progress, successful, partial, failed, or skipped.

4. **Interpret the displayed status.**

   Use the following guidance:

   - If you see **QUEUED**, analysis has not started yet. Check back after a short time.
   - If you see **IN PROGRESS**, Atloria is still processing the source. Wait until the status changes before relying on the detected information.
   - If you see **SUCCESS**, analysis is ready for use.
   - If you see **PARTIAL**, review the results because warnings may have affected the completeness of the detected information.
   - If you see **FAILED** or **SKIPPED**, do not assume the project has complete source context.

5. **Review the detected information after processing completes.**

   When the status is **SUCCESS** or **PARTIAL**, review the project information made available by the analysis. Use the project navigation to continue to the area relevant to your work:

   | If you want to… | Select… |
   |---|---|
   | Review project changes | **Source** or the project’s changes area |
   | Compare or inspect project versions | The versions area |
   | Review visual captures | The screenshots area |
   | Read generated technical material | **User Docs** or the technical documentation area |
   | Return to the main project landing area | **Open Project Dashboard** |

6. **Return to the project list when finished.**

   Select **← Back to Projects** to monitor another project. You can then search for and open a different project without losing your place in the project list.

## Tips and Best Practices

- **Wait for a final status before reviewing results.** Information can change while the status is **IN PROGRESS**. Use detected information for decisions only after the status reaches **SUCCESS** or, with additional review, **PARTIAL**.

- **Treat PARTIAL as a completed result with warnings.** A partial analysis is not the same as a failed analysis. You can often continue working, but verify that the detected project information is sufficient for your task.

- **Use the project-specific progress view.** When working with several projects, always confirm that you opened the correct focused project before checking **Status**.

- **Use search to reduce mistakes.** Enter a distinctive project name in **Search projects...** or **Search across all projects...** rather than selecting a similarly named project from the list.

- **Review related project areas after a successful analysis.** Analysis prepares source context that can support work in changes, versions, screenshots, analytics, and technical documentation. Open the area that matches your next task rather than treating progress monitoring as the final step.

## Related Pages

- [Manage Projects](#)
- [Review Source Changes](#)
- [Compare Project Versions](#)
- [Review Project Screenshots](#)
- [Use Technical Documentation](#)
- [View Project Analytics](#)

## Troubleshooting

| Issue | Likely cause | Resolution |
|---|---|---|
| **Status remains QUEUED** | Analysis is waiting to start. | Wait and reopen **View Progress** to check for an updated status. If the status does not change for an extended period, contact your administrator or support team. |
| **Status shows IN PROGRESS for longer than expected** | The project is still being processed or requires additional time. | Wait for a final status, then refresh or revisit the project’s **View Progress** screen. Do not rely on incomplete results while processing is active. |
| **Status shows PARTIAL** | Analysis completed with warnings. | Review the detected project information and continue only if it supports your task. If critical information is missing, ask your administrator or support team to investigate the project analysis. |
| **Status shows FAILED or SKIPPED** | Analysis did not run or could not complete. | Confirm that you opened the intended project and review the project setup. If you cannot restart analysis from your workspace, contact your administrator or support team. |

<!-- source: use-analyzed-source-context.md -->

# Use Analyzed Source Context

This page explains how to use source analysis results to create more accurate Technical Docs in Atloria. Reviewing the analyzed context before you generate or edit documentation helps you describe the right product surfaces, relationships, and user flows.

## Overview

Source analysis gives you a structured view of the application materials that Atloria has identified. Use this context when you need to understand what documentation should cover before you begin writing. It is especially useful when a project contains multiple product areas, shared components, services, or documentation types.

When you create Technical Docs, use the analyzed source context to confirm the scope of the material. For example, analysis can group findings by categories such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. It can also identify relationships, such as one component rendering another component or a service calling an API.

You should use the source context before selecting **Generate Documentation →** or editing generated content. This helps you avoid documenting assumptions, omitting dependent areas, or mixing user-facing instructions with implementation-focused Technical Docs.

> 📷 _Screenshot pending: The Technical Docs area with options to review analyzed source context before generating documentation._

## Prerequisites

Before you start, make sure you have:

- Access to the relevant Atloria project.
- A completed or available source analysis for the project.
- Permission to view **Technical Docs** and source-related information.
- A clear documentation goal, such as documenting a product surface, a user flow, or a set of related entities.
- An understanding of whether your content belongs in **User Docs** or **Technical Docs**.
- Any existing documentation you want to compare against or import using **Or import existing documentation**.

## Step-by-Step Instructions

1. Open the project that contains the source analysis you want to use.

2. Select **Technical Docs** from the project documentation options.

3. Select **View Source** to review the source material associated with the project.

4. Select **Source** if you need to focus on the analyzed source context rather than generated documentation content.

5. Review the available analysis findings to identify the product area you need to document.

6. Check the analysis categories to understand where the selected area belongs in the project, such as frontend, backend, database, API schema, configuration, documentation, or infrastructure.

7. Review the identified entities to determine the type of item you are documenting, such as a component, hook, page, layout, route, context, provider, store, controller, service, repository, or middleware.

8. Review relationship findings to understand how the selected item connects to other items, such as **RENDERS**, **USES HOOK**, **USES CONTEXT**, **PROVIDES CONTEXT**, **CALLS API**, **IMPLEMENTS API**, **DEPENDS ON**, or **USES SERVICE**.

9. Select the relevant item or area in the source context to narrow the scope of your documentation.

10. Return to **Technical Docs** after you have identified the relevant context.

11. Select **Generate Documentation →** when you are ready to create documentation based on the reviewed context.

12. Review the generated documentation for alignment with the source analysis before you publish, export, or share it.

13. Select **Export Documentation** if you need to provide the completed documentation outside Atloria.

> 📷 _Screenshot pending: The View Source area showing analyzed categories, entities, and relationships used to prepare Technical Docs._

## Tips and Best Practices

- Use the source analysis to define the documentation boundary before generating content. If the analysis shows a frontend component that calls an API and depends on a service, decide whether your document should cover only the component or the complete flow.

- Follow the analysis organization when planning your content. Analysis may progress through categories such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. Use this progression to identify related areas that may need cross-references.

- Treat relationships as context, not as a substitute for a documentation purpose. For example, a **CALLS API** relationship can explain why two areas are connected, but your documentation should still focus on the user’s intended task or the technical topic you selected.

- Keep documentation types separate. Use **Technical Docs** for implementation-oriented information and **User Docs** or **📋 User Manuals** for instructions that explain what end users see and do. This prevents the dual-documentation-type issue of placing user-manual content beside technical material without a clear distinction.

- Use **View Source** when generated content seems too broad, incomplete, or unrelated to your intended topic. Confirm the selected entities and relationships before generating again.

- If you already have material to preserve, select **Or import existing documentation** before generating new content. This can help you compare existing coverage with what the analysis identifies.

## Related Pages

- [Generate Technical Documentation](#)
- [View Source Analysis Results](#)
- [Use User Docs and Technical Docs](#)
- [Import Existing Documentation](#)
- [Export Documentation](#)
- [Create User Guides](#)

## Troubleshooting

### You cannot find the area you need in the source context

Select **View Source** again and review adjacent categories or related entities. The item you need may be represented as a related component, service, route, or context rather than as the product surface name you expected.

### Generated documentation covers the wrong topic

Return to **Source** and narrow your review to the specific entities and relationships relevant to your documentation goal. Then select **Generate Documentation →** again after confirming the correct context.

### You are unsure whether to use User Docs or Technical Docs

Use **User Docs**, **📋 User Manuals**, or **User Guides** when you are writing instructions for people using the product. Use **Technical Docs** when the material needs to explain analyzed structure, relationships, or technical behavior.

<!-- source: understand-source-analysis-parsing.md -->

# Understand Source Analysis Parsing

Source analysis parsing prepares your Atloria project for product intelligence and user documentation. It examines the project source, organizes what it finds into meaningful categories, and identifies how application elements relate to one another.

## Overview

When you add or maintain a project in Atloria, source analysis helps turn a collection of source files into understandable product context. Rather than treating every file as isolated, the parsing process identifies application elements such as components, pages, routes, services, repositories, hooks, stores, controllers, and middleware.

The parser also organizes findings by category. These categories include **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**. This organization helps you understand which parts of a project have been analyzed and makes it easier to focus on the area most relevant to your documentation or product-intelligence work.

In addition to identifying elements, source analysis records relationships between them. For example, a component may **RENDERS** another component, **USES HOOK**, **USES CONTEXT**, **CALLS API**, or **USES SERVICE**. These relationships provide the context needed to explain how a user-facing workflow is supported across different areas of your project.

> 📷 _Screenshot pending: Project Source area showing source analysis options and parsed project context._

## Prerequisites

Before you begin source analysis parsing, make sure you have the following:

- Access to the appropriate Atloria project from **Projects** or **1. Hub: All Projects**.
- A project whose source is available for analysis.
- Permission to view project source and configuration information.
- A clear understanding of the project area you want to investigate, such as frontend behavior, backend services, database access, or API behavior.
- Access to **Source** and, when configuration changes are needed, **2. Parser Settings**.
- A reason to refresh or review analysis, such as newly added features, changed integrations, updated API behavior, or documentation that needs current context.

## Step-by-Step Instructions

1. **Open the project from the project hub.**

   Start from **Projects** or select **1. Hub: All Projects**. Use **Search projects...** if you need to locate a specific project quickly.

   Select the project you want to analyze. If you are returning from another project area, use **← Back to Projects** or **&larr; Back to Projects** to return to the project list.

2. **Go to the project’s source area.**

   In the selected project, choose **Source**. This is the area where you review the project’s source-based context and prepare it for product intelligence and documentation work.

   Source analysis is especially useful before you create or revise content in **User Guides**, because it provides evidence about the application structure and the connections between features.

3. **Review parser configuration when needed.**

   Select **2. Parser Settings** when you need to review the settings that control how source analysis is prepared for the project.

   Use this area before relying on a new or refreshed analysis result. Parser settings matter because they determine the context Atloria uses when organizing source findings. If your project has changed substantially—for example, if it now includes a new API, database layer, or frontend application—review the settings before continuing.

   > 📷 _Screenshot pending: Parser Settings screen for reviewing source analysis preparation for a project._

4. **Run or review source analysis for the project.**

   Start the project’s source analysis from the available source-analysis controls in the **Source** area. Atloria coordinates the parsing work across the project rather than limiting the review to one type of source.

   As parsing proceeds, Atloria classifies findings into categories such as:

   - **FRONTEND** for user-facing application elements
   - **BACKEND** for server-side capabilities
   - **DATABASE** for data access and data-model-related elements
   - **API SCHEMA** for API definitions and contracts
   - **CONFIG** for configuration-related information
   - **DOCUMENTATION** for documentation-related source context
   - **INFRASTRUCTURE** for deployment and supporting-platform context

   These categories help you interpret the scope of the analysis. For example, a change to a visible product screen may involve both **FRONTEND** findings and related **BACKEND** or **API SCHEMA** findings.

5. **Use entity findings to understand the application structure.**

   Review the entities identified by the analysis. Depending on your project, Atloria can recognize items such as **COMPONENT**, **HOOK**, **PAGE**, **LAYOUT**, **ROUTE**, **CONTEXT**, **PROVIDER**, **STORE**, **CONTROLLER**, **SERVICE**, **REPOSITORY**, and **MIDDLEWARE**.

   Treat these findings as a map of the product’s structure. For user-facing documentation, start with pages, layouts, routes, and components. Then follow related hooks, contexts, stores, and services when you need to understand why a screen behaves in a particular way.

6. **Follow relationships to build feature context.**

   Review the relationships shown for parsed entities. Relationships can indicate that one item **RENDSERS** another item, **USES HOOK**, **USES CONTEXT**, **PROVIDES CONTEXT**, **USES STORE**, **DISPATCHES ACTION**, **CALLS API**, **IMPLEMENTS API**, **DEPENDS ON**, **USES SERVICE**, **INJECTS**, or **QUERIES MODEL**.

   Use these connections to trace a feature beyond the initial screen or page. For example, a visible component may render another component, use a hook for its behavior, and call an API through a service. This broader context is valuable when you need to distinguish a simple display change from a change that affects data, permissions, or workflow behavior.

7. **Use the parsed context when creating user documentation.**

   After reviewing the source analysis, go to **User Guides** or **📋 User Manuals** to create or update user-facing content. Use the analysis to confirm feature names, workflow dependencies, and the likely impact of a change.

   If you need to locate existing material, use **Search documents, categories, projects...**. Search helps you check whether related documentation already exists before you create a new guide.

## Tips and Best Practices

- **Start with the user-facing layer.** For a manual or user guide, begin with **PAGE**, **LAYOUT**, and **COMPONENT** findings. Then use relationships such as **CALLS API** or **USES SERVICE** only when they help explain visible behavior.

- **Do not assume a frontend change is isolated.** A visible component can depend on a hook, context, store, service, API, or database query. Review its relationships before documenting what a change means for users.

- **Use categories to narrow your review.** If you are documenting a screen interaction, focus first on **FRONTEND**. If the interaction involves saved data or an integration, expand your review to **BACKEND**, **DATABASE**, and **API SCHEMA**.

- **Review parser settings after major project changes.** New application areas, services, APIs, or configuration can affect the completeness and usefulness of your source context.

- **Use analysis as evidence, not as user-facing wording.** Parsed entity and relationship names describe project structure. In user documentation, translate that structure into what users see and do on screen.

- **Keep related documentation aligned.** When source analysis reveals that one feature depends on another, check linked guides so that instructions remain consistent across the product.

## Related Pages

- [Manage Projects](#)
- [Configure Parser Settings](#)
- [Review Project Source](#)
- [Create User Guides](#)
- [Use Product Intelligence](#)
- [Search Projects and Documentation](#)

## Troubleshooting

### I cannot find the project I need to analyze

Return to **Projects** or **1. Hub: All Projects** and use **Search projects...**. Confirm that you have access to the correct project before looking for **Source** or **2. Parser Settings**.

### The analysis does not provide enough context for the feature I am documenting

Review related categories instead of looking only at the initial frontend finding. A user-facing feature may be connected to a service, API implementation, data query, or configuration item. Follow relationships such as **USES SERVICE**, **CALLS API**, and **QUERIES MODEL** to gather fuller context.

### The project has changed, but the analysis no longer reflects the current structure

Open **2. Parser Settings** and review the project’s analysis preparation. Then refresh or rerun source analysis from **Source** using the available controls. Recheck the affected categories and relationships before updating content in **User Guides**.

<!-- source: understand-source-discovery-processing.md -->

# Understand Source Discovery Processing

Source discovery processing examines your product source to identify the screens, product surfaces, and documentation entities that can support documentation generation. Understanding this process helps you verify that the right parts of your product are available before you create User Guides or User Manuals.

## Overview

When you use source-based documentation features, Atloria organizes what it finds into meaningful product information. This includes user-facing product surfaces, such as pages, layouts, and components, as well as supporting entities such as services, routes, contexts, stores, and data-related elements.

Discovery distinguishes between entity types so that documentation can be built with the right context. For example, a user-facing `COMPONENT`, `PAGE`, or `LAYOUT` can contribute to a description of what users see, while a `SERVICE`, `CONTROLLER`, or `REPOSITORY` can help establish how a feature is supported behind the scenes.

Atloria also identifies relationships between entities. These relationships can show that one component **RENDERS** another, a component **USES HOOK**, a screen **CALLS API**, or a service **QUERIES MODEL**. This information helps Atloria connect visible product behavior with the supporting documentation context.

> 📷 _Screenshot pending: Source discovery view showing product surfaces, discovered entities, and their relationships._

## Prerequisites

Before you begin, make sure you have:

- Access to the product workspace you want to document.
- Source material available for analysis or import.
- Permission to generate or manage documentation in the workspace.
- A clear understanding of whether you are creating **User Guides**, **User Manuals**, or another documentation type.
- Any existing documentation ready if you plan to use **Or import existing documentation** instead of generating documentation from discovered source context.

## Step-by-Step Instructions

1. Open the product workspace where you want to prepare documentation context.

2. Select **Product** to review the product-level documentation area.

3. Open **Source** to access source-based analysis and discovery information.

4. Review the discovered product surfaces to confirm that user-facing areas of the product are represented.

5. Use **Search entities…** to find a specific discovered entity by name.

6. Select a result from **Search entities…** to review the entity’s available context.

7. Check the entity type to understand its role in the product structure.

8. Confirm whether the entity is a user-facing item, such as a `COMPONENT`, `PAGE`, or `LAYOUT`.

9. Confirm whether the entity is a supporting item, such as a `SERVICE`, `CONTROLLER`, `REPOSITORY`, `CONTEXT`, or `STORE`.

10. Review the entity relationships to understand how the selected item connects to other discovered items.

11. Look for relationships such as **RENDERS** when you need to understand which visible elements appear within another component or page.

12. Look for **USES HOOK**, **USES CONTEXT**, or **USES STORE** when you need to understand how a screen obtains its behavior or state.

13. Look for **CALLS API**, **IMPLEMENTS API**, or **USES SERVICE** when you need to understand supporting product behavior.

14. Review documentation-related entities when you need to identify existing documentation context.

15. Select **View Source** when you need to compare the discovered entity with its available source representation.

16. Return to the documentation area after you have confirmed the relevant product surfaces and entities.

17. Select **📋 User Manuals** when you are preparing end-user documentation.

18. Select **User Guides** when you are preparing guided documentation for product users.

19. Select **Generate Documentation →** after you have confirmed that the relevant source context is available.

> 📷 _Screenshot pending: The Source area with the “Search entities…” field and a list of discovered product entities._

## Tips and Best Practices

- Start with user-facing entities. For an enterprise user manual, prioritize discovered `PAGE`, `LAYOUT`, and `COMPONENT` entities because these are most likely to represent screens and visible product surfaces.

- Use relationship information to confirm context rather than treating every discovered item as a separate user task. For example, an entity with a **RENDERS** relationship may be part of a larger screen rather than a standalone destination for users.

- Search by familiar product names. Use **Search entities…** to locate recognizable screen, feature, or service names. This is especially useful in large products with many discovered entities.

- Review supporting entities when a visible surface needs clarification. A `SERVICE` or `CONTROLLER` may not appear in a user manual, but its relationships can help identify the purpose of a visible screen or action.

- Keep documentation types distinct. Use **📋 User Manuals** and **User Guides** for end-user content. If your workspace supports multiple documentation styles, make sure you select the type that matches your audience before choosing **Generate Documentation →**.

- Import existing content when appropriate. Select **Or import existing documentation** if your team already has approved material that should be used alongside discovered product context.

- Treat discovery as context preparation. Discovery helps Atloria identify what your product contains; you should still review generated documentation to ensure that terminology, navigation, and instructions match what users actually see.

> 📷 _Screenshot pending: Documentation area showing “📋 User Manuals,” “User Guides,” “Or import existing documentation,” and “Generate Documentation →”._

## Related Pages

- [Create User Manuals](#)  
- [Generate Documentation](#)  
- [Import Existing Documentation](#)  
- [Review Product Surfaces](#)  
- [Search and Review Entities](#)  
- [Export Documentation](#)  

## Troubleshooting

### I cannot find the product surface I expected

Use **Search entities…** with the screen name, feature name, or a related term. If no relevant result appears, verify that the correct product workspace and source context are selected before generating documentation.

### I found an entity, but it does not look like a screen

Check its entity type and relationships. Items such as `SERVICE`, `REPOSITORY`, `CONTEXT`, and `STORE` are supporting entities rather than user-facing surfaces. Look for connected `PAGE`, `LAYOUT`, or `COMPONENT` entities to find the visible product area.

### The generated documentation does not focus on the right user experience

Before selecting **Generate Documentation →**, review the discovered product surfaces and their related entities. Prioritize the user-facing entities that represent the workflow you want to document, then generate content from that confirmed context.

<!-- source: analyze-a-full-stack-nextjs-and-nestjs-source.md -->

# Analyze a Full-Stack Next.js and NestJS Source

This page explains how to prepare and review a full-stack Next.js and NestJS source project in Atloria. Completing this review helps you confirm that Atloria has the context it needs before you create user-facing documentation or investigate product behavior.

## Overview

Atloria analyzes the source provided for a project and organizes its findings into a project-focused workspace. For a full-stack Next.js and NestJS application, this helps you understand how the user interface, server-side behavior, and shared product concepts relate to one another.

Use source analysis when you have added or selected a project and need to verify the available source context before documenting the product. This is especially useful when the product includes both frontend screens and backend services, because user-visible behavior can depend on the relationship between the two.

During analysis, Atloria can identify application structure and relationships, such as components that render other components, frontend hooks and contexts, state stores, API interactions, services, and data models. Treat this information as context for understanding the product—not as a substitute for checking the user experience in the running application.

When a parse completes successfully, the project’s source context is available for review. A successful parse may also complete with warnings. In that case, you can continue reviewing the available findings, while noting that some source details may require validation.

> 📷 _Screenshot pending: The Projects area showing a selected project and the Source action._

## Prerequisites

Before you begin, make sure that you have:

- Access to Atloria and permission to open the relevant project.
- A project containing the full-stack Next.js and NestJS source.
- Source that has been added or connected to the project.
- A clear product area or documentation goal to investigate.
- Enough time for the source parse to finish before relying on analysis results.
- A supported browser session in which you can access **Projects** and the project workspace.

## Step-by-Step Instructions

1. Select **Projects** to open the list of projects available to you.

2. Use **Search projects...** to locate the full-stack Next.js and NestJS project if it is not immediately visible.

3. Open the project you want to analyze from the project list.

4. Select **Open Project Dashboard** to enter the focused workspace for the selected project.

5. Select **Source** to open the project’s source-analysis area.

6. Select **View Source** to review the source context that Atloria has prepared for the project.

7. Confirm that the source analysis has completed successfully before using its findings for documentation work.

8. Review any warnings shown with the completed parse before assuming that every part of the project was analyzed.

9. Identify the frontend area relevant to your task, such as a page, screen component, or user-facing feature.

10. Identify the corresponding backend area when the feature depends on server-side data, actions, or business rules.

11. Follow the displayed relationship context to understand how the user-facing area connects to supporting application behavior.

12. Record the user-visible screens, actions, and outcomes that you need to validate in the running product.

13. Select **User Docs** when you are ready to use the prepared source context while working on user documentation.

14. Select **&larr; Back to Projects** when you need to leave the focused project and choose another project.

> 📷 _Screenshot pending: The Source area after analysis, including parse completion status and source relationship context._

## Tips and Best Practices

- Start from the user experience. Begin with the screen or workflow that users interact with, then use source analysis to understand supporting behavior. This keeps your documentation focused on what users see and do.

- Review both sides of a full-stack feature. In a Next.js and NestJS project, a frontend screen may depend on data or actions provided by the backend. Confirm the connection before documenting outcomes such as saved changes, loaded profile data, or status updates.

- Treat warnings as a review signal. A parse can complete successfully with warnings. You can use the available results, but validate important user-facing details in the product before publishing documentation.

- Use relationship context to trace behavior carefully. Atloria can surface chains involving rendered components, hooks, contexts, stores, actions, API calls, services, and models. Use these relationships to understand why a screen behaves as it does, but describe the final documentation in user language.

- Keep terminology consistent with the product. When you write the resulting guide, use labels that users see, such as **Projects**, **Source**, **View Source**, and **Open Project Dashboard**.

- Analyze only the scope you need. If you are documenting one feature, focus first on the relevant frontend screen and its supporting behavior. This makes validation faster and reduces unrelated findings.

## Related Pages

- [Manage Projects](#)
- [Open a Project Dashboard](#)
- [Review Source Context](#)
- [Create User Documentation from Product Evidence](#)
- [Validate Documentation Against the Running Product](#)

## Troubleshooting

### The project does not appear in the list

1. Select **Projects**.

2. Enter the project name in **Search projects...**.

3. Confirm that you have access to the project if it still does not appear.

### Source analysis has not completed

1. Return to the project dashboard.

2. Select **Source**.

3. Wait until the parse completion status indicates that the analysis has finished before relying on the source findings.

### The parse completed with warnings

1. Review the warning information shown with the completed parse.

2. Continue using the available source context for initial investigation.

3. Validate critical screens and user outcomes in the running application before finalizing documentation.

<!-- source: analyze-a-frontend-source.md -->

# Analyze a Frontend Source

Analyzing a frontend source helps you prepare accurate context before generating user documentation. You can use the source view and documentation generation actions to identify user-facing screens, components, relationships, and relevant product behavior.

## Overview

Frontend source analysis turns application interface code into documentation context. This context helps you understand which screens exist, which reusable interface elements they contain, and how users move between them. It is especially useful before you generate or regenerate User Guides, User Manuals, or other product documentation.

During analysis, Atloria identifies frontend entities such as components, pages, layouts, routes, contexts, providers, stores, and hooks. For a typical frontend review, you may see interface elements such as an avatar, user profile, loading indicator, statistics card, editor, source view, language selector, or comparison view.

The analysis also identifies relationships between items. For example, a user profile can render an avatar and statistics cards, while an editor toolbar can provide options to switch between a source view and a comparison view. Reviewing these relationships helps you describe what users see and do without documenting internal implementation details.

> 📷 _Screenshot pending: The documentation workspace showing the View Source action and documentation generation controls._

## Prerequisites

Before you begin, make sure you have the following:

- Access to the relevant Atloria project and its documentation workspace.
- A frontend source or project version that is available for review.
- Permission to view source information and generate documentation.
- A clear documentation goal, such as documenting a user profile screen, source editor, or documentation-generation workflow.
- An understanding of the intended audience for the output, such as end users, administrators, or product teams.

## Step-by-Step Instructions

1. Open the project documentation workspace for the product you want to analyze.

2. Select **View Source** to open the available source context for the current documentation item.

3. Review the frontend entities shown in the source context.

4. Identify the user-facing screen or interface area you want to document.

5. Record the visible elements that users interact with on that screen.

6. Check whether the screen includes reusable interface elements such as an avatar, loading indicator, statistics card, editor, or selection control.

7. Identify the main user action supported by the screen.

8. Review the relationships shown for the selected frontend entity.

9. Note relationships that affect the user experience, such as one interface area rendering another or using shared application context.

10. Classify the selected item according to its frontend role.

11. Treat items identified as **Component** as reusable interface elements.

12. Treat items identified as **Page** or **Layout** as higher-level user-facing areas that may contain multiple components.

13. Treat items identified as **Context**, **Provider**, or **Store** as shared behavior that may affect several screens.

14. Review the parser category for the source item.

15. Select **FRONTEND** when you are preparing context for visible application screens and interactions.

16. Continue through other available categories only when they affect the user task you are documenting.

17. Use **Source** when you need to return to the source-oriented view of the current material.

18. Review editor-related controls when the source context includes editable or formatted content.

19. Select the language control when you need to view content using the appropriate language formatting.

20. Switch between source and comparison views when both views are available.

21. Verify whether a comparison view highlights changes that could affect the user instructions.

22. Describe only the current user-visible behavior when the source shows a change that has not been confirmed in the product interface.

23. Select **User Guides** when you are ready to prepare end-user documentation from the analyzed context.

24. Select **▶ Generate Docs** to create documentation from the current analysis.

25. Review the generated documentation for accurate screen names, actions, and user-facing terminology.

26. Select **Regenerate Docs** if the generated content does not reflect the source context or intended user task.

27. Select **↻ Re-generate** when you need to run the generation process again after updating your analysis.

28. Select **✦ Regenerate AI docs** when you want Atloria to produce an updated AI-assisted documentation draft.

29. Select **Export Documentation** when the reviewed documentation is ready to share outside the workspace.

> 📷 _Screenshot pending: A frontend source analysis view showing entity classifications, relationships, and the source or comparison display._

## Tips and Best Practices

- Focus on one user task at a time. For example, document viewing a user profile separately from editing source content or generating documentation. This keeps instructions clear and reduces unnecessary technical detail.

- Start with the **FRONTEND** category when your goal is a user manual. Frontend analysis is the most direct source of information about what users see, including pages, controls, labels, loading states, and displayed values.

- Use entity types to organize your review. A **Component** is usually a reusable visible element, while a **Page** or **Layout** provides the broader user journey. This distinction helps you avoid writing a separate manual page for every small visual element.

- Pay attention to rendering relationships. When one item renders another, document the visible result rather than the underlying relationship. For example, if a user profile displays an avatar and statistics cards, explain what users see in the profile and what information the cards display.

- Review shared context carefully. Relationships such as **USES CONTEXT**, **PROVIDES CONTEXT**, **USES STORE**, or **DISPATCHES ACTION** can explain why content is consistent across screens. In the user manual, describe the resulting behavior only if users can observe it.

- Use comparison mode when documenting updates. A source-and-difference view can help you spot changed labels, fields, or user flows before you regenerate documentation. Confirm that the changed behavior is present in the product before adding it to user instructions.

- Preserve exact labels. When a control is labeled **View Source**, **Regenerate**, **Generate More**, or **Export Documentation**, use the same wording in your documentation. Exact labels make instructions easier to follow.

- Regenerate only after refining context. If the first generated draft is incomplete, return to **View Source**, review the frontend entities and relationships, then use **Regenerate Docs** or **✦ Regenerate AI docs**.

- Keep internal details out of the final user guide. Analysis can identify relationships such as **RENDERS**, **USES HOOK**, **CALLS API**, or **DEPENDS ON**, but end users need to know what appears on screen and which action to take.

## Related Pages

- [Generate User Documentation](#)
- [Review and Regenerate Documentation](#)
- [Export Documentation](#)
- [Compare Source Changes](#)
- [Prepare Documentation Context](#)

## Troubleshooting

### You cannot find the source analysis view

Select **View Source** from the documentation workspace. If the action is not available, confirm that you opened the correct project documentation item and that you have permission to view source context.

### The generated documentation describes technical details instead of user actions

Return to **View Source** and focus your analysis on frontend screens, visible controls, and user outcomes. Then select **Regenerate Docs** or **✦ Regenerate AI docs** to produce a revised draft.

### The generated content does not reflect recent interface changes

Review the source and comparison views for updated labels, controls, and relationships. Confirm the intended user-facing behavior, then select **↻ Re-generate** or **Regenerate** to create an updated version.

### You are unsure whether an identified relationship belongs in the manual

Include the relationship only when it changes what users see or do. For example, document that a profile shows an avatar or loading state, but do not include internal relationship names unless they are visible in the application.

<!-- source: open-a-source-entity-by-slug.md -->

# Open a Source Entity by Slug

A slug is the readable identifier Atloria uses to locate a discovered source entity within a project. This page explains how to use a slug to open the correct source entity and confirm that you are viewing the intended project context.

## Overview

When Atloria discovers source entities and their relationships, it assigns each entity a slug-based identifier. You can use this identifier when you receive a shared Atloria link, open a source reference from another document, or return to a source entity you reviewed previously.

Opening an entity by slug is useful when entity names are similar, when a project contains many discovered sources, or when a teammate sends you a direct link. The slug directs you to a specific public project view and can continue into an audience or document view when those details are available.

After you open the entity, use the project navigation to review its source information, related documentation, and available analysis. The **Source** option is the primary place to verify the source context associated with the entity.

> 📷 _Screenshot pending: A shared Atloria link showing the slug portion that identifies the source entity._

## Prerequisites

Before you begin, make sure you have:

- Access to the Atloria project that contains the discovered source entity.
- The entity’s slug or a direct Atloria link provided by a teammate, report, or related document.
- Permission to view the project’s source information.
- A web browser with an active Atloria session, if the project is not publicly available.
- The project name or a distinctive keyword, in case you need to locate the project from the **Projects** area.

## Step-by-Step Instructions

1. Open the Atloria link that contains the source entity slug.

2. Review the page that opens to confirm that it belongs to the expected Atloria project.

3. Select **Open Project Dashboard** if you need to move from the shared entity view into the project workspace.

4. Click **Source** to open the project’s source information.

5. Compare the displayed source name and project context with the slug or link you received.

6. Select **View Source** when it is available to inspect the underlying source details for the entity.

7. Click **Open →** when you need to open the available source-related item or continue into its detailed view.

8. Select **User Docs** if you need supporting documentation for the source entity or related product information.

9. Click **&larr; Back to Projects** when you have finished reviewing the entity and want to return to the project list.

> 📷 _Screenshot pending: The project dashboard with the Source option and View Source action visible._

### If You Need to Find the Project First

1. Select **Projects** from the Atloria navigation.

2. Click the **Search projects...** field.

3. Enter the project name, a recognizable source name, or another keyword associated with the slug.

4. Select the matching project from the search results.

5. Click **Open** to enter the selected project.

6. Select **Source** to locate and verify the source information associated with the slug.

> 📷 _Screenshot pending: The Projects screen showing the Search projects field and Open action._

## Tips and Best Practices

- Treat a slug as an identifier, not as a display name. A source entity’s visible name may be similar to another entity, while its slug is intended to identify the specific entity referenced by the link.

- Start with the direct shared link when one is available. This reduces the chance of opening a similarly named project or source entity through search.

- Verify the project context after opening the link. If the expected source details are not available, use **Open Project Dashboard** and then **Source** to confirm that you are in the correct project.

- Use **View Source** for verification rather than relying only on a document title or a related page. Source information is the best place to confirm that the entity matches the intended discovered source.

- Use **Search projects...** only when you do not have a working direct link or need to locate the project manually. Search terms based on the project name are generally more reliable than abbreviated or informal entity names.

- If a shared link opens a more specific audience or document view, first confirm the project context, then use the available navigation to return to the source information as needed.

## Related Pages

- [Open a Project Dashboard](#)
- [Search for a Project](#)
- [View Source Information](#)
- [Use User Docs](#)
- [Analyze Source Entity Relationships](#)
- [Open a Shared Atloria Document](#)

## Troubleshooting

### The link does not open the expected source entity

Confirm that you copied the complete link, including the slug. If the link still opens an unexpected project or page, open **Projects**, use **Search projects...** to locate the expected project, select **Open**, and then choose **Source** to verify the entity manually.

### I can open the project but cannot find source details

Select **Open Project Dashboard**, then click **Source**. If **View Source** is not available, the source details may not be available in your current view or you may not have permission to access them. Contact the project owner or your Atloria administrator.

### The project search returns multiple similar results

Use a more specific term in **Search projects...**, such as the full project name. After selecting a result, click **Open** and verify the source through **Source** before continuing.

<!-- source: explore-project-entities.md -->

# Explore Project Entities

You can explore the entities extracted from a project’s source to understand how its user interface, business logic, data models, and APIs fit together. This helps you quickly locate components, services, models, and endpoints when investigating a project or planning documentation work.

## Overview

Project entity exploration gives you a structured way to inspect the building blocks discovered in a project. Instead of reviewing source files one at a time, you can use the project workspace to search for entities and move between source-oriented views.

Entities may represent different parts of an application, including frontend components, hooks, pages, layouts, routes, contexts, providers, stores, controllers, services, repositories, and middleware. The entity type helps you recognize the role an item plays in the overall system. For example, a component is typically part of the visible interface, while a service commonly contains business operations and a model represents structured data.

Relationships provide additional context about how entities work together. You may see relationships such as **RENDERS**, **USES HOOK**, **USES CONTEXT**, **PROVIDES CONTEXT**, **USES STORE**, **DISPATCHES ACTION**, **CALLS API**, **IMPLEMENTS API**, **DEPENDS ON**, **USES SERVICE**, **INJECTS**, or **QUERIES MODEL**. Reviewing these connections is useful when you need to assess the impact of a change or trace how a feature reaches its supporting services and data.

> 📷 _Screenshot pending: The project Source view with the “Search entities…” field available for finding extracted entities._

## Prerequisites

Before you begin, make sure that:

- You have access to Atloria and the project you want to inspect.
- The project is available in the **Projects** area.
- You have selected the correct project from the project list or opened its dashboard.
- The project’s source has been processed so extracted entities are available to browse or search.
- You know at least one useful search term, such as a component name, service name, model name, route-related term, or endpoint-related term.

## Step-by-Step Instructions

1. Open the project workspace.

   Start from **Projects**. If you are viewing a list of projects, use **Search projects...** to find the project by name. You can also use **Search across all projects...** when you need to locate a project or item across your available projects.

   Select the project you want to investigate. Depending on where you start, you may see navigation cues such as **1. Hub: All Projects**, **2. Focused Project**, or **1. Active Project** that help distinguish the project list from the currently selected project.

2. Open the selected project’s dashboard.

   Click **Open Project Dashboard** to enter the focused workspace for the project. The dashboard provides the project-specific navigation you need before examining its source intelligence.

   If you opened the wrong project, use **← Back to Projects** to return to the project list and choose another one.

   > 📷 _Screenshot pending: The project area showing the “Open Project Dashboard” action and project navigation._

3. Select **Source** from the project navigation.

   In the project sidebar, select **Source**. This is the appropriate area for inspecting information derived from the project’s source.

   The sidebar may be described in your workspace as **2. Project Sidebar**. Use it to stay within the current project while moving between areas such as source, product-oriented information, and other project views.

4. Search for an entity.

   Locate the **Search entities…** field. Enter the name of an entity or a relevant keyword.

   Use specific terms when possible. For example, search for:
   - A visible UI component, such as a profile or statistics component.
   - A service associated with a business capability.
   - A model or data concept used by the application.
   - A route, controller, or endpoint-related name when investigating API behavior.
   - A technical term such as “context,” “store,” or “repository” when tracing application structure.

   Start with the most recognizable name. If you do not find the expected entity, try a shorter keyword or a related functional term.

5. Review the entity’s type and role.

   Open or select a matching entity to inspect its classification. The type tells you how the item participates in the application. A project may contain entities across the following areas:

   - **Component**, **Hook**, **Page**, **Layout**, **Route**, **Context**, **Provider**, and **Store** for frontend structure and state.
   - **Controller**, **Service**, **Repository**, and **Middleware** for backend behavior and request handling.
   - Models and API-related entities for data and interface analysis.

   Use this classification to decide where to continue your investigation. For example, begin with a **Component** when you are trying to understand what users see, then follow its relationships to find the hooks, contexts, stores, services, or APIs it uses.

6. Inspect relationships to trace dependencies.

   Review the relationships associated with the entity. Relationship labels explain the direction and nature of the connection.

   For example, a component may **RENDERS** another component or **USES HOOK**. A service may **QUERIES MODEL**, while another entity may **CALLS API** or **USES SERVICE**. These connections help you follow a feature from the visible interface toward its state, business logic, and data access.

   When evaluating potential changes, review both the entities an item uses and the entities that use it. This gives you a more complete view of possible downstream effects.

7. Use adjacent project tools when needed.

   Use **⚙️ Components** when you want to focus on component-oriented information. Use **⚡ API Explorer** when your investigation needs to move from source entities toward API exploration. If you need user-facing context for a capability, select **📋 User Manuals** or **User Guides**.

   Use **View Source** when you need to verify details in the underlying project source after identifying the relevant entity.

> 📷 _Screenshot pending: An extracted entity selected in the Source area, showing its entity type and relationship connections._

## Tips and Best Practices

- Search by business capability as well as by technical name. A direct entity name is often fastest, but terms related to a feature can help you find supporting services, models, and API-related entities.
- Start from the user-facing entity when investigating behavior. Begin with a **Component**, **Page**, or **Route**, then follow relationships such as **USES HOOK**, **USES CONTEXT**, **USES STORE**, and **CALLS API**.
- Start from a service or model when investigating data behavior. Follow **USES SERVICE**, **DEPENDS ON**, **INJECTS**, and **QUERIES MODEL** relationships to understand how backend logic and data access are connected.
- Do not assume that similarly named entities have the same role. Check the entity type before drawing conclusions; a component, service, route, and model can all use related names while serving different purposes.
- Use **View Source** to validate your understanding when relationship information identifies an area that needs closer review.
- Keep your investigation within the correct project. The **Projects** list and **Open Project Dashboard** action help you confirm that you are exploring the intended project rather than another available project.

## Related Pages

- [Manage Projects](#)
- [Open a Project Dashboard](#)
- [Explore Components](#)
- [Use API Explorer](#)
- [View Project Source](#)
- [Find User Guides and User Manuals](#)

## Troubleshooting

### No results appear after using “Search entities…”

Check the spelling and try a shorter or broader keyword. Search for a related concept, such as a feature name, service term, route term, or model term. Confirm that you are in the correct project and that you selected **Source** before searching.

### I found an entity but cannot tell what it does

Review its entity type first, then inspect its relationships. A **Component** may lead you to hooks, contexts, or stores, while a **Service** may lead you to APIs or models. Use **View Source** if you need additional confirmation.

### I am viewing entities for the wrong project

Use **← Back to Projects** to return to **Projects**, locate the intended project with **Search projects...**, and then select **Open Project Dashboard**. Return to **Source** and repeat your search.

<!-- source: trace-entity-relationships.md -->

# Trace Entity Relationships

This page explains how to follow the connections between entities in a project’s analyzed source. Tracing these relationships helps you understand where a feature begins, what it relies on, and how a change can affect other parts of the product.

## Overview

A project is made up of connected entities rather than isolated files or screens. For example, a visible component may render another component, use a hook, depend on a service, or query a model. Following these connections gives you a clearer picture of how a product capability is assembled.

Relationship tracing is especially useful when you need to answer questions such as:

- Which components are involved in a user-facing screen?
- What hooks, contexts, stores, or actions support a component?
- Which service or model is used behind a product feature?
- What may be affected if you update an entity?

Atloria presents relationships as directed connections. The relationship label tells you how the starting entity connects to the next entity. For example, a chain can move from a **COMPONENT** to a **HOOK**, then to a **PAGE**, **LAYOUT**, **ROUTE**, **CONTEXT**, **PROVIDER**, **STORE**, **CONTROLLER**, **SERVICE**, and **REPOSITORY**. This allows you to trace a feature from its visible interface toward the supporting product logic.

> 📷 _Screenshot pending: A focused project view showing the Source area used to begin source entity discovery._

## Prerequisites

Before you begin, make sure that:

- You have access to the relevant project in **Projects**.
- The project source has been added and is available for analysis.
- You know the entity, feature, or product area you want to investigate, such as a component name, service name, or screen behavior.
- You can open the project’s focused view by selecting **Open Project Dashboard**.
- You understand whether you are tracing from a user-facing entity toward dependencies, or from a supporting entity toward the features that use it.

## Step-by-Step Instructions

1. Open the project you want to investigate.

   Start from **Projects**. If you are working across multiple projects, use **Search projects...** to locate the project. You can also use **Search across all projects...** when you need to find a project or content beyond the current project list.

   Select the project and choose **Open Project Dashboard** to enter the focused project view.

2. Go to the project’s source information.

   In the focused project area, select **Source**. This is the starting point for examining the entities identified from your project source and understanding how they connect.

   > 📷 _Screenshot pending: The Source view with the “Search entities…” field available for locating a project entity._

3. Find the entity you want to trace.

   Use the **Search entities…** field to search for a known entity. Enter a specific name when possible—for example, the name of a component, hook, context, service, repository, or model.

   Begin with the entity closest to the question you are trying to answer. If you are investigating a visible product behavior, start with the related component or page. If you are investigating data access or system behavior, start with the service, repository, or model involved.

4. Review the entity’s relationships.

   Open the entity and review the relationship labels shown with its connected entities. Treat each label as a statement about the connection:

   - **RENDERS** indicates that one component displays another component.
   - **USES HOOK** indicates that an entity relies on a hook.
   - **USES CONTEXT** and **PROVIDES CONTEXT** show how shared context is consumed or made available.
   - **USES STORE** and **DISPATCHES ACTION** show interactions with application state.
   - **CALLS API** and **IMPLEMENTS API** distinguish a caller from the entity that provides the API behavior.
   - **DEPENDS ON** identifies a direct dependency.
   - **USES SERVICE**, **INJECTS**, and **QUERIES MODEL** help you follow a feature into its supporting service and data layers.

5. Follow the relationship in the direction shown.

   Select a connected entity to continue the trace. Read the relationship label before moving on so that you preserve the meaning of the chain. For example, a path may show that a component **USES HOOK**, the hook **USES CONTEXT**, and the context **PROVIDES CONTEXT** to the rest of the feature.

   Continue until you reach the level needed for your investigation. A user-interface question may only require tracing through components and hooks. An impact-analysis question may require continuing through stores, controllers, services, repositories, and models.

6. Trace backward when you need to understand impact.

   To understand what a change could affect, begin with the entity you plan to change and look for entities that render it, use it, depend on it, or call it. This reverse investigation is useful before changing shared components, contexts, services, or models.

7. Confirm the source details when necessary.

   Select **View Source** when you need to verify the implementation context for an entity or relationship. Use this to confirm names and surrounding source details after you have identified the relevant relationship path.

   If you need generated explanatory material for a project area, select **User Docs** where available and review the applicable user-facing documentation alongside your relationship trace.

> 📷 _Screenshot pending: An entity detail view showing relationship labels such as RENDERS, USES HOOK, USES SERVICE, and QUERIES MODEL._

## Tips and Best Practices

Start narrow. Search for one known entity rather than trying to understand the entire project at once. A specific component, hook, or service provides a practical anchor for the trace.

Read relationship labels literally and in order. **USES SERVICE** does not mean the service renders the component, and **CALLS API** does not mean the entity implements that API. The direction and wording of the relationship are important when you are determining ownership and dependency.

Use a layered approach. For user-interface investigation, trace from **COMPONENT** through related components, hooks, contexts, and stores. For deeper behavior analysis, continue from controller and service relationships toward repositories and models. This keeps the investigation focused while still allowing you to follow the full dependency chain when needed.

Be cautious with shared entities. A context, provider, store, service, or model can support multiple features. Before changing one, trace both its dependencies and the entities that use it to identify possible product-wide effects.

## Related Pages

- [Manage Projects](#)
- [Explore Project Source](#)
- [Review Project Changes](#)
- [Compare Project Versions](#)
- [Use Technical Documentation](#)

## Troubleshooting

### I cannot find the entity I need

Use **Search entities…** with the entity’s exact name where possible. If you are searching from a business-feature name rather than a source entity name, start with the visible component or page associated with that feature and trace from there.

### The relationship chain becomes too large to follow

Stop at the layer relevant to your question. For example, stop after hooks and context for a screen-behavior question, or continue through services and models only when you need to understand backend or data dependencies. Trace one branch at a time and record the labels between entities.

### I am unsure whether an entity is safe to change

Trace backward to identify entities that **RENDER**, **USE**, **DEPEND ON**, or **CALL** the entity. Then use **View Source** to validate the context before making a change. Shared contexts, stores, services, and models should be treated as potentially high-impact entities.

<!-- source: inspect-source-symbols.md -->

# Inspect Source Symbols

You can inspect source symbols while reviewing generated documentation to confirm that descriptions match the underlying product behavior. This helps you validate names, dependencies, and relationships before you publish or share documentation.

## Overview

Source-symbol inspection lets you compare documentation review content with the source material associated with it. Use this task when a generated explanation mentions a component, page, service, data model, or other source entity and you need to verify that the description is accurate.

During review, source analysis can organize findings by category. Categories may progress from **FRONTEND** through **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**. These categories help you understand which part of the product a symbol belongs to before you decide whether its documentation needs revision.

You may also encounter relationship information that explains how symbols work together. For example, a source entity can **RENDERS** another component, **USES HOOK**, **CALLS API**, **DEPENDS ON** another entity, **USES SERVICE**, or **QUERIES MODEL**. Reviewing these relationships is especially important when validating user flows and feature behavior.

> 📷 _Screenshot pending: The documentation review screen showing the View Source action and source inspection area._

## Prerequisites

Before you start, make sure you have:

- Access to the relevant project and documentation review.
- A documentation item ready to review.
- Permission to open the review and source information for the project.
- A clear understanding of the documentation statement, workflow, or user behavior you want to validate.
- The source symbol name, if it is already referenced in the documentation you are reviewing.

## Step-by-Step Instructions

1. Open the project documentation review that contains the content you want to validate.

2. Select **Review & Publish** to enter the documentation review workflow.

3. Select **1 Review Summary** to locate the documentation section that needs source validation.

4. Read the documentation statement that refers to a source entity, behavior, or relationship.

5. Click **View Source** to open the source information for the item you are reviewing.

6. Select **Source** to focus on the available source content.

7. Identify the symbol named in the documentation, such as a component, hook, page, layout, route, context, provider, store, controller, service, repository, or middleware.

8. Review the symbol’s category to determine whether it belongs to the frontend, backend, database, API schema, configuration, documentation, or infrastructure area.

9. Review the symbol’s relationships to confirm how it interacts with other entities.

10. Compare the visible source behavior with the documentation statement you read in the review.

11. Return to the review by clicking **Back to Review**.

12. Update the documentation review content if the source inspection shows that the statement is incomplete, inaccurate, or missing an important dependency.

13. Select **Preview** to check how the validated documentation will appear to readers.

> 📷 _Screenshot pending: A source inspection view highlighting a symbol, its category, and relationships to other entities._

## Tips and Best Practices

- Validate one claim at a time. For example, first confirm that a component renders another component, then separately confirm whether it uses a hook or calls an API.

- Treat entity type and relationship type as different pieces of information. A symbol might be a **COMPONENT**, while its relationship might be **RENDERS** another component or **USES HOOK**. Both facts may be needed for an accurate explanation.

- Follow the category sequence when reviewing broad behavior. Start with **FRONTEND** symbols for user-facing behavior, then check **BACKEND**, **DATABASE**, and **API SCHEMA** symbols when the documentation describes data handling or server-side behavior.

- Use relationship details to avoid overstating behavior. For example, **CALLS API** indicates a direct API interaction, while **DEPENDS ON** indicates reliance on another entity but does not necessarily describe a user-visible action.

- Review names carefully. Symbols can include components, hooks, contexts, stores, services, and repositories that have similar names but different responsibilities.

- Use **Preview** after making changes so you can confirm that source-based clarification remains understandable for the intended audience.

- If you need to validate a visual or formatting-related documentation change, use the available source view rather than assuming that generated content reflects the current source behavior.

## Related Pages

- [Review and Publish Documentation](#)
- [Preview Documentation](#)
- [Generate Documentation](#)
- [Add Code Examples](#)
- [Export Documentation](#)
- [User Guides](#)

## Troubleshooting

### You cannot find the source information for the documentation item

Click **View Source** from the specific review item rather than from a general documentation page. If source information is still unavailable, confirm that you opened the correct project and review content.

### The symbol name does not match the documentation wording

Review the visible symbol type and its relationships before changing the documentation. The documentation may use a user-friendly term, while the source uses a more specific entity type such as **SERVICE**, **STORE**, or **CONTEXT**.

### The relationship does not support the documentation claim

Return by selecting **Back to Review**, then revise the statement to reflect the relationship you verified. For example, describe a symbol as depending on another entity rather than calling it directly when the relationship is **DEPENDS ON**.

<!-- source: use-the-entity-tree.md -->

# Use the Entity Tree

Use the Entity Tree to explore the product entities discovered in your project and understand how they relate to one another. This helps you move from a high-level product view to the specific components, flows, and relationships that make up the product.

## Overview

The Entity Tree presents discovered product intelligence in a navigable hierarchy. You can use it to review entities such as product surfaces, user flows, components, and relationship-focused findings without manually tracing every source file.

When you are investigating how an area of the product is organized, start with the **Tree** view. The tree is especially useful when a search result or top-level entity indicates that additional related entities exist beneath it. Expand the hierarchy to follow the relationships that connect product concepts across the application.

You can also use the entity search field to narrow the tree. For example, searching for “User Flow” can help you locate a relevant flow quickly, while searching for a phrase such as “Product Surfaces” can focus the tree on product-level findings.

> 📷 _Screenshot pending: The Entity Tree showing the Tree view, the Search entities… field, and discovered entity entries._

## Prerequisites

Before you begin, make sure that:

- You have access to the relevant project in Atloria.
- Entity discovery has completed for the project you want to review.
- You know a keyword, entity name, product area, or relationship topic you want to investigate.
- You are viewing the project’s source and product intelligence area.
- You have selected the appropriate documentation context if both **User Docs** and **View Source** are available.

## Step-by-Step Instructions

1. Open the project whose discovered entities you want to explore.

2. Select **Tree** to open the Entity Tree view.

3. Review the top-level entities shown in the tree.

4. Click an entity name to select it and view its available details.

5. Expand an entity that has child entries to reveal related entities beneath it.

6. Continue expanding child entries until you reach the level of detail you need.

7. Select **Search entities…** to begin filtering the Entity Tree.

8. Enter a keyword or entity name in **Search entities…**.

9. Review the filtered entity entries that match your search.

10. Clear the search text to return to the broader Entity Tree.

11. Select an entity such as **Product Surfaces — what you actually have** to investigate product-level findings.

12. Select an entity such as **User Flow** to investigate a discovered user journey or interaction path.

13. Select a relationship-oriented entry to understand how one entity connects to another.

14. Select **Source** when you need to switch from the hierarchy to the underlying source-oriented context.

15. Select **User Docs** when you need to return to user-facing documentation content.

> 📷 _Screenshot pending: A user entering text in Search entities… and expanding a matching entity to view its related children._

## Tips and Best Practices

- Start broad, then narrow your investigation. Begin with top-level entries such as **Product Surfaces — what you actually have**, then expand into more specific entities and relationships.

- Use the **Search entities…** field for exact names and distinctive phrases. Search is most effective when you use terms that appear in the discovered entity name, such as “User Flow,” “Dashboard,” or “Product.”

- Review relationships as a chain rather than as isolated entries. Discovered relationships can describe how one item renders another, uses a hook or context, provides context, uses a store, dispatches an action, or reaches a service and model. Following the chain helps you understand both the visible product behavior and the dependencies behind it.

- Treat similarly named entities carefully. The Entity Tree may include entities representing different levels of the product, such as a broad product surface, a component, or a relationship. Expand and inspect the surrounding hierarchy before drawing conclusions.

- Use **Tree** and **Source** together. The **Tree** view helps you understand structure and relationships, while **Source** helps you investigate the supporting source-oriented information when you need more detail.

- Use the documentation context intentionally. **User Docs** is useful when you want to connect a discovered entity to user-facing guidance. **View Source** is useful when you need to examine the source-oriented perspective for the selected content.

## Related Pages

- [Explore Source Intelligence](#)
- [Search Discovered Entities](#)
- [Analyze Entity Relationships](#)
- [Use Source View](#)
- [Create and Review User Manuals](#)
- [Use API Explorer](#)

## Troubleshooting

### No entities appear in the Tree view

Confirm that you opened the correct project and that entity discovery has completed. If the project has not yet been analyzed, the Entity Tree may not contain discovered entries to explore.

### Search does not show the entity you expect

Clear **Search entities…** and check the top-level tree first. Then try a shorter or more distinctive term, such as “Dashboard,” “User,” or “Product,” instead of a full sentence or assumed entity name.

### You can see an entity but cannot understand its relationships

Expand the entity and inspect its child entries. If the hierarchy alone does not provide enough context, select **Source** to investigate the source-oriented view, then return to **Tree** to continue following the relationship structure.

<!-- source: explore-the-entity-relationship-graph.md -->

# Explore the Entity Relationship Graph

Use **View Graph** to examine product entities and the relationships between them. This helps you understand how parts of the product connect before you review source details or create documentation.

## Overview

The Entity Relationship Graph provides a visual way to explore the entities discovered for a product and the connections between them. Instead of reviewing entities one at a time, you can use the graph to see relationship paths such as components that render other components, components that use hooks, or entities that depend on services.

Use the graph when you need to understand the scope of a product area, trace how an entity is connected to other entities, or identify related items for further review. The graph is especially useful when an entity participates in multiple relationships, such as rendering another component while also using a hook or context.

The graph complements the entity search and source review tools. You can first locate a specific item with **Search entities…**, open the graph with **View Graph**, and then use **View Source** when you need to inspect the supporting source information for an entity.

> 📷 _Screenshot pending: The Entity Relationship Graph opened from the View Graph action, showing entities and their connecting relationships._

## Prerequisites

Before you start, make sure that:

- You can access the relevant product or project in Atloria.
- The product has entities available for review.
- You know the entity, feature area, or relationship you want to investigate.
- You have access to the actions **View Graph**, **View Source**, and **Search entities…**.
- You have reviewed the product’s **Overview** if you need context before exploring relationships.

## Step-by-Step Instructions

1. Open the product or review area that contains the entities you want to investigate.

2. Select **Product** to work with the product-level entity information.

3. Enter an entity name or relevant keyword in **Search entities…** to narrow the available entities.

4. Select the entity you want to investigate from the search results or entity list.

5. Click **View Graph** to open the Entity Relationship Graph for the selected product context.

6. Review the entity nodes shown in the graph to identify the entity you selected and the entities connected to it.

7. Read the relationship labels between nodes to understand how the connected entities relate to each other.

8. Follow a connection from the selected entity to identify directly related entities, such as a component that **RENDERS** another component or **USES HOOK**.

9. Select a connected entity in the graph when you want to continue investigating that entity’s relationships.

10. Review the next set of connections to trace a relationship chain, such as a component using a hook, the hook using context, and the context providing values through a provider.

11. Click **View Source** when you need to examine the source information associated with an entity you identified in the graph.

12. Return to **View Graph** after reviewing source information to continue tracing connections.

> 📷 _Screenshot pending: A selected entity in the graph with labeled connections to related entities, including relationship types such as RENDERS and USES HOOK._

## Tips and Best Practices

Start with a focused question. For example, you might want to find what a component renders, determine which entities use a specific hook, or trace a dependency from a page to a service. Beginning with one entity makes large relationship networks easier to interpret.

Use the relationship label as the meaning of the connection. A relationship such as **RENDERS** indicates a display relationship between entities, while **USES HOOK**, **USES CONTEXT**, and **PROVIDES CONTEXT** help you follow how shared behavior or data is connected. Other relationships, such as **DEPENDS ON**, **USES SERVICE**, and **QUERIES MODEL**, help you understand dependency paths across the product.

Trace one connection at a time. A long chain may move through several kinds of entities—for example, from a frontend entity through a component and hook, then onward to context, a provider, a store, controller, service, repository, middleware, or model. Review each relationship label before moving to the next entity so that you do not mistake an indirect connection for a direct one.

Use **Search entities…** before opening **View Graph** when the product contains many entities. Searching first gives you a clear starting point and reduces the time needed to locate the relevant area of the graph.

Use **View Source** only after the graph identifies an entity or relationship that needs closer review. The graph is best for discovering connections; source review is best for validating the details behind a connection.

## Related Pages

- [Search Product Entities](#)
- [View Entity Source Information](#)
- [Review Product Overview](#)
- [Use User Docs](#)
- [Explore API Documentation with API Explorer](#)

## Troubleshooting

### You cannot find the entity you want to inspect

Use **Search entities…** with a more specific entity name or keyword. If no matching entity appears, return to **Overview** to confirm that you are working in the correct product or review context.

### The graph has too many connected entities to interpret easily

Begin again with the specific entity most relevant to your question. Follow only its direct connections first, then select one related entity at a time to continue the relationship trace.

### You need more detail than the graph provides

Select the relevant entity and click **View Source**. Use the source view to review the supporting information, then return to **View Graph** to continue exploring related entities.

<!-- source: entitytree-exploring-product-entities.md -->

# EntityTree: Exploring Product Entities

EntityTree helps you explore the entities that make up your product model and see how they relate to one another. Use it when you need to understand a product area, trace relationships between entities, or locate a specific entity before reviewing its source context.

## Overview

EntityTree presents product entities in a browsable hierarchy. It is designed to help you move from a broad product view to individual entities without needing to search through every repository or document manually.

You can use the tree to explore product surfaces, user-facing flows, documentation topics, and other discovered entities. For example, the entity list may include items such as **Product Surfaces — what you actually have**, **User Flow**, or **Browse Repositories**. These entries provide a starting point for understanding how parts of the product are organized.

EntityTree is especially useful during source and product intelligence work. Start with a known product concept, use **Search entities…** to narrow the list, and then review the entity’s relationships to understand how it connects to other parts of the product model.

> 📷 _Screenshot pending: The EntityTree view showing the Product area, the Search entities… field, and a hierarchy of product entities._

## Prerequisites

Before you begin, make sure that:

- You have access to the relevant Atloria project.
- Product entities have been discovered or added to the project model.
- You know a product term, screen name, user flow, or documentation topic you want to investigate.
- You have permission to view product intelligence and source-related information where applicable.
- You understand whether you are looking for a user-facing product entity or its supporting source context.

## Step-by-Step Instructions

1. Open the project where you want to explore the product model.

2. Select **Product** to work with product-focused entities rather than source-focused information.

3. Locate the **Search entities…** field above the entity list.

4. Enter a keyword that identifies the entity you want to find.

5. Review the filtered entity results shown in the tree.

6. Select an entity name to make it the focus of your exploration.

7. Expand the selected entity’s branch when an expansion control is available.

8. Review the child entities displayed beneath the selected entity.

9. Select a related entity in the branch to follow the relationship from one product concept to another.

10. Continue expanding related entries until you reach the level of detail you need.

11. Use **View Source** when you need to compare the product entity with its available source context.

12. Select **Source** to switch your attention from the product model to the related source-oriented view.

13. Return to **Product** when you want to continue exploring product relationships.

14. Select **User Docs** when the entity relates to user documentation or a user-facing manual topic.

15. Select **📋 User Manuals** when you want to locate user-manual content associated with the product area you are exploring.

> 📷 _Screenshot pending: A user entering a term in Search entities… and expanding matching entities to review related product concepts._

### Example: Explore a repository browsing flow

1. Enter `Browse` in **Search entities…**.

2. Select **Browse Repositories** from the matching results.

3. Expand the entity branch to review related entries.

4. Select **Browse Repos** if it appears as a related entity or alternate product label.

5. Select **3. Repo Browser** to examine the product area associated with repository browsing.

6. Select **User Flow** to understand the flow-oriented context connected to the repository browsing experience.

7. Select **View Source** if you need to investigate supporting source information for the selected product entity.

> 📷 _Screenshot pending: The EntityTree filtered for Browse, with Browse Repositories, Browse Repos, and 3. Repo Browser visible in the relationship hierarchy._

## Tips and Best Practices

- Start with the most specific term you know. Searching for a screen or feature name, such as **Repo Browser**, usually produces more focused results than a broad term such as “product.”

- Try alternate names when an entity does not appear immediately. A concept may be represented with a user-facing label, a shorter label, or a broader product-area name. For example, **Browse Repositories** and **Browse Repos** may both be useful search terms.

- Explore both parent and child entries. A parent entity gives you context for where an item belongs, while child entities can reveal more detailed product concepts and supporting relationships.

- Treat relationships as navigation paths, not just a list. If an entity leads to **User Flow**, use that connection to understand the user journey. If it leads to documentation topics, use **User Docs** or **📋 User Manuals** to investigate the user-facing guidance.

- Use **Product** and **Source** together when needed. The **Product** view helps you understand what users experience; **Source** helps you investigate the available implementation context. Switching between them can clarify whether two similarly named entities refer to the same product capability.

- Search for documentation-oriented entities when researching product guidance. Entries such as **Product Surfaces — what you actually have** or **Lane ③ — User manuals / help centers / KBs** can help you identify relevant manual and help-center coverage.

## Related Pages

- [Browsing Repositories](#)
- [Using Source Intelligence](#)
- [Viewing Entity Source Context](#)
- [Understanding User Flows](#)
- [Finding User Manual Content](#)
- [Product Surfaces and Product Model Discovery](#)

## Troubleshooting

### No entities appear after searching

1. Clear the text in **Search entities…**.

2. Enter a shorter or alternate keyword.

3. Try a related product term, such as **Product**, **User Flow**, or **Source**.

4. Confirm that you are working in the correct project.

### The entity I found does not show the relationship I expected

1. Expand the entity’s available branch.

2. Select its parent entity to review the broader context.

3. Select related child entities to follow adjacent product concepts.

4. Use **View Source** to review source context when the product relationship alone is not enough to explain the connection.

### I cannot tell whether I should use Product or Source

1. Select **Product** when you want to understand screens, product areas, user flows, or documentation-facing concepts.

2. Select **Source** when you need to investigate the available source context for an entity.

3. Return to **Product** after reviewing source information to continue mapping the entity’s product relationships.

<!-- source: explore-captured-product-flows.md -->

# Explore Captured Product Flows

Captured product flows help you review how people move through a product and how screens, components, and supporting systems relate to one another. Use this view when you need to understand a user journey before reviewing, documenting, or publishing product knowledge.

## Overview

Product flows provide a structured way to explore the paths captured from a product. Rather than reviewing isolated screens, you can use flows to understand the sequence of user actions and the relationships between parts of the product experience.

This is especially useful when you are preparing documentation, validating a review, or trying to understand how a feature works from beginning to end. For example, a flow may show how a user starts on one page, uses a component or action, and then reaches another part of the product.

Captured information can include frontend, backend, database, API schema, configuration, documentation, and infrastructure areas. This broader context helps you distinguish the visible user experience from the systems that support it. Relationships can also help explain how components render other components or use shared functionality.

> 📷 _Screenshot pending: Product flow review area showing captured journeys and their connected product elements._

## Prerequisites

Before you begin, make sure that you have:

- Access to the relevant project and version.
- A product review that contains captured information.
- Permission to view the project’s review materials.
- An understanding of the feature, journey, or business process you want to investigate.
- A completed or in-progress review when you need to use **Review & Publish**.

## Step-by-Step Instructions

1. **Open the project review for the version you want to examine.**

   Start from the relevant project and open its version review. The review area is where you can assess captured information before it is turned into published documentation.

   If you are returning from another review area, select **Back to Review** to return to the main review context.

2. **Open the product-focused view.**

   Select **Product** when you want to focus on the captured product experience rather than source-oriented details. This view is useful for understanding journeys in terms of screens, interactions, and user-facing behavior.

   Depending on your review context, you may also see **Loop Flows**. Use it to examine repeated or connected flow paths that may be relevant to a broader journey.

3. **Review the flow summary.**

   Select **1 Review Summary** to see the current review summary. Use the summary to orient yourself before examining individual journeys or product areas.

   Look for the sequence of captured steps and identify:
   - Where the journey begins.
   - Which user-facing area or action advances the journey.
   - Where the journey ends or changes into another flow.
   - Any connections to related components, pages, or services.

4. **Follow the journey in the order it is presented.**

   Review each captured step from start to finish. Treat each step as part of a user journey, not as an isolated implementation detail. As you review, ask what the user is trying to accomplish at that point and what outcome they should expect.

   Where the captured view identifies entities, use their type to understand their role. For example, a captured entity may represent a page, layout, component, hook, route, context, provider, store, controller, service, repository, or middleware. User journeys will usually be easiest to understand when you begin with pages and components, then use the supporting relationships only when more context is needed.

5. **Use relationship information to clarify connections.**

   When a flow shows relationships between items, use them to understand how one part of the experience leads to another. A relationship may indicate that one component **renders** another component or **uses** shared functionality.

   This is helpful when a journey appears to change unexpectedly. Instead of assuming a gap in the captured flow, check whether the current item connects to another component, hook, or page.

6. **Switch to source-oriented context only when necessary.**

   If you need additional detail to validate what was captured, select **View Source** or **Source**. Use this view to confirm supporting context, then return to the product review so that you can continue assessing the journey from the user’s perspective.

   Avoid relying on source-oriented details as the primary description of the journey. Your documentation should explain what users see and do.

7. **Prepare the flow for documentation review.**

   When you understand the journey, return to the summary and select **Review & Publish**. This lets you move from exploration into reviewing the documentation output.

   You may also see **Preview** or **2. Preview Modal** during the review process. Use preview options to check whether the flow is understandable before publication or export.

> 📷 _Screenshot pending: Review Summary showing product-flow information and the Review & Publish action._

## Tips and Best Practices

- **Start with the user’s goal.** Identify what the user is trying to complete before examining supporting technical relationships. This keeps your review focused on the actual product journey.

- **Review flows in sequence.** A captured flow is most valuable when read from beginning to end. Skipping directly to a connected item can make it difficult to understand why the user reached that point.

- **Use categories for context, not as the journey itself.** Categories such as frontend, backend, database, API schema, configuration, documentation, and infrastructure help you understand scope. The product flow should still be described in terms of user actions and outcomes.

- **Check repeated paths carefully.** When using **Loop Flows**, look for steps that may recur or connect to another journey. Repeated paths can indicate shared navigation, reusable interactions, or a point where users may need clearer guidance.

- **Preview before publishing.** Use **Preview** to confirm that the journey is understandable to someone who did not capture it. If the sequence is unclear, return to the review and clarify the flow before selecting **Review & Publish**.

- **Use source context sparingly.** **View Source** can help verify a connection, but it should not replace a plain-language explanation of the user experience.

## Related Pages

- [Review and Publish Documentation](#)
- [Use the Review Summary](#)
- [Preview Documentation Before Publishing](#)
- [Export Documentation](#)
- [Understand Product Intelligence](#)

## Troubleshooting

### You cannot find the flow you expect

Return to **1 Review Summary** and confirm that you opened the correct project version. A flow may be associated with a different version or may not have been captured in the current review.

### The journey is difficult to follow

Review the flow from its first step and inspect the relationships between connected items. If needed, use **View Source** to confirm supporting context, then return to the product view to describe the journey in user-facing terms.

### You are not ready to publish

Do not select **Review & Publish** until the flow sequence and user outcome are clear. Use **Preview** to assess the documentation output, then return with **Back to Review** if you need to continue exploring or refining your understanding.

<!-- source: document-a-product-workflow.md -->

# Document a Product Workflow

This page explains how to create and refine documentation for a product workflow in Atloria. Clear workflow documentation helps readers understand the order of actions, decisions, and expected outcomes in a product experience.

## Overview

Product workflow documentation describes how someone moves through a multi-step experience, such as reviewing information, creating a payment, or completing a maintenance request. Rather than listing isolated features, a workflow document connects the steps in the order a user performs them.

You can manage workflow documentation from **Documents**. Use **Search documents...** to find an existing document when you need to update, review, compare, or translate it. When you are starting a new workflow, create a new document and write the experience as a sequence of user actions.

As you prepare the document, focus on what the reader sees and does: screen names, visible buttons, menu items, field labels, and results. For example, a workflow can direct the reader to select **Create Payment**, review **1 Review Summary**, and use **Next Steps** to continue.

> 📷 _Screenshot pending: The Documents page showing the document list and the Search documents... field._

## Prerequisites

Before you begin, make sure you have:

- Access to the Atloria workspace where the product documentation is managed.
- A clear understanding of the product experience you want to document.
- The intended audience for the workflow, such as end users or internal reviewers.
- The names of the screens, buttons, menu items, and fields that users will encounter.
- Any screenshots or visual references needed to explain complex screens.
- An existing document selected if you are updating, comparing, translating, or reviewing documentation rather than creating it.

## Step-by-Step Instructions

1. Open **Documents** from the Atloria application navigation.

2. Select **Search documents...** if you want to locate an existing workflow document.

3. Enter a distinctive word from the workflow title in the **Search documents...** field.

4. Select the matching document from the search results if you are revising an existing workflow.

5. Start a new document if no existing document covers the product experience you need to explain.

6. Enter a descriptive title that identifies the user goal, such as “Create a Payment” or “Review a Product Summary.”

7. Write a one- or two-sentence introduction that tells readers what they will accomplish and why the workflow matters.

8. Add an **Overview** section that explains when users should use the workflow.

9. Add a **Prerequisites** section that lists what readers need before they start.

10. Add a **Step-by-Step Instructions** section for the main workflow.

11. Write one user action per numbered step.

12. Name the screen, menu item, button, or field exactly as the user sees it.

13. Direct the reader to select **Create Payment** when the workflow begins a payment process.

14. Direct the reader to review **1 Review Summary** when the workflow includes a summary or confirmation stage.

15. Direct the reader to select **Next Steps** when the reader needs to continue beyond the current stage.

16. Use **Back to Review** when your instructions need to explain how a user returns to the review experience.

17. Describe the visible result after each important action, such as a review summary appearing or the next stage becoming available.

18. Add a screenshot placeholder immediately after a step when a visual reference will help the reader recognize the screen.

19. Select **View Source** or **Source** only when you need to review the source-oriented view of the document content.

20. Compare the document with another version when you need to verify what changed before sharing the updated workflow.

21. Review the completed workflow from beginning to end as though you are the intended reader.

22. Save or finalize the document according to the options available in your workspace.

> 📷 _Screenshot pending: A workflow document section that instructs users to review 1 Review Summary and continue with Next Steps._

## Tips and Best Practices

- Use task-focused titles. A title such as “Create a Payment” is easier to find and understand than a broad title such as “Payments.”
- Keep each numbered instruction to a single action. If users must select **Create Payment** and then complete a field, make those separate steps.
- Use the exact visible label whenever possible. For example, write **Search documents...**, **Documents**, **Next Steps**, and **Back to Review** exactly as they appear.
- Explain what changes after an action. Readers need to know whether they should see a summary, return to a review screen, or move to the next stage.
- Add screenshots for screens with several choices, unfamiliar terminology, or review information that readers must verify.
- Use comparisons when updating a workflow. Reviewing differences helps you confirm that new instructions do not remove an important step or change the intended order.
- Use translation tools only after the workflow is complete in its original language. This reduces the chance of revising several language versions repeatedly.
- Keep source-oriented content separate from user instructions. **View Source** and **Source** can help with review, but end-user workflow steps should describe the visible product experience.

## Related Pages

- [Manage Documents](#)
- [Search for Documentation](#)
- [Compare Document Versions](#)
- [Translate a Document](#)
- [Review Product Documentation](#)
- [Create User Guides](#)

## Troubleshooting

### You cannot find the workflow document

Use **Search documents...** and search with a unique word from the title. If the document still does not appear, check whether the workflow was created under a different title or whether you need access to the relevant workspace.

### The instructions do not match the product screen

Revisit the product experience and confirm the exact labels shown to users. Update instructions to use visible text such as **Create Payment**, **1 Review Summary**, or **Next Steps**, rather than internal names or assumptions.

### You are unsure what changed in an updated workflow

Open the document comparison view and review the differences before publishing or sharing the revised content. Pay particular attention to changed step order, removed prerequisites, and screenshots that no longer match the current experience.

<!-- source: compare-product-flow-revisions.md -->

# Compare Product Flow Revisions

Comparing product flow revisions helps you identify how an experience has changed between versions and keep the associated documentation accurate. Use this process before reviewing or publishing documentation for a changed product flow.

## Overview

Product flows can change when screens, user actions, relationships, or supporting services are updated. The comparison view lets you examine revisions side by side so you can determine whether the documented flow still reflects the current experience.

You will typically use this feature after a new version is available for review, when a change request affects a documented flow, or before selecting **Review & Publish**. Compare the earlier and later revisions, identify the user-visible impact, then update the documentation where needed.

The comparison workspace can include a source-oriented view and a difference view. Use the available comparison controls to focus on changes, then use **Save Changes** after you update the documentation.

> 📷 _Screenshot pending: The product flow revision comparison workspace showing version comparison controls and changed content._

## Prerequisites

Before you start, make sure you have the following:

- Access to the relevant project and its product flow documentation.
- At least two available revisions or versions to compare.
- Permission to edit the associated documentation if you need to make updates.
- A clear understanding of the flow you are reviewing, including the expected user journey.
- Any supporting change information needed to confirm why the experience changed.

## Step-by-Step Instructions

1. Open the project that contains the product flow documentation you want to review.

2. Open the area where the project’s versions or revisions are available.

3. Select **Compare Versions** to open the version comparison workspace.

4. Choose the revision that represents the earlier version of the product flow.

5. Choose the revision that represents the newer version of the product flow.

6. Select **Compare** to load the differences between the selected revisions.

7. Review the comparison results to identify additions, removals, and modifications that affect the product flow.

8. Select **Source** if you need to inspect the source-oriented representation of the changed content.

9. Use the comparison display to review each changed section and determine whether it changes what a user sees or does in the flow.

10. If the comparison identifies a change in the documented experience, open the related product flow documentation for editing.

11. Update the flow description so that it reflects the current user journey, including changed screens, actions, decisions, and outcomes.

12. Update any affected diagrams or visual flow content if the changed experience is represented graphically.

13. Select **Save Changes** to keep your documentation updates.

14. Select **Back to Review** when you are ready to return to the documentation review process.

15. Select **1 Review Summary** to confirm that the revised documentation and comparison findings are ready for review.

> 📷 _Screenshot pending: A comparison result showing changed product flow content and the Source option._

## Tips and Best Practices

- Compare revisions before you begin editing. This helps you distinguish actual experience changes from wording or formatting differences.

- Focus on changes that alter the user journey. For example, review changes that add or remove a step, change a decision point, redirect users to another screen, or change the result of an action.

- Review relationships between parts of the flow, not only individual screens. A component can render another component or use a hook or service, and these changes may indicate that the visible experience or its supporting behavior has changed.

- Check changes across the relevant product areas. A flow may involve frontend behavior, backend processing, data storage, API schema, configuration, and documentation. Not every technical change needs a user-facing documentation update, but you should verify its effect on the experience.

- Use **Change branch** when your organization maintains changes in a different branch or revision context. Confirm that you are comparing the intended versions before selecting **Compare**.

- Keep documentation language user-centered. Describe the screen, control, and result that users encounter rather than internal implementation details.

- Save documentation changes before moving to **Review & Publish**. Unsaved edits may not be included in the review stage.

- Use **View Changelog** when you need additional context about changes included in a version. This can help you validate whether a difference is expected.

## Related Pages

- [Review Product Flow Documentation](#)
- [Update Product Flow Documentation](#)
- [Review and Publish Documentation](#)
- [View Project Changelog](#)
- [Export Documentation](#)
- [Request Documentation Changes](#)

## Troubleshooting

### **Compare Versions** does not show the revisions you need

Confirm that the required earlier and newer versions are available in the project. If your team uses multiple branches, select **Change branch** and choose the branch that contains the revisions you need to compare.

### The comparison shows changes, but the product flow appears unchanged

Review the changed content carefully in both the regular comparison display and **Source** view. Some differences may be structural or supporting changes that do not affect the user journey. Update documentation only when the visible experience, user action, decision, or outcome has changed.

### You cannot save documentation updates

Verify that you have editing permission for the documentation and that you have made changes in the editable documentation area. After making your updates, select **Save Changes** again. If the issue continues, return to **Back to Review** and confirm that the documentation is in the correct review context.

<!-- source: understand-screenshot-capture-processing.md -->

# Understand Screenshot Capture Processing

Screenshot capture processing creates visual evidence for your product flow documentation. It helps you review what users see at key points in a flow and keep published documentation aligned with the product experience.

## Overview

Atloria captures screenshots as part of product flow documentation and review. These images provide visual context alongside the written steps, helping reviewers confirm that a documented action matches the relevant screen, control, or state in the product.

You typically use screenshot processing after a product version is available for review. From the review area, you can open screenshot management, inspect the captured evidence, and request a new capture when an image is missing, outdated, or no longer represents the current interface.

The capture process supports both individual and bulk updates. Use **Recapture** for a specific screenshot that needs replacement, or use **Bulk Recapture** when multiple screenshots in a flow or version need to be refreshed together. When the evidence is ready, return to review and continue toward publication.

> 📷 _Screenshot pending: The Review Summary area showing the Manage Screenshots link for a product version._

## Prerequisites

Before you begin, make sure you have:

- Access to the relevant project and product version.
- A version that is ready to review.
- Permission to open the review and screenshot management areas.
- A product environment that can be captured successfully.
- A clear understanding of which flow steps require visual evidence.
- Any recent product changes completed before you request a recapture.

## Step-by-Step Instructions

1. Open the project version that you want to review.

2. Select **1 Review Summary** to view the version’s review workspace.

3. Select **Manage Screenshots →** to open the screenshot management area.

4. Review the available screenshots to identify evidence that is missing, outdated, or incorrect.

5. Select **Preview** for a screenshot when you need to inspect its visual evidence before changing it.

6. Select **Capture** when a screenshot does not yet have captured evidence.

7. Select **Recapture** when you need to replace an existing screenshot with a current version.

8. Select **3. Bulk Recapture** when several screenshots need to be updated together.

9. Confirm the screenshots you want to refresh in the bulk recapture workflow.

10. Wait for the capture processing to complete before relying on the updated images during review.

11. Check the refreshed screenshot evidence to confirm that the correct screen and interface state were captured.

12. Select **Back to Review** to return to the review workspace.

13. Continue with **Review & Publish** after the screenshots accurately support the documented flow.

> 📷 _Screenshot pending: Screenshot management screen showing Preview, Capture, Recapture, and Bulk Recapture actions._

## Tips and Best Practices

- Capture screenshots after the relevant product changes are complete. Recapturing too early can create evidence for an interface that is still changing.

- Use **Preview** before selecting **Recapture**. This helps you avoid replacing a screenshot that is already accurate.

- Use **Recapture** for a single incorrect or stale image. This keeps the update focused on the one flow step that changed.

- Use **3. Bulk Recapture** when a broader interface update affects several steps, such as a navigation change, a shared layout update, or renamed controls.

- Review screenshots in the context of the associated product flow. A screenshot can look correct on its own while still showing the wrong point in the user journey.

- Pay attention to visible action labels and screen states. For example, documentation that refers to **Manage Screenshots →**, **Capture**, or **Review & Publish** should be supported by evidence showing the applicable stage of the workflow.

- Return to **1 Review Summary** after processing captures. This is the appropriate place to verify that the visual evidence supports the overall version review before publication.

- If you are preparing end-user documentation, keep screenshots focused on the controls users need to act on. Avoid relying on images that include unrelated areas of the application.

## Related Pages

- [Review a Product Version](#)
- [Manage Screenshots for a Product Version](#)
- [Use Bulk Recapture](#)
- [Preview Documentation Before Publishing](#)
- [Review and Publish Product Documentation](#)
- [Export Documentation](#)

## Troubleshooting

### A screenshot is missing

Open **Manage Screenshots →** from **1 Review Summary** and select **Capture** for the missing evidence. After processing completes, review the new image with **Preview** before returning to review.

### A screenshot shows an outdated interface

Select **Preview** to verify that the image is no longer accurate. Then select **Recapture** to request an updated image for that specific screenshot. Use **3. Bulk Recapture** instead if the same product change affects multiple screenshots.

### The captured image does not support the documented step

Return to the relevant flow and determine whether the issue is the screenshot, the documented instruction, or both. Request **Recapture** if the image represents the wrong screen or state. Update the flow documentation before selecting **Review & Publish** if the written step no longer matches what users see.

<!-- source: return-to-previous-product-flow-views.md -->

# Return to Previous Product Flow Views

This page explains how to return from a product-flow view to the screen you were reviewing previously. Using the return control helps you move between product-flow documentation and review work without losing your place in the workflow.

## Overview

Product-flow views help you inspect documentation, source context, and review information for a product. When you open a product-flow view from another Atloria screen, a back-navigation control is available to take you to the previous relevant view.

Use this control when you have finished checking a product flow and want to continue your earlier task, such as reviewing documentation or comparing changes. For example, you may open a flow while working in **Review &amp; Publish** and then return to the review area by selecting **Back to Review**.

The available return destination depends on how you entered the product-flow view. If you opened the flow from a review screen, returning takes you back to that review context. If you are comparing documentation changes, you may also see **← Previous Change**, which moves to the prior change in the review sequence rather than leaving the current workflow.

> 📷 _Screenshot pending: Product-flow view showing the return navigation control and related review actions._

## Prerequisites

Before returning from a product-flow view, make sure that:

- You have opened a product-flow view from an Atloria product or documentation workflow.
- You have reviewed or saved any information you need from the current view.
- You know whether you want to return to the review area or move through a sequence of changes.
- You have access to the relevant project and version review area, if your flow was opened during documentation review.

## Step-by-Step Instructions

1. Open the product-flow view that you want to leave.

2. Review the current flow, source information, or documentation details before navigating away.

3. Locate the return control near the product-flow navigation area.

4. Click **Back to Review** when you want to return to the documentation review screen that led to the current product-flow view.

5. Wait for the review screen to open.

6. Confirm that the review context is still visible, including the relevant project, version, or documentation item.

7. Click **← Previous Change** instead when you are reviewing a sequence of changes and want to inspect the change immediately before the current one.

8. Select **1 Review Summary** when you want to return to the review summary rather than continue examining individual changes.

9. Select **Product** if you need to return to the broader product area and continue exploring product-related information.

10. Select **Source** when you need to review the source-oriented view associated with the current documentation or flow.

> 📷 _Screenshot pending: The Back to Review action displayed from a product-flow view._

## Tips and Best Practices

- Use **Back to Review** after examining a flow that was opened during review. This keeps your work focused on the same review process instead of requiring you to locate the item again manually.

- Use **← Previous Change** only when you want to move through the change history one item at a time. It is intended for reviewing the prior change, not for returning to a different workspace.

- Check the destination after you return. The screen you reach reflects the context from which you opened the product-flow view, such as a review summary or an individual change.

- If you need a high-level view of the review process, choose **1 Review Summary** rather than repeatedly moving backward through individual changes.

- Use **Source** when the question you are investigating concerns implementation context, and use **Product** when you need to return to the product-oriented documentation view.

- Before leaving a flow, make a note of any details you need to compare later. Returning to review changes the screen context from the flow view to the review workflow.

## Related Pages

- [Review and Publish Documentation](#)
- [Use the Review Summary](#)
- [Review Documentation Changes](#)
- [View Product Documentation](#)
- [View Source Information](#)
- [Export Documentation](#)

## Troubleshooting

### You do not see **Back to Review**

The return action may only be available when you opened the product-flow view from a review workflow. Select **Product** or **Source** to continue in the available context, or return to the appropriate review area and reopen the flow from there.

### **← Previous Change** does not take you back to the review summary

**← Previous Change** moves to the preceding change in a change sequence. To return to the overall review status, select **1 Review Summary** instead.

### You returned to a different screen than expected

The return destination depends on the screen from which you entered the product-flow view. Review the available actions—such as **Back to Review**, **Product**, and **Source**—and select the one that matches the area you need to continue working in.

<!-- source: explore-product-flow-entities.md -->

# Explore Product Flow Entities

Use the EntityTree to explore the product entities identified in your project and understand how they relate to one another. This view helps you review product flow documentation by moving from individual entities to the relationships that connect the product experience.

## Overview

Product flow entities represent the parts of your application that contribute to how the product works. Depending on the project content, these can include frontend entities such as components, hooks, pages, layouts, contexts, providers, and stores, as well as backend entities such as controllers, services, repositories, middleware, routes, and database-related items.

The EntityTree organizes these entities so you can browse them in a structured view rather than searching through source material manually. Use it when you need to understand where a product capability is represented, identify related parts of the application, or prepare to review the product flow documentation.

Relationships provide the context behind the tree. For example, one component may **render** another component, or a component may **use** a hook. Reviewing these connections helps you follow the path of a product interaction across the entities involved, instead of treating each item as an isolated technical artifact.

> 📷 _Screenshot pending: The EntityTree showing product entities and their relationship hierarchy._

## Prerequisites

Before you begin, make sure that:

- You have access to the relevant project in Atloria.
- The project version you want to review is available.
- Product or source intelligence has been generated or imported for the project.
- You know the product area, screen, feature, or entity name you want to investigate.
- You can access the project’s review area when you need to return to the documentation review workflow.

## Step-by-Step Instructions

1. **Open the project and choose the version you want to investigate.**

   Start from the project that contains the product flow documentation you need to review. Select the appropriate version so that the EntityTree reflects the correct snapshot of the product and its source intelligence.

2. **Navigate to the product flow entity view.**

   Open the EntityTree from the project’s product documentation and review area. The tree presents entities in an organized structure, helping you move from broad product areas into the individual items that support them.

   If you are working from the review workflow, use **Back to Review** when you need to return to the review summary after exploring entities.

3. **Browse the entity hierarchy.**

   Expand the available branches to inspect the entities identified for the product. The tree may include entities such as:

   - Components
   - Hooks
   - Pages
   - Layouts
   - Routes
   - Contexts and providers
   - Stores
   - Controllers
   - Services
   - Repositories
   - Middleware

   Use the hierarchy to understand which entities belong together. For example, a page may contain or render components, while those components may use hooks or shared context.

4. **Search for a specific entity.**

   Use the **Search entities…** field to find an entity by name. Enter a meaningful term, such as a page name, a component name, or a feature keyword.

   Search is especially useful in larger projects where the tree contains many frontend, backend, database, API schema, configuration, documentation, or infrastructure entities. If your search does not immediately show the expected item, try a shorter or more distinctive part of the entity name.

> 📷 _Screenshot pending: The “Search entities…” field filtering the EntityTree to matching product entities._

5. **Select an entity to examine its connections.**

   Choose an entity in the tree to focus your review on that item and its relationships. Look for relationship descriptions that explain how entities interact. Common relationship language can include **renders** and **uses**.

   For example, if a component renders another component, the relationship helps you understand the visible composition of a product screen. If a component uses a hook, the relationship can indicate where that component receives shared behavior or data.

6. **Use source information when you need additional context.**

   When source context is available, select **View Source** to inspect the supporting source material associated with the entity. Use this only when you need to confirm what an entity represents or validate a relationship shown in the EntityTree.

   The EntityTree is intended to support product understanding first. Source information is useful for resolving uncertainty, but you can often understand the overall product flow by following the entity hierarchy and relationship labels.

7. **Return to documentation review.**

   After identifying the entities relevant to the product flow, use **Back to Review** to continue reviewing the generated documentation. You can use what you learned from the EntityTree to assess whether the documentation accurately describes the product experience and its supporting relationships.

## Tips and Best Practices

- **Start with the product-facing entity.** Begin with a page, layout, or visible component when you are investigating a user journey. Then follow relationships such as **renders** to understand what appears within that experience.

- **Use relationships to follow behavior.** A relationship such as **uses** can help you trace shared behavior from a component to a hook, context, provider, store, or service. This is useful when a feature’s behavior is not fully represented by a single screen-level entity.

- **Search before manually expanding a large tree.** The **Search entities…** field is the fastest way to locate a known entity. Once you find it, use its surrounding hierarchy and relationships to identify related entities.

- **Review across product layers when necessary.** A user-facing feature can involve more than frontend entities. Follow the flow into controllers, services, repositories, routes, database items, or API schema entities when you need a fuller understanding of how the product capability is supported.

- **Use the EntityTree as a review aid.** During documentation review, compare the entities and relationships you find with the written product flow. If an important page, component, or connection appears absent from the documentation, flag it for follow-up before publishing.

## Related Pages

- [Review Product Flow Documentation](#)
- [Use the Review Summary](#)
- [View Source for Documentation Review](#)
- [Generate Documentation](#)
- [Export Documentation](#)

## Troubleshooting

### I cannot find the entity I am looking for

Use **Search entities…** and try a shorter search term. Entity names may be based on the product’s underlying structure, so search for a distinctive word from the page, component, feature, or service name. If the entity still does not appear, verify that you opened the correct project version.

### The relationships do not explain the full product flow

Start with the visible product entity and inspect related entities step by step. A complete flow may span multiple layers, such as a page, component, hook, controller, service, and repository. Use **View Source** when you need supporting context for an unclear relationship.

### I need to return to the documentation review workflow

Select **Back to Review**. This returns you to the review area, where you can continue reviewing the documentation after investigating the relevant entities and relationships.

<!-- source: capturedflows-documenting-captured-product-flows.md -->

# CapturedFlows: Documenting Captured Product Flows

CapturedFlows help you review recorded product journeys and turn observed user interactions into clear documentation. Use them when you need to understand how a user moves through a product experience before writing or reviewing a User Guide.

## Overview

A CapturedFlow brings together the screens and interactions that make up a product journey. Instead of documenting an isolated screen, you can use the flow to follow the user’s path from one action to the next and identify the purpose of each step.

This is especially useful when you are preparing documentation for a feature with multiple screens, such as creating a record, reviewing information, and publishing or exporting documentation. Reviewing the full flow helps you describe the correct order of actions and use the labels that users actually see.

CapturedFlows support Source and Product Intelligence work by giving you a focused view of a journey before you create or update documentation. You can use the flow alongside your project’s documents, source context, and review process.

> 📷 _Screenshot pending: The CapturedFlows area showing a selected product journey and its recorded steps._

## Prerequisites

Before you begin, make sure that:

- You have access to the relevant project in Atloria.
- A product flow has been captured for the journey you want to document.
- You know which audience and documentation type the journey supports, such as **User Guides**.
- You have permission to view project documentation and participate in review activities.
- You have identified whether you are reviewing an existing document or preparing a new one.

## Step-by-Step Instructions

1. Open the project that contains the product journey you want to document.

2. Select **Loop Flows** to open the area where captured product journeys are available.

3. Select the captured flow that matches the user journey you need to review.

4. Review the first screen in the flow to understand where the user begins the journey.

5. Move through each recorded interaction in sequence to identify what the user selects, enters, or confirms.

6. Record the visible screen name, field name, and button label for each interaction you plan to describe.

7. Note any navigation actions that move the user to another screen, such as selecting **Documents** or **User Guides**.

8. Identify the outcome of the flow, such as reaching **Review & Publish**, opening **Preview**, or choosing **Export Documentation**.

9. Select **View Source** when you need additional context for a screen or interaction.

10. Use the **Source** view to confirm terminology and relationships that affect the journey you are documenting.

11. Return to the flow and compare the source context with the visible user experience.

12. Open **Documents** when you are ready to locate the documentation that describes the journey.

13. Enter keywords in **Search documents...** to find an existing page for the captured flow.

14. Select the relevant document from the search results.

15. Select **Preview** to check how the documented steps will appear to readers.

16. Select **Review & Publish** when the documentation is ready for the project review process.

> 📷 _Screenshot pending: A captured flow showing sequential user interactions and the selected step’s screen details._

## Tips and Best Practices

- Review the flow in its recorded order. A user journey can depend on earlier actions, and documenting steps out of sequence can cause readers to miss required information.
- Use the labels shown in the captured screens. For example, write **Search documents...**, **Review & Publish**, and **Export Documentation** exactly as users see them.
- Document one user action per numbered instruction. If a user must select a button and then complete a field, make those separate steps.
- Use the captured flow to distinguish navigation from completion. Selecting **Preview** lets users inspect documentation, while **Review & Publish** moves it into the review and publishing process.
- Check source context when a screen’s purpose is unclear, but keep the finished User Guide focused on what users see and do.
- Use **Back to Review** when you need to return from a detailed review view to the broader review process.
- If a captured journey includes a documentation task, verify that the final instructions match the relevant document audience, such as **User Guides**.

## Related Pages

- [Working with Documents](#)
- [Creating a New Document](#)
- [Searching Documentation](#)
- [Reviewing and Publishing Documentation](#)
- [Previewing and Exporting Documentation](#)
- [Using Source Context for Product Intelligence](#)

## Troubleshooting

### You cannot find the flow you need

Return to the project and select **Loop Flows** again. Confirm that you are viewing the correct project and that a flow has been captured for the journey you want to document. If no matching flow is available, request that the journey be captured before documenting it.

### The screen labels do not match an existing document

Use the captured flow as the primary reference for what users see. Update the document to use the current visible labels, then select **Preview** to verify the revised instructions.

### You are unsure whether a document is ready to publish

Review the complete captured journey, confirm that every user action is represented in the correct order, and verify the result of the final action. When the page is complete, select **Review & Publish** rather than assuming that previewing the page publishes it.

<!-- source: create-an-atloria-organization.md -->

# Create an Atloria Organization

An Atloria organization provides the shared workspace for your teams, projects, and documentation. Create or select the correct organization before creating projects so that shared work is grouped under the right business area.

## Overview

Organizations are the top-level workspace for collaborative work in Atloria. They help you separate teams, projects, and documentation that belong to different departments, customers, or business units.

After your organization is available, you can use the **Projects** area to create and manage the projects that belong to it. The project hub includes options such as **Create project**, **Quick Create**, and search tools for finding work across projects.

The currently captured interface confirms the project-management controls but does not include a verified organization-creation screen, organization field list, or organization-specific button label. Because organization setup may be limited to designated administrators or provisioned during onboarding, use the steps below to confirm your workspace and continue safely into project setup.

> 📷 _Screenshot pending: Organization workspace selection or organization creation screen, including the organization name field and primary action button._

## Prerequisites

Before you begin, make sure that you have:

- An active Atloria user account.
- Access to the Atloria workspace where you need to create or manage projects.
- Administrator or organization-management permission, if your company restricts organization setup.
- The approved organization name for your team, department, customer, or business unit.
- A clear understanding of which projects and documentation should belong to the organization.
- A plan for who will manage organization-level access and project ownership.

## Step-by-Step Instructions

1. Sign in to Atloria with the account that has access to your intended workspace.

2. Open the workspace or administration area assigned to your account.

3. Look for an organization selection or organization-management option.

4. Select the option to create an organization if it is available to your account.

5. Enter the approved organization name in the organization name field.

6. Complete any additional organization details shown on the screen, such as an identifier, workspace description, or owner information.

7. Review the organization name carefully before saving.

8. Select the primary save or create button shown on the organization screen.

9. Confirm that the new organization is selected as your active workspace after it is created.

10. Open **Projects** to begin setting up work within the organization.

11. Select **Create project** to create a standard project in the active organization.

12. Select **Quick Create** instead if you need the faster project-creation flow available in your workspace.

13. Use **Search projects...** to confirm whether a project already exists before creating a duplicate.

14. Use **Search across all projects...** when you need to check for related work beyond the current project list.

15. Select **1. Hub: All Projects** to return to the central project hub when you need to review the organization’s project portfolio.

> 📷 _Screenshot pending: Projects hub showing “1. Hub: All Projects”, “Search projects...”, “Quick Create”, and “Create project”._

## Tips and Best Practices

- Use a stable, recognizable organization name. Choose a name that users can identify easily in workspace selection lists and in shared documentation.

- Create separate organizations only when teams need clear operational separation. For example, separate customer environments, independently managed business units, or distinct security boundaries may require different organizations. Do not create a new organization simply because you are starting a new project.

- Check the project hub before creating new work. The **Search projects...** field helps you find projects in the current list, while **Search across all projects...** is useful when you need a broader search.

- Create the organization before creating shared content. This helps ensure that projects, agents, and documentation are established in the correct workspace from the start.

- Use **Create project** for a standard project setup. Use **Quick Create** only when you understand the defaults that your workspace applies.

- Plan ownership early. Make sure that at least one responsible administrator can manage the organization and its projects if the original creator is unavailable.

- Keep names consistent. If your company uses naming standards for departments, clients, regions, or environments, apply those standards to organization and project names.

## Related Pages

- [Create a Project](#)
- [Manage Organization Members](#)
- [Search Projects](#)
- [Create Documentation](#)
- [Export Documentation](#)
- [Create and Manage Agents](#)

## Troubleshooting

### You do not see an option to create an organization

Your account may not have organization-management permission, or your organization may be provisioned during onboarding. Contact your Atloria administrator and ask them to confirm whether organization creation is available for your role.

### You are in the Projects area but cannot find the organization you need

Return to your workspace or organization selector and verify that the correct organization is active. The **Projects** hub and **1. Hub: All Projects** show projects for the workspace you can access, not necessarily every organization in your company.

### You are unsure whether to create a new organization or a new project

Create a project when the work belongs to an existing team or shared workspace. Create a separate organization only when the work requires a separate top-level workspace, ownership model, or access boundary. Use **Search projects...** before creating a project to avoid duplicates.

<!-- source: configure-project-settings.md -->

# Configure Project Settings

Project settings let you organize how a project is identified and how its documentation workspace is configured. Use these settings when you create a new project, update an existing project’s scope, or adjust the options used to generate and present documentation.

## Overview

Atloria provides project-level settings so you can manage each project independently from the **Projects** hub. This is useful when your organization maintains multiple applications, repositories, or documentation workspaces and needs each one to have its own configuration.

From a project’s settings area, you can work with three configuration sections:

- **General Settings** for the project’s primary setup and identity.
- **Parser Settings** for options related to how Atloria processes the project.
- **Template Settings** for documentation workspace and presentation options.

The available settings are organized in the **Project Sidebar**, helping you move between project workspaces without returning to the organization-wide **Projects** list. When your configuration is complete, you can use **View Your Documentation →** to review the resulting documentation workspace.

> 📷 _Screenshot pending: Project settings screen showing the Project Sidebar and the General Settings, Parser Settings, and Template Settings options._

## Prerequisites

Before you begin, make sure you have the following:

- Access to the Atloria workspace that contains the project.
- A project listed in the **Projects** hub.
- Permission to open and manage the project’s **Settings**.
- The project information and documentation requirements you want to apply.
- A clear understanding of whether you need to update general project information, parser behavior, template choices, or all three.

## Step-by-Step Instructions

1. Select **Projects** from the **Workspace Sidebar**.

2. Use **Search projects...** if you need to find a project in a large project list.

3. Select the project you want to configure from the **Projects** list.

4. Open **Settings** from the project workspace.

5. Select **General Settings** in the settings navigation.

6. Review the general project setup information shown in **General Settings**.

7. Update the available general settings to reflect the project’s current identity and scope.

8. Save or confirm your general settings changes using the available on-screen action.

9. Select **Parser Settings** in the settings navigation.

10. Review the available parser configuration options for the selected project.

11. Adjust the parser options that match the technologies and content included in your project.

12. Save or confirm your parser settings changes using the available on-screen action.

13. Select **Template Settings** in the settings navigation.

14. Review the available documentation template and workspace options.

15. Choose the template settings that best match the documentation experience you want users to see.

16. Save or confirm your template settings changes using the available on-screen action.

17. Select **View Your Documentation →** to open the project’s documentation and verify the configured experience.

18. Select **Open Project Dashboard** if you want to return to the project’s primary workspace after reviewing the documentation.

> 📷 _Screenshot pending: General Settings selected in the Project Sidebar, with the project’s available identity and scope controls visible._

> 📷 _Screenshot pending: Template Settings selected, showing documentation workspace configuration options and the View Your Documentation button._

## Tips and Best Practices

- Configure **General Settings** before changing parser or template options. This helps ensure you are working in the correct project and applying changes to the intended documentation workspace.

- Use **Parser Settings** when the project’s content or technology coverage changes. For example, revisit these options after adding a major frontend, backend, database, API schema, configuration, documentation, or infrastructure area to the project.

- Treat **Template Settings** as presentation choices for the documentation workspace. Review the documentation after changing these settings by selecting **View Your Documentation →**.

- Configure one project at a time. The **Workspace Sidebar** gives access to the broader workspace, while the **Project Sidebar** applies to the currently selected project.

- Use **← Back to Projects** when you need to switch projects rather than editing the current project’s settings.

- Avoid using **Delete Project** as part of routine configuration. Deletion is separate from updating settings and should only be used when the project is no longer needed.

- If you are onboarding a new project, complete the configuration before relying on the documentation workspace. A project may show a configured state, such as **Configured**, after its setup has been completed.

## Related Pages

- [Manage Organization Projects](#) — Find, open, and organize projects from the **Projects** hub.
- [Create a New Project](#) — Set up a project before configuring its settings.
- [Configure Parser Settings](#) — Adjust project processing options.
- [Configure Documentation Templates](#) — Set documentation workspace and template preferences.
- [View Project Documentation](#) — Review the documentation available through **View Your Documentation →**.
- [Open the Project Dashboard](#) — Return to the main project workspace and project activities.

## Troubleshooting

### You cannot find the project you want to configure

1. Select **Projects** in the **Workspace Sidebar**.

2. Enter the project name in **Search projects...**.

3. Select the matching project from the results.

4. If the project is not listed, verify that you are in the correct workspace or ask an administrator to confirm your project access.

### You are editing the wrong project

1. Select **← Back to Projects**.

2. Locate the correct project by using **Search projects...** or browsing the project list.

3. Select the correct project.

4. Open **Settings** again before making changes.

### Your documentation does not reflect the settings you expected

1. Open **Settings** for the active project.

2. Review **General Settings**, **Parser Settings**, and **Template Settings** to confirm the intended configuration.

3. Save or confirm any corrections using the available on-screen action.

4. Select **View Your Documentation →** to review the documentation workspace again.

5. If the issue continues, verify that you are working in the intended **Active Project** rather than a **New Project** or another project workspace.

<!-- source: archive-or-restore-a-project.md -->

# Archive or Restore a Project

Archiving lets you remove a documentation project from the active working list without deleting it. Restoring makes an archived project available for ongoing documentation work again.

## Overview

Use archiving when a project is complete, paused, retired, or no longer needs to appear alongside your organization’s active projects. Archived projects remain identifiable by the **Archived** status, helping you keep the **Projects** hub focused on current work.

A project moves through two practical stages in this workflow:

1. **Active Project** — The project appears in the main **Projects** area and can be opened from its project dashboard.
2. **Archived** — The project is marked **Archived** and is separated from active work. You can locate it when you need to review it or return it to active use.

Restoration reverses the archive state. Restore a project when documentation work resumes, when a project becomes active again, or when you archived it by mistake. Administrators typically manage this lifecycle, while documentation contributors can continue working after the project is restored.

> 📷 _Screenshot pending: The Projects hub showing active projects, search controls, and an archived project marked Archived._

## Prerequisites

Before you archive or restore a project, make sure that:

- You are signed in to Atloria and can access the **Projects** hub.
- You can open the project you want to manage.
- You have confirmed that the project should no longer be treated as active, or that it is ready to resume active work.
- Any team members who rely on the project’s documentation have been informed of the planned status change.
- You have reviewed the project name carefully. Use **Search projects...** or **Search across all projects...** if you need help finding it.
- You understand that **Delete Project** is different from archiving. Use **Archive** when you want to preserve the project rather than remove it.

## Step-by-Step Instructions

### Archive a project

1. Open **Projects**.

   From the projects area, use the project list to find the active project you want to archive. If the list is long, enter the project name in **Search projects...**.

2. Select the project.

   Open the project from the list to reach its focused project area. You may see navigation options such as **Open Project Dashboard** and **View Your Documentation →**.

3. Review the project before changing its status.

   Confirm that you selected the correct project and that your team no longer needs it in the active project list. If you opened the wrong project, select **← Back to Projects** or **Back to Projects** to return to the hub.

4. Select **Archive**.

   In the project actions, choose **Archive**. This changes the project from an active project to an archived project.

5. Confirm the archived state.

   Return to **Projects** and locate the project. The project is identified as **Archived** rather than remaining among active projects.

   Archiving affects the project’s lifecycle state; it is not the same as selecting **Delete Project**. Do not use **Delete Project** when your intention is to retain the project for possible future work.

> 📷 _Screenshot pending: The focused project screen with the Archive action and project navigation visible._

### Restore an archived project

1. Open **Projects**.

   Start from the **Projects** hub, which is the central place for viewing your organization’s projects.

2. Find the archived project.

   Locate the project marked **Archived**. Use **Search projects...** or **Search across all projects...** to find it by name when necessary.

3. Open the archived project.

   Select the archived project to review it. Confirm the project name and status before changing it back to active.

4. Use the project restoration control.

   Choose the restoration option available for the archived project to return it to active use. After restoration, the project is no longer shown as **Archived** and returns to the active project workflow.

5. Reopen the project dashboard.

   Select **Open Project Dashboard** to verify that the restored project is available for your team. You can then use **View Your Documentation →** to continue documentation work.

> **Note:** **Restore this version** applies to a documentation version. It is not the same as restoring an archived project. Use it only when you intend to return documentation content to a previous version.

## Tips and Best Practices

- **Archive instead of delete when work may resume.** Archiving is the safer lifecycle choice for completed, paused, or seasonal projects.
- **Search before taking action.** Similar project names can make it easy to select the wrong item. Use **Search projects...** and confirm the project before choosing **Archive**.
- **Tell contributors about the status change.** Project administrators manage archiving and restoration, but writers, reviewers, and other contributors need to know whether a project is active.
- **Use project restoration for project lifecycle changes.** If you only need to revert documentation content, use the version area and **Restore this version** rather than changing the entire project’s archive status.
- **Keep the active list meaningful.** Archive projects that no longer need regular attention so current documentation work is easier to find in **Projects**.

## Related Pages

- [Create a Project](#)
- [Open and Navigate a Project Dashboard](#)
- [Search for Projects](#)
- [Delete a Project](#)
- [Restore a Documentation Version](#)
- [Export Documentation](#)

## Troubleshooting

### I cannot find the project I want to archive or restore

Use **Search projects...** in the project list. If you are looking across a broader set of projects, use **Search across all projects...**. Check whether the project is already marked **Archived**.

### I see **Delete Project**, but I only want to hide the project from active work

Do not select **Delete Project**. Return to the project actions and use **Archive** instead. Archiving is intended for lifecycle management; deletion is a separate action.

### I restored a version, but the project is still archived

**Restore this version** restores documentation content for a version; it does not change the project’s **Archived** status. Open the archived project and use the project restoration control to return the project to the active lifecycle.

<!-- source: configure-organization-member-access.md -->

# Configure Organization Member Access

Use **Access Control** to configure the access information your organization uses for team members. This helps you assign and verify access for administrators, managers, writers, and contributors while keeping access configuration consistent across the team.

## Overview

Organization member access is managed from the **Access Control** area. When you need to give a new team member access, update an existing member’s authorization information, or confirm that access has been configured, begin here.

The access configuration flow includes a **Configure →** action and fields for supplying authorization information. Depending on your organization’s setup, you may be asked to **Enter access token** or **paste a member JWT**. Use credentials issued by your organization’s approved identity or access-management process.

After configuration is completed, the interface can show a **Configured** status. Treat this status as confirmation that the access setup has been recorded. If your organization uses role-based access control, ensure the member’s assigned permissions match their work responsibilities, such as administration, management, writing, or contribution.

> 📷 _Screenshot pending: The Access Control area showing the Configure action and configured access status._

## Prerequisites

Before you configure member access, make sure you have:

- Permission to manage organization or team access.
- The correct member authorization information.
- An approved access token, if your organization uses tokens.
- A valid member JWT, if your organization uses JWT-based access.
- A clear understanding of the member’s intended responsibilities, such as administrator, manager, writer, or contributor.
- Confirmation that the member should be included in the organization or team.

## Step-by-Step Instructions

1. Open the organization or team area where you manage members.

2. Select **Access Control**.

3. Review the current access information shown for the organization or member.

4. Click **Configure →**.

5. Select the access method requested by the configuration screen.

6. Enter the approved credential in the **Enter access token** field when your organization uses an access token.

7. Paste the member’s authorization value in the **paste a member JWT** field when your organization uses a member JWT.

8. Verify that the credential belongs to the intended team member before continuing.

9. Complete the on-screen configuration action provided after you enter the credential.

10. Return to **Access Control** after the configuration is complete.

11. Confirm that the access entry shows **Configured**.

12. Review the member’s access level and confirm it is appropriate for their responsibilities.

> 📷 _Screenshot pending: The configuration view with the Enter access token and paste a member JWT fields._

## Tips and Best Practices

- Use only credentials issued through your organization’s approved access process. Do not reuse a token or member JWT from another person unless your organization explicitly authorizes it.

- Match access to the member’s actual duties. Administrators typically need broader configuration authority than managers, writers, or contributors. Give each person only the access needed to complete their work.

- Verify the member identity before you paste a credential. A JWT or access token can grant access to the associated identity, so confirming the recipient before configuration helps prevent incorrect assignments.

- Check for the **Configured** status after completing the process. If that status does not appear, do not assume the access change was applied.

- Use **Share with Team** only when you need to communicate access-related information with the team. Avoid sharing sensitive authorization values in team notes or general team communications.

- If you add operational context for the team, use **Add any notes for the team...** for non-sensitive information, such as the reason access was configured or who should review it. Do not place access tokens or member JWTs in notes.

- Review access whenever a member changes responsibilities. For example, update access when a contributor becomes a writer, a writer becomes a manager, or an administrator no longer needs administrative responsibilities.

## Related Pages

- **Manage Organization Members** — Add, review, and remove organization members.
- **Role-Based Access Control (RBAC)** — Understand role-based permissions for organization members.
- **Team Activity** — Review team-related activity and changes.
- **Share with Team** — Share relevant non-sensitive updates with team members.
- **Application Security & Access Control** — Review broader organization security practices.

## Troubleshooting

### The configuration screen asks for a credential I do not have

Request the required access token or member JWT through your organization’s approved access-management process. Do not create, guess, or reuse credentials from another member.

### I entered a credential, but the access entry does not show “Configured”

Return to **Access Control** and start the **Configure →** flow again. Verify that the credential was pasted completely and belongs to the intended member. If the status still does not change, contact an organization administrator to confirm that your account can manage access.

### I am unsure which access level to assign

Confirm the member’s responsibilities with the team owner or organization administrator. Assign the least amount of access necessary for the member to perform their work, and review the assignment if their responsibilities change.

<!-- source: send-and-manage-invitations.md -->

# Send and Manage Invitations

Use organization invitations to give collaborators access to Atloria without sharing existing user credentials. This page explains how to send invitations, monitor pending invitations, and help invited users complete access setup.

## Overview

Invitations are used when you need to add a new collaborator to your organization or workspace. Administrators typically send an invitation to the collaborator’s email address, select the appropriate access level, and then monitor the invitation until the collaborator accepts it.

Invited users receive an invitation link that opens the Atloria invitation screen. On that screen, they may be asked to provide the access token included with their invitation. The visible field is labeled **Enter access token**.

Pending invitations are useful when a collaborator has not yet completed setup. Review pending invitations regularly so you can resend an invitation when necessary, remove invitations that are no longer needed, and avoid leaving access requests open for people who should not join the organization.

> 📷 _Screenshot pending: Organization invitation management screen showing sent and pending invitations._

## Prerequisites

Before you begin, make sure you have:

- Administrator permission to manage organization access.
- The collaborator’s correct email address.
- A confirmed understanding of the access the collaborator should receive.
- Access to the relevant organization or team settings.
- A secure way to share any required access token with the invited collaborator.
- A plan for reviewing invitations that remain pending.

## Step-by-Step Instructions

### Send an invitation

1. Open the organization or team area where access is managed.

2. Select **Manage in Settings** when it is available.

3. Open the invitation or team-access area in Settings.

4. Select the control for creating or sending an invitation.

5. Enter the collaborator’s email address in the email field.

6. Select the access level or role that the collaborator should receive.

7. Review the invitation details before sending them.

8. Select the button that sends the invitation.

9. Confirm that the new invitation appears in the pending invitation list.

10. Record why the collaborator was invited in your team’s normal access-review process.

> 📷 _Screenshot pending: Invitation form with email address, access selection, and send action._

### Help an invited collaborator join

1. Ask the collaborator to open the invitation link they received.

2. Ask the collaborator to enter the invitation access token in **Enter access token** if that field is displayed.

3. Ask the collaborator to submit the token and continue through the invitation process.

4. Verify that the collaborator can access the intended organization resources after accepting the invitation.

5. Review the invitation list to confirm that the invitation is no longer pending.

### Manage pending invitations

1. Open the organization or team access settings.

2. Locate the list of invitations that are still pending.

3. Review the recipient email address for each pending invitation.

4. Check whether the invitation is still required.

5. Resend the invitation when the recipient did not receive it or cannot locate it.

6. Cancel or remove the invitation when the recipient no longer needs access.

7. Review access again after the collaborator joins to confirm that their access level is appropriate.

8. Use **Team Activity** to review relevant team changes when your organization makes that view available.

## Tips and Best Practices

- Send invitations only to verified email addresses. A typo can send an access request to the wrong person and delay onboarding.

- Use the lowest level of access that allows the collaborator to complete their work. If your organization uses role-based controls, review access against your **Role-Based Access Control (RBAC)** practices before sending the invitation.

- Treat access tokens as sensitive information. If a collaborator is asked to use **Enter access token**, share the token through an approved secure channel rather than placing it in public chat messages or unprotected documents.

- Review pending invitations on a regular schedule. An invitation that remains pending may indicate an incorrect email address, a delivery issue, or a change in staffing.

- Remove invitations that are no longer needed. This is especially important for contractors, temporary project members, or collaborators whose work has ended.

- When you manage access for multiple environments or versions, verify that the collaborator is being added to the correct area. You may see options such as **Manage all versions →** or **🕒 Go to Version Manager** in areas where version access is relevant.

- Keep team notes focused on the access decision. Where available, use **Add any notes for the team...** to document why access was granted, changed, or removed.

## Related Pages

- [Manage Team Access](#)
- [Role-Based Access Control (RBAC)](#)
- [Review Team Activity](#)
- [Manage Version Access Control](#)
- [Application Security & Access Control](#)

## Troubleshooting

### The invited collaborator cannot continue past the invitation screen

Ask the collaborator to confirm that they opened the complete invitation link. If the screen displays **Enter access token**, ask them to enter the token provided with the invitation and try again. If the token is unavailable or suspected to be incorrect, cancel the pending invitation and send a new one through your approved process.

### The invitation is still pending

Confirm that the recipient email address is correct. Ask the recipient to check spam, junk, and email filtering folders. If they cannot find the invitation, resend it from the pending invitation list. Remove the original invitation if your organization’s process requires only one active invitation per person.

### The collaborator joined but has the wrong access

Review the collaborator’s assigned role or access selection in the organization’s access settings. Update the access level to match their current responsibilities, and use **Team Activity** to confirm that the change was recorded if that screen is available.

<!-- source: remove-organization-members.md -->

# Remove Organization Members

Remove a collaborator’s access when they no longer need to work in your Atloria workspace. Keeping membership current helps protect workspace content and ensures that only the right people can use shared resources.

## Overview

Organization membership controls who can participate in shared workspace activity. When a team member changes roles, leaves a project, or no longer requires access, you should remove them promptly rather than leaving unused access in place.

Start from the **Workspace Sidebar**, where you can access workspace-level actions. Use **Share with Team** to review the people who currently have access and locate the collaborator whose access should be removed.

Removing a member affects their workspace access, not the underlying content you and other authorized collaborators can still see. Before you remove someone, make sure their work has been handed over and that they are not the only person responsible for an important shared item.

> 📷 _Screenshot pending: The Workspace Sidebar with the Share with Team action highlighted._

## Prerequisites

Before you begin, make sure that:

- You are signed in to the correct Atloria workspace.
- You have permission to manage workspace access.
- You know which collaborator needs to be removed.
- Any work owned or managed by that collaborator has been reviewed or reassigned as needed.
- You have confirmed that removing the collaborator is appropriate for the workspace, not just for one document.

## Step-by-Step Instructions

1. Open the **Workspace Sidebar**.

2. Select **Share with Team**.

3. Review the list of collaborators shown in the sharing and access view.

4. Locate the collaborator whose workspace access you want to remove.

5. Open the available actions for that collaborator.

6. Select the option to remove the collaborator’s access from the workspace.

7. Review the confirmation message, if one is displayed.

8. Confirm the removal.

9. Return to the collaborator list.

10. Verify that the removed collaborator is no longer listed as having workspace access.

> 📷 _Screenshot pending: The collaborator access list showing the member action menu and the removal confirmation prompt._

## Tips and Best Practices

- **Use the workspace sharing area for access changes.** Begin with **Share with Team** when you need to change who can access the workspace.

- **Do not confuse document cleanup with member removal.** The **Remove from Doc** action applies to a document-level task and is not the same as removing a collaborator from the organization or workspace.

- **Check for ownership and handoff needs first.** If the collaborator is responsible for important work, coordinate a handoff before removing access. This prevents the remaining team from losing context around active work.

- **Remove access as soon as it is no longer needed.** Prompt removal is especially important after role changes, contract completion, or employee departures.

- **Review workspace access regularly.** Periodically open **Share with Team** and confirm that the collaborator list still reflects your active team.

- **Use the correct workspace.** If you work with multiple workspaces, verify the workspace name in the **Workspace Sidebar** before making a removal. Removing access in the wrong workspace can interrupt a collaborator’s work unnecessarily.

- **Keep notes outside the removal action when needed.** If your team needs to record why access was removed, use your established team process. The available action **Add any notes for the team...** may be useful for team context where applicable, but it should not replace an approved access-review process.

## Related Pages

- [Share a Workspace with Your Team](#)
- [Review Organization Member Access](#)
- [Manage Workspace Roles and Permissions](#)
- [Remove a Collaborator from a Document](#)
- [Review Team Activity](#)

## Troubleshooting

### You cannot find **Share with Team**

Open the **Workspace Sidebar** and look for **Share with Team** in the available workspace actions. If the option is not available, you may not have permission to manage workspace access. Contact a workspace administrator for assistance.

### You can see the collaborator but cannot remove them

Your role may allow you to view collaborators without changing their access. Ask an administrator with workspace access-management permissions to complete the removal.

### You removed access but still see the collaborator’s previous work

Removing a collaborator changes access; it does not automatically remove existing shared work or activity history. Review the workspace content separately and use the appropriate content-management process if changes are required. Do not use **Remove from Doc** unless you intend to remove an item from a specific document.

<!-- source: configure-authentication-access.md -->

# Configure Authentication Access

Authentication helps protect your Atloria organization, projects, and team access by requiring users to identify themselves before they can continue. This page explains how to open the Authentication area and complete the available authorization and OAuth 2.0 setup actions.

## Overview

Use Authentication when you need to connect Atloria to an approved identity or authorization flow. Authentication access is especially important before sharing project information with team members, connecting external services, or allowing users to work across projects.

In Atloria, authentication-related options are grouped under **Authentication**. From this area, you can review the **Authentication Guide**, open **OAuth 2.0 Setup**, and use authorization actions such as **Authorize Atloria** or **Authorize Bitbucket** when those connections are required.

Authentication works alongside project and team workflows. After access is configured, you can return to **Projects**, use **Share with Team**, and manage the work that your authorized users can access. If a project or service is not authorized, Atloria may prompt you to complete an authorization action before you can continue.

> 📷 _Screenshot pending: The Authentication screen showing the Authentication Guide and OAuth 2.0 Setup options._

## Prerequisites

Before you start, make sure that you have:

- Access to the Atloria organization or project you want to protect.
- Permission to configure access for the organization or project.
- The sign-in details required by your organization’s identity provider, if applicable.
- Approval to authorize any external service, such as Bitbucket.
- The correct project selected if you are configuring access for a specific project.
- The details your organization requires for an OAuth 2.0 connection.

## Step-by-Step Instructions

1. Open the Atloria workspace that contains the organization or project you want to protect.

2. Select **Authentication** to open the authentication options.

3. Select **Authentication Guide** to review the available authentication instructions before making changes.

4. Select **OAuth 2.0 Setup** if you need to configure OAuth 2.0 access.

5. Enter the OAuth 2.0 details requested on the setup screen.

6. Select **Configure →** to save or continue the OAuth 2.0 configuration.

7. Select **Authorize Atloria** when Atloria asks you to approve its authorization request.

8. Complete the authorization prompts shown by your sign-in provider.

9. Select **Authorize Bitbucket** if your project requires access to Bitbucket.

10. Complete the Bitbucket authorization prompts shown in the authorization window.

11. Select **← Authentication** to return to the Authentication area after completing an authorization action.

12. Select **Projects** or **← Back to Projects** to return to your project list.

13. Open the project you want to work with after authentication is configured.

14. Select **Share with Team** when you are ready to provide authorized team members with access to the project.

> 📷 _Screenshot pending: The OAuth 2.0 Setup screen with the Configure → action._

> 📷 _Screenshot pending: The Authentication area showing the Authorize Atloria and Authorize Bitbucket actions._

## Tips and Best Practices

- Review **Authentication Guide** before selecting an authorization option. This helps you choose the correct setup path for your organization or project.

- Configure OAuth 2.0 before inviting or sharing work with a larger team when your organization relies on OAuth-based access. Doing so helps ensure that users are authenticated consistently.

- Use **Authorize Atloria** only when you are ready to approve Atloria’s access request. Complete the prompts in the authorization window rather than closing the window early.

- Use **Authorize Bitbucket** only for projects that need a Bitbucket connection. This keeps external access limited to the services your team actually uses.

- After completing setup, return to **Projects** and confirm that you can open the relevant project. If you cannot continue into a project, review the Authentication area again and check whether an authorization step is still required.

- When sharing a project, use **Share with Team** only after the necessary authentication setup is complete. This reduces the chance that team members receive access instructions before they can sign in successfully.

## Related Pages

- [Manage Projects](#)
- [Share a Project with Your Team](#)
- [OAuth 2.0 Setup](#)
- [Authorize Bitbucket Access](#)
- [Authentication Guide](#)

## Troubleshooting

### You cannot find the authorization options

Select **Authentication** from your Atloria workspace. If you are working inside a project, use **← Authentication** to return to the Authentication area. If the option is still unavailable, confirm that you have permission to configure organization or project access.

### Authorization does not complete

Select **Authorize Atloria** or **Authorize Bitbucket** again, then complete every prompt shown by the authorization provider. Make sure you are signed in with the account that has permission to approve access for the required organization or service.

### You configured access but cannot open a project

Select **Projects** or **← Back to Projects**, then open the project again. If access is still blocked, return to **Authentication**, review **Authentication Guide**, and verify that the required OAuth 2.0 or service authorization step was completed.

<!-- source: manage-organization-users.md -->

# Manage Organization Users

Use your organization’s settings to control who can access Atloria and to review team access. Keeping user access current helps ensure that the right people can collaborate while former or unauthorized users do not retain access.

## Overview

Organization user management is used when you need to add colleagues, share access with a team, review who belongs to the organization, or update a person’s access level. In Atloria, you begin from the organization’s settings area using the **Manage in Settings** action.

Access management is especially important when a team member joins, changes responsibilities, or leaves your organization. Review access regularly and limit administrative access to people who are responsible for managing the organization.

The available evidence confirms the **Manage in Settings** and **Share with Team** actions, as well as an invitation acceptance experience. It does not confirm the names of individual role options, user-list columns, or removal controls. Use the labels shown in your organization’s Settings screen when completing those actions.

> 📷 _Screenshot pending: Organization Settings showing the area used to manage team access and organization users_

## Prerequisites

Before you start, make sure that you have:

- Access to the Atloria organization you want to manage.
- Permission to open and change organization settings.
- The work email address for each person you plan to invite.
- A clear understanding of the access each person needs.
- Approval from your organization’s access-control owner, if your company requires it.
- A current list of people who should retain access.

## Step-by-Step Instructions

1. Open the Atloria organization where you need to manage team access.

2. Click **Manage in Settings**.

3. Locate the organization access or user-management area in Settings.

4. Review the list of people who currently have access to the organization.

5. Select the control for adding or inviting a user.

6. Enter the new user’s work email address in the invitation form.

7. Select the access level or role that matches the user’s responsibilities.

8. Send the invitation using the confirmation button shown on the invitation form.

9. Ask the invited person to open the invitation they receive.

10. Have the invited person complete the available invitation acceptance steps.

11. Return to the organization access area after the invitation is accepted.

12. Confirm that the new person appears in the organization’s user list with the intended access level.

13. Select an existing user when you need to review or change that person’s access.

14. Choose the appropriate role or access setting for the user.

15. Save or confirm the access change using the button displayed on screen.

16. Select the organization’s remove, revoke, or equivalent access control when a person should no longer have access.

17. Confirm the removal when Atloria asks you to verify the change.

> 📷 _Screenshot pending: Invitation form with email entry, available access options, and the action to send an invitation_

## Tips and Best Practices

- Use **Share with Team** when you want to begin sharing Atloria with colleagues, then review the resulting access in Settings. This helps you distinguish between sharing work with a team and maintaining the organization’s ongoing access list.

- Assign the least access needed for each person’s work. For example, reserve organization-management access for the small group responsible for team membership and security decisions.

- Use work email addresses rather than personal addresses. This makes it easier to manage access when employees change roles or leave the organization.

- Review organization membership after staffing changes, project handoffs, or access-policy updates. Remove access promptly when it is no longer needed.

- Verify invitations after they are accepted. An invitation sent successfully does not by itself confirm that the recipient has completed the acceptance process.

- Do not assume that every organization has the same role names. The available interface evidence identifies access-management functionality but does not confirm the exact role labels. Follow the role descriptions shown in your Settings screen and your organization’s internal access policy.

- Limit use of **Manage in Settings** to authorized administrators. Changes made there can affect who can work with your organization’s Atloria content.

## Related Pages

- [Invite Team Members](#)
- [Share Content with Your Team](#)
- [Organization Settings](#)
- [Role-Based Access Control](#)
- [Application Security and Access Control](#)

## Troubleshooting

### You cannot find **Manage in Settings**

Confirm that you are working in the correct Atloria organization. If the action is not available, you may not have permission to manage organization settings. Contact an existing organization administrator to request the required access.

### An invited user cannot join

Confirm that the invitation was sent to the correct work email address. Ask the recipient to check spam or filtered mail folders, then send a new invitation if your organization’s Settings screen provides that option.

### A user has more access than intended

Open the organization access area through **Manage in Settings**, select the user, and change their available access setting. If the correct access option is unclear, follow your organization’s access-control policy before saving the change.

<!-- source: claim-organization-access.md -->

# Claim Organization Access

Use the organization claim screen to request or confirm access to an organization using the access token provided to you. Completing this process helps ensure that organization ownership and team access are assigned through the correct authorization flow.

## Overview

Organization access claims are used when you need to establish access to an organization that has been shared with you or when you are asked to verify your authorization. The claim screen uses an access token to associate your request with the intended organization.

You may also be able to include information for other administrators or reviewers during the claim process. Where available, the **Add any notes for the team...** area lets you provide context, such as why access is needed or who supplied the token.

This task is especially important for administrators managing enterprise access, including areas such as **Access Control**, **Application Security & Access Control**, and **👤 Role-Based Access Control (RBAC)**. Complete the claim carefully, because the access token determines which organization access request is being processed.

> 📷 _Screenshot pending: Organization claim screen showing the Enter access token field._

## Prerequisites

Before you start, make sure you have:

- A valid organization claim link or invitation from an authorized administrator.
- The access token supplied with the claim request.
- Permission to request or manage access for the organization.
- Any details you may need to share with reviewers, such as your role or reason for requesting access.
- A secure way to handle the token; do not send it in public chat channels or include it in unrelated tickets.

## Step-by-Step Instructions

1. Open the organization claim link provided by your administrator or organization contact.

2. Review the organization and access context displayed on the claim screen before entering any information.

3. Click the **Enter access token** field.

4. Enter the access token exactly as it was provided to you.

5. Check the token for missing characters, extra spaces, or an incorrect copied value.

6. Add an explanation in **Add any notes for the team...** if you need to provide context for the request.

7. Describe only the information needed to help the reviewing team understand your request, such as your business role or the reason you need organization access.

8. Use the submission action displayed on the claim screen to send the token and any notes for review.

9. Read the confirmation, validation message, or next-step message displayed after you submit the claim.

10. Select **Share with Team** if the screen offers this action and you need to notify your team about the claim or its outcome.

11. Follow any follow-up instructions shown on the screen if additional authorization or review is required.

> 📷 _Screenshot pending: Claim screen showing the Add any notes for the team... area and Share with Team action._

## Tips and Best Practices

- Treat the access token as sensitive authorization information. Share it only through approved organization channels.
- Copy and paste the token when possible. This reduces the risk of mistyping characters.
- Do not add unnecessary confidential information in **Add any notes for the team...**. Keep notes focused on the access request.
- If you are requesting access for a specific enterprise area, state that clearly in your note. For example, identify whether your work relates to **Access Control**, **👥 Access Control**, or **👤 Role-Based Access Control (RBAC)**.
- Use **Share with Team** only when the relevant team needs visibility into the request. Sharing broadly can expose information that is not needed by all recipients.
- Do not assume that access is active until the screen confirms the outcome or your organization’s access administrators notify you. The available interface labels do not identify separate on-screen stages such as Draft, Approved, or Paid, so rely on the confirmation shown after submission.
- If your organization uses separate access areas, make sure you are claiming the correct organization context before you submit the token.

## Related Pages

- [Access Control](#access-control)
- [Application Security & Access Control](#application-security-and-access-control)
- [Role-Based Access Control (RBAC)](#role-based-access-control-rbac)
- [Team Activity](#team-activity)
- [Version Access Control](#version-access-control)

## Troubleshooting

### The access token is not accepted

Re-enter the value in **Enter access token** and verify that it matches the token you received. Check for leading or trailing spaces that may have been included when copying the token. If it still fails, request a new token from the administrator who initiated the claim.

### I do not know what to write in the notes field

The **Add any notes for the team...** field is optional context for reviewers. Include your role, the organization you need access to, and the business reason for the request. Do not include passwords, unrelated credentials, or confidential information that reviewers do not need.

### I need other people to know about the claim

Use **Share with Team** when it is available on the claim screen. Share the request only with the team members responsible for access decisions or follow-up work.

<!-- source: configure-documentation-categories.md -->

# Configure Documentation Categories

This page explains how to organize and locate documentation by category in Atloria. A clear category structure helps administrators keep user and technical documentation easy to find as the document library grows.

## Overview

Atloria presents documentation through the **Documents** area and separates documentation into user-facing and technical content. You can use the available documentation views to review the existing organization, create documents in the appropriate area, and confirm that documents can be found through category-aware search.

Use category organization when your organization needs to distinguish different kinds of content, such as user guides, user manuals, and technical documentation. This makes it easier for readers to locate the right material without reviewing every document in the library.

The available interface evidence shows that Atloria supports searching across documents, categories, and projects through the **Search documents, categories, projects...** field. It also shows separate entry points for **User Docs**, **Technical Docs**, **📋 User Manuals**, and **Technical**. Use these areas to maintain a consistent documentation structure.

> 📷 _Screenshot pending: Documents area showing the Search documents, categories, projects... field and document organization options_

## Prerequisites

Before you begin, make sure you have the following:

- Access to the Atloria application.
- Permission to view the **Documents** area.
- A project selected if you are working with project-specific technical documentation.
- A planned naming convention for categories, such as “User Guides,” “Administration,” “API Reference,” or “Technical.”
- A list of documents that should be organized or reviewed.

## Step-by-Step Instructions

1. Open the **Documents** area from the main application navigation.

2. Review the available documentation sections, including **User Docs** and **Technical Docs**.

3. Select **📋 User Manuals** when you want to review documentation intended for end users.

4. Select **Technical** when you want to review documentation intended for technical audiences.

5. Use the **Search documents, categories, projects...** field to search for an existing category name.

6. Enter a category keyword that matches your planned structure, such as “User Guides” or “Technical.”

7. Review the search results to identify documents and categories that already use the keyword.

8. Select a document from the results when you need to check whether it belongs in the intended category area.

9. Click **← Back to Documents** after reviewing a document to return to the document list.

10. Select **Create New Document** when you need to add documentation that supports your category structure.

11. Select **Create Document** to begin creating the new document.

12. Choose the appropriate documentation area—such as **User Docs** or **Technical Docs**—before adding content.

13. Use the document title and content to apply your organization’s approved category terminology consistently.

14. Return to the **Documents** area after creating the document.

15. Enter the category keyword in **Search documents, categories, projects...** to verify that readers can locate the document using the expected term.

16. Select **Export Documentation** when you need an exported copy of the documentation set for review or distribution.

> 📷 _Screenshot pending: Create New Document flow showing placement of a user or technical document within the documentation library_

## Tips and Best Practices

- Use consistent category names. For example, choose either “User Guides” or “User Documentation” as your standard term rather than using both for the same type of content.

- Separate user-facing and technical content. Place task-oriented instructions for end users under **User Docs** or **📋 User Manuals**, and keep implementation-oriented material in **Technical Docs** or **Technical**.

- Search before creating new material. The **Search documents, categories, projects...** field searches across multiple organizational levels, so it can help you avoid creating duplicate or overlapping categories.

- Include the category term in document titles when appropriate. This improves discoverability when users search the document library.

- Review project context before organizing technical content. If Atloria displays **Select a project to view documents**, select the relevant project before reviewing or updating project-specific documentation.

- Keep category structures simple. A small set of clear, recognizable categories is easier for readers to navigate than many similarly named categories.

- Use **Delete Documents** carefully. Before deleting documentation, confirm that the document is obsolete and is not the only document using a category name or organizational term.

## Related Pages

- [Create a New Document](#)
- [Manage Documents](#)
- [Create User Manuals](#)
- [View Technical Documentation](#)
- [Export Documentation](#)
- [Search Documentation](#)

## Troubleshooting

### You cannot find a category or document

Use the **Search documents, categories, projects...** field and try a shorter keyword. For example, search for “user” instead of “User Guides.” Also check both **User Docs** and **Technical Docs**, because the document may be organized for a different audience.

### You see “Select a project to view documents”

Select the appropriate project before attempting to review technical documentation. Project-specific documents may not appear until a project is selected.

### You cannot create or remove documentation

If **Create New Document**, **Create Document**, or **Delete Documents** is unavailable, your account may not have the required access. Contact your Atloria administrator to request document-management permissions.

<!-- source: configure-document-collections.md -->

# Configure Document Collections

Document collections help you group related documentation and present it in a predictable hierarchy. Use collections when your project contains related documents that should be discovered, reviewed, and maintained together.

## Overview

In Atloria, documents are managed from the **Documents** area. You can use the available configuration workflow to define how related documentation is organized, including the order in which document groups appear and the hierarchy pattern they follow.

A useful hierarchy reflects the way your teams consume documentation. For example, you may group material by delivery stage, such as **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**. This makes it easier for readers to move from an implementation area to the related supporting material.

Collection planning is especially important before you generate or import a large number of documents. A consistent structure improves search results, reduces duplicate content, and helps readers understand where a document belongs.

> 📷 _Screenshot pending: The Documents area and the available configuration entry point for organizing document collections._

## Prerequisites

Before you configure document collections, make sure that:

- You can access the **Documents** area.
- You have selected the correct project, if Atloria displays **Select a project to view documents**.
- You know which documents should belong together.
- You have agreed on the hierarchy that your organization wants readers to follow.
- You have identified whether content will be created in Atloria or brought in through **Or import existing documentation**.
- You have the required administrative permissions to change documentation configuration.

## Step-by-Step Instructions

1. Open **Documents** from the application navigation.

2. Select the project you want to configure if the page displays **Select a project to view documents**.

3. Review the existing documents by using the **Search documents...** field.

4. Search for related content by entering a document name, category, or project in **Search documents, categories, projects...**.

5. Click **Configure →** to open the available documentation configuration options.

6. Define a collection for documents that share the same purpose, audience, or delivery area.

7. Assign a hierarchy pattern that places related collection levels in the intended reading order.

8. Use a lifecycle-oriented sequence when your documents follow implementation stages, such as **FRONTEND → BACKEND → DATABASE → API SCHEMA → CONFIG → DOCUMENTATION → INFRASTRUCTURE**.

9. Place documents that describe configuration work in the **CONFIG** portion of the hierarchy.

10. Place documentation intended for end users or internal readers in the **DOCUMENTATION** portion of the hierarchy.

11. Add new content by clicking **Create New Document** when a required document does not yet exist.

12. Click **Create Document** to begin creating the new document.

13. Use **Or import existing documentation** when the document already exists outside Atloria.

14. Return to the document list by selecting **← Back to Documents** after completing your configuration changes.

15. Verify the resulting organization by searching for documents with **Search documents...**.

> 📷 _Screenshot pending: The configuration screen showing collection definitions and the hierarchy pattern used to organize related documents._

## Tips and Best Practices

- **Use one hierarchy pattern consistently.** If your organization uses delivery stages, keep the same sequence across collections. For example, do not place database guidance before frontend guidance in one collection and reverse the order in another unless there is a clear reader-focused reason.

- **Group by reader need, not only by technical ownership.** A collection should help a reader find connected information. A backend-owned document may still belong alongside frontend material if both are needed to complete the same task.

- **Use categories to improve discovery.** The document search experience supports searching across documents, categories, and projects. Consistent category naming makes collection content easier to find.

- **Create collections before generating large amounts of content.** Select **Generate Documentation →** only after you understand where generated documents should appear in the overall structure.

- **Separate configuration guidance from implementation guidance.** When using a staged hierarchy, keep setup and environment instructions under **CONFIG**, while end-user or reference material belongs under **DOCUMENTATION**.

- **Review imported documents after import.** Imported content may use naming or organizational conventions that differ from your current collection hierarchy. Confirm that it appears in the intended collection before sharing it broadly.

- **Use document comparison when reviewing structural changes.** If a collection reorganization involves revising documents, use the document comparison view to confirm that content changes are intentional before communicating the updated structure.

## Related Pages

- [Manage Documents](#)  
- [Create a New Document](#)  
- [Import Existing Documentation](#)  
- [Generate Documentation](#)  
- [Compare Document Changes](#)  
- [Export Documentation](#)  
- [Configure CI/CD](#)  

## Troubleshooting

### You cannot see documents for the project

If the page displays **Select a project to view documents**, select the appropriate project before searching or configuring collections. Documents are shown in the context of the selected project.

### Search does not return the documents you expect

Try both available search experiences. Use **Search documents...** for document-focused searching, and use **Search documents, categories, projects...** when you need to search across document names, categories, and projects. Also check whether the document is in a different project.

### A document does not fit the current hierarchy

Review the document’s purpose and its primary reader. Move it to the collection stage that best represents what the reader needs to do next. If the document spans several stages, keep it in the primary stage and add clear links to related documents in adjacent stages.

### You need to remove obsolete collection content

Review the documents first, then use **Delete Documents** only for content that is no longer needed. Export documentation before deleting content when you need to preserve a record of the previous collection structure.

<!-- source: set-documentation-ownership.md -->

# Set Documentation Ownership

This page explains how to establish clear responsibility for documentation areas in Atloria. Assigning an owning team and a maintainer helps ensure that documents remain accurate, reviewed, and maintained over time.

## Overview

Documentation ownership identifies who is responsible for a documentation area, such as frontend guidance, backend references, database material, API schema information, configuration instructions, or infrastructure documentation. You may need to set ownership when your organization creates a new documentation area, imports existing material, or notices that documents no longer have a clear maintainer.

In Atloria, you manage documentation from the **Documents** area. You can create new documentation, import existing documentation, search the available documents, and organize your work around projects and categories. Use these capabilities to locate the documents belonging to an area and record the responsible team and named maintainer in the document content or your organization’s approved ownership convention.

The available interface evidence does not show a dedicated **Owner**, **Team**, or **Maintainer** field. Before setting up a governance process, confirm whether your Atloria workspace has an ownership field or a custom template available. If it does not, document the ownership information consistently within each document until an administrator provides a dedicated ownership control.

> 📷 _Screenshot pending: The Documents screen showing document search, creation, and document management actions._

## Prerequisites

Before you begin, make sure that you have:

- Access to the **Documents** area.
- Permission to create or edit the documentation that you will govern.
- The name of the responsible team for each documentation area.
- A named maintainer or contact person for each area.
- An agreed ownership convention, such as recording the team and maintainer at the beginning of a document.
- A list of the projects, categories, or documentation areas that need an owner.
- A plan for reviewing ownership when teams, systems, or responsibilities change.

## Step-by-Step Instructions

1. Open **Documents** from the application navigation.

2. Select the relevant project if the screen displays **Select a project to view documents**.

3. Search for the documentation area by entering keywords in **Search documents...**.

4. Use **Search documents, categories, projects...** when you need to find documents across multiple projects or categories.

5. Open the document that represents the documentation area you want to assign.

6. Review the document’s current content to determine whether an owning team or maintainer is already identified.

7. Record the responsible team in the document using your organization’s approved ownership format.

8. Record the named maintainer or primary contact in the document using the same ownership format.

9. Save the document using the available save action in the document editing experience.

10. Repeat the ownership record for other documents in the same area when each document needs an individual maintainer.

11. Create an area-level ownership document by selecting **Create New Document** when no suitable document exists.

12. Choose **Create Document** to begin creating the ownership record.

13. Add the responsible team and maintainer to the new document.

14. Add the documentation area or scope that the team owns to the new document.

15. Add a review expectation to the new document, such as reviewing ownership after team changes or major documentation updates.

16. Save the new ownership document.

17. Use **Search documents...** to confirm that the ownership record can be found by other administrators and contributors.

18. Export the documentation by selecting **Export Documentation** when you need to share the ownership register outside Atloria.

> 📷 _Screenshot pending: The new document flow with the Create New Document and Create Document actions._

## Tips and Best Practices

- **Use one ownership convention consistently.** Because the visible interface evidence does not confirm dedicated ownership fields, use a standard section in each governed document. For example, your organization may place the responsible team, maintainer, and review date at the top of the document. Consistency makes ownership easier to locate through search and review.

- **Assign both a team and a person.** A team provides continuity when people change roles. A named maintainer provides a clear contact for questions, corrections, and review requests.

- **Define ownership by documentation area.** Atloria documentation can cover areas such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. Assign ownership at the area level first, then identify exceptions for individual documents when needed.

- **Use searchable wording.** Include the team name and maintainer name exactly as your organization uses them. This improves the usefulness of **Search documents...** and **Search documents, categories, projects...**.

- **Keep project context clear.** If your workspace contains multiple projects, use **Select a project to view documents** before reviewing or updating ownership. This helps prevent a team from being assigned to a similarly named document in the wrong project.

- **Review ownership before deleting documents.** The **Delete Documents** action can remove documentation that may serve as an ownership record. Confirm that ownership information has been moved or retained elsewhere before deleting a document.

- **Use exports for governance reviews.** **Export Documentation** can support periodic governance reviews with team leads, documentation managers, or compliance stakeholders. Review exported material for missing owners, outdated maintainers, and unassigned areas.

- **Create ownership records when importing content.** When using **Or import existing documentation**, review the imported documents immediately. Imported documentation may contain legacy contacts or no ownership information at all.

## Related Pages

- [Manage Documents](#)
- [Create a New Document](#)
- [Import Existing Documentation](#)
- [Search Documents](#)
- [Export Documentation](#)
- [Delete Documents](#)
- [Document Governance Review](#)

## Troubleshooting

### You cannot find the document that needs an owner

Use **Search documents...** with the document title or a distinctive keyword. If the document may be in another project or category, use **Search documents, categories, projects...** instead. If the screen prompts you to choose a project, select the correct project first.

### You do not see a field for team ownership or maintainer

The available interface labels do not confirm a dedicated ownership field. Record the owning team and maintainer in the document content using your organization’s agreed format. Contact your Atloria administrator if your organization requires a structured ownership field or an ownership template.

### You are unsure whether to update an existing document or create a new one

Update an existing document when it already defines the documentation area and can clearly display ownership information. Select **Create New Document** and then **Create Document** when you need a standalone ownership register, a new documentation-area overview, or a record for an area that does not yet have documentation.

<!-- source: enable-ai-documentation-generation.md -->

# Enable AI Documentation Generation

Use AI Documentation Generation to create technical documentation for an eligible project from the project workspace. Enabling generation helps you turn project information into documentation faster and gives you a generation process you can monitor or cancel when needed.

## Overview

AI Documentation Generation is available from the **Projects** area. You use it to select a project, start documentation generation, and then follow the generation status from the project’s documentation workspace.

This feature is useful when you need a documentation baseline for a project without writing every page manually. After generation starts, the project displays the **4. Generation Running** stage. You can wait for generation to finish, or select **▣ Cancel Generation** if you need to stop the process.

Generation is intended for eligible projects. If you cannot find the generation option for a project, confirm that you have opened the correct project and that it is available in your organization’s project list. You can also use project search to locate the project before starting.

> 📷 _Screenshot pending: The Projects screen showing the Generation area and the Generate Documentation button._

## Prerequisites

Before you begin, make sure that you have:

- Access to the **Projects** area.
- An eligible project available in the project list.
- Permission to work with the project’s documentation.
- A project you can locate using **Search projects...** or **Search across all projects...**.
- A reason to generate new documentation rather than import existing material through **Or import existing documentation**.
- Time to monitor the initial generation, especially if you may need to select **▣ Cancel Generation**.

## Step-by-Step Instructions

1. Select **Projects** to open the project hub.

2. Enter the project name in **Search projects...** to narrow the project list.

3. Select the project that needs AI-generated documentation.

4. Select **Generation** to open the project’s generation area.

5. Review the project information to confirm that you are working in the intended project.

6. Select **Generate Documentation →** to begin AI documentation generation.

7. Wait for the screen to show **4. Generation Running** to confirm that generation has started.

8. Select **View Your Documentation →** after generation is available to open the generated documentation.

9. Select **Export Documentation** if you need a copy of the generated documentation outside the application.

> 📷 _Screenshot pending: A project documentation generation screen displaying the “4. Generation Running” status and the “▣ Cancel Generation” action._

### Cancel a generation in progress

1. Open the project that has the **4. Generation Running** status.

2. Select **▣ Cancel Generation** to stop the active generation.

3. Return to the project’s documentation area when you are ready to review existing documentation or start another generation.

### Enable ongoing project updates

1. Open the project’s generation or documentation controls.

2. Select **3. Schedule Enabled** when scheduled generation is available for the project.

3. Select **⚡ Enable Versioning** if you want to enable version tracking for the documentation.

4. Select **5. Enable Versioning** to continue through the versioning stage when it is displayed in the project workflow.

## Tips and Best Practices

- Use **Search projects...** before opening a project when your organization has many projects. This reduces the risk of generating documentation for the wrong project.

- Confirm the project before selecting **Generate Documentation →**. Generation is started from the project workspace, so the documentation produced is associated with the project you currently have open.

- Treat **4. Generation Running** as an active processing state. Avoid assuming the documentation is ready until you can select **View Your Documentation →** and review the result.

- Use **▣ Cancel Generation** only when you intentionally want to stop the current run. If you cancel, review the project documentation afterward to determine whether any previously available documentation remains useful.

- If your organization maintains documentation over time, enable scheduling with **3. Schedule Enabled** where available. Scheduled generation can help keep documentation aligned with project changes.

- Enable versioning with **⚡ Enable Versioning** when you need to preserve and compare documentation over time. This is particularly useful before major releases or significant project updates.

- If you already have approved documentation, consider **Or import existing documentation** instead of immediately generating new content. Imported material may be more appropriate when you need to preserve an established documentation set.

- Review generated documentation before distributing or exporting it. AI-generated content is a starting point and should be checked for accuracy, completeness, terminology, and organization-specific requirements.

## Related Pages

- [Manage Projects](#) — Find, open, and organize projects from the **Projects** hub.
- [View Generated Documentation](#) — Open documentation using **View Your Documentation →**.
- [Export Documentation](#) — Download or distribute generated project documentation.
- [Enable Documentation Versioning](#) — Use **⚡ Enable Versioning** to track documentation changes.
- [Compare Documentation Versions](#) — Review differences between saved documentation versions.
- [Import Existing Documentation](#) — Use **Or import existing documentation** when you already have source material.
- [Review Project Changes](#) — Review project changes that may affect generated documentation.

## Troubleshooting

### You cannot find the Generate Documentation option

1. Select **Projects** to return to the project hub.

2. Enter the project name in **Search projects...**.

3. Open the correct project and select **Generation**.

If the option is still unavailable, the project may not be eligible for AI Documentation Generation or you may not have the required access. Contact your organization’s Atloria administrator.

### Generation remains on “4. Generation Running”

1. Stay on the project’s generation screen and confirm that **4. Generation Running** is still displayed.

2. Wait for the status to change before selecting **View Your Documentation →**.

3. Select **▣ Cancel Generation** only if you need to stop the active generation.

If the status does not progress, contact your administrator and provide the project name and the status shown on screen.

### You need to retain documentation history

1. Open the project’s documentation controls.

2. Select **⚡ Enable Versioning**.

3. Continue through **5. Enable Versioning** if it appears as the next workflow stage.

After versioning is enabled, use the project’s version history and comparison tools to review documentation changes over time.

<!-- source: configure-generation-scope.md -->

# Configure Generation Scope

Configure the generation scope to define which project information and documentation areas Atloria uses when preparing documentation. A clear scope helps you generate documentation that is relevant to the selected project and avoids unnecessary output.

## Overview

Generation scope determines the project context used for documentation generation. You begin from the project you want to document, then use the project’s **Generation** area to review the available information and documentation coverage before starting generation.

Atloria organizes project analysis into documentation areas such as **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**. The areas available for a project depend on the information Atloria has identified or configured for that project.

Use generation scope when you are preparing documentation for a new project, when a project’s implementation changes, or when you want to focus documentation work on specific parts of the project rather than treating all projects as one workspace.

> 📷 _Screenshot pending: The Generation area for a focused project, showing the project context and available documentation areas._

## Prerequisites

Before you configure generation scope, make sure that:

- You can access the **Projects** hub.
- The project you want to document has already been created.
- You have selected the correct project from the project list.
- The project has been configured or analyzed sufficiently for Atloria to identify documentation areas.
- You know whether you need documentation for frontend, backend, database, API schema, configuration, documentation, or infrastructure information.

## Step-by-Step Instructions

1. Open **Projects** from the main application navigation.

2. Use **Search projects...** if you need to locate a project by name.

3. Select the project you want to configure.

4. Confirm that you are working in the correct focused project by reviewing the project context in the project sidebar.

5. Select **Generation** from the project navigation.

6. Review the project information shown in the Generation area.

7. Review the documentation areas available for the project.

8. Include the **FRONTEND** area when you need documentation about user-facing application components and behavior.

9. Include the **BACKEND** area when you need documentation about server-side services and application processing.

10. Include the **DATABASE** area when you need documentation about stored data and database-related entities.

11. Include the **API SCHEMA** area when you need documentation about application interfaces and API definitions.

12. Include the **CONFIG** area when you need documentation about project configuration.

13. Include the **DOCUMENTATION** area when you need Atloria to consider existing documentation-related project content.

14. Include the **INFRASTRUCTURE** area when you need documentation about deployment, environment, or infrastructure-related project information.

15. Review the selected project and documentation areas before continuing.

16. Start generation using the available generation action in the **Generation** area.

17. Wait for the generation status to show that processing is running.

18. Select **Cancel Generation** only if you need to stop the current generation run.

19. Open the generated project documentation when it becomes available.

20. Select **Export Documentation** if you need a copy of the completed documentation outside Atloria.

> 📷 _Screenshot pending: The Generation screen with project information, documentation areas, and the action used to begin generation._

## Tips and Best Practices

- Configure scope from the focused project, not from the **Projects** hub. This helps ensure the generated documentation is tied to the intended project.
- Use **Search projects...** before opening a project when your organization manages many projects. Selecting the wrong project can produce documentation for the wrong codebase or product area.
- Include only the documentation areas that support your immediate documentation goal. For example, a user-interface guide may primarily need **FRONTEND** coverage, while an integration guide may need **BACKEND** and **API SCHEMA** coverage.
- Include **DATABASE** when the documentation must explain data entities or data relationships. Leave it out when the intended audience does not need data-model information.
- Include **CONFIG** and **INFRASTRUCTURE** when operational teams need the resulting documentation. These areas are especially useful for deployment, environment, and maintenance-oriented documentation.
- Review scope before you begin generation. If you change your mind after generation has started, use **Cancel Generation** and update the scope before starting another run.
- Wait for the current generation run to finish before relying on the documentation or using **Export Documentation**. Exporting is most useful after the generated content is complete.

> 📷 _Screenshot pending: A generation run in progress, including the Cancel Generation action and completion status area._

## Related Pages

- [Create a New Project](#)
- [Open a Project Dashboard](#)
- [View Project Documentation](#)
- [Export Documentation](#)
- [Manage Project Changes](#)
- [Review Project Versions](#)

## Troubleshooting

### The project does not appear in the project list

1. Open **Projects**.

2. Enter the project name in **Search projects...**.

3. Select **New Project** if the project has not yet been created.

4. Complete project creation before returning to configure generation scope.

### The documentation area you need is not available

1. Confirm that you opened the correct project.

2. Review the project’s configured information and analysis status.

3. Make sure the project contains the relevant type of information, such as frontend, backend, database, API schema, configuration, documentation, or infrastructure content.

4. Run generation again after the project information has been updated or configured.

### Generation is taking longer than expected

1. Open **Generation** for the selected project.

2. Check whether generation is still running.

3. Wait for the current generation to complete.

4. Select **Cancel Generation** only when you intend to stop the run and revise the scope before generating again.

<!-- source: set-generated-content-review-rules.md -->

# Set Generated Content Review Rules

Use Atloria’s generation and review workflow to establish how AI-generated documentation is checked before publication. Clear review rules help you keep generated content accurate, consistent, and ready for your documentation audience.

## Overview

Atloria supports a review-and-publish workflow for generated documentation. You begin in the **Generation** area, generate or import documentation, inspect the result in **Preview**, and complete the process through **Review & Publish**.

The available interface does not show a separate form for entering named review rules. Instead, you establish review expectations by using a consistent review process: require a preview check, verify content before publishing, and return to the review workspace when revisions are needed.

Use this process whenever you generate new documentation, regenerate content after source changes, or import existing documentation that must meet your organization’s quality standards.

> 📷 _Screenshot pending: The Generation screen showing options to generate documentation, preview results, and begin Review & Publish._

## Prerequisites

Before you start, make sure you have:

- Access to the project version for which documentation will be generated or reviewed.
- Documentation ready to generate, or existing documentation ready to import.
- Agreed review expectations for accuracy, terminology, completeness, and approval responsibility.
- A designated reviewer who can verify generated content before it is published.
- Time to wait for the generation process to complete if **Generation Running** is displayed.

## Step-by-Step Instructions

1. Open the project version that contains the documentation you want to review.

2. Select **Generation** to open the documentation generation workspace.

3. Choose **Generate Documentation →** when you want Atloria to create documentation from the available project content.

4. Select **Or import existing documentation** when you want to review documentation that was created outside the generation workflow.

5. Wait for **Generation Running** to finish before beginning the review.

6. Select **Cancel Generation** if the generation was started with the wrong content or should not continue.

7. Open **Preview** after generation is complete.

8. Review the generated content for factual accuracy.

9. Review the generated content for required sections and expected level of detail.

10. Review terminology, names, and descriptions for consistency with your organization’s standards.

11. Select **Copy** when you need to copy generated text for comparison, editing, or review outside the preview.

12. Select **Review & Publish** when the content is ready for formal review.

13. Check **Review Summary** to confirm the documentation is ready for the next approval decision.

14. Select **Back to Review** when you need to return to the review workspace and continue checking the content.

15. Select **View Your Documentation →** only after the required review checks are complete.

> 📷 _Screenshot pending: The Review Summary area with Back to Review and View Your Documentation actions._

## Tips and Best Practices

- Define your review expectations before starting generation. For example, decide who checks technical accuracy, who checks writing quality, and who gives final publication approval.

- Treat generated content as a draft until it has been reviewed. Use **Preview** to inspect the content before moving forward with **Review & Publish**.

- Review each generation separately. A new generation can produce different wording, structure, or coverage, even when it relates to the same documentation area.

- Use **Back to Review** rather than publishing immediately when you identify missing details, incorrect statements, or content that does not meet your team’s standards.

- Establish a minimum review checklist for every document. Your checklist can include:
  - Technical facts are correct.
  - Important user tasks are included.
  - Terms match the product interface and internal terminology.
  - Content is understandable for the intended audience.
  - Sensitive, outdated, or unverified information is removed.

- Do not rely on generation status alone as an approval signal. **Generation Running** indicates that content is being created; it does not indicate that the content has been reviewed or approved.

- Use the **Preview** action before sharing or exporting documentation. This helps you identify issues while the content is still in the review workflow.

## Related Pages

- [Generate Documentation](#)
- [Review and Publish Generated Documentation](#)
- [Preview Generated Documentation](#)
- [Export Documentation](#)
- [Share a Preview Link](#)

## Troubleshooting

### You cannot find a place to enter review rules

Atloria’s visible generation and review actions do not include a dedicated review-rules form. Establish review rules as a team checklist and apply that checklist during **Preview** and **Review & Publish**.

### Generation is still in progress

If **Generation Running** is displayed, wait for the process to finish before reviewing the output. Select **Cancel Generation** only when you need to stop the current generation attempt.

### The generated documentation is not ready to publish

Select **Back to Review** from **Review Summary**. Recheck the content in **Preview**, compare it with your review expectations, and proceed to **View Your Documentation →** only after the required checks are complete.

<!-- source: connect-a-project-source.md -->

# Connect a Project Source

Connect a supported project source to an Atloria project so Atloria can analyze the project and make its source available for project-level work. This connection is also required before you can verify that Atloria can reach the source.

## Overview

A project source is the codebase or other supported source location that Atloria uses for source analysis. You connect the source while creating a project or manage the connection later from the project’s **Source** area.

Use this process when you are setting up a new project, changing the source associated with an existing project, or confirming that Atloria can access a source after connection details have changed. The **Test Connection** action helps you verify the connection before relying on source analysis results.

After a source is connected and processing completes, Atloria can use the project source as the basis for analysis. If a connection is no longer needed, you can remove it with **Disconnect**. Disconnecting a source prevents further work that depends on that project’s connected source until you connect one again.

> 📷 _Screenshot pending: The Projects area showing the New Project action and a project’s Source option._

## Prerequisites

Before you begin, make sure you have:

- Access to the Atloria **Projects** area.
- Permission to create or manage the target project.
- A supported project source that your organization is authorized to connect.
- The source location and any access information required by your organization’s source provider.
- A decision about whether you are creating a **New Project** or updating an existing project.
- Network and access permissions that allow Atloria to reach the selected source.

## Step-by-Step Instructions

### Connect a source while creating a project

1. Select **Projects** to open the list of available projects.

2. Select **New Project** to start creating a project.

3. Enter the required project information on the new-project screen.

4. Provide the source connection information required for the supported source you want to connect.

5. Select **Create project** to create the project with the source connection.

6. Select **⚡ Test Connection** to check whether Atloria can reach the connected source.

7. Review the connection result before proceeding with source analysis.

8. Select **Open Project Dashboard** to return to the project after the connection has been verified.

### Connect or verify a source for an existing project

1. Select **Projects** to open the project list.

2. Use **Search projects...** to find the project you want to update.

3. Select the project to make it the active project.

4. Select **Source** from the project options.

5. Enter or update the connection information for the supported source.

6. Select **Test Connection** to verify access to the source.

7. Review the test result and correct the source information if the connection is not successful.

8. Select **View Source** when you need to inspect the connected source from the project.

> 📷 _Screenshot pending: The Source area for an active project, including Test Connection, View Source, and Disconnect actions._

### Disconnect a project source

1. Open the project that currently has the source connection.

2. Select **Source**.

3. Select **Disconnect** to remove the source connection from the project.

4. Confirm the disconnect action if Atloria asks you to confirm it.

5. Return to **Projects** when you are finished managing the project connection.

## Tips and Best Practices

- Test the connection immediately after creating the project or changing source details. Selecting **Test Connection** early helps you identify access problems before you expect source analysis to run.

- Use **Search projects...** when your organization has many projects. This helps you avoid changing the source connection for the wrong project.

- Confirm that you are working in the intended active project before selecting **Disconnect**. A disconnect removes the project’s current source association and can interrupt work that depends on source access.

- Use **View Source** as a quick check that you are working with the expected project source after a successful connection.

- If analysis completes with warnings, review the source connection and source contents before assuming all source material was processed as expected. A completed analysis can require follow-up when warnings are present.

- Keep project-source ownership clear within your team. Limit source connection changes to administrators or users who understand the project’s intended source and access requirements.

## Related Pages

- [Create a Project](#)
- [Manage Projects](#)
- [Test a Source Connection](#)
- [View Project Source](#)
- [Run Source Analysis](#)
- [Disconnect a Project Source](#)

## Troubleshooting

### **Test Connection** does not succeed

Verify that the source location and access information are current and that your organization still permits Atloria to access the source. Update the connection information in **Source**, then select **Test Connection** again.

### You cannot find the project to update

Open **Projects** and use **Search projects...** with the project name. If the project still does not appear, confirm that you have access to the correct Atloria workspace or ask an administrator to verify your project permissions.

### **View Source** does not show the expected source

Confirm that you selected the correct project and open **Source** to review its connection information. If the wrong source is connected, update the connection details and select **Test Connection** before using **View Source** again.

<!-- source: configure-source-analysis.md -->

# Configure Source Analysis

Configure Source Analysis to control which parts of your connected project Atloria examines when building documentation intelligence. These settings help you focus generated documentation on the most relevant source areas and analysis categories.

## Overview

Source Analysis is configured through the project setup flow, where you move through **1. General Settings**, **2. Parser Settings**, and **3. Template Settings**. The parser settings are where you define the analysis focus for the source material that Atloria will use.

Use Source Analysis when you want documentation intelligence to reflect a particular type of project content, such as frontend components, backend services, databases, API schemas, configuration, documentation, or infrastructure. A focused configuration reduces unrelated results and helps the generated documentation match the purpose of your project.

Atloria’s analysis recognizes different kinds of source entities, including components, hooks, pages, layouts, routes, contexts, providers, stores, controllers, services, repositories, and middleware. It can also identify relationships between entities, such as when one component renders another component or uses a hook.

> 📷 _Screenshot pending: Project setup flow showing General Settings, Parser Settings, and Template Settings._

## Prerequisites

Before you configure Source Analysis, make sure you have:

- Access to the project you want to document.
- A connected source integration, such as GitHub, GitLab, or Bitbucket.
- Permission to open the project’s **Settings** or setup configuration.
- A clear idea of the source areas you want Atloria to prioritize, such as frontend, backend, database, or infrastructure.
- A project selected as the **Focused Project**, if your workspace contains more than one project.

## Step-by-Step Instructions

1. Open the project you want to configure.

2. Select **Settings** from the available project actions.

3. Open the setup or configuration area that displays **1. General Settings**, **2. Parser Settings**, and **3. Template Settings**.

4. Select **2. Parser Settings**.

5. Review the available analysis categories for the source scope you want documented.

6. Select the frontend category when you want Atloria to analyze user-interface source, including components, hooks, pages, layouts, contexts, providers, and stores.

7. Select the backend category when you want Atloria to analyze server-side source, including controllers, services, repositories, and middleware.

8. Select the database category when database-related source should be included in the documentation intelligence.

9. Select the API schema category when your documentation should include API definitions and schema-related source.

10. Select the configuration category when application configuration should be considered during analysis.

11. Select the documentation category when existing documentation source should be included in the analysis scope.

12. Select the infrastructure category when deployment, environment, or infrastructure source is relevant to your documentation.

13. Confirm the selected scope before continuing to **3. Template Settings**.

14. Select **View Source** when it is available and you need to inspect the underlying source content associated with an analysis result.

15. Select **Source** when it is available to switch from a rendered or compared view to the source view.

16. Continue through **3. Template Settings** after you finish selecting the analysis scope.

17. Select **Generate Documentation →** when you are ready to create documentation using the configured analysis settings.

> 📷 _Screenshot pending: Parser Settings screen showing available source analysis categories and selected scope._

## Tips and Best Practices

- Start with the categories that match your documentation goal. For example, select frontend and backend categories for an application architecture guide, or select API schema and backend categories for API-focused documentation.

- Avoid selecting every category unless you need a broad project overview. A narrower scope can make the resulting documentation more focused and easier to review.

- Include **CONFIG** and **INFRASTRUCTURE** when operational behavior matters. These areas can provide useful context for how the application is configured and deployed.

- Include **DOCUMENTATION** when your repository contains material you want Atloria to use alongside source analysis. This is useful when existing written guidance should inform generated output.

- Use **View Source** to verify that an analysis result is based on the source you expected. This is especially helpful when reviewing relationships between entities.

- Review detected relationships in context. For example, a component may render another component or use a hook; these relationships can make architecture and feature documentation more complete.

- If your project includes multiple technologies, select the categories relevant to each area of the project. Atloria can recognize common frontend entities such as React, Vue, or Angular components, as well as custom hooks and related entities.

## Related Pages

- [Connect a Source Integration](../integrations/)
- [Configure Project Settings](../project-settings/)
- [Configure Documentation Templates](../template-settings/)
- [Generate Documentation](../generate-documentation/)
- [Export Documentation](../export-documentation/)
- [Configure CI/CD](../configure-cicd/)

## Troubleshooting

### Parser Settings are not available

1. Open the correct project before selecting **Settings**.

2. Confirm that you have permission to manage project configuration.

3. Verify that the project has a connected source integration before attempting to configure analysis.

### The generated documentation does not cover an expected area

1. Return to **2. Parser Settings**.

2. Select the missing analysis category, such as frontend, backend, database, API schema, configuration, documentation, or infrastructure.

3. Select **Generate Documentation →** again after updating the scope.

### An analysis result does not appear to match the expected source

1. Select **View Source** from the result actions.

2. Review the source shown under **Source**.

3. Adjust the selected parser categories if the result is being drawn from an unintended part of the project.

<!-- source: schedule-source-reanalysis.md -->

# Schedule Source Reanalysis

Schedule source reanalysis to keep your organization’s source understanding aligned with the latest source changes. A recurring review helps you identify whether the current analysis is still accurate before users rely on generated insights, entities, or documentation.

## Overview

Source analysis is most useful when it reflects the current state of your application. As source files change, previously identified components, hooks, pages, services, repositories, and other entities can become outdated. Scheduling reanalysis lets you plan for the analysis to be refreshed regularly instead of relying on a one-time review.

Use scheduled reanalysis when your team makes frequent changes, when multiple teams contribute to the same codebase, or before using analysis results for planning and documentation work. The analysis workspace shows the current condition of the work through areas such as **1. Current State**, **Current Pipeline**, and **3. Schedule Enabled**.

A scheduled run is not complete merely because scheduling is enabled. You should confirm that the resulting parse finishes successfully and review any warnings or differences before treating the refreshed analysis as current.

> 📷 _Screenshot pending: The source analysis workspace showing 1. Current State, Current Pipeline, and 3. Schedule Enabled._

## Prerequisites

Before you schedule source reanalysis, make sure that:

- You have access to the source analysis workspace for the source you want to maintain.
- An initial source analysis is available so that you can review its **1. Current State**.
- You understand which changes should be included in the next analysis cycle.
- You have reviewed the **Current Pipeline** for any existing analysis activity.
- You can review source differences using **View Source** and **Compare with current** when a refreshed analysis produces changes.
- Your organization has determined how often source understanding should be refreshed based on the rate of source changes.

## Step-by-Step Instructions

1. **Open the source analysis workspace.**

   Go to the analysis area for the source you want to keep current. Start by locating **1. Current State**. This area establishes the baseline that the scheduled reanalysis will refresh or compare against.

   Review the current state before enabling or relying on a schedule. If the existing analysis is already incomplete or has unresolved warnings, address those findings first so that future scheduled results have a meaningful baseline.

2. **Review the active analysis flow.**

   Locate **Current Pipeline** and check whether another analysis is already running or awaiting review. Scheduling a refresh is most useful when the current pipeline is in a stable condition.

   If an analysis is in progress, allow it to finish before evaluating the new result. Avoid treating partial work as the final source understanding.

3. **Confirm that scheduling is enabled.**

   Find **3. Schedule Enabled** in the analysis workflow. This indicates that recurring source reanalysis has been enabled for the source.

   Use your organization’s scheduling settings to define the appropriate recurring review pattern. Choose a frequency that matches how quickly the source changes. For example, a rapidly changing application may need more frequent review than a stable service or repository.

   After you enable the schedule, return to **3. Schedule Enabled** and verify that the workspace indicates the schedule is active.

4. **Monitor the next analysis result.**

   When the scheduled analysis runs, monitor its parse result. A successful result is shown as a parse that is **completed successfully with no errors**. This is the preferred outcome because it means the refreshed analysis was produced without parse errors.

   A parse can also complete **with warnings**. Warnings do not necessarily prevent you from using the analysis, but they should be reviewed before you rely on the result for decisions, planning, or generated documentation.

5. **Review the updated source when changes are detected.**

   Select **View Source** to inspect the source associated with the analysis result. Use **Compare with current** when you need to check how the analyzed version differs from the current source state.

   In the comparison view, use the **Source** option when you need to focus on the source itself rather than a difference view. Comparing the refreshed analysis with the current source helps you determine whether the scheduled result still represents the version your team is actively changing.

> 📷 _Screenshot pending: A source comparison view with View Source, Source, and Compare with current available._

6. **Preserve intentional manual edits when applicable.**

   If your workspace presents generated version 3 updates and you have reviewed the differences, choose **Keep V3 Edits** to retain selected version 3 edits. Choose **Keep All V3 Edits** only when you have confirmed that all displayed version 3 edits should remain.

   Do not use either option simply because a scheduled analysis has completed. First review the updated source and compare it with the current state so that you do not retain changes that are no longer appropriate.

7. **Use the refreshed analysis as the new operating baseline.**

   After the parse completes successfully and you have reviewed relevant differences, use the refreshed result as the current source understanding. Future scheduled runs can then be evaluated against this updated baseline.

## Tips and Best Practices

- **Treat “Schedule Enabled” and “analysis successful” as separate checks.** **3. Schedule Enabled** confirms that recurring work is planned; it does not confirm that the latest parse completed without errors. Always check the parse outcome after a scheduled run.

- **Review warnings promptly.** A result that completes with warnings may still be usable, but warnings can indicate parts of the source that need attention. Resolve or document them before downstream teams depend on the analysis.

- **Compare before preserving edits.** Use **Compare with current** and **View Source** before selecting **Keep V3 Edits** or **Keep All V3 Edits**. This is particularly important when the source has changed between the scheduled analysis and your review.

- **Match the schedule to change volume.** Reanalysis is most valuable when it occurs often enough to catch meaningful changes without creating unnecessary review work. Revisit the schedule if releases, team activity, or source complexity changes.

- **Use entity changes as a review signal.** A refreshed analysis may identify or update entities such as components, hooks, pages, layouts, routes, contexts, providers, stores, controllers, services, repositories, or middleware. Review unexpected changes in these areas, especially after major refactoring.

## Related Pages

- [Review Source Differences](#source-comparison)
- [Understand Parse Status Results](#parse-status-results)
- [Manage Generated Version 3 Edits](#manage-v3-edits)
- [Review Current Pipeline Activity](#current-pipeline)

## Troubleshooting

### The schedule is enabled, but the analysis is not current

Check **Current Pipeline** to determine whether work is still in progress or awaiting completion. Then review the parse status. Scheduling enables planned reanalysis, but you should wait for a completed result before using it as the current source understanding.

### The parse completed with warnings

Review the warnings and inspect the affected source using **View Source**. Use **Compare with current** to determine whether the warning relates to a recent source change. Do not assume that a warning-free baseline has been established until the warning has been reviewed.

### The refreshed result contains edits you did not expect

Open the comparison view and select **Compare with current**. Review the source before keeping generated edits. Use **Keep V3 Edits** for reviewed edits, or **Keep All V3 Edits** only after confirming that every version 3 edit should be retained.

<!-- source: understand-code-analysis.md -->

# Understand Code Analysis

Code analysis examines your source material and organizes it into information that Atloria can use for AI Generation and technical documentation. Understanding this process helps you provide complete inputs and recognize what Atloria is processing before you generate documentation.

## Overview

Atloria analyzes source material to identify the major parts of an application and the relationships between them. During analysis, the system can classify material across areas such as **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**.

Within those areas, Atloria identifies entities that are useful in technical documentation. For example, it can distinguish entities such as **COMPONENT**, **HOOK**, **PAGE**, **LAYOUT**, **ROUTE**, **CONTEXT**, **PROVIDER**, **STORE**, **CONTROLLER**, **SERVICE**, **REPOSITORY**, and **MIDDLEWARE**. This organization gives AI Generation the context it needs to describe how parts of your application work together.

You typically use code analysis before selecting **Generate Documentation →** from the **Technical Docs** area. The results help the generated documentation explain application structure, dependencies, and relationships—for example, when one component renders another component or when a component uses a hook.

> 📷 _Screenshot pending: The Technical Docs area showing documentation actions and the source-analysis workflow._

## Prerequisites

Before you begin, make sure you have the following:

- Access to the relevant project in Atloria.
- Source material available for the project.
- Permission to work in the **Technical Docs** area.
- A clear understanding of whether you want to generate new documentation or work from existing documentation.
- Enough time for the generation process to complete without closing or deleting the work in progress.

## Step-by-Step Instructions

1. Open your project in Atloria.

2. Select **Technical Docs** to open the technical documentation workspace.

3. Review the available starting options in the workspace.

4. Select **Add code examples** if you need to provide source examples that will help describe implementation details.

5. Select **Or import existing documentation** if you want Atloria to work with documentation you already have.

6. Select **View Source** when you need to inspect the source material associated with the documentation.

7. Select **Source** in the editor toolbar to display the source-focused view.

8. Select **Technical** in the editor toolbar to return to the technical documentation-focused view.

9. Use the language selector in the source editor if you need the displayed source content to use the appropriate language formatting.

10. Review the source content for completeness before starting generation.

11. Check that the source includes the parts of the application you expect Atloria to analyze, such as frontend elements, backend services, database-related material, configuration, or API schemas.

12. Select **Generate Documentation →** when the source material is ready for analysis and documentation generation.

13. Watch for the status **4. Generation Running** to confirm that Atloria is processing the submitted material.

14. Wait for generation to finish before making decisions based on the documentation output.

15. Select **▣ Cancel Generation** only if you need to stop the current generation process.

16. Review the generated technical documentation after processing is complete.

17. Select **Export Documentation** if you need to save or share the completed documentation outside Atloria.

18. Select **View Your Documentation →** when you are ready to open and review the generated documentation.

> 📷 _Screenshot pending: The source editor showing the Source and Technical view options and the language selector._

## Tips and Best Practices

- Provide representative source material. Analysis is more useful when the material includes the application areas you want documented, rather than isolated files with no surrounding context.

- Include related parts of the application together when possible. For example, documentation is stronger when it can connect a **COMPONENT** to the hook it uses, the service it depends on, or the page where it appears.

- Review both views before generation. Use **Source** to verify the material being analyzed, then use **Technical** to focus on the documentation-oriented result.

- Choose the correct language formatting in the source editor. Proper formatting makes source content easier for you to review before generation.

- Do not cancel generation unless necessary. When **4. Generation Running** is displayed, Atloria is actively processing your material. Canceling ends that generation attempt, so you may need to start again.

- Treat analysis categories as a coverage check. If your documentation should explain database behavior, API schemas, or infrastructure, make sure relevant source material is included alongside frontend and backend material.

- Use **Add code examples** selectively. Add examples that clarify important behavior, relationships, or implementation patterns. Avoid adding unrelated samples that could make the generated explanation less focused.

- Review generated output before exporting. Use **View Your Documentation →** to confirm that key application entities and relationships are represented accurately.

## Related Pages

- [Generate Technical Documentation](#)
- [Add Code Examples](#)
- [Import Existing Documentation](#)
- [Review Generated Documentation](#)
- [Export Documentation](#)
- [Manage Documentation Generation](#)

## Troubleshooting

### Generation does not start

Confirm that you are in **Technical Docs** and that source material or code examples are available for the project. Then select **Generate Documentation →** again. If you imported existing documentation instead, verify that the import is complete before starting generation.

### The source view does not look correct

Select **View Source**, then choose **Source** in the toolbar. Check the language selector and select the language that best matches the source material you are reviewing. This improves readability while you validate the content.

### Generation is taking longer than expected

Check whether **4. Generation Running** is still displayed. If it is, allow the process to continue. Use **▣ Cancel Generation** only when you intend to stop the current attempt; canceling does not produce completed documentation.

### Generated documentation is missing expected application details

Review the supplied source material and add relevant examples with **Add code examples**. Include connected material where possible—for example, pages with their components, components with their hooks, or services with related repositories—then select **Generate Documentation →** to run generation again.

<!-- source: understand-source-analysis-processing.md -->

# Understand Source Analysis Processing

Source analysis processing helps Atloria interpret the source material connected to your project so it can organize findings into useful documentation context. Understanding this process helps you choose the right project, review the available source information, and locate the documents produced from that analysis.

## Overview

Atloria source analysis works with the source material associated with your project and makes that information available for documentation work. As an administrator, you typically use this process when you need to confirm that a project’s source is available, review the project’s technology context, or find documents that were created from the analyzed source.

The analysis process supports source-driven documentation rather than requiring you to manually describe every application area. When source analysis is available for a project, you can use the **Source** and **Atloria Stack** actions to review the source-oriented context that Atloria has identified.

After analysis results are available, related output is managed through **Documents**. The documents area lets you select a project, search for generated or existing documentation, and manage documents when they are no longer needed.

> 📷 _Screenshot pending: Source analysis entry area showing the View Source, Atloria Stack, Source, and Documents actions._

## Prerequisites

Before you begin, make sure you have the following:

- Access to the Atloria project you want to review.
- A project with source material available to Atloria.
- Permission to view project source and documents.
- A supported browser session signed in to Atloria.
- A clear understanding of which project you want to inspect, especially if your organization manages multiple projects.

## Step-by-Step Instructions

1. Open the Atloria project that contains the source material you want to understand.

2. Click **Source** to open the project’s source-focused view.

3. Review the source information displayed for the selected project.

4. Click **View Source** when you need to inspect the available source material more directly.

5. Use the displayed source information to confirm that you are reviewing the intended project and application area.

6. Click **Atloria Stack** to review the technology and application context identified for the project.

7. Review the stack information to understand the types of application elements Atloria may use when organizing analysis findings.

8. Click **Documents** to move from source context to the project’s documentation output.

9. Select the project when the page displays **Select a project to view documents**.

10. Enter a keyword in **Search documents...** to find documentation within the selected project.

11. Enter a broader term in **Search documents, categories, projects...** when you need to search across document names, categories, or projects.

12. Select a document from the results list to review documentation created from or related to the analyzed source.

> 📷 _Screenshot pending: Documents area showing the “Select a project to view documents” message and the “Search documents...” field._

## Tips and Best Practices

- Start with **Source** before reviewing documents. This helps you verify that you are working with the correct project context before interpreting document output.

- Use **Atloria Stack** to orient yourself to the application’s overall structure. Stack information is especially useful when similar projects use different technologies or when you need to distinguish frontend, service, and data-related areas.

- Select a project before searching for documents. If the documents page shows **Select a project to view documents**, Atloria cannot display project-specific documentation until you choose one.

- Use specific terms in **Search documents...**. For example, search using a feature name, business area, or document title rather than a broad term such as “app.”

- Use **Search documents, categories, projects...** when you do not know which project contains the document. This broader search is useful for administrators who oversee multiple projects or documentation categories.

- Treat document deletion as permanent. The **Delete Documents** action is accompanied by the confirmation text **I understand, delete**, indicating that you should verify your selection before completing the action.

- Keep source review and document management separate. Use **View Source**, **Source**, and **Atloria Stack** to understand analysis context; use **Documents** to locate, review, or manage the resulting documentation.

## Related Pages

- [Manage Project Documents](#)
- [Search Documents and Categories](#)
- [Delete Documents](#)
- [Review Atloria Stack Information](#)
- [Authorize Atloria Access](#)

## Troubleshooting

### You see “Select a project to view documents”

You have opened **Documents**, but no project is currently selected.

1. Select the project you want to review.
2. Return to the documents list.
3. Use **Search documents...** after the project’s documents are displayed.

### You cannot find an expected document

The document may belong to another project, may use a different title, or may be categorized differently.

1. Clear the value in **Search documents...**.
2. Search again using a shorter or more specific keyword.
3. Use **Search documents, categories, projects...** to search across projects and categories.
4. Confirm the project source by returning to **Source** or **View Source**.

### You are considering deleting documents

Deleting documents can remove information that other users rely on.

1. Click **Delete Documents** only after reviewing the selected documents.
2. Confirm that the correct project and documents are selected.
3. Use **I understand, delete** only when you are certain the documents should be removed.

<!-- source: understand-batch-screenshot-processing.md -->

# Understand Batch Screenshot Processing

Batch screenshot processing prepares multiple application views for use in generated visual documentation. Understanding this process helps you monitor generation activity, locate the resulting screenshots, and review the source material used to create documentation.

## Overview

Batch screenshot processing is part of Atloria’s documentation generation workflow. Rather than handling one screen at a time, the process gathers screenshots associated with a documentation generation and makes them available for review and management.

You typically use this workflow when you are generating documentation for a project or version that includes visual guidance. During generation, Atloria can show that work is in progress through the **4. Generation Running** stage. After generation, you can use **Manage Screenshots →** to review the screenshots associated with the generated documentation.

Screenshot processing is especially useful when you need consistent visual evidence across many documents. For example, you can use the screenshots to support instructions, explain screen states, or verify that generated documentation reflects the intended application experience.

> 📷 _Screenshot pending: The documentation generation screen showing the “4. Generation Running” stage and the “Cancel Generation” action._

## Prerequisites

Before you begin, make sure you have the following:

- Access to an Atloria project with documentation generation available.
- A project or version selected for generation.
- Documentation content or source material ready to generate.
- Permission to view generated documents and screenshots.
- A browser session that remains open while you monitor generation, if your organization requires active monitoring.
- An understanding of which generated documents need visual screenshots.

## Step-by-Step Instructions

1. Open **Documents** from the Atloria application navigation.

2. Select the project whose documentation you want to generate.

3. Select the relevant project version when version-specific documentation is available.

4. Click **Generate Documentation →**.

5. Review the generation options that are presented for the selected project.

6. Start the documentation generation process.

7. Watch for the **4. Generation Running** status to confirm that generation is in progress.

8. Wait for the generation process to finish before reviewing its visual output.

9. Click **Manage Screenshots →** when the action becomes available.

10. Review the screenshots displayed for the generated documentation.

11. Open a generated document from **Documents** when you need to confirm how screenshots support its instructions.

12. Click **View Source** when you need to compare generated documentation with its available source material.

13. Select **Source** when you need to focus on the source view rather than the documentation view.

14. Return to **Documents** after completing your screenshot review.

> 📷 _Screenshot pending: The generated documentation area with the “Manage Screenshots →” action available for reviewing batch-produced screenshots._

## Tips and Best Practices

- Start screenshot processing as part of a complete documentation generation, not as an isolated review activity. The screenshot output is most useful when you can compare it with the documents created in the same generation.

- Monitor the **4. Generation Running** stage before expecting screenshots to be available. If generation is still running, visual documentation assets may not yet be ready for review.

- Use **Manage Screenshots →** as your primary review location. This keeps screenshot review separate from reading or editing individual documents.

- Use **View Source** when a generated screenshot or document needs validation against its original material. Source review can help you determine whether an issue comes from the available source information or from the generated documentation.

- Review screenshots in the context of the intended audience. A screenshot that is useful for an administrator-focused document may not provide enough guidance for an end-user document.

- Keep visual documentation aligned with the generation output. If you regenerate documentation after changing the underlying project material, review the screenshots again so that your visual guidance remains consistent.

- Avoid canceling a generation unless necessary. Selecting **Cancel Generation** stops the active generation workflow, which can prevent the expected documentation and screenshot output from becoming available.

> 📷 _Screenshot pending: A document view showing the “View Source” and “Source” actions used to validate generated documentation against its source material._

## Related Pages

- [Generate Documentation](#)
- [Manage Screenshots](#)
- [Review Generated Documents](#)
- [View Documentation Source](#)
- [Compare Document Changes](#)
- [Export Documentation](#)

## Troubleshooting

### The **Manage Screenshots →** action is not available

Confirm that you started a documentation generation for the selected project or version. If the generation is still in progress, wait until the **4. Generation Running** stage completes before checking for screenshots.

### Generation is taking longer than expected

Check whether the screen still shows **4. Generation Running**. If it does, allow the process to continue. Use **Cancel Generation** only if you intentionally need to stop the current generation and restart it later.

### A generated document does not appear to match its screenshot

Open the document and select **View Source**. Review the available source material to determine whether the mismatch originates in the source information or in the generated documentation. If needed, regenerate the documentation after the source material has been corrected.

<!-- source: enable-entity-exploration.md -->

# Enable Entity Exploration

Entity Exploration lets authorized project contributors find and review entities identified in an analyzed project. Use it after a project has been created and analyzed so contributors can search the available model instead of manually locating entities in project documentation.

## Overview

Entity Exploration provides a searchable view of analyzed entities within the context of a project. Contributors can use the **Search entities…** field to locate an entity by name and focus their review on the relevant part of the product model.

You typically enable access to Entity Exploration by making sure contributors can open the correct project and its documentation area. Entity availability depends on the project having analyzed content; an empty or newly created project may not yet provide entities to search.

This task is important when you want project contributors to explore the same analyzed model, review entity relationships, and use project documentation without switching between separate projects.

> 📷 _Screenshot pending: Entity Exploration showing the Search entities… field and available analyzed entities._

## Prerequisites

Before you begin, make sure that:

- You can access the **Projects** area.
- The project has already been created.
- The project contains analyzed source material or generated documentation.
- The people who need to explore entities are authorized project contributors.
- You know which project should provide the entities.
- You can open the project dashboard using **Open Project Dashboard**.

## Step-by-Step Instructions

1. Open **Projects** from the application navigation.

2. Use the **Search projects...** field to locate the project that contains the analyzed entities you want to share.

3. Select the appropriate project from the project list.

4. Click **Open Project Dashboard** to enter the focused project workspace.

> 📷 _Screenshot pending: A project in the Projects list with the Open Project Dashboard action available._

5. Open the project’s documentation area from the project workspace.

6. Confirm that the project is selected before continuing. If the documentation area displays **Select a project to view documents**, return to **Projects** and open the intended project dashboard.

7. Locate the entity exploration area within the project documentation.

8. Click the **Search entities…** field.

9. Enter the name of an analyzed entity that contributors should be able to find.

10. Review the matching entity results to confirm that the project’s analyzed entities are available for exploration.

11. Share the project with the authorized contributors through your organization’s established project-access process.

12. Ask contributors to open **Projects**, select the same project, and use **Search entities…** to locate the entities they need.

13. Verify access with a contributor account or with a contributor who has been granted access.

14. If contributors need to return to the project list, instruct them to select **← Back to Projects** or **&larr; Back to Projects**, depending on the screen they are using.

## Tips and Best Practices

- Keep related entities in the same project whenever possible. Entity search is performed in the context of the selected project, so contributors should open the correct project before searching.

- Use clear, recognizable entity names in the underlying analyzed material. This makes results easier to find when contributors type into **Search entities…**.

- Confirm that analysis or documentation generation has completed before asking contributors to explore entities. If no analyzed material is available, the search experience may not return useful results.

- Use **Search projects...** before opening a dashboard when your organization has many projects. This reduces the risk of enabling contributors to work in the wrong project.

- Treat project access as the boundary for Entity Exploration. Only provide project access to contributors who should be able to view the analyzed product model.

- If you manage several projects, use the project name and project dashboard as the primary context check before reviewing entity results. Do not assume that similarly named entities belong to the same project.

## Related Pages

- [Create a Project](#)
- [Open a Project Dashboard](#)
- [View Project Documentation](#)
- [Search Entities](#)
- [Manage Project Contributors](#)
- [Generate Technical Documentation](#)

## Troubleshooting

### The documentation area says “Select a project to view documents”

You are not currently working in a selected project context. Click **← Back to Projects**, locate the project with **Search projects...**, and select **Open Project Dashboard** before opening documentation again.

### No entities appear when you use “Search entities…”

Confirm that you opened the correct project and that the project contains analyzed source material or generated documentation. A new project may not have entities available until analysis has been completed.

### A contributor cannot find or open the project

Verify that the contributor has been granted access to the intended project through your organization’s project-access process. Then ask them to open **Projects**, search for the project using **Search projects...**, and select **Open Project Dashboard**.

<!-- source: configure-relationship-visibility.md -->

# Configure Relationship Visibility

This page explains how to prepare a project for relationship visibility configuration in Atloria. Relationship visibility affects how you explore connections between entities in a project, helping users focus on the relationships that matter for their current review.

## Overview

Relationships represent connections between entities in a product model. When relationship visibility is configured appropriately, project explorers can present a clearer view of related items and reduce distractions from connections that are not relevant to a particular review.

You typically configure relationship visibility when you are preparing a project for technical documentation, model review, change analysis, or stakeholder exploration. Before changing visibility settings, make sure you are working in the correct project, because relationship presentation is relevant to the focused project rather than the overall project list.

Atloria provides project navigation from the **Projects** area. From there, you can search for a project, open its dashboard, and continue to the project areas used for exploration and documentation.

> 📷 _Screenshot pending: Relationship exploration view showing entities and their visible relationships._

## Prerequisites

Before you begin, make sure that:

- You can access the **Projects** area.
- The project you want to configure already exists.
- You know the project name or can locate it by using **Search projects...**.
- The project contains analyzed entities and relationships to explore.
- You have the appropriate administrator or project-management permissions for the project.
- You understand which relationships should be emphasized or hidden for the intended audience.

## Step-by-Step Instructions

1. Select **Projects** to open the list of available projects.

2. Use **Search projects...** to find the project whose relationship presentation you want to review.

3. Select the matching project from the search results to make it the active project.

4. Select **Open Project Dashboard** to open the focused project workspace.

> 📷 _Screenshot pending: The Projects page with a selected project and the Open Project Dashboard action._

5. Open the project area used for product-model exploration or technical documentation.

6. Locate the relationship or entity exploration panel for the active project.

7. Review the entities displayed in the exploration panel before changing any visibility option.

8. Identify the relationship types that users need to see during project exploration.

9. Identify relationship types that should not appear in the current exploration context.

10. Open the relationship visibility controls when they are available in your project’s exploration interface.

11. Select the visibility option for each relationship type you want to present to users.

12. Clear the visibility option for each relationship type you do not want to present.

13. Review the updated entity relationships in the exploration view.

14. Save or apply the visibility changes if the screen provides a save or confirmation action.

15. Return to the project exploration view and verify that the visible relationship paths match the intended model view.

> 📷 _Screenshot pending: Relationship visibility controls with relationship types selected or cleared for project exploration._

> **Important:** The available evidence confirms project navigation labels such as **Projects**, **Search projects...**, and **Open Project Dashboard**. The specific relationship-visibility control labels and save behavior should be confirmed in your Atloria environment before publishing organization-specific instructions or training materials.

## Tips and Best Practices

- Configure visibility for a specific exploration purpose. For example, a documentation reviewer may need broad relationship visibility, while a stakeholder review may benefit from a smaller set of business-relevant connections.

- Start with the most important relationship types visible. This makes it easier to confirm that users can follow the primary paths through the product model before adding secondary relationships.

- Review visibility changes in the exploration view immediately after applying them. A relationship type can be correctly selected in a configuration panel but still produce an overly complex model view when many entities use that relationship.

- Use the project search when you manage many projects. The **Search projects...** field helps you avoid opening and configuring the wrong project.

- Confirm that you are in the focused project workspace before making changes. Selecting **Open Project Dashboard** after choosing the project helps ensure you are reviewing the intended project context.

- Coordinate visibility decisions with your documentation and architecture owners. Relationship visibility affects how users interpret the structure of the model, so inconsistent settings can make different project views harder to compare.

## Related Pages

- [Manage Projects](#)
- [Open a Project Dashboard](#)
- [Explore Product Model Entities](#)
- [Review Project Changes](#)
- [Generate Technical Documentation](#)
- [Compare Project Versions](#)

## Troubleshooting

### You cannot find the project to configure

1. Select **Projects**.
2. Enter part of the project name in **Search projects...**.
3. Confirm that you are searching the correct project list.
4. If the project is not listed, verify that the project has been created and that you have access to it.

### You opened a project but cannot find relationship visibility controls

1. Select **Open Project Dashboard** to confirm that you are in the focused project workspace.
2. Open the project’s product-model, entity, or technical-documentation exploration area.
3. Check whether relationships have been generated for the project.
4. Ask a project administrator to confirm whether your role includes permission to change relationship presentation settings.

### Relationship changes do not appear in exploration

1. Review the selected relationship types in the relationship visibility controls.
2. Confirm that the active project contains entities using those relationship types.
3. Apply or save the changes if the interface provides a confirmation action.
4. Refresh the exploration view and check the relationship paths again.

<!-- source: manage-source-context-access.md -->

# Manage Source Context Access

This page explains how to open and review source-derived technical context in Atloria. Controlling who can view this context helps you share useful implementation details while keeping access aligned with your organization’s access-control practices.

## Overview

Atloria provides technical documentation views that can include source-derived symbols, relationships, and implementation context. You can use these views when you need to understand how product elements relate to technical components, validate generated technical content, or review the source material behind a documentation entry.

The main entry point is **Technical Docs**. From there, you can switch to the **Technical** view and use **View Source** when it is available for the selected content. The source view is intended for reviewing technical context; it is not a replacement for your organization’s source repository permissions or security policies.

Access should be governed carefully because technical context may expose details such as entity relationships, component references, lifecycle information, and other implementation-oriented symbols. For example, a technical documentation area may include entries related to **👥 Access Control**, **Application Security & Access Control**, or **👤 Role-Based Access Control (RBAC)**.

> 📷 _Screenshot pending: Technical Docs page showing the Technical view and View Source action_

## Prerequisites

Before you begin, make sure that:

- You can open the relevant project in Atloria.
- You have access to the project’s **Technical Docs** area.
- You know which technical documentation entry or symbol you need to review.
- Your organization has defined which users or roles may review source-derived technical context.
- You have permission to use **Manage in Settings** if you need to review or update access-related settings.
- You understand that **View Source** may reveal implementation context that should be handled according to your organization’s security standards.

## Step-by-Step Instructions

1. Open the project that contains the technical documentation you want to review.

2. Select **Technical Docs** to open the project’s technical documentation area.

3. Select **Technical** to focus on technical rather than product-oriented documentation.

4. Locate the documentation entry that contains the source-derived context you need to govern or review.

5. Select the entry to display its available technical details.

6. Review the entry title and visible context before opening source information.

7. Click **View Source** to display the source-derived context for the selected documentation.

8. Review the symbols, relationships, and technical references shown in the source view.

9. Use the displayed source context to confirm whether the selected entry contains information appropriate for the intended audience.

10. Return to the documentation entry when you have completed your review.

11. Select **Manage in Settings** if your organization provides access management through Settings.

12. Review the available access controls in Settings before changing any permissions.

13. Apply your organization’s approved role or group assignments for users who need to review technical context.

14. Remove or avoid granting access for users who only need product-facing documentation.

15. Save or confirm your access changes if the Settings screen presents a save or confirmation action.

16. Return to **Technical Docs** and verify that the appropriate users can access the required documentation view.

> 📷 _Screenshot pending: View Source display with source-derived symbols and technical references_

## Tips and Best Practices

- Give access based on job responsibilities. Users who maintain technical documentation, architecture, integrations, or security controls may need source context; users who only consume end-user documentation often do not.

- Use the **Product** and **Technical** views intentionally. The **Product** view is better suited to product-facing material, while **Technical** is the appropriate area for implementation-oriented context.

- Review source context before sharing it broadly. Technical entries can include relationships and lifecycle descriptions, such as references to rendering, hooks, contexts, stores, services, repositories, or models. Treat this information as technical material.

- Use **View Source** to validate documentation grounding. When a technical document describes a symbol or relationship, compare it with the source-derived information before relying on it for design, security, or operational decisions.

- Keep access reviews aligned with RBAC practices. If your organization uses role-based access control, review access to technical context when users change roles, join a project, leave a project, or change responsibilities.

- Separate documentation responsibilities from source access responsibilities. Access to **Technical Docs** and **View Source** should be granted according to your internal policy; do not assume that every documentation contributor requires the same level of technical visibility.

- Use **Manage in Settings** for centralized administration when it is available. Centralized settings reduce the risk of inconsistent permissions across projects or teams.

## Related Pages

- [Use Technical Docs](#)
- [View Source-Derived Context](#)
- [Manage Project Access](#)
- [Role-Based Access Control (RBAC)](#)
- [Manage Product and Technical Documentation](#)
- [Go to Version Manager](#)

## Troubleshooting

### You cannot open Technical Docs

Confirm that you are in the correct project and that your account has access to the project’s documentation. If **Technical Docs** is unavailable, ask a project administrator to review your project membership and assigned role.

### You do not see View Source

First, select **Technical** and open a specific technical documentation entry. If **View Source** still does not appear, the selected content may not have source-derived context available, or your access level may not permit source review. Contact an administrator to confirm your assigned access.

### You can view documentation but cannot manage access

Use **Manage in Settings** only if it is available to your account. If you cannot open or update settings, your role may allow documentation review without administrative access. Ask an administrator who manages **👤 Role-Based Access Control (RBAC)** to make the required access changes.

<!-- source: enable-product-flow-capture.md -->

# Enable Product Flow Capture

Product Flow Capture collects information about how users move through your product within a selected project. Use it when you need to document, review, or maintain the product flows associated with a project.

## Overview

Product Flow Capture is managed from the project area in Atloria. You begin from the **Projects** hub, open the project you want to work with, and use **Capture** to start collecting the project’s product-flow information.

Capturing is project-specific. Before you select **Capture**, make sure you have opened the correct project. This helps ensure that the information collected belongs to the intended product and does not affect another project in your workspace.

If you need to collect the information again after the product changes, use **Recapture**. The project also provides **Bulk Recapture** when you need to refresh captured information across a broader set of items.

> 📷 _Screenshot pending: The Projects hub showing the project list, search field, and New Project button._

## Prerequisites

Before you enable Product Flow Capture, make sure you have the following:

- Access to the Atloria **Projects** area.
- An existing project listed in **Projects**.
- The correct project selected for the product flow you want to collect.
- Permission to work with the project and start a capture.
- A clear understanding of whether you need a first-time capture, a single refresh using **Recapture**, or a broader refresh using **Bulk Recapture**.

## Step-by-Step Instructions

1. Select **Projects** to open the hub that lists all available projects.

2. Use the **Search projects...** field to find the project if it is not immediately visible.

3. Select the project you want to configure for product-flow collection.

4. Select **Open Project Dashboard** to open the focused project workspace.

5. Confirm that the project dashboard belongs to the product whose flows you want to capture.

6. Select **Capture** to enable and begin collection of product-flow information for the project.

7. Wait for the capture to complete before leaving the project dashboard.

8. Review the captured project information in the project workspace to confirm that the collection was completed for the correct project.

> 📷 _Screenshot pending: The focused project dashboard with the Capture action available for starting Product Flow Capture._

9. Select **Recapture** when you need to collect the product-flow information again after product changes.

10. Select **Bulk Recapture** when you need to refresh captured information for multiple applicable items rather than starting an individual recapture.

11. Select **← Back to Projects** or **&larr; Back to Projects** when you are finished working in the project and want to return to the project list.

## Tips and Best Practices

- Start with **Capture** for a project that has not yet had its product-flow information collected. Use **Recapture** only when you need to refresh existing captured information.

- Verify the active project before selecting **Capture**. The **Projects** hub contains multiple projects, and capture activity should be performed only from the intended focused project.

- Use **Search across all projects...** when you need to locate content or context across the workspace. Use **Search projects...** when your immediate goal is to find and open a particular project.

- Prefer **Recapture** after targeted product updates. For example, use it after changes to screens, navigation, or user journeys that may affect an existing product flow.

- Use **Bulk Recapture** carefully. It is most useful when a larger update affects several applicable items and you need to refresh their collected information together.

- Do not use **Delete Project** as part of the capture process. Deleting a project removes the project rather than enabling or refreshing its product-flow collection.

- If you are setting up a project for the first time, select **New Project** and then **Create project** before returning to the project dashboard to use **Capture**.

## Related Pages

- [Create a New Project](#)
- [Open and Manage a Project](#)
- [Recapture Product Flow Information](#)
- [Use Bulk Recapture](#)
- [Search Projects](#)
- [Review Project Changes](#)

## Troubleshooting

### You cannot find the project to capture

1. Select **Projects** to return to the project hub.

2. Enter the project name in **Search projects...**.

3. Select the matching project.

4. Select **Open Project Dashboard**.

If the project is not listed, create it first using **New Project** and **Create project**.

### You selected Capture for the wrong project

1. Select **← Back to Projects** or **&larr; Back to Projects**.

2. Locate the correct project using **Search projects...**.

3. Select the correct project.

4. Select **Open Project Dashboard**.

5. Select **Capture** in the correct project workspace.

### Existing product-flow information needs to be updated

1. Open the affected project from **Projects**.

2. Select **Open Project Dashboard**.

3. Select **Recapture** to refresh the captured information.

4. Select **Bulk Recapture** instead if you need to refresh multiple applicable items as part of a wider update.

<!-- source: configure-flow-review-practices.md -->

# Configure Flow Review Practices

Configure flow review practices so your team can validate captured flows consistently before they are published or used as product documentation. A clear review process helps reviewers confirm that each flow is complete, accurate, and ready for stakeholders.

## Overview

Flow review is the validation stage for captured product flows. You use it when a flow needs review before it moves into a publish-ready state, such as **Version 4 — Pre-Publish Review**. Reviewers can inspect the flow, return to the review workspace when changes are needed, and use preview options to check how the flow will be presented.

The review area includes a summary stage, shown as **1 Review Summary**, and a configured stage, shown as **2. Configured**. These stages help your team understand whether a flow is still being assessed or has been prepared for the next review and publishing activities.

Use review practices for all flow types that your organization documents, including **User Flow**, **Pipeline Flows**, **Loop Flows**, and **Agent Loop Flow Diagrams**. You can also apply the same practices when reviewing flows for product surfaces, security, and authentication scenarios.

> 📷 _Screenshot pending: The flow review workspace showing the “1 Review Summary” stage and review actions._

## Prerequisites

Before you begin, make sure that you have:

- Access to the relevant project and version.
- A captured flow that is ready for review.
- Permission to access the review workspace.
- A defined reviewer or review team for the flow.
- Agreement on the information that must be validated before publishing, such as user steps, product surfaces, authentication requirements, or security expectations.
- A version selected for review, such as **Version 4 — Pre-Publish Review**.

## Step-by-Step Instructions

1. Open the project that contains the captured flow you want to validate.

2. Select the version that contains the flow review work.

3. Open the review workspace for the selected version.

4. Review the **1 Review Summary** stage to understand the current review status and the information included in the flow.

5. Identify the type of flow you are reviewing, such as **User Flow**, **Pipeline Flows**, **Loop Flows**, or **Agent Loop Flow Diagrams**.

6. Compare the captured steps with the expected user journey or business process.

7. Confirm that the flow includes the relevant product areas, including **Product Surfaces — what you actually have** when applicable.

8. Review authentication-related steps against the **🔐 Authentication & Authorization Flow** requirements when the flow includes sign-in, access control, or permissions.

9. Review security-related steps against the **✅ Security Best Practices Implemented** information when the flow handles protected data, privileged actions, or access-sensitive tasks.

10. Select **Preview** to inspect the flow in preview mode.

11. Review the flow presentation in **1. Preview Mode** to confirm that the steps are understandable before you move forward.

12. Select **Back to Review** if the preview reveals missing, unclear, or incorrect flow information.

13. Update the review decisions and flow details needed to address the identified issues.

14. Select **Configure →** when the review content is ready to move into the configuration stage.

15. Confirm that the stage changes to **2. Configured** after configuration is complete.

16. Select **Review & Publish** when the configured flow is ready for final review and publishing activities.

> 📷 _Screenshot pending: The Preview screen showing the “Preview” action and “1. Preview Mode” state._

## Tips and Best Practices

- Review one flow objective at a time. For example, validate a **User Flow** separately from a **Pipeline Flows** diagram so reviewers can focus on the correct audience and outcome.

- Use **Preview** before moving to **Review & Publish**. Previewing helps you catch wording, sequence, and presentation issues before the flow reaches a broader audience.

- Treat **1 Review Summary** as the team’s working checkpoint. Use this stage to verify that the captured flow represents what users actually do, rather than what the team expects users to do.

- Use **Back to Review** whenever you find an issue in preview. Returning to review is preferable to moving an incomplete flow into the configured stage.

- Configure flows only after the review team agrees that the steps are accurate. The **2. Configured** indicator should represent a flow that has completed its review preparation.

- Review access-related flows carefully. If a flow includes authentication or authorization, confirm that the visible steps align with the organization’s approved authentication and access practices.

- Consider sharing a preview with stakeholders when external feedback is required. The **Share Preview Link** option can help reviewers validate flow content without changing the underlying review work.

- Use **Configure CI/CD** only when your organization’s publishing or review process includes CI/CD-related flow configuration. Keep this separate from the content review of the user journey itself.

## Related Pages

- [Capture Product Flows](#)
- [Review and Publish a Flow](#)
- [Use Preview Mode for Flow Validation](#)
- [Share a Flow Preview Link](#)
- [Configure CI/CD for Product Flows](#)
- [Manage Project Versions](#)

## Troubleshooting

### You cannot find the flow review workspace

Confirm that you opened the correct project and version. Review work is associated with a specific version, such as **Version 4 — Pre-Publish Review**. If the expected version is unavailable, ask your project administrator to confirm your access.

### The flow does not look correct in Preview

Select **Back to Review** and correct the flow before proceeding. Check the step order, user actions, product surfaces, and any authentication or security-related content. Select **Preview** again after making the corrections.

### The flow is not showing as configured

Complete the required configuration activity by selecting **Configure →** from the review process. Verify that the stage displays **2. Configured** before continuing to **Review & Publish**.

<!-- source: set-flow-documentation-ownership.md -->

# Set Flow Documentation Ownership

This page explains how to assign a responsible maintainer for workflow and experience documentation in Atloria. Clear ownership helps ensure that documentation is reviewed, updated, and kept accurate as product flows change.

## Overview

Atloria organizes product knowledge around flows, including **Pipeline Flows**, **Loop Flows**, and **User Flow** documentation. You can use the Documentation Hub to locate the flow documentation that needs an accountable maintainer.

Documentation ownership is especially important when a flow reaches the **DOCUMENTATION** stage of its lifecycle. A flow may move through stages such as **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**. When a flow is in the documentation stage, assign a person or team who understands the workflow and can keep its instructions current.

The available captured interface labels confirm how to access documentation areas, but do not identify a specific ownership field, owner selector, or save button. Use your organization’s enabled ownership control on the selected flow or documentation record; its availability can depend on your workspace configuration and permissions.

> 📷 _Screenshot pending: The Documentation Hub entry point, including the “View Your Documentation →” action._

## Prerequisites

Before you begin, make sure you have the following:

- Access to the Atloria project containing the flow documentation.
- Permission to manage documentation or flow settings for that project.
- The name of the individual or team that will maintain the documentation.
- Agreement on which flow needs an owner, such as a **Pipeline Flows**, **Loop Flows**, or **User Flow** item.
- A defined review expectation for the owner, such as reviewing documentation after workflow, authentication, or product-surface changes.
- Access to any related implementation or product knowledge needed to validate the documentation, especially for flows such as **🔐 Authentication & Authorization Flow** or **OAuth 2.0 Flow**.

## Step-by-Step Instructions

1. Open the documentation area by selecting **View Your Documentation →**.

2. Open **Documentation Hub**.

3. Select the project that contains the flow documentation you want to maintain.

4. Open the appropriate flow category, such as **Pipeline Flows**, **Loop Flows**, or **User Flow**.

5. Select the specific flow or experience document that needs an assigned maintainer.

6. Review the flow’s current lifecycle stage.

7. Confirm that the documentation is ready for ownership when the flow has reached **DOCUMENTATION** or when documentation work is otherwise required.

8. Open the ownership or responsibility control available for the selected documentation item.

9. Select the individual or team responsible for maintaining the flow documentation.

10. Save or confirm the ownership change using the confirmation action shown in your workspace.

11. Review the displayed owner or responsibility indicator on the flow documentation.

12. Record the expected review trigger for the owner, such as a change to a product surface, a user journey, or an authentication flow.

> 📷 _Screenshot pending: The selected flow documentation page showing the ownership control, assigned maintainer, and confirmation action._

### When to assign ownership

Assign ownership as soon as documentation has a stable scope. For example, assign a maintainer when documentation describes a product surface, an agent loop, a user journey, or an integration flow that other teams will rely on.

If the flow is still changing rapidly across **FRONTEND**, **BACKEND**, **DATABASE**, or **API SCHEMA** work, you can still identify a provisional owner. That person can coordinate updates until the flow reaches the **DOCUMENTATION** stage. Once the documentation is stable, confirm the long-term maintainer and review schedule.

For cross-functional flows, assign ownership to the person or team best positioned to validate the user-facing experience. A technical contributor may own implementation details, while a product, support, or experience team may own the guidance users depend on.

## Tips and Best Practices

- Assign one clearly accountable maintainer whenever possible. Multiple contributors can participate, but one person or team should be responsible for confirming that updates are complete.

- Match the owner to the flow type. For example, assign an authentication specialist to **🔐 Authentication & Authorization Flow** or **OAuth 2.0 Flow** documentation, and assign a product-flow owner to **User Flow** documentation.

- Review documentation when the underlying experience changes. Updates to product surfaces, generated documentation, templates, or agent loop diagrams can affect the accuracy of existing flow guidance.

- Use the Documentation Hub as the starting point for ownership reviews. It provides a central place to locate documentation instead of relying on separately shared links or outdated copies.

- Treat generated content as a starting point. If you use **Generate Documentation →** or **Generate documentation from your code**, assign a maintainer to review the generated result before treating it as complete.

- Consider ownership before exporting. Select **Export Documentation** only after the assigned maintainer has verified the content, especially when documentation will be shared outside the immediate project team.

- Reassign ownership when team responsibilities change. Do not leave documentation assigned to a former contributor, inactive team, or person who no longer owns the related product area.

## Related Pages

- [Use the Documentation Hub](#)
- [Generate Documentation](#)
- [Export Documentation](#)
- [Manage Pipeline Flows](#)
- [Manage Loop Flows](#)
- [Document User Flows](#)
- [Document Authentication and Authorization Flows](#)
- [Use Documentation Templates](#)

## Troubleshooting

### You cannot find an ownership control

Confirm that you opened the specific flow documentation item rather than only the Documentation Hub landing page. If no ownership option appears on the selected item, ask a project administrator whether ownership assignment is enabled for your workspace or whether you need additional permissions.

### You cannot save the assigned maintainer

Verify that you have permission to manage the selected project’s documentation. If you can view the flow but cannot confirm changes, a project administrator may need to assign the owner or update your access level.

### The documentation has an owner but is out of date

Open the affected flow and compare the documentation with the current product experience. Ask the assigned maintainer to review the content when the workflow has changed, especially after changes to authentication, user journeys, product surfaces, or generated documentation.

<!-- source: enable-technical-documentation.md -->

# Enable Technical Documentation

Technical Documentation workspaces let you create developer-facing content for a project, including generated technical reference material and imported documentation. Enable this workspace when your project needs documentation for software components, APIs, data structures, configuration, or infrastructure.

## Overview

The **Technical Docs** workspace provides a dedicated area for technical documentation work. Unlike reader-focused documentation, this workspace is intended for content that helps developers understand and work with the technical parts of a project.

You can begin by generating documentation from the project or by bringing in existing material. The workspace supports documentation across categories such as **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**.

After documentation is available, you can view it, copy content when needed, export it, and optionally use versioning and scheduled documentation updates. These options help you keep developer-facing documentation usable as the project changes.

> 📷 _Screenshot pending: The Technical Docs workspace showing documentation generation and import options._

## Prerequisites

Before you start, make sure that you have:

- Access to the project where you want to enable technical documentation.
- Permission to open the project’s **Technical Docs** area.
- Project information available for documentation generation, if you plan to use **Generate Documentation →**.
- Existing documentation files or content available, if you plan to use **Or import existing documentation**.
- A clear decision about whether the documentation should be versioned or updated on a schedule.

## Step-by-Step Instructions

1. Open the project that requires developer-facing documentation.

2. Select **Technical Docs** from the project navigation.

3. Review the Technical Docs workspace to confirm that you are working in the correct project.

4. Select **Generate Documentation →** to create technical documentation from the available project information.

5. Wait for the workspace to show **Generating Documentation** while the documentation is being prepared.

6. Review the generated documentation when the workspace displays **Documentation Ready!**.

7. Select **View Your Documentation →** to open the generated technical documentation.

8. Use the available documentation style selector to choose the presentation style that best fits your audience.

9. Select **Generate** after choosing a style if you need to create or refresh the documentation in that style.

10. Select **Or import existing documentation** instead of generating content if your technical documentation already exists outside Atloria.

11. Complete the import process to add your existing technical documentation to the workspace.

12. Select **⚡ Enable Versioning** if you need to preserve and manage documentation versions over time.

13. Enable scheduling when the workspace shows **3. Schedule Enabled** and you want documentation updates to occur on a recurring basis.

14. Select **Export Documentation** when you need a copy of the completed documentation for use outside the workspace.

15. Select **Copy** beside content that you want to place in another tool, message, or document.

> 📷 _Screenshot pending: The Technical Docs workspace after generation, showing “Documentation Ready!”, “View Your Documentation →”, export, and versioning options._

## Tips and Best Practices

- Generate documentation only after the project information you want documented is available. Technical documentation is most useful when it reflects the current frontend, backend, database, API schema, configuration, and infrastructure details.

- Use **Or import existing documentation** when your organization already maintains approved technical content. Importing existing material can help you preserve established terminology, architecture decisions, and team conventions.

- Review generated content before exporting or sharing it. Generation can organize documentation around technical categories, but you should confirm that the content is appropriate for its intended developer audience.

- Enable **⚡ Enable Versioning** for documentation that changes alongside releases, integrations, or architecture updates. Versioning is especially useful when developers need to distinguish current guidance from earlier documentation.

- Use scheduling only when regular refreshes are appropriate for your project. A scheduled update can help keep documentation aligned with ongoing changes, but you should still review important updates before distributing them broadly.

- Choose a documentation style deliberately. A compact style may be helpful for concise reference content, while a more detailed style may be better for onboarding or complex implementation guidance.

- Export documentation after it reaches a reviewed state. Keep exported copies labeled with the relevant project and version so users can identify the correct material later.

## Related Pages

- [Generate Documentation](#)
- [Import Existing Documentation](#)
- [View Technical Documentation](#)
- [Enable Documentation Versioning](#)
- [Schedule Documentation Updates](#)
- [Export Documentation](#)

## Troubleshooting

### You cannot find the Technical Docs workspace

Confirm that you opened the correct project and that your account has access to its documentation areas. If **Technical Docs** is not available in the project navigation, contact a project administrator to verify your permissions.

### Documentation remains on “Generating Documentation”

Wait for the generation process to complete, then check whether the workspace changes to **Documentation Ready!**. If the status does not change, refresh the workspace and try **Generate Documentation →** again after confirming that the project information is available.

### You need documentation that differs from the generated result

Use **Or import existing documentation** to add approved technical content, or select a different documentation style and generate the documentation again. Review the result before using **Export Documentation** or sharing copied content.

<!-- source: configure-api-reference-output.md -->

# Configure API Reference Output

This page explains how to configure API Reference output for your project’s technical documentation. Configuring the output helps you define how API capabilities, schemas, and examples are presented before you generate documentation.

## Overview

API Reference documentation gives technical readers a structured view of the APIs identified in your project. Use it when you need to communicate available API capabilities alongside the schemas and code examples that help developers understand how to use them.

You configure this output from the **Technical Docs** area of your project. The configuration workflow includes selecting **API Reference**, reviewing **Output Settings**, and adding examples where they will improve the generated reference.

The interface indicates configuration progress with **2. Configured**. After configuration is complete, you can generate the documentation and review the resulting API Reference output.

> 📷 _Screenshot pending: Technical Docs workspace showing the API Reference option and configuration progress_

## Prerequisites

Before you begin, make sure you have:

- Access to the project for which you want to create technical documentation.
- Opened the project’s **Technical Docs** area.
- API capabilities and schema information available in the project for documentation.
- Any code examples you want to include prepared for review.
- A decision about whether you want to create new documentation or use **Or import existing documentation**.

## Step-by-Step Instructions

1. Open your project’s **Technical Docs** area.

2. Select **Technical** if you are choosing the type of documentation to create.

3. Select **API Reference** to configure API-focused documentation output.

4. Click **Configure →** to open the documentation configuration workflow.

5. Select **Output Settings** to review the output options for the API Reference.

6. Review the API capabilities included in the reference output.

7. Review the available API schema information included in the reference output.

8. Select **Add examples** when you want to include examples with the API Reference.

9. Select **Add code examples** when you want examples that demonstrate API usage in code.

10. Choose the documentation style in the style selector that best fits the intended audience and level of detail.

11. Confirm that the configuration status shows **2. Configured**.

12. Click **Generate Documentation →** to create the configured API Reference output.

13. Select **View Your Documentation →** to review the generated documentation.

> 📷 _Screenshot pending: API Reference configuration showing Output Settings, example options, and the Generate Documentation button_

## Tips and Best Practices

- Configure API Reference output only after the relevant API capabilities and schemas are available in the project. The usefulness of the generated reference depends on the available project information.

- Use **Add examples** for examples that clarify common API interactions. Examples are most helpful when they show a realistic request, response, or usage scenario rather than repeating schema details.

- Use **Add code examples** when your readers need implementation-oriented guidance. Keep examples focused on the API capability being documented so readers can quickly connect the example to the corresponding reference information.

- Review your selected documentation style before generating. A compact style can be useful for readers who need a concise reference, while a more detailed presentation may be better for onboarding or cross-team handoffs.

- Check for **2. Configured** before selecting **Generate Documentation →**. This helps ensure that the configuration stage is complete before output is generated.

- Use **View Your Documentation →** after generation to verify that the API capabilities, schemas, and examples appear in a logical order and provide the amount of detail your audience needs.

## Related Pages

- [Generate Technical Documentation](#)
- [Add Code Examples to Technical Documentation](#)
- [Import Existing Documentation](#)
- [Configure CI/CD for Documentation](#)
- [Export Documentation](#)
- [Choose Documentation Templates](#)

## Troubleshooting

### API Reference is not available to select

Return to the **Technical Docs** area and confirm that you are configuring **Technical** documentation. Then select **API Reference** from the available documentation options.

### The documentation is not ready to generate

Confirm that the workflow displays **2. Configured**. If the status is not shown, click **Configure →** and review **Output Settings**, including the API reference content and any examples you want to add.

### Generated output does not include the examples you expected

Before generating, use **Add examples** or **Add code examples** to include the needed examples. Then select **Generate Documentation →** again and use **View Your Documentation →** to review the updated output.

<!-- source: govern-code-snippet-content.md -->

# Govern Code Snippet Content

Use source-based examples and code snippets to keep your technical documentation accurate, useful, and aligned with your organization’s standards. This page explains how to establish a consistent review process for snippets and SDK-related documentation in Atloria.

## Overview

Technical documentation can include generated content, imported documentation, and manually added code examples. Governing this content means deciding which examples are appropriate for readers, verifying that examples match the current source, and maintaining a consistent style across documentation.

You need this process when you publish API references, SDK guidance, integration examples, or implementation details for developers. A governed approach helps prevent outdated examples, incomplete setup instructions, and snippets that expose internal-only implementation details.

In Atloria, you can begin technical documentation from the **Technical Docs** area, generate documentation from available source material, import existing content, and add code examples where they improve the reader’s understanding. Readers can use **View Source** when source context is available, and can use **Copy** to reuse an approved example.

> 📷 _Screenshot pending: The Technical Docs area showing options to generate documentation, add code examples, or import existing documentation._

## Prerequisites

Before you begin, make sure you have:

- Access to the relevant project’s **Technical Docs** area.
- Permission to create, update, or publish technical documentation for the project.
- An approved documentation style for code examples, such as compact examples for reference material or more explanatory examples for guides.
- Current source material or a verified implementation to use as the basis for examples.
- A defined review owner for SDK documentation, API examples, and security-sensitive snippets.
- A decision about whether examples should be generated, imported, or added manually.

## Step-by-Step Instructions

1. Open the project where you want to govern technical documentation.

2. Select **Technical Docs** to view the project’s technical documentation workspace.

3. Select **Generate Documentation →** when you want Atloria to create documentation from the available source material.

4. Select **Or import existing documentation** when your approved SDK or API documentation already exists outside Atloria.

5. Select **Add code examples** when the documentation needs a source-based example, usage snippet, or SDK implementation sample.

6. Select **Add examples** when you want to include additional examples that clarify a technical concept or implementation pattern.

7. Review each added example for a clear user goal before keeping it in the document.

8. Remove or rewrite examples that do not show a complete, meaningful task for the intended technical audience.

9. Select the available documentation style option, such as **compact**, when you are preparing concise API-reference examples.

10. Use the documentation reader to confirm that the selected style makes the example easy to scan without hiding required context.

11. Select **View Source** for an example when you need to compare the published explanation with its available source context.

12. Verify that names, inputs, expected behavior, and dependencies in the example match the source context you reviewed.

13. Confirm that the example does not reveal credentials, private configuration values, internal addresses, or other sensitive information.

14. Confirm that the example includes only the code needed to demonstrate the documented task.

15. Select **Copy** from the reader to test whether an approved example can be copied cleanly for reader use.

16. Replace any copied output that includes unintended surrounding text, incomplete instructions, or environment-specific values.

17. Select **Export Documentation** when you need to distribute the governed version for review, archival, or publication through another approved channel.

18. Select **View Your Documentation →** to review the documentation as a reader before you consider its examples approved.

> 📷 _Screenshot pending: A technical documentation page with a code example, the View Source action, and the Copy action visible._

## Tips and Best Practices

- Base examples on verified source behavior. Use **View Source** as part of your review whenever it is available, especially for API and SDK content.

- Keep examples focused. A snippet should demonstrate one task, such as initializing a client, calling an operation, or handling a result. Split large workflows into separate examples instead of combining unrelated tasks.

- Use the **compact** style for short reference examples. Reserve more detailed surrounding explanation for cases where readers must understand prerequisites, limitations, or expected outcomes.

- Treat generated content as a starting point, not an automatic approval. Select **Generate Documentation →**, then review the resulting examples for accuracy, audience suitability, and sensitive content.

- Use imported documentation carefully. When you select **Or import existing documentation**, confirm that imported SDK versions, terminology, and examples match the project’s current implementation.

- Include realistic values without publishing secrets. Use clearly fictional placeholders for tokens, keys, account identifiers, and URLs.

- Maintain consistency across similar examples. For example, use the same naming conventions, error-handling approach, and setup assumptions throughout one technical documentation set.

- Review documentation after major source changes. Examples can become misleading even when they still look syntactically correct.

> 📷 _Screenshot pending: The documentation reader showing a source-based example and the View Source option used to validate it._

## Related Pages

- [Generate Technical Documentation](#)
- [Add Code Examples to Technical Documentation](#)
- [Import Existing Documentation](#)
- [Review and Publish Technical Documentation](#)
- [Export Documentation](#)
- [Manage Documentation Templates](#)

## Troubleshooting

### The generated example does not match the current implementation

Select **View Source** and compare the example with the available source context. Update the example to reflect the verified behavior, then review the reader view again through **View Your Documentation →**.

### The example is too long or difficult to understand

Use **Add examples** to separate the content into smaller task-based examples. Keep each snippet focused on one outcome and move background information into the surrounding documentation text.

### The copied snippet includes values readers cannot use

Select **Copy** to test the reader experience before approval. Replace internal values, credentials, and environment-specific settings with safe placeholders and explain which values readers must provide.

<!-- source: configure-robots-directives.md -->

# Configure Robots Directives

Robots directives control whether documentation crawlers can discover and index your published technical documentation. Use these controls when you need to manage search visibility, restrict crawler access during preparation, or confirm that only approved documentation is discoverable.

## Overview

Robots directives are instructions for automated crawlers, such as search-engine bots and documentation indexing services. They help you control which documentation areas can be crawled and whether pages should appear in search results.

In Atloria, documentation work is managed from the **Technical Docs** area of a project. Before changing crawler access, make sure the documentation you intend to publish is configured and reviewed. The documentation workflow includes a **CONFIG** stage before the **DOCUMENTATION** stage, so crawler-related decisions should be finalized before you distribute or export your documentation.

Use robots controls when you need to:

- Prevent unfinished technical documentation from being indexed.
- Allow approved technical documentation to be discovered by crawlers.
- Recheck crawler access after changing documentation structure or publishing settings.
- Coordinate search visibility with your organization’s access-control and security policies.

> 📷 _Screenshot pending: The Robots Directives controls showing available crawler-access options for technical documentation._

## Prerequisites

Before you begin, make sure you have:

- Access to the applicable project.
- Permission to configure project documentation settings.
- A project with **Technical Docs** available.
- A clear decision from your documentation owner or security team about whether crawlers should be allowed or restricted.
- Documentation content that is ready for the appropriate visibility level.
- An understanding of whether your organization uses access controls, such as **Role-Based Access Control (RBAC)**, for documentation access.

## Step-by-Step Instructions

1. Open the project that contains the technical documentation you want to manage.

2. Select **Technical Docs**.

3. Select **Configure →** to open the available documentation configuration options.

4. Locate the robots or crawler-access controls in the documentation configuration area.

5. Review the current crawler-access setting before making a change.

6. Select the option that matches your publishing decision.

7. Choose the restrictive option if the documentation is unfinished, internal, or not ready for search discovery.

8. Choose the permissive option only when the documentation is approved for crawler access.

9. Review any related visibility or access-control settings before saving your decision.

10. Save or apply the updated configuration using the confirmation action shown on the screen.

11. Return to **Technical Docs** after the change is saved.

12. Select **View Your Documentation →** to review the documentation as it will be presented to readers.

> 📷 _Screenshot pending: The Technical Docs configuration area with robots or crawler-access settings highlighted._

13. Confirm that the visible documentation matches the intended crawler-access decision.

14. Select **Export Documentation** only after you have confirmed that crawler access and documentation visibility are appropriate for distribution.

## Tips and Best Practices

- Configure crawler access before treating documentation as ready to publish. The documentation process includes configuration before documentation generation and delivery, so decisions about visibility should be made early.

- Use restrictive crawler settings while documentation is being generated, reviewed, or reorganized. This reduces the chance that incomplete pages are discovered before they are ready.

- Review robots directives whenever you add a new documentation area, change the documentation structure, or update access-control requirements.

- Do not assume that user access and crawler access are the same. Your organization may use **Access Control** or **Role-Based Access Control (RBAC)** to limit who can open documentation, while robots directives separately communicate instructions to automated crawlers.

- Coordinate crawler-access decisions with the owners of application security and access control. This is especially important for technical references that could expose implementation details, internal processes, or non-public configuration guidance.

- Verify your documentation presentation after configuration changes. Use **View Your Documentation →** to check that the intended content is available and organized correctly before exporting or sharing it.

- If you use documentation templates, review the generated output after changing crawler settings. A template can affect which sections are included, while robots directives affect crawler behavior for the resulting documentation.

## Related Pages

- [Configure Technical Documentation](./configure-technical-documentation)
- [Generate Documentation](./generate-documentation)
- [View Technical Documentation](./view-technical-documentation)
- [Export Documentation](./export-documentation)
- [Configure CI/CD](./configure-cicd)
- [Manage Access Control](./manage-access-control)
- [Role-Based Access Control (RBAC)](./role-based-access-control)

## Troubleshooting

### You cannot find robots or crawler-access controls

Open **Technical Docs** and select **Configure →** again. If no crawler-related option is available, your organization may manage robots directives outside the project’s documentation configuration screen, or your role may not include the required configuration permission. Contact a project administrator or documentation administrator.

### Your documentation is visible when it should remain restricted

Review both the robots directive setting and the project’s access-control settings. Robots directives provide instructions to crawlers, but they do not replace access restrictions. Confirm that the appropriate **Access Control** or **Role-Based Access Control (RBAC)** policy is also applied.

### You changed the setting but are unsure whether the documentation is ready to share

Select **View Your Documentation →** and inspect the generated documentation before selecting **Export Documentation**. If content is still incomplete, return to **Configure →** and apply the more restrictive crawler-access option until the documentation is approved.

<!-- source: configure-documentation-sitemaps.md -->

# Configure Documentation Sitemaps

This page explains how Atloria supports discovery of your published technical documentation through its documentation sitemap. Keeping your documentation published and accessible helps users and search tools find the latest approved content.

## Overview

A documentation sitemap is a discovery aid for published documentation. It helps organize the public documentation pages that Atloria makes available through your published documentation area, including technical documentation and individual document pages.

You typically review sitemap availability after you have generated and published documentation. The sitemap is relevant when you want readers to discover your documentation from the published documentation navigation, when you are sharing documentation externally, or when you are validating that published content—not work in progress—is available to the public documentation experience.

In Atloria, the key control point is publication. Documentation must reach the **Published** state before it can be presented in the published documentation area and become available for discovery. Draft content remains separate from the public experience.

> 📷 _Screenshot pending: The published documentation area showing the Technical Docs navigation and the View Published Docs action._

## Prerequisites

Before you begin, make sure that:

- You can access the Atloria project or workspace that contains the documentation.
- You have documentation ready to publish, either generated in Atloria or imported through **Or import existing documentation**.
- Your documentation has been reviewed for accuracy, titles, and audience suitability.
- You have the required permission to publish documentation for the project.
- You know whether you are managing **Technical Docs**, user-facing documentation, or both.
- You have access to the public documentation view through **View Published Docs**.

## Step-by-Step Instructions

1. Open the documentation area for your Atloria project.

2. Select **Technical Docs** to work with your project’s technical documentation.

3. Select **Configure →** if you need to complete the project’s documentation setup before publishing.

4. Select **Generate Documentation →** if the documentation you want to publish has not yet been generated.

5. Select **Or import existing documentation** if you are bringing previously written documentation into Atloria.

6. Review the documentation that Atloria has prepared for publication.

7. Confirm that each document intended for discovery is ready to be published.

8. Publish the documentation so that its status changes to **Published**.

9. Check the **3. Published Status** area to confirm that publication has completed.

10. Select **View Published Docs** to open the public documentation experience.

11. Review the published documentation navigation to confirm that your technical documentation appears under the expected documentation section.

12. Select **Technical** in the published documentation navigation to verify that technical content is visible to readers.

13. Open a published document to confirm that its title and content are available in the public documentation experience.

14. Repeat the publication process whenever you add, revise, or regenerate documentation that should be discoverable.

> 📷 _Screenshot pending: The Published status and View Published Docs action used to verify that documentation is available publicly._

## Tips and Best Practices

- Publish only finalized content. The sitemap supports discovery of published documentation, so review content before moving it into the **Published** state.

- Use clear, distinct document titles. Readers use the published documentation navigation to locate content, and clear titles make technical topics easier to recognize.

- Verify the public view after every significant documentation update. Select **View Published Docs** and check the published navigation rather than relying only on the authoring or configuration view.

- Keep technical documentation organized separately from other documentation types. Atloria supports **Technical Docs** alongside other documentation, so confirm that readers can find the right material in the appropriate published section.

- Treat publication as the discovery checkpoint. If a document is not visible through **View Published Docs**, it should not be considered ready for sitemap-based discovery.

- Regenerate documentation when your underlying project changes. Select **Generate Documentation →** when you need Atloria to produce updated documentation, then review and publish the updated result.

- Use **Export Documentation** when you need a copy of the published documentation for external review, archival, or distribution. Exporting does not replace checking the content in **View Published Docs**.

- If your organization uses automated delivery practices, review **Configure CI/CD** and **Authorize Atloria** as part of your broader documentation publishing process. Ensure automated updates are reviewed before they are published for discovery.

## Related Pages

- [Generate Technical Documentation](#)
- [Import Existing Documentation](#)
- [Publish Documentation](#)
- [View Published Documentation](#)
- [Configure CI/CD for Documentation](#)
- [Export Documentation](#)

## Troubleshooting

### Published documentation does not appear in the public view

Confirm that the documentation status is **Published**. Review the **3. Published Status** area, then select **View Published Docs** again. Content that has not been published remains unavailable in the public documentation experience.

### The Technical section does not contain the expected documents

Return to **Technical Docs** and verify that the documents were generated or imported into the correct documentation type. If needed, select **Generate Documentation →** or **Or import existing documentation**, then publish the resulting documentation.

### Recent documentation changes are not visible

Regenerate the documentation if the project has changed, review the updated content, and publish it again. Then use **View Published Docs** to confirm that readers can see the current published version.

<!-- source: understand-the-atloria-platform.md -->

# Understand the Atloria Platform

Atloria helps you generate, review, publish, and support technical documentation for your software. This page explains the main platform areas so you can understand how documentation moves from analysis to a published experience.

## Overview

Atloria brings together documentation generation, publishing, support, and administration in one platform. You use it when you need to turn information about an application into organized technical documentation, make that documentation available to the right audience, and maintain it as your product changes.

The platform is organized around several visible areas. **Technical Docs** is where documentation work is centered. From there, you can begin generation, review available documentation, export documentation, or import existing material. The **Atloria Stack** and **Components** areas help you understand the parts of the software that contribute to the documentation set, such as user-facing application elements, supporting services, data-related areas, configuration, and infrastructure.

Documentation generation is a staged process. Atloria can identify information across categories such as **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**. As generation progresses, you may see **4. Generation Running**. When the process finishes, the result may indicate that the parse completed successfully or completed with warnings. Warnings do not necessarily prevent documentation from being created, but they indicate that you should review the output carefully.

After generation, you can use publishing features to make documentation available through a shareable documentation site. Atloria also includes support-oriented tools, including **🤖 AI Support**, **Support Agent**, and **6. Support Chat**, so users can find answers while viewing published documentation.

> 📷 _Screenshot pending: The Atloria workspace showing Technical Docs, Atloria Stack, Components, Generation, Publishing, and Support Agent areas._

## Prerequisites

Before you begin working with Atloria, make sure you have the following:

- Access to your organization’s Atloria workspace.
- Permission to connect or authorize the software source that Atloria will analyze.
- A clear understanding of the documentation audience you want to serve, such as internal technical teams or external users.
- Existing documentation files if you plan to use **Or import existing documentation** instead of generating new content.
- Time for the generation process to complete, especially for a large or complex application.
- A plan for reviewing warnings and validating generated documentation before publishing it.

## Step-by-Step Instructions

1. **Open the documentation area.**

   In your Atloria workspace, select **Technical Docs**. This is the starting point for creating or managing technical documentation. Use this area when you want to generate documentation from your application or work with documentation that already exists.

2. **Choose how you want to create documentation.**

   If you want Atloria to create documentation based on your connected application, select **Generate Documentation →**. If you already have documentation that you want to bring into Atloria, select **Or import existing documentation**.

   Generating documentation is useful when you need Atloria to organize information from across your software. Importing is useful when you have established content that should be retained, improved, or published through Atloria.

3. **Authorize Atloria when prompted.**

   Select **Authorize Atloria** to allow the platform to access the connected source needed for documentation generation. Complete the authorization steps shown on screen before continuing.

   Authorization is important because Atloria needs access to the relevant application information before it can analyze the software and prepare documentation.

4. **Start documentation generation.**

   Select **Generate Documentation →** and confirm the settings presented to you. Atloria begins examining relevant areas of the application, including frontend, backend, database, API schema, configuration, documentation, and infrastructure information.

   During this work, the platform may display **4. Generation Running**. Keep the workspace open or return later to check progress. If you need to stop the process, select **◼ Cancel Generation**.

5. **Review the generation outcome.**

   When generation is complete, review the status shown in Atloria. A successful result means the analysis completed without errors. A result with warnings means Atloria completed the process but found items that may need your attention.

   Review the generated documentation for completeness, especially where your application has complex relationships between components. For example, a component may render another component or use a hook; these relationships can help explain how the application works, but they should be checked for accuracy and usefulness to your intended readers.

6. **Open and review your documentation.**

   Select **View Your Documentation →** to open the generated documentation experience. Review page titles, structure, terminology, and audience suitability before sharing it more broadly.

   Confirm that the content explains the user-visible behavior of your application and that sensitive internal details are not exposed to the wrong audience.

7. **Publish or export the approved content.**

   Use the **Publishing** area when the documentation is ready to share. If you need a portable copy for another process, select **Export Documentation**.

   Publishing lets readers access the documentation through a public or audience-specific documentation experience. Exporting is useful for archiving, review workflows, or delivery outside the platform.

8. **Enable support experiences as needed.**

   Use **🤖 AI Support**, **Support Agent**, or **6. Support Chat** when you want readers to receive help while using the documentation. These options are particularly useful after publishing, when readers may need clarification without contacting your team directly.

> 📷 _Screenshot pending: The Technical Docs area showing Generate Documentation, Generation Running status, Cancel Generation, and View Your Documentation actions._

## Tips and Best Practices

- **Start with the intended audience.** Documentation for technical teams may need more implementation context, while customer-facing documentation should focus on tasks and outcomes. Review generated material with the reader’s needs in mind.

- **Treat warnings as review items.** A completed generation with warnings can still provide useful output. However, you should inspect the affected areas before publishing and fill in missing explanations where necessary.

- **Use imports to preserve established content.** Select **Or import existing documentation** when you already have approved manuals, policies, or technical references that should remain part of your documentation library.

- **Review before publishing.** Generation helps organize information, but you remain responsible for accuracy, clarity, and appropriate access. Use **View Your Documentation →** to validate the published reading experience.

- **Use support tools after publication.** **🤖 AI Support** and **6. Support Chat** can help readers find answers quickly, reducing repetitive questions sent to your documentation team.

- **Cancel only when necessary.** Select **◼ Cancel Generation** only when you need to stop the current run. If generation is progressing normally, allow it to complete so you can review the results and any warnings.

## Related Pages

- [Generate Documentation](#)
- [Import Existing Documentation](#)
- [Review Generated Documentation](#)
- [Publish Documentation](#)
- [Export Documentation](#)
- [Configure AI Support](#)
- [Use the Atloria Recorder](#)

## Troubleshooting

### Generation is still showing “4. Generation Running”

Wait for the process to complete and refresh the workspace if needed. Large applications or applications with multiple areas can take longer to analyze. Avoid starting a second generation unless you intentionally need a new run.

### Generation completed with warnings

Open the generated documentation using **View Your Documentation →** and review the affected content. Warnings indicate that Atloria completed the process but may not have captured every detail cleanly. Add or revise documentation before publishing if important information is incomplete.

### You cannot start generation or access connected application information

Confirm that you completed **Authorize Atloria** and that you are using an Atloria workspace where you have the required access. If authorization is no longer valid, repeat the authorization process before selecting **Generate Documentation →**.

<!-- source: understand-the-atloria-monorepo.md -->

# Understand the Atloria Monorepo

This page helps you understand how the Atloria monorepo is organized and how its major areas work together. This context helps you make informed administrative decisions when reviewing technical documentation, infrastructure information, and generated documentation outputs.

## Overview

The Atloria monorepo brings multiple Atloria applications and supporting areas together in one managed workspace. Rather than treating the public website, authenticated application experience, documentation processing, code analysis, and screenshot capture as unrelated systems, the monorepo organizes them as coordinated parts of the Atloria platform.

As a technical administrator, you will most often use this understanding when you need to identify where a feature belongs, review generated technical documentation, or determine which part of the platform is responsible for a problem. For example, user-facing account access belongs with the sign-in, registration, password reset, invitation, and single sign-on experiences. Publicly shared documentation belongs with the public documentation experience, while analysis and capture activities support the documentation generation process behind the scenes.

Atloria documentation also classifies discovered material into categories that move from **FRONTEND** through **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**. This sequence is useful when you review a technical documentation set because it presents the system from the user-facing layer through the supporting platform layers.

> 📷 _Screenshot pending: The Technical Docs area showing available documentation categories and navigation options._

## Prerequisites

Before reviewing the Atloria monorepo structure, make sure you have:

- Access to the Atloria administrator experience appropriate to your organization.
- Permission to view **Technical Docs** and, where applicable, **Infrastructure** information.
- A basic understanding of your organization’s Atloria deployment, including whether you use single sign-on, invitations, or public documentation sharing.
- Access to the documentation workspace or exported documentation provided by your Atloria implementation team.
- A clear review goal, such as validating an architecture overview, locating documentation gaps, or checking infrastructure coverage.

## Step-by-Step Instructions

1. **Open the technical documentation area.**

   From the available Atloria navigation options, select **Technical Docs**. This is the starting point for reviewing documentation that explains how the platform is arranged and how its major areas relate to each other.

   If your workspace presents an overview entry, select **Overview** or **📊 Overview** first. The overview helps you understand the breadth of the documented system before you focus on an individual area.

2. **Start with the platform structure.**

   Select **Structure** when it is available. Use this view to orient yourself around the logical areas of the monorepo rather than beginning with a single feature or issue.

   Focus first on the distinction between:
   - The user-facing Atloria experience, including authentication and public documentation access.
   - The administrative and operational experience, including enterprise analytics and operational views.
   - The supporting documentation-processing capabilities, such as analysis, orchestration, and screenshot capture.
   - The platform-level areas represented by configuration and infrastructure documentation.

   This approach matters because a feature may involve more than one area. A public documentation page, for example, can depend on both the public presentation experience and the documentation content that was generated or imported.

3. **Review documentation by category.**

   In the technical documentation content, review categories in the order in which they are presented:

   1. **FRONTEND**
   2. **BACKEND**
   3. **DATABASE**
   4. **API SCHEMA**
   5. **CONFIG**
   6. **DOCUMENTATION**
   7. **INFRASTRUCTURE**

   This order gives you a practical path for understanding a feature. Begin with what users see, then follow the supporting services and data, and finally review the configuration and infrastructure required to operate it.

   For infrastructure-specific information, select **Infrastructure** or **🔐 Infrastructure Security** where available. Use these sections when your review concerns hosting, security posture, operational dependencies, or deployment-related responsibilities.

4. **Use Atloria Stack information to connect the layers.**

   Select **Atloria Stack** when you need a cross-platform view. This helps you recognize that user actions in one area can be supported by processes elsewhere in the monorepo.

   For example, the platform includes experiences for logging in, registering, resetting passwords, completing single sign-on, and accepting invitations. It also provides public documentation views that can be opened through shared documentation links. Supporting platform areas analyze source material and capture screenshots so documentation can reflect the actual user experience.

5. **Review relationships, not only categories.**

   When technical documentation describes relationships, use it to understand how one documented item supports another. Relationship descriptions may show that a user interface component renders another component, uses a hook or context, calls an API, depends on a service, or queries a model.

   You do not need to trace implementation details to benefit from these relationships. Instead, use them to answer administrative questions such as:
   - Which areas may be affected by a change?
   - Does a user-facing screen rely on a shared platform capability?
   - Is a documentation gap limited to one category, or does it affect several layers?

6. **Save or export your reviewed structure when needed.**

   If you are arranging or confirming the documentation organization, use **Save Structure** to preserve your changes. If you need to circulate the documentation outside Atloria, select **Export Documentation**.

   If your organization already has material to bring into Atloria, use **Or import existing documentation** instead of recreating content manually. After importing or reviewing source material, **Generate Documentation →** can be used to produce documentation outputs for review.

> 📷 _Screenshot pending: The Structure or Atloria Stack view showing how user-facing, documentation, and infrastructure areas are grouped._

## Tips and Best Practices

- **Review from the user experience inward.** Start with **FRONTEND** documentation and continue through backend, data, configuration, and infrastructure. This makes technical documentation easier to connect to real user outcomes.

- **Treat public and authenticated experiences separately.** Public documentation sharing, user invitations, login, registration, password reset, and single sign-on serve different audiences and may have different administrative requirements.

- **Use relationship information for impact assessment.** A relationship such as “calls API,” “uses service,” or “depends on” signals that a change or issue may extend beyond the screen or item you are currently reviewing.

- **Keep technical documentation and user manuals distinct.** Atloria supports both technical documentation and user-facing manuals. Technical documentation explains platform structure and dependencies; user manuals explain the actions people take on screen. Review the correct document type for your audience.

- **Check documentation coverage across all categories.** A complete technical review should not stop at application behavior. Include **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE** so operational dependencies are visible.

## Related Pages

- [Review Technical Docs](#)
- [Use the Atloria Stack View](#)
- [Manage Infrastructure Security Documentation](#)
- [Generate Documentation](#)
- [Import Existing Documentation](#)
- [Export Documentation](#)
- [Understand User Manuals and Technical Documentation](#)

## Troubleshooting

### You cannot find the Technical Docs area

Your account may not have the required access, or your organization may not have enabled the relevant documentation workspace. Confirm that you can access **Technical Docs** and ask an Atloria administrator to verify your permissions.

### The documentation does not include an expected category

Review whether the missing information belongs under **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, or **INFRASTRUCTURE**. If it is absent across these categories, import existing material using **Or import existing documentation** or generate updated content with **Generate Documentation →**.

### You are unsure whether to use technical documentation or a user manual

Use **Technical Docs** when you need to understand platform structure, dependencies, configuration, or infrastructure. Use user manuals when you need instructions for completing a task through visible screens, fields, menus, and buttons.

<!-- source: enable-screenshot-capture.md -->

# Enable Screenshot Capture

Screenshot capture creates visual records of your project’s screens so you can review them and include them in visual documentation. Use this process when you first set up a project or when you need to refresh screenshots after interface changes.

## Overview

Screenshot capture is managed from the project you want to document. You start in **Projects**, open the relevant project, and select **Manage Screenshots →** to access the screenshot management area.

From there, you can use **Capture** to begin collecting screenshots for the project. Captured images provide a visual reference for the project’s documentation and review activities.

If your project’s interface changes later, return to the screenshot management area and use **Recapture** or **Bulk Recapture** as appropriate. This lets you replace or refresh the visual record rather than relying on outdated images.

> 📷 _Screenshot pending: The Projects hub showing the project list, search field, and New Project action._

> 📷 _Screenshot pending: A focused project view with the Manage Screenshots action and screenshot capture controls._

## Prerequisites

Before you enable screenshot capture, confirm that you have the following:

- Access to the **Projects** area.
- A project that already appears in the project list.
- Permission to open the project dashboard and manage its screenshots.
- A project whose screens are available for capture.
- An understanding of whether you need an initial capture, a single refresh, or a bulk refresh of existing screenshots.

## Step-by-Step Instructions

1. Select **Projects** to open the project hub.

2. Use **Search projects...** to find the project if it is not immediately visible.

3. Select the project you want to document.

4. Select **Open Project Dashboard** if you are not already on the project dashboard.

5. Select **Manage Screenshots →** to open screenshot management for the selected project.

6. Review the available screenshot controls before starting a capture.

7. Select **Capture** to begin screenshot capture for the project.

8. Wait for the capture process to complete before navigating away from the screenshot management area.

9. Review the resulting screenshots in the project’s screenshot area.

10. Select **Recapture** when you need to refresh screenshots after a change to the project interface.

11. Select **Bulk Recapture** when you need to refresh multiple existing screenshots together.

12. Select **← Back to Projects** when you have finished managing screenshots.

## Tips and Best Practices

- Use **Capture** for the first visual capture of a project. This establishes the initial set of screenshots used for visual documentation.

- Use **Recapture** after making a focused interface change. For example, if you updated a specific screen or workflow, refresh its visual record so reviewers see the current interface.

- Use **Bulk Recapture** when broad changes affect many screens. This is more appropriate after a major interface update than refreshing screenshots individually.

- Start from the correct project. Screenshot management is tied to the focused project, so confirm that the project dashboard you opened is the one you intend to document.

- Keep project names easy to find. The **Search projects...** field helps you locate the correct project quickly when your organization has many projects.

- Review screenshots after each capture or recapture. A successful capture should result in current visual material that can support documentation and project review.

- Consider screenshot capture part of your documentation maintenance routine. When the user interface changes, refresh screenshots along with the written documentation so both remain aligned.

- Do not confuse project navigation with screenshot management. **← Back to Projects** returns you to the project list, while **Manage Screenshots →** opens the controls needed to capture or refresh images.

## Related Pages

- [Manage Projects](#manage-projects) — Find, open, and organize projects from the **Projects** hub.
- [Open the Project Dashboard](#open-project-dashboard) — Access actions for a focused project.
- [Review Project Versions](#review-project-versions) — Review project versions and associated visual material.
- [Export Documentation](#export-documentation) — Export project documentation after screenshots and written content are current.
- [Manage Technical Documentation](#manage-technical-documentation) — Create and maintain written documentation for a project.

## Troubleshooting

### You cannot find the project

Use **Search projects...** from **Projects** and enter identifying text for the project. If the project still does not appear, confirm that you have access to it or ask a project administrator to verify your permissions.

### You cannot see screenshot controls

Open the correct project and select **Open Project Dashboard**, then select **Manage Screenshots →**. Screenshot actions such as **Capture**, **Recapture**, and **Bulk Recapture** are available from screenshot management rather than the general project list.

### Screenshots no longer match the current interface

Return to **Manage Screenshots →** and select **Recapture** for an updated screenshot. If multiple screens changed, select **Bulk Recapture** to refresh the affected visual documentation together.

<!-- source: configure-screenshot-batches.md -->

# Configure Screenshot Batches

Configure screenshot batches to capture product interfaces in an organized, repeatable workflow. This helps you keep visual documentation current when product screens change or when you need to recapture multiple interfaces at once.

## Overview

Screenshot batches let you organize product-interface captures into a planned sequence rather than capturing screens one at a time. You can use this workflow when preparing visual documentation for a product, updating documentation after a release, or collecting screenshots for several product surfaces.

The screenshot workflow includes a configuration stage and a bulk recapture stage. The interface identifies these stages as **2. Configured** and **3. Bulk Recapture**, helping you confirm that capture settings are ready before you begin a large recapture effort.

After you capture screenshots, you can use them as part of your documentation workflow. The application also provides options such as **Generate Documentation →**, **Export Documentation**, and **View Your Documentation →** for continuing from captured product surfaces to published documentation.

> 📷 _Screenshot pending: Screenshot management area showing configuration, capture, and bulk recapture actions._

## Prerequisites

Before you configure a screenshot batch, make sure you have:

- Access to the appropriate product in Atloria.
- A product interface or product surface that is ready to capture.
- The necessary permissions to use **Manage Screenshots →**.
- A clear list of screens or user flows that need to be included in the batch.
- A stable version of the product interface, especially if you plan to use the screenshots in generated or exported documentation.
- Existing documentation ready to import if you intend to use **Or import existing documentation** as part of your broader documentation process.

## Step-by-Step Instructions

1. Open the product you want to document.

2. Select **Product [actions]** to open the available product actions.

3. Click **Manage Screenshots →**.

4. Review the screenshot workflow status shown on the page.

5. Select **Configure →** to begin configuring the screenshot batch.

6. Identify the product surfaces that you want the batch to capture.

7. Confirm that the interfaces you selected represent the documentation scope you need.

8. Complete the available configuration choices for the batch.

9. Verify that the workflow shows **2. Configured** after your configuration is complete.

10. Select **Capture** to capture the configured product interfaces.

11. Review the captured results before continuing with a larger recapture operation.

12. Select **3. Bulk Recapture** when you need to update multiple configured screenshots.

13. Choose **Recapture** for an individual screenshot when only one interface needs to be updated.

14. Use the bulk recapture option when several product interfaces have changed and should be refreshed together.

15. Review the updated captures to ensure that the screenshots reflect the current product interface.

16. Select **Generate Documentation →** when you are ready to create documentation from the captured material.

17. Select **View Your Documentation →** to review the resulting documentation.

> 📷 _Screenshot pending: Batch configuration view with the Configure, Capture, Recapture, and Bulk Recapture actions._

## Tips and Best Practices

- Configure the batch before starting a large capture effort. The **2. Configured** stage is your checkpoint that the batch is ready for capture.

- Use **Capture** for the initial capture of configured product interfaces. Use **Recapture** when one existing screenshot needs to be refreshed.

- Use **3. Bulk Recapture** when a release changes multiple screens. This is more efficient than updating each screenshot individually.

- Keep your batch focused on one product area or documentation goal. For example, capture a related group of product surfaces together rather than mixing unrelated workflows in the same batch.

- Review screenshots after each capture or recapture. Visual documentation is most useful when it reflects what users currently see in the product.

- Capture stable interfaces whenever possible. If a screen is still changing, wait until the expected user experience is finalized before using it in generated documentation.

- Continue into the documentation workflow only after confirming that your captures are correct. You can then select **Generate Documentation →** or use **Export Documentation** when you need to distribute the completed content.

## Related Pages

- [Manage Product Screenshots](#)
- [Capture Product Interfaces](#)
- [Bulk Recapture Screenshots](#)
- [Generate Documentation from Captures](#)
- [Export Documentation](#)
- [Configure CI/CD](#)

## Troubleshooting

### The batch does not show as configured

Return to **Manage Screenshots →** and select **Configure →** again. Complete the available configuration choices, then confirm that the workflow displays **2. Configured** before attempting to capture screenshots.

### A screenshot is outdated after a product change

Select **Recapture** if only one screenshot needs updating. If several screens changed as part of the same release, use **3. Bulk Recapture** to refresh the configured group.

### The captured screenshots are not ready for documentation

Review the captured product interfaces and recapture any screens that do not represent the intended user experience. When the screenshots are accurate, select **Generate Documentation →** to continue, or select **View Your Documentation →** to review existing documentation.

<!-- source: manage-screenshot-retention.md -->

# Manage Screenshot Retention

This page explains how to maintain screenshot assets used in your visual documentation. Consistent retention and replacement practices help ensure that published documentation reflects the current application experience.

## Overview

Screenshots are visual documentation assets that show users what they can expect to see when completing a task. As your application changes, older screenshots can become inaccurate—for example, when a button label changes, a workflow moves to a different screen, or a new version introduces a redesigned interface.

You can use **Manage Screenshots →** to review screenshot-related work for your documentation. When you need to review documentation by release or compare visual assets across releases, use **🕘 Go to Version Manager** or **Manage all versions →**.

A practical retention process is to keep screenshots that still match the current user interface, replace screenshots that no longer match, and retain version-specific screenshots when they document a supported historical version. For example, a screen identified as **Version 4 — Screenshots** should be kept only while Version 4 documentation remains relevant to your users.

> 📷 _Screenshot pending: The documentation area showing the Manage Screenshots action._

## Prerequisites

Before you begin, make sure you have:

- Access to the project’s documentation area.
- Permission to manage documentation versions and screenshot assets.
- A current version of the application available for comparison.
- A clear understanding of which documentation version you are updating.
- Replacement screenshots prepared when existing images no longer match the interface.
- A plan for supported and archived documentation versions.

## Step-by-Step Instructions

1. Open your project’s documentation area.

2. Select **Manage Screenshots →**.

3. Review the screenshots associated with the documentation you are maintaining.

4. Compare each screenshot with the current application screen it represents.

5. Identify screenshots that show outdated labels, layouts, navigation, data, or workflows.

6. Keep screenshots that accurately represent the current user experience.

7. Mark outdated screenshots for replacement according to your organization’s documentation review process.

8. Create a replacement image that shows the same task in the current application interface.

9. Ensure the replacement image clearly displays the screen, action, or result that the related documentation describes.

10. Update the relevant screenshot asset in the screenshot management area.

11. Review the updated documentation to confirm that the replacement image appears with the correct procedure or topic.

12. Select **🕘 Go to Version Manager** when you need to review screenshots for a specific documentation version.

13. Select **Manage all versions →** when you need to review retention across multiple versions.

14. Open the version that contains the screenshots you want to assess.

15. Review version-specific screenshot groups, such as **Version 4 — Screenshots**.

16. Retain screenshots for a version while that version’s documentation is still available to users.

17. Replace version-specific screenshots only when the documented version’s interface has changed or the image is inaccurate.

18. Remove or archive obsolete screenshots only after confirming that they are not required by an active documentation version.

19. Select **View Your Documentation →** to verify the reader-facing result after completing your updates.

> 📷 _Screenshot pending: A documentation version screen showing a version-specific screenshot area, such as Version 4 — Screenshots._

## Tips and Best Practices

- **Review screenshots whenever documentation changes.** If you update a procedure because a user-facing action changed, review the associated visual asset at the same time.

- **Use screenshots to confirm visible labels.** A screenshot should match the labels users see, including actions such as **Manage Screenshots →**, **Manage all versions →**, and **Export Documentation** where applicable.

- **Keep screenshots focused.** Capture only the area needed to support the instruction. Avoid images that include unrelated windows, personal data, temporary notifications, or test content.

- **Use version-aware retention.** Do not assume that one screenshot applies to every documentation version. A screenshot that is correct for one version may be misleading for another.

- **Replace rather than silently reuse outdated images.** If an image shows an earlier layout or workflow, create a current replacement instead of using it as a general illustration.

- **Validate in the published documentation view.** After updating images, use **View Your Documentation →** to check placement, readability, and relevance in the final documentation.

- **Coordinate screenshot updates with documentation generation.** If your organization generates documentation, confirm that screenshot updates are included before using **Generate Documentation →** or reviewing the **Documentation Ready!** state.

- **Maintain an archive policy outside the screen when necessary.** The available actions support managing screenshots and documentation versions, but your organization should define how long superseded images and retired-version assets are retained.

## Related Pages

- [Manage Documentation Versions](#)
- [Generate Documentation](#)
- [View Your Documentation](#)
- [Export Documentation](#)
- [Documentation Templates](#)
- [Documentation Automation](#)

## Troubleshooting

### A screenshot does not match the current application

Return to **Manage Screenshots →** and compare the image with the current screen. Replace the screenshot if visible labels, page layout, or the documented workflow have changed.

### You are updating the wrong documentation version

Select **🕘 Go to Version Manager** or **Manage all versions →**. Confirm that you are reviewing the intended version before retaining, replacing, or archiving screenshot assets.

### You cannot confirm how the screenshot appears to readers

Select **View Your Documentation →** after making your changes. Review the published documentation presentation and verify that the image supports the surrounding instructions.

<!-- source: configure-documentation-review-workflows.md -->

# Configure Documentation Review Workflows

You can use the documentation review area to prepare generated technical documentation for review and publication. This workflow helps writers, technical contributors, and approvers work from the same review summary before documentation is shared or exported.

## Overview

Atloria provides a documentation review experience as part of the Technical Docs workflow. After documentation has been generated or imported, you can open the review area to inspect the review summary, return to earlier review work, preview the documentation, and continue toward publication.

The visible workflow indicates when documentation is configured through the **2. Configured** status. From there, you can use **Review & Publish** to move into the review stage. The review screen includes **1 Review Summary**, which gives reviewers a single place to assess the documentation before it is published or distributed.

Use this process when you need to coordinate contributions from writers and technical contributors before an approver signs off. For example, a writer can prepare the documentation, a technical contributor can validate technical accuracy, and an approver can review the final presentation using the preview and export options.

> **Note:** The available review experience supports reviewing and publishing documentation. If your organization needs named approval roles, mandatory approval gates, or custom status names, establish those responsibilities in your internal governance process before beginning the review.

> 📷 _Screenshot pending: The Technical Docs workflow showing the Configured status and the Review & Publish action._

## Prerequisites

Before you start, make sure you have the following:

- Access to the relevant project’s **Technical Docs** area.
- Documentation that has been generated using **Generate Documentation →** or added through **Or import existing documentation**.
- Documentation configuration completed so that the workflow shows **2. Configured**.
- Agreed reviewers for writing quality, technical accuracy, and final approval.
- A decision about the documentation style before review, if your organization uses multiple documentation styles.
- Any required diagrams, technical source information, or supporting content ready for reviewers to validate.

## Step-by-Step Instructions

1. Open **Technical Docs** for the project that contains the documentation you want to review.

2. Select **Configure →** if the documentation has not yet been configured.

3. Complete the available configuration choices for the documentation.

4. Confirm that the workflow displays **2. Configured**.

5. Select **Review & Publish** to open the documentation review process.

6. Review the information in **1 Review Summary**.

7. Ask the writer to verify that the document is complete, readable, and appropriate for its intended audience.

8. Ask the technical contributor to verify that technical descriptions, API information, relationships, and diagrams are accurate.

9. Select **Preview** to view the documentation as readers will see it.

10. Review the preview for formatting, section order, terminology, and diagram readability.

11. Select **Back to Review** to return to the review screen after checking the preview.

12. Resolve any content issues by returning to the documentation preparation work before continuing with publication.

13. Select **View Your Documentation →** when you are ready to open the completed documentation view.

14. Select **Share Preview Link** if you need to give reviewers access to a shareable preview.

15. Select **Export Documentation** when the approved documentation must be downloaded or distributed outside Atloria.

> 📷 _Screenshot pending: The review screen showing 1 Review Summary, Back to Review, Preview, Share Preview Link, and Export Documentation actions._

## Tips and Best Practices

- Assign review responsibilities before selecting **Review & Publish**. A clear division between writing review, technical review, and approval reduces repeated review cycles.

- Use **Preview** as the final presentation check. The review summary helps you assess the documentation process, while the preview helps you identify reader-facing issues such as unclear structure or difficult-to-read content.

- Validate technical content with a subject-matter contributor. Technical documentation can include information across areas such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. The appropriate contributor should confirm the sections that apply to their area.

- Treat **2. Configured** as a readiness checkpoint. Do not begin formal review until the documentation configuration and expected content are complete.

- Use **Share Preview Link** for asynchronous reviews. This is useful when writers, contributors, and approvers cannot review the documentation in the same session.

- Export only after approval. **Export Documentation** is best used after reviewers have completed their checks and any requested changes have been addressed.

- Keep review feedback focused on the reader outcome. Writers should address clarity and organization; technical contributors should address correctness; approvers should confirm that the document is ready to share or publish.

## Related Pages

- [Generate Technical Documentation](#)
- [Import Existing Documentation](#)
- [Configure Documentation Output](#)
- [Preview Documentation](#)
- [Share a Documentation Preview](#)
- [Export Documentation](#)
- [Configure CI/CD](#)

## Troubleshooting

### The **Review & Publish** option is not available

Confirm that the documentation has completed configuration and that **2. Configured** is displayed. If the documentation has not been generated or imported, use **Generate Documentation →** or **Or import existing documentation** first.

### Reviewers cannot see the document in the expected format

Select **Preview** and check the reader-facing presentation. If the content or structure is not ready, return to the documentation preparation work, make the necessary updates, and reopen the review process.

### A reviewer needs to review the documentation outside Atloria

Select **Share Preview Link** to provide access to a preview. If a downloadable copy is required after approval, select **Export Documentation**.

<!-- source: set-version-approval-policies.md -->

# Set Version Approval Policies

Use the version review process to control which documentation version is approved for publication. Establishing this review requirement helps ensure that only reviewed content is published to your documentation site.

## Overview

Atloria manages approval at the documentation version level. Before you publish a version, open its review area and use the available review summary to verify that the version is ready for release.

You typically use this process when a new version has been generated, when reviewers need to compare documentation changes, or when you want to prevent an unreviewed version from becoming the published version. The version remains separate from the currently published documentation until you choose the publish action.

The version workflow centers on the **Versions** area and the **Review & Publish** option. From there, you can review a specific version, compare it with other versions when needed, and publish only the version that has completed your organization’s review process.

> 📷 _Screenshot pending: The Versions area showing the Review & Publish option for a documentation version._

## Prerequisites

Before you begin, make sure you have:

- Access to the applicable project.
- Permission to review and publish documentation versions.
- At least one generated documentation version available in **Versions**.
- Agreement on who must review the version before it is published.
- Any required content updates completed in the version under review.

## Step-by-Step Instructions

1. Open the project that contains the documentation versions you want to govern.

2. Select **Versions** to view the project’s available documentation versions.

3. Identify the version that requires approval before publication.

4. Select **Review & Publish** for that version.

5. Review the information shown in **Review Summary**.

6. Select **Compare Versions** if you need to evaluate the selected version against another version.

7. Review the differences and confirm that the documentation changes meet your organization’s approval requirements.

8. Return to the version review area by selecting **Back to Review**.

9. Confirm with your designated reviewers that the version is approved for publication.

10. Select the publish action displayed for the approved version, such as **Publish Version 4**.

11. Verify that the version shows the **Published** status after publication.

12. Select **View Published Docs** to confirm that the approved documentation is available to readers.

> 📷 _Screenshot pending: The Review Summary screen for a selected documentation version before publication._

## Tips and Best Practices

- Use **Review & Publish** as the final checkpoint for every version. This creates a consistent approval practice even when different people generate, review, and publish documentation.

- Review changes with **Compare Versions** before publishing. Comparing versions is especially useful when a generated version contains broad updates and reviewers need to identify what changed from the prior release.

- Treat the **Published** status as your release confirmation. A version is not the active published documentation merely because it is visible in **Versions**; confirm that it is marked **Published**.

- Establish an internal approval checklist outside the screen before selecting the publish action. For example, require content accuracy review, stakeholder sign-off, and a comparison against the current published version.

- Publish only the version your reviewers approved. If several generated versions exist, carefully verify the version number and review summary before selecting **Publish Version 4** or the corresponding publish action.

- Use **View Published Docs** after publishing. This lets you verify the reader-facing result rather than relying only on the version’s status.

- If you need a new candidate for review, select **Generate New Version** or **Generate Next Version** before restarting the review process. Do not publish a new version until it has completed your required review.

## Related Pages

- [Manage Documentation Versions](#)
- [Review and Publish a Documentation Version](#)
- [Compare Documentation Versions](#)
- [Generate a New Documentation Version](#)
- [View Published Documentation](#)

## Troubleshooting

### You cannot find the version you need to approve

Open **Versions** and confirm that a documentation version has been generated. If no suitable version is available, select **Generate New Version** or **Generate Next Version**, then wait for the new version to appear before beginning review.

### You are unsure which version is currently live

Look for the **Published** status in the version list. You can also select **View Published Docs** to open the published documentation and confirm what readers currently see.

### The version is not ready to publish

Do not select the publish action. Use **Compare Versions** to identify changes that need review, then return with **Back to Review**. After the necessary updates are included in a new version, repeat the review and approval process before publishing.

<!-- source: manage-review-contributors.md -->

# Manage Review Contributors

Use the review workspace to coordinate documentation review and maintain coverage before publishing a version. This page explains how to use the available review and version-management actions to keep review activity organized across your documentation areas.

## Overview

Review governance helps you confirm that a documentation version has been reviewed before it is published or shared. In Atloria, the review workspace centers on **Review Summary**, where you can return to the current review and assess the version’s readiness.

When a version needs broader coverage, use the review workspace together with version-management actions. The available controls let you return to the review, manage supporting screenshots, open version management, and preview or export documentation as part of your review process.

Contributor assignments may be managed through your organization’s internal review process rather than through a dedicated contributor field on the review screen. Use **Review Summary** as the shared point of reference for reviewers, and make sure each documentation area has an identified reviewer before moving toward publication.

> 📷 _Screenshot pending: The Review Summary screen showing the available review actions._

## Prerequisites

Before you begin, make sure you have:

- Access to the relevant project and documentation version.
- Permission to open the version’s **Review & Publish** area.
- A list of the documentation areas that require review.
- Identified reviewers for each area, such as frontend, backend, database, API schema, configuration, documentation, or infrastructure content.
- Any screenshots or supporting visual evidence needed for the review.

## Step-by-Step Instructions

1. Open the documentation version that you want to review.

2. Select **Review & Publish**.

3. Select **Review Summary** to open the version’s review workspace.

4. Identify the documentation areas that require reviewer coverage for this version.

5. Assign a responsible reviewer for each identified area using your organization’s approved review-assignment process.

6. Record the reviewer and expected completion date in your team’s review tracker or other approved governance record.

7. Return to Atloria and select **Manage Screenshots →** when reviewers need to verify visual documentation evidence.

8. Add or update the screenshots that reviewers need to assess the documented screens and workflows.

9. Select **Back to Review** to return to the review workspace after managing screenshots.

10. Review the current version’s documentation with the assigned reviewers.

11. Select **Preview** when you need to inspect how the documentation will appear before publication.

12. Select **Share Preview Link** when you need to provide reviewers with access to the preview.

13. Ask each reviewer to confirm the documentation areas they reviewed and to report any gaps.

14. Update your review tracker when a reviewer completes an assigned documentation area.

15. Select **Manage all versions →** when you need to compare review coverage or status across versions.

16. Select **🕘 Go to Version Manager** when you need to work with the version outside the current review workspace.

17. Return to **Review Summary** after version-management work is complete.

18. Select **Export Documentation** only after your required reviewers have completed their review and the version is ready for downstream use.

> 📷 _Screenshot pending: Review workspace showing Review Summary, Manage Screenshots, Back to Review, Preview, and version-management actions._

## Tips and Best Practices

- Assign reviewers by documentation area, not only by the overall version. This makes it easier to identify uncovered content before publication.

- Use a consistent coverage model for areas such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. Not every version will contain all areas, but each area that is present should have a responsible reviewer.

- Use **Manage Screenshots →** early in the review cycle. Visual documentation can require additional review when screens, labels, or workflows have changed.

- Use **Preview** before asking reviewers for final approval. A preview helps reviewers assess the documentation as readers will see it.

- Use **Share Preview Link** when reviewers need to review the same version without navigating through the project themselves.

- Keep review assignments outside the interface if your organization does not provide a contributor-assignment field in the review workspace. Record the reviewer, scope, date assigned, status, and any outstanding issues in your approved tracking process.

- Return to **Review Summary** after any work in **Manage all versions →** or **🕘 Go to Version Manager**. This helps you keep the current version’s review activity centralized.

- Do not treat documentation generation as review completion. **Generate Documentation →** creates or updates documentation; reviewers still need to assess the result before publication.

## Related Pages

- [Review and Publish Documentation](#)
- [Manage Documentation Versions](#)
- [Manage Screenshots](#)
- [Preview Documentation](#)
- [Export Documentation](#)
- [Share a Preview Link](#)

## Troubleshooting

### A reviewer cannot find the version to review

Confirm that the reviewer has access to the correct project and version. If they need access to a preview instead of the full project workspace, use **Share Preview Link** after opening **Preview**.

### A documentation area has no assigned reviewer

Review your coverage list in **Review Summary** and identify the unassigned area. Assign a responsible reviewer through your organization’s governance process, then record the assignment in your review tracker before proceeding.

### Reviewers need visual evidence that is missing or outdated

Select **Manage Screenshots →** and update the visual evidence for the affected documentation area. Select **Back to Review** when the screenshots are ready, then ask the reviewer to recheck the updated content.

<!-- source: enable-documentation-freshness-tracking.md -->

# Enable Documentation Freshness Tracking

Documentation freshness tracking helps you identify documentation that may be affected when your project changes. Use it after you add a project to Atloria so you can review change-related documentation work from the project workspace.

## Overview

Freshness tracking connects your project’s change activity with its documentation review process. When project changes are available, you can use the project’s change-review area to focus on documentation that may need attention.

This feature is useful when your team regularly updates application code, APIs, configuration, infrastructure, or database structures. Rather than treating documentation as a separate, manual task, you can review documentation impact alongside the changes in the selected project.

Atloria organizes project analysis across categories such as **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**. Documentation freshness review is particularly valuable when a change affects one or more of these areas.

> **Note:** The available project screens do not show a separate button labeled “Enable Freshness Tracking.” In practice, you enable this workflow by creating or selecting a project and using its change-review area to identify documentation affected by project changes.

> 📷 _Screenshot pending: A selected project workspace showing the project sidebar and the area used to review project changes._

## Prerequisites

Before you begin, make sure that you have:

- Access to Atloria and permission to open the **Projects** area.
- A project already listed in Atloria, or the information needed to add one.
- Access to the project’s source repository or connected project source.
- A reason to review documentation freshness, such as recently introduced project changes.
- Permission to save project-level updates when the **Save Changes** action is available.

## Step-by-Step Instructions

1. Click **Projects** to open the list of available projects.

2. Search for the project by entering its name in the **Search projects...** field.

3. Select the project you want to track for documentation freshness.

4. Click **Open Project Dashboard** to open the focused project workspace.

5. Use the **Project Sidebar** to open the project’s changes area.

6. Review the available project changes to identify changes that may affect documentation.

7. Focus your review on changes related to **DOCUMENTATION**, as well as changes in related areas such as **API SCHEMA**, **CONFIG**, **DATABASE**, **FRONTEND**, and **BACKEND**.

8. Open the affected change record to inspect the change in more detail.

9. Use **✎ Request Changes** when the documentation or change details need follow-up before the change can be accepted.

10. Click **Save Changes** after you make any available project-level review updates.

11. Click **View Your Documentation →** to open the project documentation and confirm whether the affected content needs to be updated.

12. Select **Export Documentation** if you need a copy of the current documentation for offline review or stakeholder distribution.

> 📷 _Screenshot pending: A change-review screen showing a project change and the documentation review action for determining whether documentation is affected._

### Add a project when no project is available

If the project you need is not listed, add it before starting the freshness review workflow.

1. Click **New Project** from the **Projects** area.

2. Click **Create project** to begin creating the project.

3. Provide the project connection details requested by the project setup screens.

4. Complete the project setup process.

5. Click **Open Project Dashboard** after the project is available.

6. Use the **Project Sidebar** to open the project’s changes area.

## Tips and Best Practices

- Review documentation impact whenever changes involve an API, data model, configuration setting, deployment setup, or user-facing interface. These changes often affect more than one documentation topic.

- Do not limit your review to items categorized as **DOCUMENTATION**. A change categorized as **API SCHEMA** may require updates to API reference material, while a **CONFIG** or **INFRASTRUCTURE** change may require updates to setup or operational instructions.

- Review changes from the focused project rather than relying only on the all-projects view. The **1. Hub: All Projects** area is useful for finding work, while **2. Focused Project** is the appropriate context for reviewing a specific project’s documentation impact.

- Use **Search across all projects...** when you need to locate a project before beginning a freshness review across a larger portfolio.

- Request clarification early. Use **✎ Request Changes** when a project change does not provide enough information to determine its documentation impact. This is preferable to approving a change without confirming whether documentation needs revision.

- Keep documentation reviews close to the project change. Reviewing documentation while the change details are current makes it easier to identify affected instructions, reference content, and technical explanations.

- Save review updates when **Save Changes** is available. Unsaved updates may not be retained when you leave the project workspace.

## Related Pages

- [Manage Projects](#)
- [Create a New Project](#)
- [Review Project Changes](#)
- [View Project Documentation](#)
- [Request Changes for a Project Update](#)
- [Export Documentation](#)

## Troubleshooting

### I cannot find the project to review

1. Click **Projects**.

2. Enter the project name in **Search projects...**.

3. Enter a broader search term in **Search across all projects...** if you are looking across multiple projects.

4. Click **New Project** if the project has not yet been added to Atloria.

### I do not see a separate “Enable Freshness Tracking” switch

1. Open the project by clicking **Open Project Dashboard**.

2. Use the **Project Sidebar** to access the project’s changes area.

3. Review the available project changes for documentation impact.

Freshness tracking is performed through the project and change-review workflow rather than through a separately verified on-screen enable switch.

### I am unsure whether a change affects documentation

1. Open the change record in the project’s changes area.

2. Check whether the change affects **DOCUMENTATION**, **API SCHEMA**, **CONFIG**, **DATABASE**, **FRONTEND**, **BACKEND**, or **INFRASTRUCTURE**.

3. Click **✎ Request Changes** if the change details do not clearly explain the documentation impact.

4. Click **View Your Documentation →** to compare the current documentation with the change under review.

<!-- source: configure-change-priorities.md -->

# Configure Change Priorities

Configure your changelog settings to establish how documentation changes are recorded and reviewed for ongoing maintenance. A clear configuration helps your team identify meaningful updates and keep published documentation current.

## Overview

Change priorities help you focus maintenance work on the documentation updates that matter most to your users. Before your team begins creating or reviewing maintenance requests, configure the project’s changelog settings so changes can be consistently tracked and communicated.

You manage this configuration from the project settings area, where the **Changelog** page provides access to changelog-related options. After saving your settings, you can use **View Changelog** to review the resulting record of documentation changes.

Use this process when you are setting up freshness management for a new project, standardizing maintenance practices across teams, or updating how your project records documentation changes.

> 📷 _Screenshot pending: The Changelog settings page showing the Save Changes action._

## Prerequisites

Before you start, make sure that:

- You can open the relevant project in Atloria.
- You have permission to change project settings.
- You have identified which documentation updates should receive the most attention during maintenance.
- You understand your team’s review process for maintenance requests.
- You are ready to save the updated configuration using **Save Changes**.

## Step-by-Step Instructions

1. Open the project for which you want to configure documentation change priorities.

2. Open the project’s settings area.

3. Select **Changelog**.

4. Review the changelog configuration options shown on the page.

5. Set the available options to reflect how your team wants to prioritize documentation maintenance.

6. Click **Save Changes**.

7. Click **View Changelog** to review the project’s change history after saving the configuration.

> 📷 _Screenshot pending: The View Changelog action and the project changelog display._

8. Return to the project workflow when you are ready to act on a specific documentation update.

9. Open the relevant change from the project’s changes list.

10. Click **✎ Request Changes** when a documentation change needs revision before it is accepted.

11. Use **← Previous Change** to move to the earlier change when reviewing changes in sequence.

12. Use **Next Change →** to move to the next change when reviewing changes in sequence.

## Tips and Best Practices

- Configure your changelog approach before asking contributors to create maintenance requests. This gives reviewers a consistent basis for deciding which documentation updates need attention first.

- Save your configuration whenever you make an adjustment. Changes are not retained until you select **Save Changes**.

- Review the changelog regularly rather than waiting until a large number of changes have accumulated. Frequent review makes it easier to identify important documentation updates and request corrections promptly.

- Use **✎ Request Changes** for updates that require clarification, correction, or additional work. This keeps the review process connected to the individual change instead of relying on separate messages.

- Review related changes in order with **← Previous Change** and **Next Change →**. Sequential review is useful when several updates affect the same feature, workflow, or documentation area.

- Treat changelog configuration as part of your broader documentation workflow. After configuration is complete, you can continue with actions such as **Generate Documentation →**, **Configure CI/CD**, or **Export Documentation** as appropriate for your project.

- If your team already maintains documentation elsewhere, consider **Or import existing documentation** before defining a new maintenance process. Imported material may contain existing change history or content that needs to be considered during prioritization.

## Related Pages

- [Create a Maintenance Request](#) — Learn how to start a documentation maintenance request.
- [Review Documentation Changes](#) — Learn how to review individual changes and use **✎ Request Changes**.
- [View the Changelog](#) — Learn how to read and use the project change history.
- [Configure CI/CD](#) — Learn how to connect documentation work to your delivery workflow.
- [Export Documentation](#) — Learn how to export maintained documentation for distribution.
- [Documentation Templates](#) — Learn how to standardize documentation structure across projects.

## Troubleshooting

### The **Save Changes** action is unavailable or does not retain my updates

Confirm that you are working in the correct project and that you have permission to edit project settings. Reopen **Changelog**, make the required changes again, and select **Save Changes** before leaving the page.

### I cannot find the changelog configuration

Open the project settings area and select **Changelog**. If the option is not available, verify that you are in the intended project and ask a project administrator to confirm your access.

### A change still needs work after I review it

Open the individual change and select **✎ Request Changes**. Add the required feedback through your normal team review process, then revisit the change after the requested updates have been made.

<!-- source: assign-freshness-maintenance-work.md -->

# Assign Freshness Maintenance Work

Use freshness maintenance work to make sure stale documentation is investigated by the right person and resolved promptly. This process helps you keep your workspace documentation accurate as your application changes.

## Overview

Freshness maintenance work is used when documentation needs attention after the underlying application, configuration, architecture, or security information has changed. You can use the workspace area to review documentation activity and create or follow a maintenance request for content that needs to be checked.

Assigning work is especially important when documentation covers a specific area of responsibility. For example, a team member responsible for frontend components can investigate interface documentation, while a security owner can review content such as **🛡️ Network Security**. Clear ownership prevents requests from being overlooked and makes it easier to confirm that a stale item has been resolved.

The available workspace experience includes guidance titled **How to create a maintenance request** and a status indicator such as **4 All Resolved**. Use these areas to understand the current state of maintenance work and to follow the documented request process. The currently available workspace evidence does not show a separate on-screen **Owner** field or assignment control, so follow your organization’s maintenance-request instructions when recording the responsible person.

> 📷 _Screenshot pending: Workspace view showing documentation freshness maintenance requests and their assigned owners._

## Prerequisites

Before you begin, make sure that you have:

- Access to the relevant **Workspace**.
- Identified the documentation that may be stale or needs investigation.
- Identified the person or team responsible for reviewing that documentation.
- The information needed to describe the change, such as the affected documentation area, feature, configuration, or security topic.
- Permission to create or manage maintenance requests in your organization’s workspace.
- An agreed way to identify the assignee in a maintenance request, such as a team name, person name, or internal ownership convention.

## Step-by-Step Instructions

1. Open the **Workspace Sidebar**.

2. Select **Workspace**.

3. Review the workspace status indicator, such as **4 All Resolved**, to understand whether existing maintenance work is already complete.

4. Select **How to create a maintenance request**.

5. Read the maintenance-request guidance shown in the workspace.

6. Start a maintenance request for the documentation that requires investigation.

7. Identify the affected documentation area in the maintenance request.

8. Describe why the documentation may be stale.

9. Record the person or team responsible for investigating the request using your organization’s assignment convention.

10. Include the expected resolution work in the request, such as reviewing content, updating documentation, or confirming that no update is needed.

11. Submit or save the maintenance request using the action provided in your workspace.

12. Return to the workspace to confirm that the request is visible for follow-up.

> 📷 _Screenshot pending: Maintenance request guidance and request-creation controls in the Workspace._

13. Open the assigned maintenance request when the responsible person has completed the investigation.

14. Review the documented outcome before marking the work as complete.

15. Select **Resolve** when the documentation has been corrected or the investigation confirms that no change is required.

16. Check the workspace status again to confirm that the resolved request is reflected in the current totals.

## Tips and Best Practices

- Assign work to the person or team that owns the affected subject area. For example, assign security-related content to the appropriate security owner when the request concerns **🛡️ Network Security**.

- Write the maintenance request so the assignee can act without needing to ask what is stale. Include the documentation topic, what changed, and what needs to be verified.

- Use a consistent owner format across requests. For example, use the same team names or individual naming convention each time. This makes it easier to identify who is accountable for follow-up.

- Do not select **Resolve** until the documentation has been reviewed and the required outcome is recorded. Resolving a request should mean the investigation is complete, not merely that someone has acknowledged it.

- Review the **4 All Resolved** indicator as a high-level completion signal. If you expected open work but see only resolved work, confirm that the request was created in the correct **Workspace**.

- Use the workspace’s maintenance-request guidance rather than relying on informal messages. The **How to create a maintenance request** guidance provides the workflow users can follow in the application.

- If the stale content is part of generated documentation, review the relevant documentation workflow before resolving the request. You may need to use **Generate Documentation →** to refresh generated material after the underlying source changes.

## Related Pages

- [Create a Maintenance Request](#)
- [Resolve Freshness Maintenance Work](#)
- [Generate Documentation](#)
- [Documentation Hub](#)
- [Export Documentation](#)
- [Manage Documentation Templates](#)

## Troubleshooting

### You cannot find an owner assignment field

The verified workspace labels do not show a separate **Owner**, **Assignee**, or similar field. Open **How to create a maintenance request** and follow the instructions available in your workspace. If your organization requires formal assignment, record the responsible person or team using the approved maintenance-request format and contact a workspace administrator if assignment controls are missing.

### The request does not appear in the expected workspace

Open the **Workspace Sidebar** and confirm that you selected the correct **Workspace** before creating the request. Then review the workspace status and request list again.

### The request was resolved too early

Open the request and confirm whether the documentation was actually updated or verified. If follow-up work is still needed, create a new maintenance request with a clear owner and a description of the remaining work. Use **Resolve** only after the investigation and required documentation changes are complete.

<!-- source: configure-documentation-templates.md -->

# Configure Documentation Templates

Documentation templates help you establish repeatable standards for the content your organization publishes. By configuring templates, you can make User Docs and Technical Docs more consistent across projects and documentation teams.

## Overview

Templates provide a starting point for documentation that follows your organization’s publishing and branding standards. Use them when you want documents to use a consistent structure, tone, and presentation instead of being created from scratch each time.

You may need to configure templates before creating documentation manually, importing existing documentation, or generating documentation for a project. This is particularly useful when different audiences require different document types, such as user-facing guides and technical reference material.

The Publishing area includes a Templates step, shown as **5. Templates**. The screen also displays a configuration status, such as **2. Configured**, so you can confirm how many template-related items are currently set up.

> 📷 _Screenshot pending: The Publishing workflow showing the “5. Templates” step and the configured-status indicator._

## Prerequisites

Before you begin, make sure you have:

- Access to the project where you want to manage documentation publishing settings.
- Permission to use the **Publishing** area.
- A clear understanding of whether the template is intended for **User Docs** or **Technical Docs**.
- Your organization’s documentation standards, such as required sections, terminology, and branding expectations.
- Any existing documentation you want to use as a reference before choosing **Create Manually** or importing existing documentation.

## Step-by-Step Instructions

1. Open the project where you want to standardize documentation.

2. Select **Publishing** from the available project documentation options.

3. Review the publishing workflow and locate **5. Templates**.

4. Select **5. Templates** to open the template configuration step.

5. Review the status displayed on the Templates step, such as **2. Configured**, to determine whether template settings already exist.

6. Choose the template purpose you need by identifying whether it will support **User Docs** or **Technical Docs**.

7. Select **User Docs** when the template is intended for end-user instructions, task guides, or user manuals.

8. Select **Technical Docs** when the template is intended for technical reference material or engineering-focused documentation.

9. Use **Create Manually** when you want to create documentation based on your organization’s approved template standards.

10. Select **Create New Document** when you are ready to start a document using the configured documentation setup.

11. Select **Create Document** to proceed with document creation after confirming that the selected documentation type and template approach are correct.

12. Choose **Or import existing documentation** when you need to bring existing material into the project instead of starting with a new document.

13. Select **Export Documentation** when you need to distribute completed documentation outside the application after it has been created using your configured standards.

> 📷 _Screenshot pending: The document creation area showing “Create Manually,” “Create New Document,” “Create Document,” and “Or import existing documentation.”_

## Tips and Best Practices

- Configure standards separately for **User Docs** and **Technical Docs**. These document types often serve different readers and should not rely on the same assumptions about terminology or level of detail.

- Use **User Docs** for content that explains how to complete tasks in the product. Keep the language action-oriented and use the labels that readers see on screen.

- Use **Technical Docs** for implementation, architecture, or technical-reference content. Keep these materials organized so technical readers can locate the information they need quickly.

- Check the **2. Configured** indicator, or the equivalent configured count shown in your workspace, before creating new documentation. This helps you confirm that the expected template-related configuration is available.

- Use **Create Manually** when consistency is more important than speed and you need to follow a defined organizational format.

- Use **Or import existing documentation** when you already have approved content that should be retained. Review imported content afterward to ensure that it meets the same standards as newly created documents.

- Use **Export Documentation** only after reviewing the document for completeness. Exported documentation should reflect the approved template structure and publishing standards.

## Related Pages

- [Create a New Document](#)
- [Import Existing Documentation](#)
- [Export Documentation](#)
- [Manage User Docs](#)
- [Manage Technical Docs](#)
- [Configure Publishing Settings](#)

## Troubleshooting

### The Templates step does not show the configuration you expected

Return to **Publishing** and select **5. Templates** again. Review the configured-status indicator, such as **2. Configured**, to confirm whether template-related settings are available for the current project.

### You are creating the wrong type of documentation

Before selecting **Create New Document**, confirm whether the document is intended for **User Docs** or **Technical Docs**. Choose the documentation type that matches the intended audience before continuing.

### You need to use existing content instead of starting a new document

Select **Or import existing documentation** rather than **Create Manually**. After importing, review the content to make sure it follows your organization’s current documentation and publishing standards.

<!-- source: configure-portal-branding.md -->

# Configure Portal Branding

Configure portal branding to make your published documentation recognizable as part of your organization. Branding helps readers identify the correct documentation portal when they open shared or public documentation.

## Overview

Published documentation is accessed through the publishing area of the Documentation Hub. After your documentation is generated and reaches the **Published** stage, you can open the published portal and review how it appears to readers.

Use portal branding when you need your organization’s documentation portal to present a consistent identity across published content. Before sharing a portal link, review the published view to confirm that the branding and documentation presentation are appropriate for your audience.

Your documentation moves through the publishing workflow from setup and configuration to publication. The visible publishing-related indicators include **2. Configured**, **3. Published Status**, and **Published**. Branding changes should be reviewed in the published portal after the documentation is published.

> 📷 _Screenshot pending: The Documentation Hub showing the Published Docs navigation area and View Published Docs action._

## Prerequisites

Before you begin, make sure that:

- You can access the **Documentation Hub**.
- Your documentation has been generated or imported.
- The documentation is configured and ready for publishing.
- Your documentation shows a **Published** status, or you are ready to publish it after completing configuration.
- You have the organization branding information you want to use, such as approved organization naming and visual assets.
- You have permission to configure publishing settings for the documentation portal.

## Step-by-Step Instructions

1. Open the **Documentation Hub**.

2. Locate the publishing area that shows **4. Published Docs Nav**.

3. Click **Configure →** to open the available configuration options for your documentation.

4. Open the portal branding controls in the publishing configuration area.

5. Enter or select your organization’s approved branding information in the available branding controls.

6. Save or apply the branding changes using the save action displayed in the configuration area.

7. Confirm that the documentation is configured by reviewing the **2. Configured** indicator.

8. Publish the documentation if it is not already published.

9. Review the **3. Published Status** area to confirm that the portal is marked **Published**.

10. Click **🌐 View Published Docs** to open the reader-facing documentation portal.

11. Review the published portal to confirm that the organization branding is displayed as expected.

12. Return to the configuration area and update the branding controls if the published appearance needs adjustment.

> 📷 _Screenshot pending: The publishing configuration area with the portal branding controls and the action used to save branding changes._

## Tips and Best Practices

- Apply only approved organization branding. Use the same organization name, logo, and visual conventions that readers expect from other customer-facing materials.

- Review branding in the published portal, not only in the configuration area. The **🌐 View Published Docs** action gives you the reader-facing view that external users will see.

- Complete branding review before broadly sharing the portal. A portal may be technically available once it is **Published**, but you should verify its presentation before distributing its link.

- Keep branding consistent across documentation updates. When you generate new documentation with **Generate Documentation →**, or use **Or import existing documentation**, revisit the published portal to make sure the presentation remains appropriate.

- Use **View Your Documentation →** when you need to review the documentation content itself. Use **🌐 View Published Docs** when you need to check the published reader experience.

- Treat configuration and publication as separate checks. **2. Configured** indicates that setup is complete, while **Published** and **3. Published Status** indicate the availability of the published portal.

## Related Pages

- [Generate Documentation](#)
- [Import Existing Documentation](#)
- [Publish Documentation](#)
- [View Published Documentation](#)
- [Configure CI/CD](#)
- [Export Documentation](#)

## Troubleshooting

### The published portal does not show the expected branding

Open **🌐 View Published Docs** again after saving your changes. If the previous appearance remains visible, return to **Configure →**, verify the branding information, save the changes, and then refresh the published portal.

### I cannot find the branding controls

Start from the **Documentation Hub** and select **Configure →**. Branding is part of the publishing configuration experience, not the generated documentation content view. If you only see content-generation options such as **Generate Documentation →**, complete or open the documentation configuration first.

### The portal is not available to review

Check **3. Published Status**. If the documentation is not marked **Published**, complete the publishing process before selecting **🌐 View Published Docs**.

<!-- source: configure-publishing-audiences.md -->

# Configure Publishing Audiences

Configure publishing audiences to control who receives your project documentation and where published documentation is made available. This helps you prepare documentation for the appropriate readers before you export or share it.

## Overview

Publishing audiences let you organize documentation for different groups, such as internal teams, customers, partners, or other intended readers. Use audience configuration when one project needs different documentation destinations or presentation choices for different groups.

You manage publishing from the active project rather than from the all-projects view. Start by selecting the correct project, then open its project-level publishing area. From there, review the available audience and destination options before making documentation available.

Publishing configuration is especially useful before using **Export Documentation** or selecting **View Your Documentation →**. Confirm that the project and intended audience are correct so that readers see the documentation intended for them.

> 📷 _Screenshot pending: The Publishing area for an active project, showing audience and publication destination options._

## Prerequisites

Before you begin, make sure that you have:

- Access to the **Projects** area.
- An existing project that is listed in the project hub.
- The correct project selected as the active project.
- Documentation available or ready to export from the selected project.
- Permission to manage project publishing and branding settings, if your organization restricts these actions.
- A clear understanding of the intended audience and the destination where the documentation should be published.

## Step-by-Step Instructions

1. Select **Projects** to open the project hub.

2. Use **Search projects...** to find the project whose documentation you want to publish.

3. Select the project to open the focused project view.

4. Confirm that you are working in the correct project by reviewing the active project context in the project sidebar.

5. Select **Publishing** in the project sidebar.

6. Create or select the audience that represents the people who should receive this documentation.

7. Choose the publication destination available for the selected audience.

8. Review the audience and destination combination before continuing.

9. Select **Export Documentation** when you are ready to generate documentation for the configured publishing setup.

10. Select **View Your Documentation →** to open the published documentation experience and verify what readers will see.

> 📷 _Screenshot pending: The project documentation area with the Export Documentation action and the View Your Documentation link._

## Tips and Best Practices

- Configure audiences from the focused project, not from the **1. Hub: All Projects** view. This helps prevent changes from being applied to the wrong project.

- Use a clear audience purpose before configuring a destination. For example, decide whether the documentation is intended for internal users or external readers before you publish it.

- Review your documentation before exporting. If the project does not yet have the content you need, return to the project documentation area and prepare the content first.

- Use **View Your Documentation →** after publishing or exporting to validate the reader-facing result. Check that the correct project documentation is displayed for the intended audience.

- Keep audience names and destinations consistent across projects. Consistent naming makes it easier for administrators to identify where each set of documentation is intended to appear.

- If you are configuring publishing as part of a new project setup, complete the project creation process first. Use **New Project** and **Create project** before attempting to configure project-specific publishing options.

- When switching between projects, use **← Back to Projects** or **&larr; Back to Projects** to return to the project list, then select the next project deliberately. Avoid assuming that a publishing change applies across all projects.

## Related Pages

- [Manage Projects](#) — Find, open, and organize projects from **Projects**.
- [Create a New Project](#) — Use **New Project** and **Create project** to add a project before configuring publishing.
- [Export Documentation](#) — Generate documentation after confirming the publishing audience and destination.
- [View Published Documentation](#) — Use **View Your Documentation →** to review the reader-facing documentation.
- [Project Documentation](#) — Select and prepare project documentation before publishing.

## Troubleshooting

### You cannot find the project you want to configure

Select **Projects**, then enter the project name in **Search projects...**. If you are in a focused project view, select **← Back to Projects** or **&larr; Back to Projects** before searching again.

### You do not see publishing options for the correct project

Confirm that you selected the intended project from the project list and that it is shown as the active project. Then select **Publishing** from that project’s sidebar. If access is restricted, contact your project administrator for publishing permissions.

### Documentation is not ready to publish or export

Open the project documentation area and verify that documentation is available for the selected project. If the screen indicates **Select a project to view documents** or **Or import existing documentation**, select a project or import existing documentation before returning to **Publishing** and **Export Documentation**.

<!-- source: configure-documentation-branding-context.md -->

# Configure Documentation Branding Context

You can configure the branding context used for published documentation so that readers see documentation associated with the correct organization identity. This helps keep externally shared documentation consistent with your organization’s publishing standards.

## Overview

Documentation branding context controls the organization-level branding applied when documentation is published. Use it before you share documentation with customers, partners, or other external readers through the published documentation experience.

Branding configuration is part of the publishing workflow. In the Documentation Hub, you may see progress indicators such as **2. Configured** and **3. Published Status**. These indicators help you confirm that documentation is configured for publishing and identify its current publishing state.

After documentation is published, readers can access it through **🌐 View Published Docs** or **View Published Docs**. You can also use **View Your Documentation →** to review the documentation experience from your organization’s perspective.

> 📷 _Screenshot pending: Documentation Hub showing the Configured and Published Status areas._

## Prerequisites

Before you start, make sure that:

- You have access to your organization’s **Documentation Hub**.
- Your documentation has been generated, imported, or otherwise prepared for publishing.
- You have the required administrative permission to configure publishing settings for your organization.
- You know which organization branding should appear in published documentation.
- You are ready to publish or review the documentation after configuration.

## Step-by-Step Instructions

1. Open the **Documentation Hub** for the documentation you want to brand.

2. Select **Publishing** to open the publishing workflow.

3. Select **Configure →** to review the available publishing configuration.

4. Open the documentation branding context for the organization.

5. Review the branding information displayed for the organization before publishing.

6. Confirm that the branding context belongs to the organization whose documentation you are preparing.

7. Save or confirm the branding configuration using the available action on the screen.

8. Review the **2. Configured** indicator to confirm that the documentation configuration is complete.

9. Open **3. Published Status** to review whether the documentation is currently published.

10. Select **View Published Docs** after publication to verify the reader-facing documentation.

> 📷 _Screenshot pending: Organization documentation branding context settings before publication._

11. Review the published documentation for consistent organization branding.

12. Return to **Publishing** if you need to update the configuration before sharing the published documentation.

## Tips and Best Practices

- Configure branding before distributing published documentation links. Readers who use **🌐 View Published Docs** should see documentation associated with the intended organization from their first visit.

- Use the configuration and publishing indicators separately. **2. Configured** indicates that publishing configuration has been completed, while **3. Published Status** helps you determine the current publication state.

- Verify the final reader experience after every branding change. Select **View Published Docs** rather than relying only on the configuration screen.

- Keep branding changes coordinated with documentation updates. If you are also generating content, use **Generate Documentation →** first, then complete publishing configuration before publishing the new version.

- If you are working with existing content, you can use **Or import existing documentation** before configuring publishing and branding.

- Consider the documentation style before publishing. The **Documentation Templates** and **The 4 Documentation Styles — path to 8+/10 each** resources can help you keep the presentation and content structure consistent with your organization’s published experience.

## Related Pages

- [Generate Documentation](#generate-documentation)  
- [Import Existing Documentation](#import-existing-documentation)  
- [Configure CI/CD](#configure-cicd)  
- [Publish Documentation](#publish-documentation)  
- [View Published Documentation](#view-published-documentation)  
- [Export Documentation](#export-documentation)  

## Troubleshooting

### The documentation does not appear ready to publish

Open **Publishing** and check **2. Configured**. If configuration is incomplete, select **Configure →** and finish the available publishing configuration before checking the publication status again.

### I cannot confirm what external readers will see

Select **View Published Docs** or **🌐 View Published Docs**. This opens the published documentation experience so you can verify the organization branding and documentation presentation as a reader would see them.

### My documentation is not yet available in the publishing workflow

Return to the Documentation Hub and prepare the content first. Select **Generate Documentation →** to generate documentation from your code, or select **Or import existing documentation** to work from existing documentation.

<!-- source: configure-published-documentation-languages.md -->

# Configure Published Documentation Languages

Configure the languages available to your documentation audiences before you share or publish documentation. This helps readers access published content in the language that best fits their needs.

## Overview

Atloria supports 24+ languages for documentation. Language configuration determines which language options are available when documentation is presented to your audiences and when they open your published documentation.

You typically configure languages during the publishing setup process, after your documentation has been generated or imported and before you direct readers to the published site. This keeps your published documentation aligned with the regions, teams, and customers you support.

Language availability is part of the broader publishing experience. After configuration, you can use **View Published Docs** or **🌐 View Published Docs** to review the reader-facing documentation and confirm that the intended language options are available.

> 📷 _Screenshot pending: Language configuration area showing the supported documentation languages and publishing controls._

## Prerequisites

Before you begin, make sure you have:

- Access to the documentation project you want to publish.
- Documentation that has been generated using **Generate Documentation →**, or content that has been added through **Or import existing documentation**.
- Access to the publishing configuration area.
- A list of the languages your documentation audiences require.
- A published documentation destination to review after configuration.

## Step-by-Step Instructions

1. Open the documentation project that you want to configure for publishing.

2. Go to the publishing area by selecting **Publishing**.

3. Select **Configure →** to open the available publishing configuration options.

4. Locate the language information by selecting **see the 24+ languages we support**.

5. Review the supported languages and identify the languages needed by your intended documentation audiences.

6. Enable or configure the languages that you want to make available for published documentation.

7. Confirm that the language configuration matches the audience or audiences that will use the documentation.

8. Return to the publishing area when you have finished configuring languages.

9. Check the publishing state shown under **3. Published Status**.

10. Publish the documentation when the publishing status and configured languages are ready for readers.

11. Select **View Published Docs** to open the published documentation.

12. If available in your workspace, select **🌐 View Published Docs** to review the public documentation experience.

13. Verify that readers can access the published documentation in the languages you configured.

> 📷 _Screenshot pending: Published documentation view used to verify the configured audience languages._

## Tips and Best Practices

- Configure languages before promoting the published documentation link to customers or internal teams. This avoids directing readers to a site before the expected language experience is ready.

- Start with the languages required by your largest or most important audiences. You can review the 24+ supported languages through **see the 24+ languages we support** when planning future expansion.

- Review your documentation content before publishing. If you are still preparing content, use **Generate Documentation →** to create documentation from your code, or select **Or import existing documentation** when you already have material to bring into Atloria.

- Use **View Published Docs** after publishing rather than relying only on the configuration screen. The published view is the best place to confirm the reader-facing result.

- Keep language choices consistent with your documentation audience strategy. For example, configure the same language expectations across related published documentation so readers have a predictable experience.

- Recheck language availability whenever you make major publishing changes, update documentation structure, or create documentation for a new audience.

## Related Pages

- [Generate Documentation](#)  
- [Import Existing Documentation](#)  
- [Publish Documentation](#)  
- [View Published Documentation](#)  
- [Configure Publishing Branding](#)  
- [Configure CI/CD](#)  
- [Export Documentation](#)  

## Troubleshooting

### You cannot find language options

Select **Publishing**, then choose **Configure →**. Look for **see the 24+ languages we support** to review the available language options. If you still cannot access configuration controls, verify that you have access to the documentation project and its publishing settings.

### The published site does not show the language experience you expected

Open **View Published Docs** or **🌐 View Published Docs** and review the published reader experience. Return to **Publishing** and confirm that the intended languages were configured before publishing. Republish the documentation if your workspace requires publishing changes to be applied again.

### Documentation is not ready to publish

Check **3. Published Status** to understand the current publishing state. If content has not yet been created, select **Generate Documentation →**. If you have existing content, select **Or import existing documentation** before completing language configuration and publishing.

<!-- source: manage-a-published-audience-by-slug.md -->

# Manage a Published Audience by Slug

A published audience slug identifies a specific audience area within your public documentation. You can use it to open the correct published experience, confirm that audience-specific content is available, and return to your publishing tools when changes are needed.

## Overview

When you publish documentation, Atloria provides a public documentation area that can be accessed through **View Published Docs** or **🌐 View Published Docs**. Within that published area, an audience slug distinguishes one audience from another.

An audience slug is the audience-specific part of the published documentation address. It helps ensure that readers reach the documentation intended for their audience, rather than a different audience or a general documentation landing page. For example, organizations may use separate published audiences for customers, partners, administrators, or internal teams.

You typically work with a published audience slug when you need to verify the reader experience after publishing, share an audience-specific documentation link, or identify why a reader is not seeing the expected documentation. The public navigation can also lead from an audience area to a specific published document.

> 📷 _Screenshot pending: Published documentation view showing the audience-specific area and navigation to published documents._

## Prerequisites

Before you begin, make sure you have:

- Access to the Atloria workspace that contains the documentation project.
- Documentation that has been published, indicated by the **Published** status.
- Permission to open publishing and settings options for the project.
- The correct public documentation project link or access to **View Published Docs**.
- The audience slug you want to verify or share, if it was provided by another administrator.
- At least one document available for the intended published audience.

## Step-by-Step Instructions

Use these steps to open and verify a published audience identified by its slug.

1. Open the documentation project in Atloria.

2. Select **Publishing** to review the project’s publishing area.

3. Confirm that the documentation shows the **Published** status.

4. Click **🌐 View Published Docs** to open the public documentation experience.

5. Locate the audience-specific section of the published documentation.

6. Check that the audience slug in the published link identifies the audience you intend to view.

7. Open the audience-specific link to display documentation for that audience.

8. Review the visible documentation navigation to confirm that the expected audience content is available.

9. Select a document from the published audience navigation to verify that its content opens correctly.

10. Use the browser’s address bar to copy the audience-specific published link when you need to share it with readers.

11. Return to Atloria and select **Manage in Settings** if the audience, publishing configuration, or available content needs to be changed.

12. Click **🌐 View Published Docs** again after making publishing changes to verify the updated public audience experience.

> 📷 _Screenshot pending: The Publishing area with the “🌐 View Published Docs” action used to open public documentation._

### Understand the published link structure

A published documentation link can lead to different levels of the public experience:

1. Open **View Published Docs** to start at the published documentation area.

2. Use the project portion of the published link to identify the documentation project being viewed.

3. Use the audience-specific portion of the link to identify the published audience.

4. Use the final document-specific portion of the link, when present, to open an individual published document within that audience.

The audience slug is important because it keeps the reader within the correct audience context. If you share only a general project-level link, readers may need to navigate further before reaching the documentation intended for them. When you share an audience-specific link, readers can enter directly into the appropriate published documentation area.

### Verify changes after publishing

If you update documentation or change publishing-related settings, verify the audience again after the update is published.

1. Return to the project’s **Publishing** area.

2. Confirm that the project remains marked **Published**.

3. Select **View Published Docs**.

4. Open the audience-specific published link.

5. Refresh the browser page to ensure you are viewing the latest published result.

6. Open an affected document to confirm that the audience can see the expected content.

7. Use **Manage all versions →** or **🕘 Go to Version Manager** if you need to review documentation versions before confirming the published result.

> 📷 _Screenshot pending: An individual published document opened from an audience-specific public documentation area._

## Tips and Best Practices

- **Share the audience-specific link.** When documentation is intended for a particular group, share the link that includes that audience’s slug rather than relying on readers to navigate from the general published documentation area.

- **Verify the Published status first.** If documentation is not marked **Published**, readers may not be able to access the expected public content.

- **Test a document, not only the audience landing area.** An audience may open successfully while a specific document is unavailable or does not display as expected. Open at least one relevant document after checking the audience link.

- **Use consistent audience names and slugs.** Choose clear, stable audience identifiers so that shared links remain understandable and easier to maintain over time.

- **Review versions before publishing changes.** Use **Manage all versions →** or **🕘 Go to Version Manager** when you need to confirm which documentation version should be visible to the audience.

- **Keep public links current.** If your organization changes its audience structure or publishing configuration, retest links that have been shared in emails, portals, onboarding materials, or support resources.

- **Use the public view for reader validation.** The **View Published Docs** experience shows what readers can access. Use it as the final check after generating, importing, exporting, or updating documentation.

## Related Pages

- [Publish Documentation](#)
- [View Published Docs](#)
- [Manage Documentation Versions](#)
- [Manage Publishing Settings](#)
- [Generate Documentation](#)
- [Export Documentation](#)

## Troubleshooting

### The audience-specific link does not show the expected documentation

1. Return to the documentation project.

2. Select **Publishing**.

3. Confirm that the documentation status is **Published**.

4. Click **🌐 View Published Docs**.

5. Open the audience-specific link again and verify that you are using the correct audience slug.

6. Select a document from the audience area to check whether the issue affects the full audience or only one document.

### You can open published documentation, but not the intended audience

1. Open **View Published Docs**.

2. Compare the audience-specific part of the link with the slug you were given.

3. Replace the link with the correct audience-specific link if you copied or received an incorrect one.

4. Select **Manage in Settings** if the correct audience is unavailable or requires configuration changes.

### Updates are not visible in the published audience

1. Open **Publishing**.

2. Verify that the current documentation is marked **Published**.

3. Select **🕘 Go to Version Manager** to review the version you expect to be public.

4. Return to **🌐 View Published Docs** after confirming the version.

5. Refresh the audience-specific public page before checking the updated document again.

<!-- source: manage-a-documentation-version-by-id.md -->

# Manage a Documentation Version by ID

A documentation version ID identifies one specific generated or published version of your project documentation. Use it when you need to review, compare, publish, or manage the screenshots for the correct version rather than working with the latest version by default.

## Overview

Documentation versioning lets you keep multiple documentation outputs for the same project. Each version has its own identifier, shown in the version-specific area of Version Manager. This identifier distinguishes one version from another when you open management tools such as review, comparison, or screenshot management.

You typically need a version ID when your project contains more than one generated documentation version. For example, you may generate a new version after updating your application, compare it with an earlier version, and then publish only the version you have reviewed. The version ID ensures that you are working on the intended documentation set.

A version can be available for management without being published. The **Published** status indicates that a version is available in the published documentation experience. Selecting a version by its ID does not publish it automatically; publishing is a separate action.

> 📷 _Screenshot pending: The Version Manager showing multiple documentation versions and their available actions._

## Prerequisites

Before you begin, make sure that you have:

- Access to the applicable project in Atloria.
- Permission to view and manage project documentation versions.
- At least one generated documentation version.
- The version ID or version number you intend to manage.
- Reviewed any changes that may affect the version before publishing it.
- Access to the project’s publishing and branding settings if you plan to verify the published result.

## Step-by-Step Instructions

1. Open your project in Atloria.

2. Select **Versions** to open the project’s version management area.

3. Locate the documentation version that matches the version ID you need to manage.

4. Select the matching version to make it the active version for your next action.

5. Click **Compare Versions** if you need to compare the selected version with another available version.

6. Select the comparison version when prompted.

7. Review the differences between the two versions before making a publishing decision.

8. Click **Manage Screenshots →** if you need to update or review screenshots associated with the selected version.

9. Review the screenshots shown for the selected version.

10. Select **Use V4 AI Version** if you want to use the available V4 AI-generated documentation version for the current documentation context.

11. Select **Use All V4 AI Versions** if you want to apply all available V4 AI-generated versions rather than choosing one individually.

12. Click **⚡ Generate Next Version** when you need to create a newer documentation version after reviewing the current version.

13. Wait for the new version to appear in the **Versions** list.

14. Select the newly generated version by its version ID before continuing with review or publishing.

15. Click **🚀 Publish Version 4** when Version 4 is the version you have approved for publication.

16. Confirm that the version displays the **Published** status after the publishing process completes.

17. Click **🌐 View Published Docs** to open the published documentation for the selected version.

18. Review the published documentation to confirm that the expected version content is visible.

> 📷 _Screenshot pending: A selected documentation version with Compare Versions, Manage Screenshots, publishing, and published-documentation actions._

## Tips and Best Practices

- Treat the version ID as the identifier for one specific documentation version. Before selecting an action, verify that you have selected the intended version in the **Versions** area.

- Compare versions before publishing when you have generated a newer version. **Compare Versions** helps you confirm that the intended documentation changes are present and that important content was not removed unexpectedly.

- Manage screenshots for the correct version. Screenshots are version-specific, so use **Manage Screenshots →** only after confirming the selected version ID.

- Generate a new version instead of assuming changes appear in an older version. Use **⚡ Generate Next Version** when your project changes require refreshed documentation.

- Publish only after review. The **Published** status is the confirmation that the version is available through the published documentation experience. A version that has been generated or selected is not necessarily published.

- Verify the final result in the published view. After using **🚀 Publish Version 4**, select **🌐 View Published Docs** to confirm what your readers will see.

- Use the V4 AI options deliberately. **Use V4 AI Version** applies a specific V4 AI version, while **Use All V4 AI Versions** applies all available V4 AI versions. Review which option best matches your documentation workflow before proceeding.

- Return to the central management area when needed. Select **🕘 Go to Version Manager** to review available versions and continue working with a specific version ID.

## Related Pages

- [Generate a New Documentation Version](#)
- [Compare Documentation Versions](#)
- [Manage Version Screenshots](#)
- [Publish Documentation](#)
- [View Published Documentation](#)
- [Configure Publishing Branding](#)
- [Export Documentation](#)

## Troubleshooting

### I cannot find the version ID I need

Open **Versions** and review the available version list. If the expected version is not listed, it may not have been generated yet. Select **⚡ Generate Next Version** to create a new version when appropriate, then return to the version list and select the newly available version.

### I published the wrong version

Return to **Versions** and identify the correct version ID. Review it with **Compare Versions** if necessary, then use the appropriate publish action for the version you intend to make available. Finally, select **🌐 View Published Docs** to verify the published result.

### My screenshots do not match the documentation version I selected

Open the intended version from **Versions** first, then select **Manage Screenshots →**. Because screenshot management is tied to the selected documentation version, verify the version ID before adding, reviewing, or replacing screenshots.

<!-- source: enable-project-analytics.md -->

# Enable Project Analytics

Project Analytics helps you review documentation activity and outcomes for an individual project. This page explains how to open a project’s analytics view and export the available reporting data for review or sharing.

## Overview

Use Project Analytics when you need visibility into how documentation work is progressing for a specific project. The analytics area is associated with an individual project, so you first select the project you want to review from the Projects hub.

From the project dashboard, you can access analytics reporting and export data using the available **Export CSV** option. Exported CSV data is useful when you need to analyze results outside Atloria, share reporting with stakeholders, or combine project results with other enterprise reports.

Analytics is project-specific. If you need reporting for another project, return to **Projects** and open that project before viewing or exporting its analytics.

> 📷 _Screenshot pending: Project dashboard showing the Analytics area and available reporting actions._

## Prerequisites

Before you begin, make sure that:

- You can access the **Projects** hub.
- The project you want to report on already exists.
- You have permission to open the selected project’s dashboard.
- Your browser allows file downloads if you plan to use **Export CSV**.
- You know which project’s documentation activity and outcomes you need to review.

## Step-by-Step Instructions

1. Select **Projects** to open the list of available projects.

2. Use the **Search projects...** field to find the project you want to analyze.

3. Select the project from the search results or project list.

4. Select **Open Project Dashboard** to open the focused project workspace.

5. Open the project’s **Analytics** area from the project navigation.

6. Review the activity and outcome information displayed for the selected project.

7. Select **Export CSV** to download the analytics data as a CSV file.

8. Open the downloaded CSV file in your preferred spreadsheet or reporting application.

> 📷 _Screenshot pending: Project Analytics view with the Export CSV action available._

## Tips and Best Practices

- Confirm that you are working in the correct project before exporting. Analytics and documentation activity are associated with the focused project, not the full Projects hub.

- Use **Search projects...** when your organization has many projects. This reduces the risk of opening a similarly named project and exporting the wrong report.

- Use **Export CSV** when you need to filter, sort, archive, or share reporting data outside the application. Keep the exported file with the project reporting period or review date in its filename.

- Return to **Projects** before switching reporting contexts. The **← Back to Projects** or **&larr; Back to Projects** action returns you to the project list, where you can select another project.

- Treat exported data as a point-in-time report. If documentation activity changes after you download the file, export a new CSV to obtain the latest available data.

- If your project team is actively generating or updating documentation, review analytics regularly rather than relying on a single export. This helps you identify changes in activity and outcomes over time.

- Do not look for a separate on-screen “Enable Analytics” switch unless your organization has added one. In the available project workflow, analytics is accessed from the selected project’s dashboard and reporting area.

## Related Pages

- [Manage Projects](#) — Find, create, and open projects from the **Projects** hub.
- [Open the Project Dashboard](#) — Access project-specific workspace tools.
- [Export Documentation](#) — Export project documentation when you need content rather than reporting data.
- [Review Project Changes](#) — Review documentation-related changes for a selected project.
- [Compare Project Versions](#) — Compare versions when assessing documentation changes over time.

## Troubleshooting

### You cannot find the project you need

Use the **Search projects...** field and enter a distinctive part of the project name. If the project still does not appear, return to **Projects** and confirm that you have access to the correct project portfolio.

### You cannot open the Analytics area

First select **Open Project Dashboard** for the intended project. If the Analytics area is still unavailable, verify that you have the required project access with your Atloria administrator.

### The CSV file does not download

Select **Export CSV** again and check whether your browser blocked the download. Allow downloads for Atloria, then repeat the export. Also check your browser’s download list or default Downloads folder for the exported file.

<!-- source: configure-analytics-access.md -->

# Configure Analytics Access

Analytics access determines which collaborators can view project reporting and export available data. Use this process to confirm analytics visibility for a project and identify when additional access configuration is required.

## Overview

Project analytics provide reporting information for a specific project. Collaborators who can access the project’s analytics area can review reporting information and, where available, use **Export CSV** to download data for analysis outside Atloria.

In the currently available interface evidence, Atloria provides project navigation and analytics reporting, but no collaborator-level analytics permission fields, role selectors, or **Save** controls are shown. This means you should first confirm the collaborator’s project access and then verify whether they can open the project’s analytics area.

If your organization needs analytics to be restricted separately from general project access, contact the project administrator or your Atloria administrator. They can confirm whether analytics access is managed through project membership or through an organization-level policy not shown in the current project interface.

> 📷 _Screenshot pending: Project analytics area showing reporting visibility and available actions._

## Prerequisites

Before you begin, make sure you have:

- Access to the Atloria **Projects** area.
- The project selected for which you want to review analytics access.
- The name or email address of the collaborator whose access you want to verify.
- Administrator or project-management assistance if the collaborator cannot access the project.
- A reason for granting reporting access, especially if the collaborator may use **Export CSV**.

## Step-by-Step Instructions

1. Select **Projects** to open the list of available projects.

2. Select the project whose reporting access you want to review.

3. Open the project’s analytics area.

4. Ask the collaborator to open the same project from their own Atloria account.

5. Ask the collaborator to open the project’s analytics area.

6. Confirm whether the collaborator can see reporting information on the analytics screen.

7. Confirm whether the collaborator can see the **Export CSV** action, if your organization allows reporting data to be exported.

8. Select **Export CSV** only when you need a downloadable copy of the displayed reporting data.

9. Review the exported file according to your organization’s data-handling requirements.

10. Remove or adjust the collaborator’s project access through your organization’s established project-access process if they should not be able to view analytics.

11. Contact an administrator if the collaborator can access the project but should not be able to access its reporting information separately.

> 📷 _Screenshot pending: Analytics screen with the Export CSV action available to an authorized collaborator._

## Tips and Best Practices

- Treat analytics visibility as project reporting access. Because no separate collaborator-level analytics control is shown in the available interface, verify access by testing the collaborator’s ability to open the project and its analytics area.

- Review access using the collaborator’s own account whenever possible. Your own administrator access may allow you to see screens or actions that are unavailable to other collaborators.

- Use **Export CSV** carefully. Exported reporting data can be stored, shared, or analyzed outside Atloria, so grant access only to collaborators who need to work with that data.

- Recheck analytics access when project team membership changes. A collaborator who no longer needs project reporting should no longer retain the project access that makes reporting visible.

- Confirm the project before reviewing access. Use **&larr; Back to Projects** to return to the project list if you opened the wrong project, then select the correct project before continuing.

- Use reporting access consistently across similar collaborators. For example, give the same level of project access to team members with the same reporting responsibilities, unless a business requirement calls for an exception.

## Related Pages

- [Manage Project Collaborators](#)
- [View Project Analytics](#)
- [Export Analytics Data to CSV](#)
- [Projects Overview](#)
- [Administrator Guide: Project Access](#)

## Troubleshooting

### A collaborator cannot open the project’s analytics area

Confirm that the collaborator can first access the correct project from **Projects**. If they cannot open the project, ask an administrator to review their project membership or assigned access.

### A collaborator can view analytics but cannot find **Export CSV**

The **Export CSV** action may not be available for every collaborator, reporting view, or organization policy. Ask an administrator to confirm whether exports are enabled for that collaborator and project.

### You need to limit analytics access without removing general project access

No separate analytics-only permission control is shown in the available interface evidence. Contact your Atloria administrator to determine whether your organization has an organization-level access policy or another approved process for separating reporting access from project access.

<!-- source: configure-reporting-exports.md -->

# Configure Reporting Exports

Configure reporting exports to share operational analytics outside Atloria in a consistent format. This page explains how to prepare your reporting view and export available data for documentation, analysis, or downstream reporting processes.

## Overview

Reporting exports let you take the information displayed in your analytics area and create a file that can be reviewed, stored, or used in another reporting tool. Depending on the export option available on your screen, you can export data as a CSV file or a JSON file.

Use exports when you need to provide operational reporting to stakeholders, retain a reporting snapshot, analyze data in a spreadsheet, or connect exported information to another internal process. CSV exports are generally best for spreadsheet-based review, while JSON exports are useful when a technical team needs structured data for another system.

Before exporting, review the analytics information currently shown in Atloria. For example, your reporting view may include operational indicators such as **Compounding operational risks**, **✅ Security Best Practices Implemented**, or **Documentation Analytics**. Exporting after you have reviewed the displayed information helps ensure that the resulting file supports the report’s intended purpose.

> 📷 _Screenshot pending: Analytics reporting view showing the available Export actions._

## Prerequisites

Before you begin, make sure that you have:

- Access to the project’s Analytics area.
- Permission to view the reporting information you intend to export.
- A selected project with analytics data available.
- A clear understanding of the audience for the export, such as operations leaders, auditors, or a documentation team.
- A spreadsheet application for reviewing CSV files, if needed.
- A secure storage location for exported files, especially when reports contain operational or security-related information.

## Step-by-Step Instructions

1. Open the project for which you want to prepare a reporting export.

2. Open the project’s **Analytics** area.

3. Review the reporting cards and operational information shown on the page.

4. Identify the information you need to include in your operational report.

5. Select **Configure →** if the Analytics area displays this action.

6. Review the available configuration options before continuing with the export.

7. Save or apply any available reporting configuration changes.

8. Confirm that the reporting view shows the information you expect to export.

9. Select **Export CSV** to download the displayed reporting data in CSV format.

10. Select **📄 Export CSV** if this is the CSV export action shown in your reporting section.

11. Select **📄 Export JSON** when you need the reporting data in JSON format.

12. Select **Export Documentation** when you need an export intended for documentation reporting.

13. Select **Export** when the screen provides a general export action rather than a format-specific button.

14. Save the downloaded file in your organization’s approved reporting location.

15. Open the exported file to verify that it contains the expected operational reporting information.

> 📷 _Screenshot pending: Export actions showing CSV, JSON, documentation, or general Export options._

16. Name the saved file according to your organization’s reporting convention.

17. Share the completed export only with the approved recipients for the report.

18. Record the export date and reporting purpose in your team’s reporting process.

If the screen shows **2. Configured**, treat it as an on-screen indication that configuration is present or has reached that stage. Review the displayed reporting setup before exporting so that you do not distribute an outdated or incomplete report.

## Tips and Best Practices

- Use **Export CSV** when recipients need to sort, filter, or review reporting data in a spreadsheet.
- Use **📄 Export JSON** when another process requires structured data rather than a tabular report.
- Use **Export Documentation** for reporting that supports documentation review or documentation-related analytics.
- Review operational indicators before exporting. Items such as **Compounding operational risks** may require additional explanation when shared with leadership or risk owners.
- Treat security-related reporting carefully. If the analytics view includes **✅ Security Best Practices Implemented**, confirm that the exported file is shared according to your organization’s security reporting procedures.
- Export only after confirming that the analytics view reflects the project and reporting period you intend to report on.
- Store exports in an approved location rather than leaving downloaded files in an unsecured local folder.
- Use a consistent file name that includes the project, reporting period, and export format. For example: `ProjectName_Analytics_2026-07_CSV`.
- If you export regularly, establish a repeatable schedule so stakeholders receive reports at predictable intervals.
- Re-open each exported file before distribution. This simple check helps you catch an incorrect project selection or an unexpected export format.

## Related Pages

- [View Project Analytics](#)
- [Review Documentation Analytics](#)
- [Manage Operational Risk Reporting](#)
- [Configure CI/CD](#)
- [Set Project Access and Permissions](#)

## Troubleshooting

### The export action is not available

Confirm that you are viewing the correct project’s **Analytics** area. If **Export CSV**, **📄 Export CSV**, **📄 Export JSON**, **Export Documentation**, or **Export** does not appear, your access level may not allow exports, or that reporting view may not offer the selected format. Contact your Atloria administrator for access guidance.

### The exported file does not contain the information you expected

Return to the Analytics area and review the reporting cards before exporting again. Confirm that you are in the intended project and that the visible analytics information includes the operational indicators you need. If available, select **Configure →** and verify the reporting configuration before creating a new export.

### I am not sure which export format to use

Choose **Export CSV** for spreadsheet-based reporting and **📄 Export JSON** for structured data use. Choose **Export Documentation** when the report is intended to support documentation review. If your team has a required reporting procedure, follow that procedure before sharing the file.

<!-- source: configure-organization-integrations.md -->

# Configure Organization Integrations

Use the **Settings → Integrations** page to connect your organization to supported source control providers. These connections let Atloria work with your repositories and make provider-specific options available where needed.

## Overview

Organization integrations connect Atloria to external repository systems. The available providers are **GitHub**, **GitLab**, and **Bitbucket**. Each provider appears as a separate integration option so you can connect only the systems your organization uses.

You may need to configure an integration when you are setting up Atloria for the first time, when your organization adopts an additional source control provider, or when an existing connection needs to be checked or removed. A new organization may show the status **1. Fresh (No Connections)**. As connections are added, the interface can indicate states such as **2. GitHub Connected**, **2. Configured**, or **3. All Connected**.

After a provider is connected, you can use **Test Connection** to confirm that Atloria can still communicate with the external system. You can also select **Disconnect** when an integration is no longer required.

> 📷 _Screenshot pending: The Settings → Integrations page showing GitHub, GitLab, and Bitbucket connection options._

## Prerequisites

Before you begin, make sure that:

- You can access your organization’s **Settings** area in Atloria.
- You have the required permissions to manage organization integrations.
- You have authorization to connect the relevant GitHub, GitLab, or Bitbucket account or organization.
- You know which repositories or provider organization Atloria should be able to access.
- Your browser allows the provider’s sign-in or authorization window to open, if prompted.

## Step-by-Step Instructions

1. Open **Settings → Integrations** from the Atloria application.

2. Review the available provider options for **GitHub**, **GitLab**, and **Bitbucket**.

3. Identify the provider you want to connect by checking its connection status.

4. Click **Connect Provider** for the provider you want to configure.

5. Click **Connect** to begin the provider connection process.

6. Complete the authorization prompts shown by the external provider.

7. Return to Atloria after the provider confirms the authorization.

8. Verify that the provider is no longer shown as not connected; Atloria may display a message such as “GitHub is not connected” before a successful connection is completed.

9. Confirm that the integration status changes to a connected or configured state, such as **2. GitHub Connected** or **2. Configured**.

10. Click **Test Connection** for the connected provider.

11. Review the test result to confirm that Atloria can communicate with the provider.

12. Click **Configure →** if additional configuration is available for that provider.

13. Select **Configure CI/CD** if you need to continue with continuous integration or continuous delivery setup for the connected provider.

> 📷 _Screenshot pending: A connected provider card showing the Test Connection, Configure →, Configure CI/CD, and Disconnect actions._

### Disconnect an integration

Use these steps only when your organization no longer needs a provider connection.

1. Locate the connected provider on the **Settings → Integrations** page.

2. Click **Disconnect** for that provider.

3. Confirm the disconnection if Atloria asks you to confirm the action.

4. Verify that the provider returns to an unconnected status.

Disconnecting removes the provider connection from Atloria. If projects or workflows rely on that provider, review their configuration before disconnecting it.

## Tips and Best Practices

- Connect only the providers your organization actively uses. If your organization uses GitHub but not GitLab or Bitbucket, you can leave the unused providers disconnected.

- Use **Test Connection** after the initial connection and whenever repository access stops working as expected. Testing the connection is the quickest way to verify that the saved integration is still available.

- Check the status indicators before making changes. **1. Fresh (No Connections)** indicates that no providers are connected, while **3. All Connected** indicates that all available provider connections have been completed.

- Use **Configure →** only after the provider is connected. Configuration options are most useful once Atloria can access the external provider.

- If your team uses automated build or deployment workflows, select **Configure CI/CD** after establishing the source control connection. This keeps repository access and CI/CD setup aligned.

- Avoid disconnecting a provider as a troubleshooting shortcut. First use **Test Connection** and verify that you are signed in to the correct external account. Disconnecting may require you to repeat the authorization process.

- If you are connecting a repository during project setup, look for **Connect Your Repository** or **Manage in Settings**. These options direct you to the appropriate connection workflow or the organization integration settings.

## Related Pages

- [Connect Your Repository](#)  
- [Configure CI/CD](#)  
- [Manage Projects and Repositories](#)  
- [Organization Settings](#)  
- [Events](#)  

## Troubleshooting

### The provider is still shown as not connected

Click **Connect Provider**, then select **Connect** again. Complete every authorization prompt from the external provider before returning to Atloria. If the status does not change, confirm that you authorized the correct provider account or organization.

### The connection test does not succeed

Click **Test Connection** again after confirming that your external provider account is active and that you still have access to the intended repositories. If the test continues to fail, disconnect the provider only if you are prepared to authorize it again, then reconnect it.

### You cannot find configuration options

First confirm that the provider shows a connected status, such as **2. Configured** or **2. GitHub Connected**. After the connection is active, use **Configure →** or **Configure CI/CD** when those actions are available.

<!-- source: configure-project-webhooks.md -->

# Configure Project Webhooks

Project webhooks let your organization send project-event notifications to external automation tools. This page explains how to prepare a project for webhook configuration and how to safely create and manage endpoints when the Webhooks controls are available in your Atloria environment.

## Overview

Webhooks are used when an event in a project needs to trigger work outside Atloria. For example, your team may use a webhook to notify an automation platform, create a task in another system, start a deployment workflow, or update an internal reporting process.

Webhook configuration is typically performed for an individual project rather than for all projects at once. Before you begin, identify the project that should send events and confirm which external system will receive them. You should also decide which project events are meaningful for the receiving workflow so that it does not run unnecessarily.

Atloria provides access to your project workspace through the **Projects** area. From there, you can search for and open the project that requires integration. The available evidence for this release confirms project navigation controls, but it does not confirm the labels, fields, or buttons used on the project Webhooks screen. Use the instructions below to reach the correct project and follow your organization’s approved Webhooks configuration process if the Webhooks option is present.

> 📷 _Screenshot pending: The project-level Webhooks configuration area showing existing webhook endpoints and the option to create a new endpoint._

## Prerequisites

Before configuring a webhook, make sure you have the following:

- Access to the **Projects** area in Atloria.
- Permission to administer the target project and its integrations.
- An existing project to configure.
- The destination URL supplied by the external service or automation workflow.
- Any authentication value, shared secret, token, or signing requirement required by the destination service.
- A list of the project events that should trigger the webhook.
- A contact who can verify deliveries in the external receiving system.

## Step-by-Step Instructions

1. Select **Projects** to open the list of projects available to you.

2. Enter the project name in **Search projects...** to find the project you want to configure.

3. Open the target project from the search results.

4. Confirm that you are working in the intended project before changing any integration settings.

5. Open the project’s integration or webhook configuration option if your project navigation displays one.

6. Select the option to create a new webhook endpoint if an existing endpoint is not already configured.

7. Enter the destination address in the endpoint URL field displayed by your Webhooks screen.

8. Enter the authentication or signing information required by the external service in the applicable security field.

9. Select the project events that should notify the endpoint.

10. Save or create the webhook using the confirmation button displayed on the Webhooks screen.

11. Review the newly created endpoint in the project’s webhook list to confirm that its destination and selected events are correct.

12. Send a test event if your Webhooks screen provides a test or delivery action.

13. Verify in the external system that the test notification was received and processed successfully.

> 📷 _Screenshot pending: The Create Webhook form with the endpoint URL, authentication or secret fields, event selections, and save action._

## Tips and Best Practices

Use a dedicated endpoint for each external workflow when possible. Separate endpoints make it easier to identify which integration received a notification and reduce the impact of changes to a single workflow.

Select only the events required by the receiving system. Sending every available event can create unnecessary traffic, duplicate work, and confusing automation results. Start with the smallest event set that supports the workflow, then expand it only after testing.

Treat webhook URLs and secrets as sensitive integration credentials. Share them only with authorized administrators, and update the destination configuration promptly if a secret is exposed or an external workflow is retired.

Use a stable, production-ready destination URL. Avoid configuring a personal workstation, temporary testing address, or endpoint that may change without notice. If you need to test, use a dedicated test endpoint and clearly distinguish it from the production endpoint.

Review existing endpoints before creating another one. Duplicate webhooks can cause the same external automation to run multiple times for one project event.

Use the project search capability when you manage many projects. The **Search projects...** field helps you reach the correct project without making changes to a similarly named project.

## Related Pages

- [Projects](#) — Find, search, and open projects.
- [Create a New Project](#) — Create a project before configuring project-level integrations.
- [Project Analytics](#) — Review project activity and outcomes.
- [Project Changes](#) — Review changes associated with a project.
- [Integration Settings](#) — Manage organization-level connections, such as GitHub, GitLab, or Bitbucket, where available.

## Troubleshooting

### You cannot find the target project

Select **Projects**, then use **Search projects...** with the project’s full or partial name. If the project still does not appear, confirm that you have been granted access to it. You can also return to the project list by selecting **← Back to Projects** where that action is available.

### You do not see a Webhooks or integration option in the project

Webhook controls may be limited by your role, organization configuration, or the version of Atloria available to your team. Confirm that you have project-administrator permissions and contact your Atloria administrator if the option is unavailable.

### The external system does not receive the webhook

First, verify that the endpoint URL is correct and reachable from the external service. Then confirm that the selected event actually occurred in the project and that any required authentication or signing value matches the receiving system’s configuration. If a test action is available, use it to isolate endpoint connectivity from normal project-event processing.

<!-- source: manage-integration-issues.md -->

# Manage Integration Issues

This page explains how to review integration-related events, investigate issues, and record them as resolved in Atloria. Managing these issues helps you keep integrations authorized, monitored, and ready for reliable use.

## Overview

Integration issues can occur when Atloria needs access to an external service, when an authorization needs attention, or when an event requires review. You can begin from **Settings → Integrations**, where you manage connected services and authorization.

Use the **Events** area to review integration activity and identify items that need action. When you have investigated an item and confirmed that no further work is needed, use **Resolve** to mark it for resolution.

Event processing may complete successfully with no errors, or it may complete with warnings. A successful completion does not always mean there is nothing to review: warnings can indicate that an event completed but needs follow-up.

> 📷 _Screenshot pending: The Settings → Integrations area, showing the controls used to manage integration access._

## Prerequisites

Before you begin, make sure you have:

- Access to the Atloria workspace where the integration is configured.
- Permission to open **Settings → Integrations**.
- The required credentials or account access for the external service, if you need to reauthorize it.
- Details about the event or issue you are investigating, such as the affected integration and the time the problem occurred.
- Confirmation from the integration owner before resolving an issue that affects a shared connection.

## Step-by-Step Instructions

1. Open **Settings → Integrations**.

   From the relevant Atloria area, select **Settings → Integrations**. If the issue directs you to integration management, select **Manage in Settings** to open the same area.

2. Review the integration’s authorization state.

   Look for an option such as **Authorize Atloria**. If this option is shown, Atloria needs permission to connect to the external service.

   Select **Authorize Atloria** and complete the authorization steps provided by the connected service. Use the account that has permission to manage that integration.

3. Open **Events** to review integration activity.

   Select **Events** to view the available integration event information. Use this area to identify events that completed with warnings or that need further investigation.

   Focus your review on events associated with the integration you are managing. Compare the event timing and outcome with the issue reported by users or administrators.

> 📷 _Screenshot pending: The Events area used to review integration activity and identify events requiring attention._

4. Investigate the issue before resolving it.

   Confirm whether the integration has the required authorization and whether the reported action can now be completed. If an event completed with warnings, determine whether the warning affects the intended result.

   Do not select **Resolve** simply because an event is no longer visible or because a connection appears authorized. Resolve an issue only after you have confirmed the underlying condition has been addressed.

5. Select **Resolve** when the issue is ready to close.

   Open the issue or review item that you have investigated, then select **Resolve**. This records that the item has been reviewed and no additional action is currently required.

   If you still need information from the integration owner or need to repeat authorization, leave the item unresolved until that work is complete.

6. Confirm the integration remains usable.

   After resolving the issue, return to **Settings → Integrations** as needed and verify that the integration still has the expected access. Review **Events** again if you need to confirm that later activity completes without errors or warnings.

## Tips and Best Practices

- **Review warnings, not only failures.** An event can complete successfully while still producing warnings. Treat warnings as a prompt to verify the result rather than automatically closing the item.
- **Authorize with the correct account.** When you select **Authorize Atloria**, use an account that is permitted to access the intended external service and workspace. Authorization with the wrong account can create a connection that does not have the access your team expects.
- **Resolve only after verification.** The **Resolve** action is best used after you have confirmed the issue’s cause and verified that the integration can perform the required action.
- **Use Settings for connection changes.** When an issue is related to access or authorization, use **Manage in Settings** or **Settings → Integrations** rather than treating the event record itself as the place to change connection permissions.
- **Keep ownership clear.** If another team owns the external service, provide them with the relevant event timing and observed warning or error before requesting access changes.

## Related Pages

- [Manage Integrations](#)
- [Authorize Atloria for an Integration](#)
- [Review Integration Events](#)
- [Resolve Review Items](#)
- [Manage Screenshots](#)

## Troubleshooting

### You cannot access the integration settings

**Problem:** You cannot open **Settings → Integrations**, or you do not see **Manage in Settings**.

**Cause:** Your Atloria account may not have the required access to manage integrations, or the integration may be managed by another administrator.

**Solution:** Ask a workspace administrator to confirm your permissions. If another team owns the integration, ask that team to review the connection or grant the appropriate access before you continue.

### The **Authorize Atloria** button is displayed

**Problem:** You see **Authorize Atloria** when reviewing an integration issue.

**Cause:** Atloria does not currently have the authorization required to use that external service, or previous authorization is no longer valid.

**Solution:** Select **Authorize Atloria** and complete the authorization process with an account that has the required service permissions. After authorization, return to **Events** and review later activity to confirm that the issue no longer occurs.

### An event completed, but it has warnings

**Problem:** The event appears to have completed successfully, but warnings are reported.

**Cause:** The integration processed the event but encountered a condition that may affect the expected outcome.

**Solution:** Review the event context and verify the intended result in the connected service. Correct any authorization, configuration, or source-data issue that you identify. Select **Resolve** only after you have confirmed that the warning does not require further action or that the underlying issue has been corrected.

<!-- source: select-an-organization-plan.md -->

# Select an Organization Plan

Selecting an organization plan determines the level of documentation service available to your organization. Use this process when you need to align Atloria’s documentation capabilities with your team’s documentation volume, access needs, and commercial requirements.

## Overview

Organization plans help you choose the level of service that best supports your documentation work. Your plan can affect the documentation features, service capacity, commercial options, and support commitments available to the organization.

You typically select or review a plan when setting up an organization, preparing to expand documentation activity, or reviewing commercial readiness. Atloria includes a **Billing** area for plan and billing-related administration.

Before making a selection, consider how your organization creates and manages documentation. For example, you may need a plan that supports a larger number of projects, more generated documentation, exports, or enterprise-level service requirements.

> 📷 _Screenshot pending: The Billing area where an administrator reviews available organization plans._

## Prerequisites

Before you begin, make sure you have:

- Administrator access to the organization.
- Permission to access **Billing**.
- A clear understanding of your organization’s documentation needs.
- Approval to make billing or plan changes, if your organization requires it.
- Any required purchasing or payment information available for your organization.
- A list of the projects and documentation workflows your plan must support, such as generating documentation or exporting documentation.

## Step-by-Step Instructions

1. Open your organization’s administration area.

2. Select **Billing**.

3. Review the plans displayed in the Billing area.

4. Compare each plan’s included documentation service level, limits, and commercial terms.

5. Identify the plan that supports your organization’s expected documentation workload.

6. Review whether the plan supports the documentation activities your team uses, such as **Generate Documentation →**.

7. Review whether the plan supports your team’s delivery requirements, such as **Export Documentation**.

8. Select the plan option that matches your organization’s needs.

9. Review the confirmation details before completing the plan selection.

10. Confirm the plan selection using the confirmation action shown on screen.

11. Return to your documentation workspace after the plan has been applied.

12. Select **View Your Documentation →** to confirm that your team can access its documentation workspace.

> 📷 _Screenshot pending: Available organization plans and the action used to select or confirm a plan._

## Tips and Best Practices

- Choose a plan based on expected usage, not only current usage. Documentation needs often grow as you add repositories, projects, and contributors.

- Consider the complete documentation workflow. If your team needs to select repositories, generate documentation, review it, and export it, verify that the selected plan supports the workflow you intend to use.

- Review service expectations for enterprise use. If your organization requires formal availability or support commitments, review the **📊 Service Level Agreement (SLA)** information before finalizing the plan.

- Include commercial stakeholders when necessary. Plan selection can involve billing, credits, plans, and enterprise requirements, so obtain internal approval before confirming a change.

- Keep documentation requirements in mind when comparing plans. If your organization uses multiple documentation approaches, review available **Documentation Templates** and documentation styles as part of your evaluation.

- Reassess your plan when your organization adds new projects. A plan that supports one team may not remain appropriate after you expand documentation generation or exporting activity.

## Related Pages

- [Manage Billing](#)
- [Generate Documentation](#)
- [Select a Repository](#)
- [View Your Documentation](#)
- [Export Documentation](#)
- [Documentation Templates](#)
- [Service Level Agreement (SLA)](#)

## Troubleshooting

### You cannot see the Billing option

You may not have the required organization permissions. Ask an organization administrator to verify that you have access to **Billing**.

### You are unsure which plan to choose

Review your expected documentation volume, number of projects, export needs, and enterprise service requirements. If your organization has purchasing requirements, involve the appropriate billing or procurement contact before making a selection.

### The selected plan does not appear to support a needed documentation activity

Confirm the activity your team needs, such as **Generate Documentation →**, **View Your Documentation →**, or **Export Documentation**. Then review the plan details again and select a plan that includes the required service level.

<!-- source: manage-billing-details.md -->

# Manage Billing Details

Use the Billing area to maintain the commercial information associated with your Atloria workspace or project. Keeping billing contacts and commercial details current helps ensure that plan, credit, and enterprise-related communications reach the right people.

## Overview

Billing details support your organization’s commercial readiness in Atloria. This includes the information used when your organization works with billing plans, credits, Stripe-related billing, or enterprise arrangements.

You may need to review or update billing details when a billing contact changes, your organization updates its commercial information, or you are preparing to manage plans and credits. The Billing area is available from the relevant management or settings experience.

The exact information available on the Billing screen can depend on your organization’s setup. Review the visible sections carefully before making changes, especially when your workspace has enterprise billing arrangements.

> 📷 _Screenshot pending: The Billing area showing commercial readiness and billing information sections._

## Prerequisites

Before you start, make sure you have:

- Access to the applicable Atloria workspace or project.
- Permission to open **Settings** or the relevant management screen.
- The current contact information for the person or team responsible for billing.
- Any approved commercial information required by your organization.
- Confirmation from your finance or procurement team if you are changing enterprise, plan, credit, or Stripe-related details.

## Step-by-Step Instructions

1. Open the Atloria workspace or project whose billing information you want to manage.

2. Select **Manage in Settings** to open the settings area.

3. Select **Billing**.

4. Review the billing page for the commercial information currently associated with your workspace or project.

5. Locate the **Contact Information** section.

6. Update the visible billing contact fields with the current information for the person or team responsible for billing communications.

7. Review the **Basic Information** section.

8. Update any visible commercial or organizational information that needs to be kept current.

9. Review the **Commercial Readiness — Stripe, credits, plans, enterprise** information to understand which commercial options apply to your organization.

10. Select the available save or confirmation control after updating the information.

11. Reopen **Billing** to confirm that the updated details are displayed correctly.

> 📷 _Screenshot pending: The Contact Information and Basic Information sections on the Billing screen._

If you are managing billing for a specific project rather than the overall workspace, start from **Project Details** and then select **Billing** where it is available. This helps you verify that you are reviewing the billing information in the correct context.

## Tips and Best Practices

- Keep **Contact Information** owned by a role or team mailbox when possible. A shared finance or billing address can reduce disruption when individual employees change roles.
- Review billing details whenever your organization changes its finance contact, legal entity information, purchasing process, or enterprise arrangement.
- Use the **Commercial Readiness — Stripe, credits, plans, enterprise** area as a checkpoint before making commercial decisions. This area helps you identify the billing capabilities and arrangements relevant to your Atloria setup.
- Confirm whether you are working at the workspace or project level before editing information. Use **Project Details** when you need to verify the project context.
- Do not treat billing contacts as general technical contacts. The billing contact should be someone who can receive and act on commercial communications.
- If you are unsure whether a change affects plans, credits, Stripe billing, or an enterprise agreement, confirm the change with your finance, procurement, or account-management team before saving it.
- Review information after updates. Reopening **Billing** is a simple way to confirm that the correct details are visible and that you updated the intended record.

## Related Pages

- [Manage Billing Plans](#)
- [Manage Credits](#)
- [Project Details](#)
- [Manage Settings](#)
- [Commercial Readiness — Stripe, credits, plans, enterprise](#)
- [Manage Screenshots](#)
- [Go to Version Manager](#)
- [Manage all versions](#)

## Troubleshooting

### You cannot find the Billing area

Select **Manage in Settings** and look for **Billing**. If you are working with a project, first check **Project Details** to confirm that you opened the correct project or workspace context.

### You cannot update billing information

Your account may not have the required settings or billing permissions. Ask a workspace administrator to review your access or to make the update on your behalf.

### You are unsure which contact information to enter

Use the contact information for the person or team that handles invoices, commercial communications, plans, credits, or enterprise discussions. Confirm the appropriate contact with your finance or procurement team before changing the visible fields.

<!-- source: review-plan-usage.md -->

# Review Plan Usage

Use the review workspace to examine plan usage alongside operational requirements before publishing a version. This review helps you confirm that the plan is complete, understandable, and ready for the next decision or release step.

## Overview

The **Review Summary** workspace brings the plan together for a final review. You can use it to assess the plan at a glance, including content related to billing, commercial readiness, monitoring, audit requirements, operational risks, and implementation activities.

Review the plan when you need to verify that planned usage remains appropriate for the organization’s capacity and operating model. For example, the plan may include sections such as **Billing**, **Commercial Readiness — Stripe, credits, plans, enterprise**, **📊 Monitoring & Audit**, and **Compounding operational risks**. These entries help you identify whether operational responsibilities, monitoring expectations, and commercial considerations have been addressed.

The review workspace also includes preview controls. Use **Preview** or **Share Preview Link** when you need to see how the plan will be presented or provide a viewable version to other stakeholders. When the plan is ready, use **Review & Publish** to proceed with publication.

> 📷 _Screenshot pending: The Review Summary workspace showing plan sections and the Review & Publish action._

## Prerequisites

Before reviewing plan usage, make sure you have:

- Access to the relevant project version and its review workspace.
- A plan version that contains the usage, billing, and operational information you need to assess.
- Permission to review or publish the version, if you need to use **Review & Publish**.
- The expected plan capacity, commercial requirements, and operational requirements from your organization.
- Stakeholder input for areas such as billing, credits, enterprise readiness, monitoring, and audit controls.

## Step-by-Step Instructions

1. Open the project version you want to review.

2. Open the **Review Summary** area for that version.

3. Locate the section titled **The whole plan at a glance**.

4. Read the plan overview to understand the planned scope before assessing individual usage and operational items.

5. Select or review the **Billing** section.

6. Compare the billing-related plan details with your organization’s expected plan capacity and usage model.

7. Select or review **Commercial Readiness — Stripe, credits, plans, enterprise**.

8. Confirm that the plan addresses the commercial requirements that apply to your organization, such as credits, plan handling, or enterprise readiness.

9. Select or review **📊 Monitoring & Audit**.

10. Verify that the plan identifies how usage and operational activity will be monitored and audited.

11. Select or review **Compounding operational risks**.

12. Identify risks that could increase as usage grows, such as additional review effort, monitoring needs, or dependencies across operational teams.

13. Select or review **Implementation Plan**.

14. Confirm that the implementation activities support the capacity and operational requirements identified during your review.

15. Select or review **UX priorities (feeds the ★ plan)** when user experience priorities affect how users will consume or manage the plan.

16. Review **Phase plan to perfect it — across all three surfaces** if the plan is being delivered in phases across multiple user experiences or operational surfaces.

17. Click **Preview** to inspect the plan in preview mode.

> 📷 _Screenshot pending: The Preview control and preview mode used to inspect the plan before publication._

18. Review the previewed content for missing usage assumptions, unclear operational requirements, or incomplete billing information.

19. Click **Share Preview Link** when you need to send the preview to stakeholders for feedback.

20. Click **Back to Review** after previewing if you need to return to the review workspace.

21. Click **Review & Publish** when the usage, capacity, commercial, and operational requirements have been reviewed and approved for publication.

## Tips and Best Practices

- Review usage together with operational requirements. A plan can appear complete from a billing perspective while still lacking monitoring, audit, or risk-management details.

- Start with **The whole plan at a glance** before reading individual sections. This gives you the context needed to judge whether a requirement belongs in the current plan or should be handled in a later phase.

- Treat **Commercial Readiness — Stripe, credits, plans, enterprise** as a cross-functional review area. You may need input from billing, finance, customer operations, and enterprise stakeholders before confirming readiness.

- Use **📊 Monitoring & Audit** to verify that the plan accounts for ongoing operational visibility, not only initial implementation. Capacity and usage decisions are easier to manage when monitoring expectations are explicit.

- Pay close attention to **Compounding operational risks**. Small manual processes or unclear ownership can become significant issues as plan usage increases.

- Use **Preview** before sharing or publishing. Previewing helps you catch formatting, wording, and completeness issues in the version that stakeholders will see.

- Use **Share Preview Link** for feedback before selecting **Review & Publish**. This gives reviewers an opportunity to validate requirements without changing the plan directly.

- If the plan includes phased delivery, use **Phase plan to perfect it — across all three surfaces** to distinguish immediate operational requirements from improvements planned for later phases.

## Related Pages

- [Review and Publish a Plan](#)
- [Share a Plan Preview](#)
- [Manage Billing Plans](#)
- [Define Commercial Readiness Requirements](#)
- [Set Up Monitoring and Audit Requirements](#)
- [Review Implementation Plans](#)

## Troubleshooting

### You cannot find the usage or capacity information you need

Review the plan sections most likely to contain supporting details, including **Billing**, **Commercial Readiness — Stripe, credits, plans, enterprise**, and **Implementation Plan**. If the required assumptions are not present, return to the plan review process and request that the plan owner add or clarify them before publication.

### The plan has operational risks but no clear mitigation

Review **Compounding operational risks** together with **📊 Monitoring & Audit**. Identify the missing owner, monitoring activity, audit expectation, or implementation task, then have the plan updated before you select **Review & Publish**.

### Stakeholders need to review the plan before it is published

Click **Preview** to check the presentation, then click **Share Preview Link** to provide stakeholders with access to the preview. Wait for required feedback and approvals, then return with **Back to Review** before publishing.

<!-- source: configure-single-sign-on.md -->

# Configure Single Sign On

This page explains how to verify whether single sign-on (SSO) configuration is available in Atloria’s current administrator security experience. SSO helps you manage member access through your organization’s identity provider, but the currently available Security screen does not show SSO-specific setup fields or identity-provider controls.

## Overview

Single sign-on lets organization members sign in using an identity provider managed by your company. Administrators typically use SSO to centralize access policies, reduce password management, and ensure that access is removed when a member leaves the organization.

In the current Atloria Security experience, you can review security-related configuration and implementation information. The screen includes items such as **Security**, **Privacy**, **Infrastructure Security**, and **Application Security & Access Control**. It also displays a status reading **2. Configured** and provides **Configure →** actions.

However, the available screen evidence does not show fields for an SSO provider, sign-in domain, metadata URL, certificate, client identifier, or member-enforcement settings. Do not assume that the visible **Configure →** action configures SSO unless the next screen explicitly presents SSO settings.

> 📷 _Screenshot pending: The Security screen showing the Security and Privacy sections, the “2. Configured” status, and available Configure actions._

## Prerequisites

Before you begin, make sure you have the following:

- Administrator access to your Atloria organization.
- Authorization from your organization to manage member authentication settings.
- The name of the identity provider your organization intends to use, such as Microsoft Entra ID, Okta, Google Workspace, or another supported provider.
- Your identity provider’s SSO configuration details, if Atloria provides an SSO setup screen in your environment.
- A documented recovery method for administrators before requiring SSO for all members.
- A test member account that can be used to confirm the sign-in experience without risking administrator access.

## Step-by-Step Instructions

1. Open the **Security** area in the Atloria administrator experience.

2. Review the status shown as **2. Configured** to understand that some security-related items are already configured.

3. Select **Configure →** only when it is associated with the security item you want to review.

4. Check the screen that opens for a section explicitly named **Single Sign On**, **SSO**, **Identity Provider**, or a similar authentication label.

5. Stop the configuration process if the screen does not display an SSO-specific option.

6. Do not use **Configure CI/CD** to configure member sign-in, because this action is labeled for CI/CD configuration rather than authentication.

7. Review **Application Security & Access Control** for access-control information that may affect organization member authentication.

8. Review **Privacy** when you need to understand privacy-related considerations for organization or member data.

9. Record the current security settings before requesting or enabling an SSO configuration feature.

10. Contact your Atloria administrator or support channel to request SSO setup guidance if no SSO-specific controls appear.

> 📷 _Screenshot pending: A future SSO configuration screen, showing the provider selection and required identity-provider fields, if this feature is made available._

## Tips and Best Practices

- Use the label on each action to determine its purpose. For example, **Configure CI/CD** is intended for continuous integration and delivery setup, not member authentication.
- Treat **2. Configured** as a status indicator for existing security configuration. It does not, by itself, confirm that SSO is enabled.
- Review the available security information before changing organization access practices. The Security area includes topics such as **Infrastructure Security**, **Application Security**, **Network Security**, **Kubernetes Security**, and **Database Security**.
- Keep at least one administrator recovery process outside the normal member sign-in flow. This helps prevent lockout if an identity-provider configuration is incomplete or unavailable.
- Test SSO with a non-critical user account before asking all organization members to use it.
- Do not share identity-provider secrets, certificates, or administrative credentials in general support messages. Use your organization’s approved secure support process.

## Related Pages

- [Security Overview](#)
- [Privacy](#)
- [Application Security & Access Control](#)
- [Infrastructure Security](#)
- [Security & Trust Findings](#)
- [Manage Organization Members](#)

## Troubleshooting

### No SSO option appears after selecting **Configure →**

The available Security screen does not currently show an SSO-specific setup option. Return to **Security**, confirm that you selected the relevant configuration action, and request assistance from your Atloria administrator or support channel. Include the name of the screen and the actions you can see.

### You see **Configure CI/CD** but need to manage member sign-in

Do not use **Configure CI/CD** for SSO. This option is labeled for CI/CD configuration and is not evidence of an authentication setup workflow. Look for an option explicitly labeled **Single Sign On**, **SSO**, or **Identity Provider**.

### You are unsure whether SSO is already enabled

Do not rely only on the **2. Configured** status. Confirm SSO only when you can view a dedicated SSO setting or when your organization has validated the sign-in process with its identity provider.

<!-- source: inspect-organization-audit-activity.md -->

# Inspect Organization Audit Activity

Use the organization’s **Activity Feed** to review administrative and workspace-related activity. Regular review helps you maintain oversight of security-sensitive changes and identify items that may require follow-up.

## Overview

Atloria groups security and privacy information in the workspace administration area. From the workspace sidebar, you can open **Security** and review the available security content, including **Activity Feed** and **Monitoring & Audit** information.

The activity area is useful when you need to understand what has occurred in the workspace during the current review session. Use it as part of routine security oversight, especially after administrative changes, access reviews, or updates to workspace settings.

The Security area also presents broader context through **Security & Trust Findings**. These findings include sections such as **Infrastructure Security Architecture**, **Network Security**, **Kubernetes Security**, **Database Security**, and **Application Security & Access Control**. Review these sections alongside activity information when you need a fuller picture of the organization’s security posture.

## Prerequisites

Before you begin, make sure that:

- You can sign in to the Atloria workspace you want to review.
- You have access to the workspace administration and security areas.
- You know which workspace activity or administrative change you are investigating.
- You have access to any internal review process your organization uses for security and privacy oversight.

## Step-by-Step Instructions

1. Open the workspace that you want to review.

2. Locate the **Workspace Sidebar**.

3. Select **Security** in the workspace sidebar.

   > 📷 _Screenshot pending: The Workspace Sidebar with the Security option selected._

4. Review the **Security & Trust Findings** area to confirm that you are viewing the workspace security information.

5. Select **Activity** to open the activity-related content.

6. Locate the **Activity Feed** section.

   > 📷 _Screenshot pending: The Activity Feed shown within the Security area._

7. Review the entries shown in the **Activity Feed**.

8. Read **What shipped — beyond the report (this session's audits)** when you need to understand the audit-related information presented for the current session.

9. Open **Monitoring & Audit** to review the monitoring and audit context available in the Security area.

10. Review **Infrastructure Security Architecture** when the activity you are investigating may relate to infrastructure controls.

11. Review **Network Security** when you need context about network-related security protections.

12. Review **Kubernetes Security** when your investigation concerns container or cluster security.

13. Review **Database Security** when you need to consider data storage or database protections.

14. Review **Application Security & Access Control** when the activity may involve application permissions or access controls.

15. Select **Privacy** if you need to continue your review with Atloria’s privacy information.

## Tips and Best Practices

- Start with **Activity Feed** when you have a specific administrative or workspace event to review. It is the most direct security-area entry point for activity oversight.

- Review the activity information together with **Security & Trust Findings**. Activity shows what you are reviewing, while the findings provide security context through areas such as **Monitoring & Audit** and **Application Security & Access Control**.

- Use **What shipped — beyond the report (this session's audits)** as a session-focused review point. Because the label refers to “this session’s audits,” revisit it when starting a new review session rather than relying on a prior session’s view.

- When an item appears relevant to more than one security domain, check each applicable section. For example, an access-related concern may warrant review of both **Application Security & Access Control** and **Database Security**.

- Include activity review in your regular administrative routines. Reviewing security and workspace activity after significant changes helps you identify concerns while the related work is still current.

- Use **Privacy** as a companion area when your review involves privacy obligations or the handling of organization information.

## Related Pages

- [Privacy](/privacy)
- [Security and Trust Findings](#overview)
- [Monitoring and Audit Review](#step-by-step-instructions)

## Troubleshooting

### You cannot find the Security area

Return to the **Workspace Sidebar** and look for **Security**. If the option is not available, confirm that you are in the intended workspace and contact your workspace administrator to verify your access.

### You cannot find Activity or Activity Feed

Open **Security** first, then select **Activity**. The activity information is presented as **Activity Feed** within the security-related content.

### You need more context for an activity item

Review **Monitoring & Audit** and the relevant security finding area, such as **Network Security**, **Database Security**, or **Application Security & Access Control**. If the item concerns privacy handling, continue to **Privacy** for related information.

<!-- source: manage-privacy-and-data-requests.md -->

# Manage Privacy and Data Requests

Use the Privacy area to review privacy-related information and respond consistently to organizational questions about data protection. This helps you provide approved, evidence-based answers without guessing or sharing unsupported details.

## Overview

Privacy and data requests can include questions about how organizational information is protected, where security controls apply, and which data-protection topics are covered by your organization’s published materials. In Atloria, you can begin from the **Security** area and select **Privacy** to access the privacy information available to your organization.

The Privacy experience is intended to support clear, grounded responses. Security and trust content distinguishes between **In-scope questions — grounded, cited (samples from the live run)** and **Out-of-scope questions — refused, not fabricated**. When you receive a request, use the available privacy and security information to answer only what is supported.

For broader data-protection questions, you may also need to review related security topics, such as **💾 Data Protection**, **Infrastructure Security Architecture**, **🗄️ Database Security**, or **Application Security & Access Control**. Use these areas to understand the context before responding to a requester.

> 📷 _Screenshot pending: The Security area showing the Privacy action used to open privacy information._

## Prerequisites

Before you begin, make sure you have:

- Access to the administrator security area.
- A clear copy of the privacy or data-related question you need to answer.
- Permission to view your organization’s security and trust information.
- Any internal approval guidance required for responding to privacy requests.
- Enough context to determine whether the question is in scope for the available privacy and security materials.

## Step-by-Step Instructions

1. Open the **Security** area in the administrator experience.

2. Select **Privacy** from the available security actions.

3. Review the privacy information presented on the Privacy screen.

4. Compare the requester’s question with the available privacy information.

5. Check **💾 Data Protection** when the question concerns protection of organizational data.

6. Review **Infrastructure Security Architecture** when the question concerns the environment supporting organizational systems.

7. Select **🗄️ Database Security** when the request concerns database protections or database-related security.

8. Review **Application Security & Access Control** when the question concerns application access, permissions, or security controls.

9. Check **🛡️ Network Security** when the requester asks about network-level protections.

10. Review **🔐 Kubernetes Security** when the question concerns container or Kubernetes security.

11. Use **In-scope questions — grounded, cited (samples from the live run)** as the standard for questions supported by the available materials.

12. Treat questions matching **Out-of-scope questions — refused, not fabricated** as unsupported by the available information.

13. Prepare a response using only information that is supported by the Privacy and Security & Trust content you reviewed.

14. Escalate the request through your organization’s approved process when the requested information is not available or requires an authorized decision.

> 📷 _Screenshot pending: Privacy and security trust topics, including Data Protection, Database Security, and Application Security & Access Control._

## Tips and Best Practices

- **Answer only supported questions.** Follow the approach indicated by **In-scope questions — grounded, cited (samples from the live run)**. Use information that is available in the Privacy and Security areas rather than relying on assumptions.

- **Do not fabricate answers for unsupported requests.** If a request falls outside the available materials, follow the standard represented by **Out-of-scope questions — refused, not fabricated**. Explain that you cannot confirm the requested detail and use your organization’s escalation process.

- **Match the topic to the right security area.** For example, use **💾 Data Protection** for data-protection questions, **🗄️ Database Security** for database questions, and **Application Security & Access Control** for questions about access controls.

- **Use the broad security context when needed.** A question may involve more than one topic. Review **Infrastructure Security Architecture**, **🛡️ Network Security**, and **🔐 Kubernetes Security** when a requester needs a fuller explanation of the applicable security context.

- **Keep administrative settings separate from request responses.** Select **Manage in Settings** only when you need to manage settings. Do not change settings merely to answer a privacy question.

- **Use published information consistently.** Provide the same evidence-based answer for similar requests so that privacy communications remain reliable across your organization.

## Related Pages

- [Review Security and Trust Findings](#)
- [Manage Data Protection Information](#)
- [Review Application Security and Access Control](#)
- [Review Database Security](#)
- [Manage Security Settings](#)
- [Manage Screenshots](#)

## Troubleshooting

### You cannot find the Privacy option

Return to the administrator **Security** area and look for the **Privacy** action. If it is not available, confirm that you have access to the security administration experience with your organization’s administrator.

### The request is not covered by the available privacy information

Do not create an answer from assumptions. Treat the request as out of scope, consistent with **Out-of-scope questions — refused, not fabricated**, and escalate it through your approved privacy, legal, security, or compliance process.

### You are unsure which security topic applies

Start with **💾 Data Protection** for general data-related questions. Then review **🗄️ Database Security**, **Application Security & Access Control**, **🛡️ Network Security**, or **Infrastructure Security Architecture** based on the specific wording of the request.

<!-- source: administer-enterprise-features.md -->

# Administer Enterprise Features

This page explains how to locate and review Atloria’s enterprise-related resources so you can prepare your organization for enterprise planning, security review, and rollout. Use these controls to keep enterprise decisions aligned with commercial readiness and access-control needs.

## Overview

Atloria groups enterprise-oriented resources around the **Enterprise** area and the broader **Atloria Stack**. These resources help you assess whether your organization is ready to support an enterprise customer, including commercial planning, security expectations, access control, and platform availability considerations.

You typically use these controls when you are preparing for an enterprise pilot, reviewing a contract opportunity, or coordinating a rollout across business and technical stakeholders. The available enterprise materials include **Commercial Readiness — Stripe, credits, plans, enterprise**, **Checklist — sell to an enterprise (pilot + contract)**, and **🔒 Enterprise Security**.

Enterprise administration is a review and coordination activity. Before you roll out enterprise capabilities, use the available checklists and gap analyses to identify open decisions, assign ownership, and confirm that the intended plan and governance approach meet your customer’s requirements.

> 📷 _Screenshot pending: The Enterprise action and Atloria Stack action in the Atloria interface._

## Prerequisites

Before you begin, make sure you have:

- Access to the Atloria workspace where the **Enterprise** action is available.
- Permission to view organization planning, security, and enterprise-readiness materials.
- A defined enterprise use case, such as a pilot, contract discussion, or broader customer rollout.
- The stakeholders who can make decisions about commercial terms, access control, security, and availability.
- A list of the customer’s requirements, including any security, governance, or uptime expectations.

## Step-by-Step Instructions

1. Select **Enterprise** to open the enterprise-focused resources available in Atloria.

2. Select **Commercial Readiness — Stripe, credits, plans, enterprise** to review the commercial considerations that may affect your enterprise plan.

3. Review the plan, credit, and enterprise-readiness information shown in the commercial readiness resource.

4. Select **Checklist — sell to an enterprise (pilot + contract)** to open the enterprise sales and rollout checklist.

5. Review each checklist item with the stakeholders responsible for the pilot or contract.

6. Record the decisions your organization needs before committing to the enterprise rollout.

7. Select **🔒 Enterprise Security** to review the security topics relevant to enterprise customers.

8. Compare the security expectations in the resource with the customer’s stated security requirements.

9. Select **Cluster A — Enterprise &amp; Access Control (Lane ①)** to review enterprise access-control considerations.

10. Identify the access-control decisions that must be agreed before users are invited or granted access.

11. Select **High Availability Features** to review availability-related capabilities that may be relevant to the planned rollout.

12. Confirm whether the customer’s availability expectations require additional planning or stakeholder approval.

13. Select **Atloria Stack** to return to the broader set of Atloria platform resources.

14. Select **Gap analysis — Atloria vs Lane 1** to review one available comparison of Atloria’s enterprise positioning.

15. Select the other available gap-analysis entries, such as **Gap analysis — Atloria vs Lane 2**, **Gap analysis — Atloria vs Lane 3**, and **Gap analysis — Atloria vs Lane 4**, when they apply to your evaluation.

16. Review **Gap analysis — Atloria's S0–S5 vs the lane** to compare maturity or stage expectations against the selected lane.

17. Use the **Search tools, features, classes...** field to find a specific enterprise topic when you do not know where it is located.

> 📷 _Screenshot pending: Enterprise resources showing Commercial Readiness, the pilot and contract checklist, Enterprise Security, and access-control materials._

## Tips and Best Practices

- Start with **Checklist — sell to an enterprise (pilot + contract)** when you are working toward a customer commitment. It provides a practical starting point for coordinating pilot and contract work.
- Review **Commercial Readiness — Stripe, credits, plans, enterprise** before making promises about commercial arrangements. This helps ensure that plan and credit considerations are reviewed alongside the enterprise opportunity.
- Treat **🔒 Enterprise Security** and **Cluster A — Enterprise &amp; Access Control (Lane ①)** as required review areas for enterprise rollouts, not as last-minute checks.
- Use the gap-analysis materials to identify differences between Atloria and the lane you are evaluating. Review every lane that is relevant to your target customer or rollout model.
- Include availability discussions early by reviewing **High Availability Features**. Availability expectations can affect rollout scope and stakeholder decisions.
- Use **Search tools, features, classes...** when you need to locate a known topic quickly instead of navigating through multiple resource areas.
- Keep enterprise decisions documented outside the review materials according to your organization’s governance process. The enterprise resources help guide review; your organization should still maintain its own approvals and decision records.

## Related Pages

- [Commercial Readiness — Stripe, credits, plans, enterprise](#)
- [Checklist — sell to an enterprise (pilot + contract)](#)
- [🔒 Enterprise Security](#)
- [Cluster A — Enterprise &amp; Access Control (Lane ①)](#)
- [High Availability Features](#)
- [Gap analysis — Atloria vs Lane 1](#)
- [Atloria Platform](#)

## Troubleshooting

### You cannot find an enterprise topic

Use the **Search tools, features, classes...** field and enter a distinctive word from the topic name, such as “security,” “availability,” “credits,” or “access control.” If the topic still does not appear, confirm that you have access to the workspace containing the enterprise resources.

### The Enterprise action is not available

Confirm that you are signed in to the correct Atloria workspace and that your account has the required access. If the action remains unavailable, contact your Atloria administrator to request access to enterprise planning resources.

### You are unsure which gap analysis to review

Start with the lane that most closely matches your current evaluation. If multiple lanes apply, review each relevant entry and then use **Gap analysis — Atloria's S0–S5 vs the lane** to compare the results against the maturity or stage model.

<!-- source: use-test-fixtures.md -->

# Use Test Fixtures

Test fixtures give you a known, repeatable project source to use when validating connection, analysis, and documentation results. They help you separate configuration problems from differences in a live repository.

## Overview

A test fixture is a controlled set of source material used for development testing. Because the source is known, you can run the same test more than once and compare the results with confidence. Use fixtures before testing against a production repository, after changing a provider connection, or when investigating unexpected documentation output.

Fixtures are especially useful for validating that Atloria identifies common application areas consistently. A fixture may include frontend components, backend services, database-related items, API schemas, configuration, documentation, and infrastructure content. During analysis, these areas are organized through stages such as **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**.

Use a fixture as your baseline. First confirm that the fixture connection and analysis work as expected. Then, if a live project behaves differently, you can focus on the differences in the live project rather than retesting your entire Atloria setup.

> 📷 _Screenshot pending: Development testing view showing a fixture project and available test actions._

## Prerequisites

Before you begin, make sure you have:

- Access to the Atloria project setup and testing screens.
- A test fixture prepared or assigned by your development-testing administrator.
- Access to the fixture’s configured Git provider, if the fixture is provider-based.
- Permission to use **Connect Provider** and complete provider selection.
- The correct provider credentials or authorization available for the fixture.
- A clear expected result for the test, such as successful connection, successful agent test, or generated documentation that can be reviewed.
- A documented baseline for comparison if you are repeating an existing test.

## Step-by-Step Instructions

1. **Open the fixture project or create a dedicated test project.**

   Use a project reserved for development testing rather than a live production project. In the project setup flow, select **Connect Provider** to begin connecting the fixture source.

   If you are reviewing an existing test project, confirm that it is clearly named as a fixture or test project before continuing. This helps prevent you from generating or exporting documentation from the wrong source.

2. **Select the fixture’s Git provider.**

   On the provider-selection step, choose the provider that hosts the fixture. The screen identifies this stage as **Git Providers** and may display a numbered step such as **1. Provider Selection** or **4. Provider Selection**.

   Select the configured provider and complete the authorization requested by your organization. A fixture should use the same provider configuration each time you repeat a test unless you are specifically testing provider behavior.

3. **Verify the provider connection.**

   Click **Test Connection** after selecting or configuring the provider. If your screen presents the action with an icon, it may appear as **⚡ Test Connection**.

   Wait for the test to complete before changing any other setting. Record whether the connection succeeded and, if relevant, the date, provider, and fixture project used. A successful connection confirms that Atloria can reach the fixture source; it does not yet confirm that the source can be analyzed successfully.

4. **Test the analysis agent.**

   Click **Test Agent** to verify that the analysis process can work with the fixture. Use the same fixture version for repeated tests so that changes in results are easier to identify.

   If your testing workflow includes an event-based connection, click **⚡ Test Webhook** as well. This confirms that the configured test event can reach Atloria. Do not treat a webhook test as a replacement for **Test Agent**; each action validates a different part of the testing workflow.

5. **Generate documentation from the fixture.**

   After the connection and agent tests succeed, select **Generate Documentation →**. Keep the test focused: use the same fixture and settings when you are validating repeatability.

   As Atloria analyzes the fixture, review whether the resulting documentation reflects the expected categories. For example, a full application fixture can produce documentation covering frontend elements, backend logic, database-related content, API schema details, configuration, and documentation material.

6. **Review the generated result.**

   Select **View Your Documentation →** to open the generated documentation. Compare the result with your expected baseline.

   When source review is available, use **View Source** or **Source** to inspect the source context associated with the generated result. This is useful when a documented item appears incomplete or unexpected: you can verify whether the fixture contains the expected source material before assuming that the result is incorrect.

   > 📷 _Screenshot pending: Generated documentation with the “View Source” and “Source” actions available for fixture-result review._

7. **Record and repeat the test.**

   Record the fixture name or version, provider used, test actions completed, and outcome. For a repeatability check, run the same fixture again without changing the source or setup. Compare the documentation result, including its identified categories and relationships, against the prior baseline.

   If the results are consistent, the fixture has provided a successful repeatable test. If they differ, use the comparison to determine whether the change came from the fixture, provider configuration, analysis environment, or documentation settings.

## Tips and Best Practices

- **Keep fixtures stable.** Do not change fixture source content while you are validating repeatability. If the source changes, treat it as a new fixture version and create a new baseline.

- **Use fixtures before live repositories.** A fixture is the safest place to test provider selection, connection checks, agent behavior, webhook delivery, and documentation generation without introducing live-project variation.

- **Test one change at a time.** For example, if you change provider credentials, test the connection first. Do not also change the fixture source or documentation settings in the same run.

- **Use the correct test action for the question.** Choose **Test Connection** to confirm access, **Test Agent** to confirm analysis readiness, and **⚡ Test Webhook** to confirm event delivery.

- **Review source when output is unexpected.** Use **View Source** or **Source** during result review. This helps you determine whether a missing or unusual documentation item is absent from the fixture or was not represented as expected.

- **Export only reviewed results.** Select **Export Documentation** only after you have reviewed the generated fixture documentation and confirmed that it is clearly marked as test output.

## Related Pages

- [Connect a Git Provider](#)
- [Test a Provider Connection](#)
- [Test Agent Access](#)
- [Test Webhook Delivery](#)
- [Generate Documentation](#)
- [Review Generated Documentation](#)
- [Export Documentation](#)

## Troubleshooting

### The fixture cannot connect to its provider

**Problem:** **Test Connection** or **⚡ Test Connection** does not succeed.

**Cause:** The selected Git provider, authorization, or fixture repository access may not match the configured test fixture.

**Solution:** Return to **Connect Provider**, confirm the correct choice under **Git Providers**, and repeat provider authorization if required. Then run **Test Connection** again before attempting **Test Agent** or **Generate Documentation →**.

### The connection succeeds, but the fixture cannot be analyzed

**Problem:** **Test Connection** succeeds, but **Test Agent** does not complete successfully.

**Cause:** Provider access confirms that Atloria can reach the fixture, but the analysis test may still be unable to process the selected fixture source or its current configuration.

**Solution:** Confirm that you are using the intended fixture version and that it has not changed since the baseline was recorded. Run **Test Agent** again, then review the fixture setup. If the workflow uses events, also run **⚡ Test Webhook** and provide the recorded test results to your development-testing administrator.

### Generated documentation differs from the previous fixture result

**Problem:** The documentation generated from the same fixture does not match the baseline.

**Cause:** The fixture source, provider configuration, analysis settings, or generated-documentation state may have changed between tests.

**Solution:** Use **View Your Documentation →** to compare the output, then select **View Source** or **Source** to confirm the source context. Verify the fixture version and test setup against your recorded baseline. If the source and setup are unchanged, record the difference and escalate it with the fixture name, test date, and completed test actions.

<!-- source: run-documentation-tests.md -->

# Run Documentation Tests

Documentation tests help you verify that generated and maintained documentation remains complete, consistent, and ready to publish. This page explains how to prepare a documentation test run, review the results, and understand how the `__tests__` areas are organized in your development workspace.

## Overview

Documentation testing is used when you need to confirm that documentation-related changes still produce the expected output. Run these checks before sharing updated manuals, exporting documentation, or treating generated content as ready for reviewers.

In Atloria, documentation work commonly moves from generation to review and publication. You can begin the documentation workflow with **Generate Documentation →**, review the resulting material, and use **Export Documentation** when the content is ready for use outside Atloria. Tests provide an additional quality check during this process by identifying issues before documentation is considered complete.

The `__tests__` areas are organized alongside the parts of the project they validate. This keeps each set of documentation tests close to the feature, screen, or workflow it covers. When you review a failed result, use the test name and its related documentation area to identify what needs attention rather than treating all test results as one undifferentiated list.

> 📷 _Screenshot pending: The documentation testing workspace showing available test groups, run controls, and result status._

## Prerequisites

Before you start, make sure you have the following:

- Access to the Atloria development-testing environment for your organization.
- Permission to view and run documentation test results.
- A documentation update, generated draft, or testable project version to validate.
- Any required project dependencies or test environment setup completed by your development team.
- A clear understanding of whether you are testing generated documentation, imported documentation, or documentation templates.
- A browser session signed in to the appropriate Atloria workspace.

## Step-by-Step Instructions

1. Open your Atloria development-testing workspace.

2. Select the documentation test area for the project or documentation update you want to validate.

3. Review the available `__tests__` groups to identify the tests associated with the documentation area you changed.

4. Select the test group that matches the feature, documentation template, or generated document you need to check.

5. Confirm that the selected test group is associated with the correct project version or documentation draft.

6. Start the documentation test run using the available run control in your testing workspace.

7. Wait for the test run to finish before reviewing individual results.

8. Review the overall result status to determine whether the documentation test run passed or reported failures.

9. Select a failed result to view the test name and the documentation behavior that did not meet expectations.

10. Compare the failed result with the corresponding documentation content, template, or generation settings.

11. Correct the identified documentation issue in the appropriate authoring or generation workflow.

12. Run the affected documentation test group again after making the correction.

13. Repeat the review and correction process until the applicable tests pass.

14. Select **Generate Documentation →** if you need to regenerate documentation after correcting an issue.

15. Review the generated output before treating it as ready for publication.

16. Select **Export Documentation** only after the relevant documentation tests have passed and the output has been reviewed.

> 📷 _Screenshot pending: A completed documentation test run with passed and failed result indicators and an expanded failure detail._

## Tips and Best Practices

- Run the smallest relevant `__tests__` group first. This helps you isolate a documentation issue quickly and avoids reviewing unrelated results.

- Use test names as your first clue when troubleshooting. Because tests are organized near the documentation area they validate, the result name should help you identify whether the issue concerns a template, generated content, navigation, or expected text.

- Test after meaningful documentation changes. Run tests after updating documentation templates, changing generated content, importing existing documentation, or revising user-facing labels.

- Generate documentation before final review when your change affects generated output. Select **Generate Documentation →** and then validate the resulting material with the appropriate tests.

- Do not export unverified output. Use **Export Documentation** only after reviewing successful results and confirming the documentation is appropriate for its intended audience.

- Keep documentation tests focused. A test group should verify one clear documentation behavior or outcome. Focused test groups are easier to understand, rerun, and maintain.

- Use **Documentation Templates** when a repeated structure or standard format is involved. Consistent templates make test results easier to interpret across multiple documents.

## Related Pages

- [Documentation Templates](#documentation-templates) — Learn how to use consistent document structures before testing output.
- [Generating Documentation](#generating-documentation) — Learn how to create or regenerate documentation with **Generate Documentation →**.
- [Export Documentation](#export-documentation) — Learn when and how to use **Export Documentation** after review.
- [Documentation Ready!](#documentation-ready) — Learn the final readiness checks for documentation that is prepared for publishing or sharing.

## Troubleshooting

### The documentation test run cannot be started

Verify that you are in the correct Atloria development-testing workspace and that you have permission to run tests. If the run control is unavailable, ask an administrator to confirm your access and the availability of the selected project version.

### A test fails after documentation was generated

Open the failed result and review the documentation behavior identified by the test. Correct the relevant content, template, or generation setting, then run the affected test group again. Do not rely on a previous successful run after changing documentation output.

### Tests pass, but the documentation still needs changes

A passing test confirms the behavior covered by that test; it does not replace editorial review. Review the generated documentation for clarity, audience suitability, and completeness before selecting **Export Documentation**.

<!-- source: set-up-your-documentation-workspace.md -->

# Set Up Your Documentation Workspace

Set up your Atloria workspace by creating a project, completing the available setup flow, and opening the project documentation area. This sequence gives you a focused place to organize documentation work before you share the project context with collaborators.

## Overview

Atloria organizes documentation work around projects. You start from the **Workspace Sidebar** or the **Projects** area, create a project, and then use the project’s setup experience to prepare its documentation workspace.

The setup flow helps you move from a newly created project to the documentation experience. Depending on your needs, you can select **Setup** to continue preparation, **Skip setup** to bypass the setup flow, or select **View Your Documentation →** when the documentation is ready to review.

Use this process whenever you are starting documentation for a new product, repository, service, or team initiative. After the project exists, you can return to the central project list through **← Back to Projects** or use **Open Project Dashboard** to work within the selected project.

> 📷 _Screenshot pending: The workspace project hub showing the Workspace Sidebar, Projects area, search field, and New Project button._

## Prerequisites

Before you begin, make sure you have:

- Access to the Atloria **Workspace**.
- Permission to create or manage projects in the workspace.
- The source or project details you want to document.
- A clear project name that your team can recognize in the **Projects** list.
- The names or contact details for collaborators who will review or contribute to the documentation.
- An understanding of whether you want to complete the guided **Setup** flow or use **Skip setup**.

## Step-by-Step Instructions

1. Open the **Workspace Sidebar**.

2. Select **Projects** to open the list of projects available in your workspace.

3. Review the project list to confirm that the documentation project does not already exist.

4. Enter a keyword in **Search projects...** if you need to locate an existing project before creating a new one.

5. Select **New Project** to begin creating a documentation project.

6. Enter the project details requested on the **New Project** screen.

7. Select **Create project** to add the project to the workspace.

8. Select the new project from the **Projects** list to make it the active project.

9. Confirm that you are working in the correct project by checking the project-focused area rather than the all-projects hub.

10. Select **Setup** to start the project setup experience.

11. Complete each available setup prompt using the project information you prepared before starting.

12. Select **View Your Documentation →** when the setup experience indicates that documentation is available.

> 📷 _Screenshot pending: The project setup experience showing Setup, Skip setup, View Your Documentation, and Open Project Dashboard actions._

13. Select **Open Project Dashboard** if you need to return to the project’s main working area instead of opening documentation immediately.

14. Select **← Back to Projects** when you need to return to the workspace-wide project list.

15. Open the project’s documentation area to verify that the new workspace is ready for documentation work.

16. Use **Export Documentation** when you need to create an exported copy of the project documentation for review or distribution.

17. Share the project name and documentation location with your collaborators so they can open the same project in Atloria.

18. Ask collaborators to confirm that they can find the project from **Projects** or by using **Search across all projects...**.

## Tips and Best Practices

- **Create one project per documentation scope.** Use a distinct project for each product, application, service, or repository you want to document. This keeps documentation, changes, versions, and analytics tied to the correct work.

- **Use recognizable project names.** A clear name makes the project easier to find through **Search projects...** and **Search across all projects...**, especially when your workspace contains many projects.

- **Complete setup before inviting broad review.** Use **Setup** first so the project has a consistent documentation starting point. When the documentation is ready, use **View Your Documentation →** to review what collaborators will see.

- **Skip setup only when appropriate.** Select **Skip setup** if the project is already prepared or if you need to reach the dashboard quickly. If you skip the guided flow, verify the documentation area before asking collaborators to begin work.

- **Keep collaborators aligned on the active project.** Atloria provides both a workspace-wide view and a project-focused view. Tell collaborators which project to open, rather than only referring to the overall workspace.

- **Use exports for formal review.** Select **Export Documentation** when stakeholders need a portable copy. Continue to use the project documentation area as the working source for updates and ongoing review.

- **Plan review around project changes and versions.** After the workspace is established, use the project’s change and version areas to help reviewers understand what has changed over time.

## Related Pages

- [Create a New Project](#)
- [Navigate the Workspace and Project Sidebars](#)
- [View Your Documentation](#)
- [Review Project Changes](#)
- [Compare Documentation Versions](#)
- [Export Documentation](#)

## Troubleshooting

### You cannot find the project you just created

1. Select **Projects** from the **Workspace Sidebar**.

2. Enter the project name in **Search projects...**.

3. Use **Search across all projects...** if you may be viewing a different project-focused area.

4. Confirm that you selected **Create project** after entering the requested project details.

### You are in the workspace but not in the correct project

1. Select **← Back to Projects**.

2. Locate the correct project in the **Projects** list.

3. Select the project to make it the active project.

4. Select **Open Project Dashboard** to continue working in that project.

### You skipped setup and cannot confirm that documentation is ready

1. Return to the active project.

2. Select **Setup** if it is available.

3. Complete the available setup prompts.

4. Select **View Your Documentation →** to verify the documentation area.

5. Use **Export Documentation** only after you have reviewed the documentation you intend to share.

<!-- source: build-a-documentation-hierarchy.md -->

# Build a Documentation Hierarchy

A clear documentation hierarchy helps people find the right information quickly. This page explains how to organize your documentation using categories, collections, and documents in Atloria.

## Overview

Your documentation hierarchy is the structure that groups related content together. Use it to separate broad subjects, such as Infrastructure or Security, from more specific collections and individual documents.

Start by creating top-level categories for major areas of knowledge. Within each category, use collections to group related documents by product area, process, team, or audience. Add individual documents at the lowest level, where readers can open and consume the detailed guidance.

For example, you might create an **Infrastructure** category, add a collection named **Infrastructure Security**, and place documents such as **Infrastructure Overview** inside that collection. This approach keeps broad topics visible while preventing the **Documents** list from becoming difficult to browse.

> 📷 _Screenshot pending: The Documents area showing the Structure option and organized documentation items._

## Prerequisites

Before you begin, make sure that you have:

- Access to the **Documents** area.
- A project selected if Atloria displays **Select a project to view documents**.
- Permission to create, edit, or delete documentation items in the selected project.
- A planned outline of your main categories and the documents that belong in each one.
- Existing documents available if you want to organize content that has already been created or imported.

## Step-by-Step Instructions

1. Open **Documents** from the application navigation.

2. Select the project that contains the documentation you want to organize.

3. Click **Structure** to open the documentation hierarchy view.

4. Review the existing categories, collections, and documents shown in the structure.

5. Create a top-level category for each major subject area you need to cover.

6. Name each category using a broad, recognizable topic, such as **Infrastructure**.

7. Add a collection inside the appropriate category.

8. Name the collection after the focused subject, process, product area, or audience it contains.

9. Add a document to the appropriate collection.

10. Give the document a specific title that tells readers what they will learn, such as **Infrastructure Overview**.

11. Repeat the collection and document steps until each document has a clear place in the hierarchy.

12. Move related documents into the same collection when they support the same task or topic.

13. Keep documents in separate collections when they serve different audiences or describe different areas of work.

14. Click **Save Structure** after you finish organizing the hierarchy.

> 📷 _Screenshot pending: The Structure view with categories, collections, documents, and the Save Structure button._

15. Return to the main document list when you want to verify that the organized content is easy to find.

16. Use the **Search documents...** field to locate a document by title after saving the structure.

17. Use **Search documents, categories, projects...** when you need to find content across a wider set of documentation items.

18. Click **← Back to Documents** when you are finished managing the hierarchy.

## Tips and Best Practices

- Use categories for long-lived, high-level topics. Categories should remain useful even as individual documents change over time.

- Use collections to make browsing easier. A collection should contain documents that readers are likely to need together.

- Keep document titles specific. A title such as **Infrastructure Overview** is easier to understand than a generic title such as “Overview.”

- Avoid placing every document directly under one category. Collections provide an important middle layer that prevents large categories from becoming cluttered.

- Organize documents by the reader’s task rather than by internal ownership alone. For example, a reader looking for security guidance should be able to find it under a meaningful collection such as **Infrastructure Security**.

- Save your work regularly. Changes made in the hierarchy are not complete until you select **Save Structure**.

- Use search to confirm your structure works. If you can find a document quickly by searching its title, category, or related project, your naming and organization are likely clear.

- Remove outdated content carefully. Use **Delete Documents** only after confirming that the documents are no longer needed and are not the only source of important guidance.

## Related Pages

- [Create a New Document](#)
- [Edit a Document](#)
- [Import Existing Documentation](#)
- [Search Documents, Categories, and Projects](#)
- [Export Documentation](#)
- [Manage Documentation Projects](#)

## Troubleshooting

### You cannot see any documents

If Atloria shows **Select a project to view documents**, select the appropriate project first. Documents and their hierarchy are displayed within the selected project context.

### Your hierarchy changes are not appearing

Return to **Structure** and confirm that you clicked **Save Structure**. If you leave the structure view without saving, your category, collection, or document placement changes may not be retained.

### You cannot find a document after organizing it

Use **Search documents...** to search by the document title. If you are unsure which project or category contains the document, use **Search documents, categories, projects...** and review the matching results.

<!-- source: publish-reader-ready-documentation.md -->

# Publish Reader Ready Documentation

This page explains how to prepare, review, and publish documentation for your target audience. Publishing makes your approved content available through the published documentation experience so readers can view the version you intend to share.

## Overview

Publishing is the final stage of preparing reader-ready documentation. Before you publish, you review the generated or imported content, choose the appropriate publishing settings, and confirm that the documentation is ready for its intended audience.

The publishing workflow shows clear progress states. Documentation starts in **3. Draft Ready**, moves through **Publishing** while the publish action is being completed, and displays as **Published** after it is available to readers. Use **Review & Publish** when you need to check content before release, and use **View Published Docs** after publishing to verify the reader experience.

You may publish a new release using **Publish Version 4** or **Publish Version**, depending on the versioning option shown in your workspace. If you need to remove a published release from reader access, use **Unpublish**.

> 📷 _Screenshot pending: The documentation publishing workflow showing Draft Ready, Publish Settings, Published Docs, and post-publish actions._

## Prerequisites

Before you begin, make sure you have the following:

- Documentation content that is ready for review, whether it was created through **Generate Documentation →** or added through **Or import existing documentation**.
- Access to the documentation project and the target audience’s documentation area.
- Content that has been checked for completeness, accuracy, and reader-friendly language.
- A decision about whether you are publishing the current documentation or creating a new version.
- Any required approval from your documentation owner, subject-matter expert, or release manager.

## Step-by-Step Instructions

1. Open the documentation project that contains the content you want to publish.

2. Select the target audience whose documentation you want to prepare for release.

3. Confirm that the documentation is in the **3. Draft Ready** stage.

4. Select **Review & Publish** to open the publishing review experience.

5. Review the documentation content for the intended audience.

6. Check that headings, explanations, and examples are understandable without internal project context.

7. Verify that technical sections are presented appropriately for the reader, such as documentation covering frontend, backend, database, API schema, configuration, documentation, or infrastructure topics.

8. Select **2. Publish Settings** to review the settings that control the release.

9. Confirm the version you want readers to receive.

10. Select **Publish Version 4** when that button is available for the release you are preparing.

11. Select **Publish Version** if your workspace displays the general version publishing option instead.

12. Select **✓ Approve & Publish** when you have completed the review and are ready to approve the release.

13. Select **Publish** to confirm publication if the screen asks for a final publishing action.

14. Wait while the documentation status changes to **Publishing**.

15. Confirm that the status changes to **Published** when publishing is complete.

16. Select **View Published Docs** to open the published reader view.

17. Review the published documentation as a reader would see it.

18. Select **🌐 View Published Docs** when available to open the published documentation in its reader-facing location.

19. Use **4. Published Docs Nav** to move through the published documentation and verify that key pages are available.

20. Complete the actions in **5 Post-Publish** after you have confirmed the release is correct.

> 📷 _Screenshot pending: The Review & Publish screen with Publish Settings, Approve & Publish, Publish Version, and publishing status controls._

## Tips and Best Practices

- Review content before selecting **✓ Approve & Publish**. Approval and publishing are presented together, so treat this action as the final confirmation that the version is suitable for readers.

- Publish documentation for a specific audience. Reader-ready content should use the terminology, depth, and examples that fit the people who will use it. For example, a reader who needs frontend guidance may not need the same level of database or infrastructure detail.

- Use the status labels to track progress. **3. Draft Ready** means the content is ready for your review. **Publishing** means the release is still being processed. **Published** means the release is available for readers.

- Always select **View Published Docs** after publication. This is the best way to catch reader-facing issues such as missing context, unclear navigation, or content that does not make sense outside the editing workflow.

- Publish a version intentionally. When **Publish Version 4** is shown, confirm that version 4 is the release you want readers to access. Do not publish a new version merely to test minor edits unless your documentation process allows it.

- Use **Export Documentation** when you need a copy of the documentation for review, sharing, archival, or use outside the published reader experience.

- Use **Unpublish** carefully. Unpublishing removes the published documentation from reader access. Confirm that readers have an alternative source before you remove a live release.

- If you are starting from existing material, select **Or import existing documentation** before beginning the review and publishing workflow. If you need Atloria to prepare initial content, start with **Generate Documentation →**.

> 📷 _Screenshot pending: The published documentation reader view opened from View Published Docs, showing reader navigation and published content._

## Related Pages

- [Generate Documentation](#) — Create documentation before beginning the review process.
- [Import Existing Documentation](#) — Bring existing documentation into your project.
- [Review Documentation Content](#) — Check documentation quality before approval.
- [Manage Documentation Versions](#) — Understand version-based publishing options.
- [Export Documentation](#) — Export documentation for external review or records.
- [Unpublish Documentation](#) — Remove a published release from reader access.

## Troubleshooting

### The documentation is not ready to publish

Confirm that the documentation has reached **3. Draft Ready**. If content is still incomplete, return to the documentation preparation process and finish the missing sections before selecting **Review & Publish**.

### The status remains Publishing

Wait until the status changes from **Publishing** to **Published** before treating the release as available to readers. If the status does not update, refresh the documentation workspace and check the publishing status again before attempting another publish action.

### Published documentation does not look correct

Select **View Published Docs** and review the reader-facing pages. If you find missing, inaccurate, or audience-inappropriate content, update the documentation, return to **Review & Publish**, and publish the corrected version. If the release must no longer be available, select **Unpublish** while you prepare the replacement.

<!-- source: analyze-a-connected-codebase.md -->

# Analyze a Connected Codebase

This page explains how to create a project from a connected source repository and use the resulting project workspace to understand its structure. Source analysis helps you turn a codebase into organized technical documentation that is easier to review, share, and maintain.

## Overview

When you connect a codebase to Atloria and create a project, Atloria analyzes the source to build an understanding of the application. The analysis identifies parts of the project such as frontend elements, backend services, database-related code, API schemas, configuration, documentation, and infrastructure.

You need this workflow when you are onboarding to an unfamiliar application, preparing technical documentation, or reviewing how parts of a project relate to each other. Rather than starting with individual files, you can begin from the project workspace and open the generated documentation through **Technical Docs**.

After a project is created, it becomes the active project in your workspace. From there, you can use project areas such as **Technical**, **Source**, versions, changes, analytics, and technical documentation to move between a high-level understanding and the supporting source material.

> 📷 _Screenshot pending: The Projects hub showing the New Project action and project search_

## Prerequisites

Before you start, make sure you have:

- Access to Atloria and permission to create or open projects.
- A source repository that you can connect to Atloria.
- Access to the repository provider you use, such as GitHub, GitLab, or Bitbucket.
- A repository or source URL ready to provide during project setup.
- A clear project name so you can find the project later in the **Projects** list.
- Enough time for Atloria to process the codebase before reviewing the generated technical documentation.

## Step-by-Step Instructions

1. **Open the Projects hub.**

   From your Atloria workspace, select **Projects**. The Projects hub is where you can view existing projects, switch your focus to a specific project, and begin creating a new one.

   If you already know the project name, use **Search projects...** to locate it. Use **Search across all projects...** when you need to search more broadly across the projects available to you.

2. **Start a new project.**

   Select **New Project**. Atloria opens the project-creation flow, where you provide the source location and project details.

   > 📷 _Screenshot pending: The New Project flow for connecting a repository source_

3. **Connect the source repository.**

   In the connection step, select the repository provider that hosts your codebase. Atloria supports repository connections represented by GitHub, GitLab, and Bitbucket options.

   Provide the repository source requested by the setup screen. Confirm that you are connecting the intended codebase, especially if your organization has similarly named repositories or multiple application versions.

4. **Create the project.**

   Enter the required project information, then select **Create project**. Atloria adds the repository as a project and begins building project understanding from the connected source.

   During analysis, Atloria organizes discovered code into categories. These categories progress through the codebase in a meaningful order:

   - **FRONTEND** for user-facing application code
   - **BACKEND** for server-side functionality
   - **DATABASE** for persistence-related code
   - **API SCHEMA** for interfaces and data contracts
   - **CONFIG** for project configuration
   - **DOCUMENTATION** for existing documentation content
   - **INFRASTRUCTURE** for deployment and environment-related resources

   This organization matters because it helps you review a connected application as a system rather than as an unstructured collection of files.

5. **Open the focused project.**

   After the project is available, open it from **Projects** or select **Open Project Dashboard**. The project dashboard is your starting point for the active project.

   If you need to return to the project list, select **← Back to Projects** or **&larr; Back to Projects**, depending on the screen you are viewing.

6. **Review the generated technical documentation.**

   In the focused project, select **Technical Docs**. This area presents the documentation built from the source analysis.

   Use the technical documentation to understand the important entities Atloria identifies in the project. Depending on the codebase, these can include components, hooks, pages, layouts, routes, contexts, providers, stores, controllers, services, repositories, and middleware.

   > 📷 _Screenshot pending: The Technical Docs area for a focused project, showing analyzed project documentation_

7. **Follow relationships from one part of the system to another.**

   Review how identified items relate to each other. For example, a component can render another component, or a component can use a hook. These relationships help you understand how a user-facing screen connects to the logic and services that support it.

   Start with the area that matches your goal. For a screen behavior, begin with frontend entities. For a data or server behavior, review backend, database, and API schema entities. This approach keeps your investigation focused while still allowing you to trace connections across the codebase.

8. **Check the source when you need confirmation.**

   Select **View Source** when you need to verify how a documented item is represented in the connected repository. You can use the **Source** area as supporting evidence while using **Technical Docs** as the primary high-level view.

   When your review is complete, select **Export Documentation** if you need to share the generated documentation outside Atloria.

## Tips and Best Practices

- **Create one project for each meaningful codebase.** A focused project makes its documentation easier to navigate and prevents unrelated applications from being analyzed together.

- **Begin with Technical Docs, not individual source files.** The documentation provides the project-level context first. Use **View Source** only when you need deeper detail or want to validate a specific conclusion.

- **Review the project by category.** Start with **FRONTEND** when documenting user experiences, then follow connections to **BACKEND**, **DATABASE**, and **API SCHEMA** as needed. This mirrors how application behavior commonly moves from the interface to supporting services and data.

- **Use relationships to avoid isolated analysis.** A component that renders another component or uses a hook is part of a larger flow. Reviewing these connections gives you a more reliable understanding than reading one entity alone.

- **Use versions and changes for ongoing projects.** After an initial analysis, project areas for versions and changes can help you review how the documented understanding evolves as the codebase changes.

## Related Pages

- [Create a New Project](#)
- [Navigate the Projects Hub](#)
- [Use Technical Docs](#)
- [Review Project Changes](#)
- [Compare Project Versions](#)
- [Export Documentation](#)

## Troubleshooting

### You cannot find the project after creating it

Return to **Projects** and use **Search projects...**. If you have access to many projects, try **Search across all projects...**. Confirm that you used the intended project name during creation.

### The documentation does not answer a specific implementation question

Open **Technical Docs** to locate the relevant entity, then select **View Source** to inspect the supporting source material. Follow related entities, such as components, hooks, services, or repositories, rather than reviewing only the first item you find.

### You connected the wrong repository

From the project workspace, return to **Projects** using **← Back to Projects**. Locate the incorrect project and use **Delete Project** if you have permission to remove it. Then select **New Project** and connect the correct repository before selecting **Create project**.

<!-- source: explore-entities-and-relationships.md -->

# Explore Entities and Relationships

Use the product model in **Technical Docs** to examine the entities that make up your application and the relationships between them. This helps you validate that technical documentation reflects how your product is actually structured and connected.

## Overview

Technical documentation is most useful when it explains more than isolated files or features. The product model helps you explore the important parts of an application—such as components, pages, layouts, services, repositories, stores, hooks, and routes—and understand how they relate to one another.

When you open **Technical Docs**, you can use the entity explorer to find a specific entity and review its connections. For example, you may want to confirm that a component renders another component, that a page uses a hook, that a service calls an API, or that a repository queries a model. Reviewing these relationships is a practical way to check whether generated or imported documentation describes the real technical design.

The model supports several types of entities, including **COMPONENT**, **HOOK**, **PAGE**, **LAYOUT**, **ROUTE**, **CONTEXT**, **PROVIDER**, **STORE**, **CONTROLLER**, **SERVICE**, **REPOSITORY**, and **MIDDLEWARE**. It also organizes findings into categories such as **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**.

> 📷 _Screenshot pending: The Technical Docs screen showing the entity search field and the product model tree._

## Prerequisites

Before you begin, make sure that:

- You have access to the relevant project in Atloria.
- Your project contains technical documentation or product-model information to review.
- You can open the **Technical Docs** area for the project.
- You know the feature, screen, service, or technical concern you want to validate.
- If documentation has not yet been created, you have generated it using **Generate Documentation →** or imported it using **Or import existing documentation**.

## Step-by-Step Instructions

1. Open your project’s **Technical Docs** area.

   Start from the project where you want to validate documentation. Select **Technical Docs** to work with the project’s technical documentation and product model.

   Depending on the state of your project, you may see options such as **Generate Documentation →**, **Or import existing documentation**, or **View Your Documentation →**. Generate or import documentation first if there is no model available to explore.

2. Locate the entity search field.

   In the entity explorer, select the field labeled **Search entities…** or **Search entities...**. The label may appear with either a typographic ellipsis or three dots.

   Enter a name or keyword related to the entity you need to inspect. For example, search for a page name, component name, service, hook, or store. Searching is especially helpful in larger projects where manually expanding categories would take time.

3. Select the entity you want to inspect.

   Choose the matching entity from the available results or from the product model tree. The model may organize entities by technical area, such as **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, or **INFRASTRUCTURE**.

   Use these categories to narrow your review:
   - Review **FRONTEND** for user-facing components, pages, layouts, hooks, contexts, providers, and stores.
   - Review **BACKEND** for controllers, services, repositories, and middleware.
   - Review **DATABASE** when you need to confirm model or data-access relationships.
   - Review **API SCHEMA** when validating how APIs are described across the application.

4. Review the entity type.

   Confirm that the selected item is classified correctly. For example, a reusable visual element should normally appear as a **COMPONENT**, while navigation-level content may be a **PAGE** or **LAYOUT**. Application logic may appear as a **HOOK**, **SERVICE**, **CONTROLLER**, or **REPOSITORY**.

   Correct classification matters because it gives readers context. A relationship from a **PAGE** to a **COMPONENT** means something different from a relationship between a **SERVICE** and a **REPOSITORY**.

5. Examine the relationships connected to the entity.

   Review the links shown for the selected entity. The product model can represent relationships such as:

   - **RENDRERS** — a component renders another component.
   - **USES HOOK** — an entity uses a hook.
   - **USES CONTEXT** or **PROVIDES CONTEXT** — an entity consumes or supplies shared context.
   - **USES STORE** or **DISPATCHES ACTION** — an entity interacts with application state.
   - **CALLS API** or **IMPLEMENTS API** — an entity consumes or provides an API.
   - **DEPENDS ON** — an entity relies on another entity.
   - **USES SERVICE** or **INJECTS** — an entity uses a service or dependency.
   - **QUERIES MODEL** — an entity accesses a data model.

   Check that each relationship tells a meaningful story about the selected entity. For example, a frontend component may **USES HOOK** and **CALLS API**, while a controller may **USES SERVICE**, and a repository may **QUERIES MODEL**.

6. Trace the relationship in both directions.

   Do not validate only one connection. Follow the connected entities to check whether the documented flow remains consistent. For instance, if a page is shown as using a component, confirm that the component is connected to the expected hook, context, store, or API behavior.

   This is useful for identifying incomplete documentation. A technical explanation may mention an API call, but the model can help you confirm which component, hook, or service initiates that call.

7. Compare the model with your technical documentation.

   Open the relevant technical documentation content and compare its explanations with the entity types and relationships you reviewed. Look for missing dependencies, incorrect ownership, or vague descriptions of how parts work together.

   If you are reviewing generated documentation, use the model as the grounding source for your validation. If you need a different presentation, use the available **StyleSelector** options before generating documentation again. You can also select **Export Documentation** when you need to share the reviewed documentation outside Atloria.

> 📷 _Screenshot pending: A selected entity showing its type and relationship links, such as USES HOOK, CALLS API, or QUERIES MODEL._

## Tips and Best Practices

- **Start with a user-facing entity.** Begin with a **PAGE**, **LAYOUT**, or **COMPONENT** when validating documentation for a feature. This gives you a clear entry point, then lets you trace toward hooks, stores, APIs, services, and data access.

- **Use relationship verbs as validation questions.** Treat each relationship as a question: “Does this component really **RENDRERS** this child component?” “Does this service actually **CALLS API**?” “Does this repository **QUERIES MODEL**?” This makes documentation reviews more specific and repeatable.

- **Check category boundaries.** A complete technical explanation often crosses categories. For example, a **FRONTEND** entity may call an endpoint described in **API SCHEMA**, which is implemented through **BACKEND** services and connected to **DATABASE** entities.

- **Distinguish implementation relationships from general dependencies.** Prefer precise relationships such as **USES HOOK**, **USES SERVICE**, or **QUERIES MODEL** when they are available. Use **DEPENDS ON** for a broader dependency that does not fit a more specific relationship.

- **Review the full chain, not just one link.** A single relationship can look correct while the overall flow is incomplete. For example, a component may call an API, but documentation should also explain the service or controller that implements the corresponding behavior where relevant.

- **Regenerate when the model changes.** If your application structure has changed, generate updated documentation using **Generate Documentation →** before relying on it for a review. A model-based review is most valuable when the documentation represents the current project.

## Related Pages

- [Generate Technical Documentation](#)
- [Import Existing Documentation](#)
- [Choose a Documentation Style](#)
- [Export Documentation](#)
- [Use API Explorer](#)

## Troubleshooting

### I cannot find the entity I need

Use **Search entities…** and try a shorter or more distinctive part of the name. If no result appears, check whether you are working in the correct project and whether technical documentation has been generated or imported.

### The relationships do not match what I expected

Review the connected entities and their types before concluding that the documentation is incorrect. A relationship may be represented through an intermediate entity—for example, a component may use a hook that calls an API rather than calling the API directly. Trace the full chain to validate the documented behavior.

### I only see options to generate or import documentation

Your project may not yet have documentation available to explore. Select **Generate Documentation →** to create documentation from the project, or select **Or import existing documentation** to bring in existing material. After documentation is available, return to **Technical Docs** and search for entities.

<!-- source: produce-an-api-reference.md -->

# Produce an API Reference

This page explains how to create developer-oriented API documentation in Atloria. An API reference gives technical teams a focused place to understand available API behavior and review supporting examples.

## Overview

Use the **API Reference** option in **Technical Docs** when you need documentation that explains an application’s API-facing functionality for developers, integrators, or technical support teams. This type of document is useful when readers need more context than a short feature description and benefit from examples alongside the reference content.

An API reference works best when it is part of a broader technical documentation set. Atloria’s technical documentation can cover application areas such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. Keep your API reference focused on the API-facing portion of that system so readers can find the information they need quickly.

You can add examples to make the reference more useful. Examples help readers connect the documented API behavior to realistic implementation scenarios.

## Prerequisites

Before you begin, make sure you have:

- Access to the relevant project in Atloria.
- Access to the project’s **Technical Docs** area.
- A clear API topic to document, such as a service integration, endpoint group, request flow, or schema-related feature.
- Technical context that you can use to verify the generated reference and its examples.
- Examples or scenarios you want developers to see in the finished documentation.

## Step-by-Step Instructions

1. Open the project where you want to create the documentation.

2. Select **Technical Docs** from the project workspace.

   > 📷 _Screenshot pending: The Technical Docs area within a project workspace._

3. Open the **Technical Docs** actions menu.

4. Select **API Reference**.

5. Review the API reference screen before generating content.

6. Select the available documentation style using the style selector.

7. Use the generate control to create the API reference content.

   > 📷 _Screenshot pending: The API Reference screen showing the style selector and generate control._

8. Review the generated reference for technical accuracy.

9. Select **Add examples** to include supporting examples.

10. Add an example that demonstrates a realistic developer task.

11. Select **Add code examples** when you need examples that show implementation-oriented context.

12. Review each example to confirm that it supports the API reference rather than repeating it.

13. Return to **Technical Docs** when you are ready to work on another document.

14. Select **Export Documentation** if you need to share the completed documentation outside Atloria.

## Tips and Best Practices

- Keep the reference centered on one API topic. A focused reference is easier for developers to scan and maintain than a document that combines unrelated integrations or services.

- Use examples deliberately. Select **Add examples** for contextual scenarios, and use **Add code examples** when an implementation-oriented illustration will help readers understand the documented behavior.

- Organize your supporting material according to the system area it describes. For example, distinguish API schema information from frontend behavior, database details, configuration, and infrastructure context.

- Explain relationships that affect how the API is used. For example, readers may need to understand whether a component calls an API, a service implements an API, or a system depends on another service.

- Check terminology before sharing the document. Consistent names for components, services, schemas, and API behavior make the reference easier to use across engineering teams.

- Use **Export Documentation** only after reviewing the generated content and examples. Exported documentation should be accurate enough for its intended audience.

## Related Pages

- [Create Technical Documentation](#)
- [Add Code Examples](#)
- [Export Documentation](#)
- [Create a Document](#)
- [Create Documentation Without a Repository](#)

## Troubleshooting

### You cannot find the API Reference option

Open **Technical Docs** and then open its actions menu. Look for **API Reference** rather than starting with a general document option such as **Create New Document**.

### Your reference does not include enough practical context

Select **Add examples** to add scenario-based material. If developers need implementation-focused guidance, select **Add code examples** and add an example that directly supports the reference topic.

### Your documentation covers too many unrelated technical areas

Separate the content by purpose. Keep API-facing material in the API reference, and place unrelated frontend, database, configuration, or infrastructure details in their appropriate technical documentation topics.

<!-- source: run-a-documentation-review-cycle.md -->

# Run a Documentation Review Cycle

A documentation review cycle helps you coordinate new content, reviewer feedback, approval, publishing, and version comparison in one repeatable process. Use this cycle whenever you need to confirm that a documentation version is ready to share or publish.

## Overview

Documentation work often moves through several stages: preparing a new version, reviewing its content, comparing it with earlier versions, incorporating feedback, and publishing the approved result. Atloria’s versioning and review tools help you keep those stages organized around the documentation version rather than managing separate copies outside the application.

You can begin from the **Versions** area, where you can generate or select a version to review. The review experience includes a **1 Review Summary** area for assessing the version, while the **Comparison** experience helps you inspect changes between versions before you approve a final version.

When your team is satisfied with the documentation, you can use **Publish Version 4** or **🚀 Publish Version 4** to make that version the published version. Publishing should be treated as the final approval step: compare the version, review outstanding feedback, and confirm that the selected version is the one you intend users to see.

> 📷 _Screenshot pending: The Versions screen showing available documentation versions and version-management actions._

## Prerequisites

Before you start a documentation review cycle, make sure you have:

- Access to the relevant project and its **Versions** area.
- A documentation version available for review, or permission to create one using **▶ Generate New Version** or **⚡ Generate Next Version**.
- A clear understanding of the documentation changes that need approval.
- Reviewer feedback or internal approval criteria for the version.
- Permission to publish if you will use **Publish Version 4** or **🚀 Publish Version 4**.
- An earlier version available if you need to use **Compare Versions** to validate changes.

## Step-by-Step Instructions

1. **Open the project’s version-management area.**

   In your project, select **Versions**. This is where you can view and manage documentation versions throughout the review cycle.

   If you are already working in another review-related area, select **🕘 Go to Version Manager** to return to the version list.

2. **Create or select the version to review.**

   If a suitable version already exists, select it and open its review experience. If you need a new version, select **▶ Generate New Version** or **⚡ Generate Next Version**.

   Use **⚡ Generate Next Version** when you want to continue the version sequence from the current documentation. This helps you keep review work associated with the correct iteration instead of overwriting or confusing earlier versions.

   In situations where AI-generated alternatives are available, you may see **Use V4 AI Version** or **Use All V4 AI Versions**. Select **Use V4 AI Version** to work with one suggested version, or select **Use All V4 AI Versions** when you need to bring all available Version 4 AI versions into the review process.

3. **Review the documentation content and context.**

   Open the selected version’s review area and use **1 Review Summary** to assess the version as a whole. Focus on whether the documentation is complete, accurate, understandable, and appropriate for its intended audience.

   If your content includes diagrams, verify that their rendered preview matches the written explanation. A diagram should clarify the process or relationship it describes; it should not introduce ambiguity or contradict the surrounding text.

   You may also encounter **7. Editor Version Context**. Use this context to confirm that you are reviewing the intended version and that your feedback applies to the correct documentation iteration.

   > 📷 _Screenshot pending: The Review screen with the 1 Review Summary area and documentation version context._

4. **Compare the version with an earlier version.**

   Select **Compare Versions** or open **Comparison**. Choose the versions you want to examine and review the differences carefully.

   Version comparison is especially useful when reviewers need to confirm that requested edits were made without removing previously approved information. Check for changed terminology, missing sections, altered diagrams, and content that may have been unintentionally duplicated.

   Treat comparison as a decision-making step, not just an editing check. If the newer version is less clear or omits approved material, return to the version-management or review workflow rather than publishing it.

5. **Incorporate review feedback and continue the cycle.**

   If the review identifies changes that are needed, return to the appropriate version workflow. You can use **Back to Review** from a related screen to continue evaluating the current version.

   If substantial changes are required, generate a subsequent version with **⚡ Generate Next Version**, then repeat the review and comparison steps. Keeping meaningful revisions in separate versions gives reviewers a clear audit trail of what changed between review rounds.

6. **Approve the final version for publishing.**

   Before publishing, confirm that the review feedback has been addressed and that the comparison results are acceptable. Verify that you are viewing the intended version number; the publish action specifically identifies the version, such as **Publish Version 4**.

   Select **Publish Version 4** or **🚀 Publish Version 4** to publish the approved documentation version. After publishing, use **View Your Documentation →** to view the published documentation from the user-facing perspective.

7. **Export or continue managing versions as needed.**

   If you need a copy for distribution or record keeping, select **Export Documentation**. To continue managing the project’s versions, select **Manage all versions →** or return to **Versions**.

## Tips and Best Practices

- **Compare before publishing.** Even when a version appears complete in **1 Review Summary**, use **Compare Versions** to catch accidental removals or changes that are easier to spot side by side.
- **Generate a new version for major revisions.** Use **⚡ Generate Next Version** when feedback results in a meaningful new review round. This preserves the earlier version for comparison and makes approval decisions easier to trace.
- **Review diagrams with their surrounding text.** Diagram previews should support the explanation. Check that labels, flow direction, and relationships are understandable to the intended audience.
- **Publish only the reviewed version.** The publish action includes the version number, such as **Publish Version 4**. Confirm the number before selecting it so that you do not publish an earlier or unintended iteration.
- **Use the published view as a final validation.** After publishing, select **View Your Documentation →** and review the result as a reader would.

> 📷 _Screenshot pending: The Comparison screen showing differences between two documentation versions before approval._

## Related Pages

- [Manage Documentation Versions](#) — Create, organize, and select documentation versions.
- [Compare Documentation Versions](#) — Review differences between two versions in detail.
- [Review and Publish Documentation](#) — Complete review checks and publish an approved version.
- [Export Documentation](#) — Export documentation for distribution or archival purposes.
- [Work with Documentation Screenshots](#) — Review and manage screenshots associated with a documentation version.

## Troubleshooting

### I cannot find the version I need to review

Open **Versions** or select **🕘 Go to Version Manager**. Confirm that you are in the correct project and look for the required version in the version-management list. If the needed changes have not yet been captured in a version, select **▶ Generate New Version** or **⚡ Generate Next Version**.

### I am not sure whether a version is ready to publish

Do not publish immediately. Review **1 Review Summary**, then select **Compare Versions** to check the current version against the previously approved version. If reviewer feedback is still unresolved or important content has changed unexpectedly, continue the review cycle instead.

### I selected the wrong version or need to return to review

Select **Back to Review** to return to the review experience. If you need to choose a different version entirely, use **Manage all versions →** or **🕘 Go to Version Manager**, then open the correct version before continuing.

<!-- source: maintain-fresh-documentation.md -->

# Maintain Fresh Documentation

Use project changes and documentation freshness signals to identify where your documentation needs attention. This helps you prioritize updates before outdated information affects readers.

## Overview

Atloria helps you maintain documentation as your project evolves. The Changes area is where you can review individual changes and use the available documentation signals to decide whether existing documentation should be updated, regenerated, or reviewed.

A freshness signal such as **1. Fresh (No Connections)** helps you understand the current documentation state for a change. Use this signal together with the change details: a change may be fresh because it has no documented connections yet, while a change connected to existing documentation may require a closer review after related work changes.

Changes can span several areas of a project, including **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**. When a change affects one of these areas, check whether the associated documentation still describes the current behavior and relationships accurately.

> 📷 _Screenshot pending: The project Changes page showing change records and documentation freshness signals._

## Prerequisites

Before you start, make sure you have:

- Access to the relevant Atloria project.
- Permission to review project changes and save documentation updates.
- A clear understanding of the change you are reviewing.
- Any required input from the people responsible for the affected frontend, backend, database, API schema, configuration, documentation, or infrastructure work.
- A decision about whether you will update the documentation directly, request changes, or generate documentation again.

## Step-by-Step Instructions

1. Open the project that contains the documentation you want to review.

2. Open the project’s **Changes** page.

3. Select the change you want to assess from the list of available changes.

4. Review the freshness signal shown for the selected change.

5. Identify whether the change is marked **1. Fresh (No Connections)**.

6. Review the change details to determine which project area is affected.

7. Check whether the change affects **DOCUMENTATION** directly.

8. Check whether the change affects a related area, such as **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, or **INFRASTRUCTURE**.

9. Compare the change with the documentation that users currently rely on.

10. Open **Documentation Hub** when you need to review the project’s existing documentation.

> 📷 _Screenshot pending: The Documentation Hub used to review existing documentation before making an update._

11. Select **View Your Documentation →** when you are ready to inspect the published or generated documentation.

12. Update the documentation content if the change makes the current explanation incomplete, inaccurate, or obsolete.

13. Select **Save Changes** after you complete your documentation updates.

14. Select **✎ Request Changes** if the change needs clarification or correction before the documentation can be kept current.

15. Select **Generate Documentation →** when you need Atloria to generate documentation from the project’s current codebase.

16. Review the generated output before treating the documentation as ready for readers.

17. Select **Export Documentation** if you need to distribute the updated documentation outside Atloria.

18. Return to the **Changes** page to continue reviewing other changes that may affect documentation freshness.

## Tips and Best Practices

- Treat freshness as a review priority, not as a substitute for reading the change. A signal such as **1. Fresh (No Connections)** tells you about the documentation connection state, but you should still inspect the change details before deciding that no action is needed.

- Review related documentation whenever work crosses project areas. For example, an API schema change can affect frontend integration guidance, backend behavior descriptions, and API reference material. A database change can also affect operational procedures or data-related explanations.

- Pay particular attention to changes categorized as **DOCUMENTATION**. These changes may directly alter the content, structure, or expectations for project documentation.

- Use **✎ Request Changes** when the available change information does not give you enough confidence to update the documentation correctly. It is better to request clarification than to publish an assumption as fact.

- Save work frequently with **Save Changes**, especially when you are reviewing several related changes. This reduces the risk of losing a completed documentation update while you investigate additional changes.

- Use **Generate Documentation →** when manual maintenance is no longer efficient or when you need a new generated baseline. After generation, verify that the resulting documentation reflects the intended user-facing behavior.

- Review the project’s documentation styles and templates when consistency is important. **The 4 Documentation Styles — path to 8+/10 each** and **Documentation Templates** can help you keep updates aligned with the rest of the documentation set.

> 📷 _Screenshot pending: The change detail page with the ✎ Request Changes action available for incomplete or unclear changes._

## Related Pages

- [Documentation Hub](#)
- [Generate Documentation](#)
- [Documentation Automation](#)
- [Documentation Versions](#)
- [Documentation Analytics](#)
- [Export Documentation](#)
- [Documentation Templates](#)

## Troubleshooting

### The change does not provide enough information to update the documentation

Select **✎ Request Changes** and explain what information is missing. Request clarification about the affected feature, expected behavior, or relationship to existing documentation before saving an update.

### The documentation appears fresh, but the change affects related functionality

Review the affected category and connected documentation manually. A freshness signal does not remove the need to assess changes that span areas such as frontend, backend, API schema, or infrastructure.

### Generated documentation does not yet meet your needs

Review the generated content in **Documentation Hub**, make the necessary edits, and select **Save Changes**. If the underlying change is incomplete or unclear, use **✎ Request Changes** before finalizing the documentation.

<!-- source: measure-documentation-outcomes.md -->

# Measure Documentation Outcomes

This page explains how to use Atloria’s analytics views and documentation exports to communicate the results of your documentation work. Measuring outcomes helps you show stakeholders what was delivered, review documentation performance, and share results outside Atloria.

## Overview

Documentation operations are more effective when you can demonstrate results rather than relying on assumptions. In Atloria, you can review documentation-related results through your project’s analytics area and use **Export Documentation** to create a shareable copy of the documentation output.

Use this workflow after you have generated or imported documentation and want to report on the outcome. For example, you may need to show an operations team what documentation is available, provide a stakeholder with an exported deliverable, or review analytics indicators that help explain the value of your documentation effort.

The documentation workspace includes actions such as **View Your Documentation**, **View Results**, and **Export Documentation**. These actions support different parts of the process: viewing the delivered documentation, reviewing available results, and sharing documentation outside the application.

> 📷 _Screenshot pending: Documentation Hub showing the View Your Documentation, View Results, and Export Documentation actions._

## Prerequisites

Before you begin, make sure you have the following:

- Access to the Atloria project whose documentation outcomes you want to review.
- Documentation that has been generated or imported into the project.
- Permission to open the project’s analytics area.
- A clear reporting purpose, such as sharing documentation with stakeholders, reviewing documentation operations, or preparing an external deliverable.
- A destination for exported documentation, such as a project archive, internal review folder, or stakeholder communication package.

## Step-by-Step Instructions

1. **Open the relevant project in Atloria.**

   Start from the project where documentation was generated or imported. Documentation outcomes are most meaningful when you review them in the context of the project that produced them.

   If you have not yet created documentation, select **Generate Documentation →** to begin. If you already have material prepared elsewhere, use **Or import existing documentation** instead.

2. **Open the Documentation Hub.**

   Look for the **Documentation Hub** or the message **Welcome to your Documentation Hub**. This is the central place to access the documentation produced for your project.

   When documentation generation is complete, the workspace may indicate **Documentation Ready!**. This confirmation means you can proceed to review and share the available documentation.

3. **Review the delivered documentation.**

   Select **View Your Documentation** to inspect the documentation output before communicating results. Review the content as your intended audience will see it.

   This check is important because an export communicates the current documentation state. Confirm that the documentation is complete, understandable, and appropriate for the people who will receive it. If you need to make changes, return to your documentation workflow before exporting.

4. **Open available results.**

   Select **View Results** to review the results available for the documentation work. Use this view to support your outcome discussion with evidence from the project rather than a general statement that documentation was created.

   When presenting results, focus on the operational question your audience needs answered. For example:
   - What documentation is now available?
   - What project area or work was documented?
   - Is the documentation ready to share or use?
   - What should the recipient do next?

5. **Go to the project analytics area.**

   Open the project’s **Analytics** area to review outcome indicators alongside the documentation results. Analytics is useful when you need a broader view of documentation operations and how documentation supports user or agent activity.

   The analytics workspace can include summary cards for documentation-related operational signals, including documentation deflection and agent traffic. Review these indicators as context for your report rather than treating any single number as a complete measure of documentation quality.

> 📷 _Screenshot pending: Project Analytics area showing outcome summary cards used to review documentation operations._

6. **Interpret analytics in context.**

   Use analytics to tell a practical story about documentation outcomes. For example, you might explain that documentation was made available for a project area and that operational indicators are being monitored to understand whether users and support teams can find the information they need.

   Avoid presenting analytics as a guarantee of success. A change in traffic or deflection can be influenced by many factors, including project activity, audience size, timing, and how documentation is promoted.

7. **Export the documentation.**

   When you are ready to share the deliverable, select **Export Documentation**. Exporting lets you communicate the documentation outcome with people who need a copy outside the Documentation Hub.

   Before you distribute the export, use a clear name that identifies the project, documentation scope, and export date in the location where you save or share it. This makes it easier for recipients to distinguish the current deliverable from older copies.

8. **Communicate the outcome.**

   Share the exported documentation together with a short summary of what it represents. Include:
   - The project or documentation scope.
   - Whether the content was generated or imported.
   - The date you reviewed or exported it.
   - The key result you want the recipient to understand.
   - Any follow-up action, such as reviewing the documentation or using it in operations.

   For internal reporting, you can pair the export with observations from **View Results** and the project’s **Analytics** area.

## Tips and Best Practices

- **Review before exporting.** Use **View Your Documentation** before selecting **Export Documentation**. This helps prevent sending a deliverable that does not reflect the documentation you intend to communicate.

- **Use results and analytics for different purposes.** **View Results** helps you review the available documentation result, while the project’s **Analytics** area provides operational context. Use both when you need to explain not only what was delivered, but also why it matters.

- **Report measured outcomes carefully.** The documentation workspace emphasizes output that is “measured, not assumed.” Use available results and analytics to support your claims, but explain the context behind the indicators instead of making unsupported conclusions.

- **Keep exports identifiable.** When sharing exported documentation, include the project name and review date in your message or storage location. This reduces confusion when documentation is updated later.

- **Use a consistent reporting cadence.** Review documentation results and analytics at regular project milestones, such as after a documentation generation cycle or before an operational review. Consistent comparisons are more useful than isolated snapshots.

- **Distinguish availability from adoption.** An export proves that documentation can be shared; analytics can help you monitor operational signals. Neither one alone confirms that every intended reader has understood or adopted the documentation.

## Related Pages

- [Generate Documentation](#)
- [Documentation Hub](#)
- [Export Documentation](#)
- [View Documentation Results](#)
- [Project Analytics](#)
- [Documentation Operations](#)

## Troubleshooting

### You do not see **Export Documentation**

Confirm that you are in the project’s documentation workspace and that documentation is available. If the workspace does not show **Documentation Ready!**, complete the documentation generation or import process first. You may also need the appropriate project access to export documentation.

### You cannot find analytics for the project

Make sure you opened the project’s **Analytics** area rather than only the Documentation Hub. If analytics is still unavailable, verify that you have access to the project and ask your Atloria administrator whether analytics access is enabled for your role.

### The results do not tell the full story you need

Use **View Results** together with the project’s analytics indicators and your project context. If you need to communicate impact, include the documentation scope, the intended audience, the review period, and the operational goal alongside the available results.

<!-- source: troubleshoot-sign-in-problems.md -->

# Troubleshoot Sign In Problems

This page helps you resolve problems signing in to Atloria, resetting access, or completing your organization’s single sign-on (SSO) process. Use these steps to regain access while protecting your account and your organization’s access controls.

## Overview

You use the **Login** screen to access Atloria. Depending on how your organization manages access, you may sign in with your Atloria credentials or continue through an organization-managed sign-in process, such as SSO.

If you cannot access Atloria, start by confirming that you are using the correct sign-in method for your organization. A password reset may not resolve an issue when your organization manages passwords through an identity provider or when your account access has been changed by an administrator.

This page also covers what to do when you are returned to the **Login** screen after attempting SSO, cannot complete a reset, or need help from your organization’s access support team.

> 📷 _Screenshot pending: The Atloria Login screen, showing the Login action._

> 📷 _Screenshot pending: The password reset screen, showing the Reset action._

## Prerequisites

Before you begin, make sure you have:

- Access to the email inbox associated with your Atloria account.
- Your organization’s required sign-in method, such as your Atloria password or SSO credentials.
- A supported browser with cookies and pop-ups allowed for your organization’s sign-in service.
- Your organization’s current network connection or VPN connection, if required.
- The ability to contact your organization’s access administrator or support team if you do not receive reset instructions or cannot complete SSO.

## Step-by-Step Instructions

### Reset your password

1. Open the Atloria **Login** screen.

2. Select the reset option to open the password reset screen.

3. Enter the account information requested on the reset screen.

4. Select **Reset** to submit your request.

5. Check the email inbox associated with your Atloria account. Also check your spam, junk, and filtered folders.

6. Follow the instructions in the reset message to create a new password.

7. Return to the **Login** screen and sign in using your updated password.

8. If you are redirected back to the **Login** screen or the new password does not work, try signing in in a private or incognito browser window. This prevents an older saved password or browser session from being reused.

### Complete an SSO sign-in

1. Open the Atloria **Login** screen.

2. Select your organization’s available sign-in option.

3. Complete the sign-in steps shown by your organization. You may be asked to enter your work email address, approve a multi-factor authentication prompt, or select an account.

4. After authentication is complete, wait for the browser to return you to Atloria.

5. If you return to the **Login** screen without access, close the browser window, reopen Atloria, and try again.

6. If the problem continues, use a private or incognito browser window and complete the SSO process again.

7. If you still cannot sign in, contact your organization’s access administrator. Ask them to confirm that your account is active and assigned access to Atloria.

### Get support for an access issue

1. Record the issue you see, such as an error message, repeated return to the **Login** screen, or missing reset email.

2. Note whether the issue happens when using a password reset, SSO, or both.

3. Include the email address you use for Atloria and the approximate time the issue occurred when contacting support.

4. If your organization uses Atloria’s support capabilities, ask the support team whether a **Support Agent** can help route your request to the correct access owner.

> 📷 _Screenshot pending: A Support Agent area used to request help with an access or sign-in issue._

## Tips and Best Practices

- Use the same email address that your organization has registered for Atloria. A personal email address may not be recognized by your organization’s access controls.
- Do not repeatedly submit password reset requests. Each new request can make it difficult to identify which reset message is current. Use the most recent message you receive.
- If your browser automatically fills a password, verify that it is not an outdated saved password before selecting **Login**.
- For SSO, choose the work account that belongs to the organization using Atloria. Selecting another signed-in account can return you to the **Login** screen without completing access.
- Keep multi-factor authentication methods available when signing in through SSO. If you cannot approve a required verification prompt, contact your organization’s identity or access administrator.
- If your organization uses role-based access control, successful authentication does not always mean that you will see every area of Atloria. Your available features depend on the access assigned to your account.

## Related Pages

- [Manage Your Atloria Profile](#)
- [Understand Role-Based Access Control (RBAC)](#)
- [Request Access to Atloria](#)
- [Use Support Agents](#)
- [Contact Access Support](#)

## Troubleshooting

### I did not receive a password reset message

**Problem:** You selected **Reset**, but no reset message arrives in your inbox.

**Cause:** The request may have been sent to a different email address, delayed by email delivery rules, or filtered into spam or junk. Your organization may also require SSO rather than an Atloria password.

**Solution:** Check spam, junk, and filtered folders first. Confirm that you used the email address associated with your Atloria account, then submit one new reset request. If no message arrives, contact your access administrator and ask whether your account uses SSO or whether the account is active.

### My new password does not let me sign in

**Problem:** You completed a reset but cannot access Atloria from the **Login** screen.

**Cause:** Your browser may be filling an older saved password, the reset may not have been completed, or your organization may manage authentication through SSO.

**Solution:** Enter the new password manually rather than using browser autofill. Try again in a private or incognito browser window. If the issue remains, use your organization’s SSO sign-in method or ask your access administrator which sign-in method applies to your account.

### SSO sends me back to the Login screen

**Problem:** You complete your organization’s sign-in steps but return to **Login** instead of entering Atloria.

**Cause:** You may have selected the wrong work account, an authentication session may be blocked by browser settings, or your Atloria access assignment may be missing.

**Solution:** Sign out of other work accounts in the browser, then try again in a private or incognito window. Allow cookies and required pop-ups for your organization’s sign-in service. If you are still returned to **Login**, contact your access administrator and ask them to verify your Atloria assignment and role-based access.

<!-- source: troubleshoot-invitation-and-access-problems.md -->

# Troubleshoot Invitation and Access Problems

This page helps you resolve common access problems in Atloria, including invitations that no longer work, projects that do not appear in your project list, and unavailable project areas. Restoring access quickly helps you return to your projects without losing time.

## Overview

Your Atloria access determines which organizations and projects you can see after signing in. When access is working correctly, you can open **Projects**, use **Search projects...** to locate a project, and select **Open Project Dashboard** for projects available to you.

Access problems can occur when an invitation has expired, was sent to a different email address, has already been used, or when your organization membership or project permission has changed. In some cases, the project still exists, but it is not visible in your current project list.

Use the checks on this page before contacting support. If the problem persists, you can use **Support Agent** or **🤖 AI Support** to provide the details needed for further help.

> 📷 _Screenshot pending: The Projects area showing the project search field and available project cards._

## Prerequisites

Before you start, make sure you have:

- Access to the email inbox where the Atloria invitation was sent.
- The invitation email, if it is still available.
- The correct Atloria account credentials for the email address that received the invitation.
- The name of the missing organization or project.
- A project link or project name, if another team member shared one with you.
- Permission to contact your organization administrator or project owner if access needs to be restored.
- A browser session signed in to Atloria.

## Step-by-Step Instructions

1. **Confirm that you are signed in with the invited email address.**

   Check the email address associated with the account you are using. Invitations are tied to the recipient’s email address. If your company uses multiple addresses, such as a personal and work address, sign out and sign in with the address that received the invitation.

2. **Open the invitation email and check its status.**

   Locate the original invitation in your inbox, including your spam, junk, and filtered folders. If the invitation link reports that it is no longer valid, do not continue trying the same link. Ask the organization administrator to send a new invitation to the correct email address.

3. **Go to the project list.**

   In Atloria, select **Projects**. If you are currently viewing a project, select **← Back to Projects** or **&larr; Back to Projects** to return to the list.

   > 📷 _Screenshot pending: The Back to Projects control used to return from a project to the Projects list._

4. **Search for the project that appears to be missing.**

   Use **Search projects...** to enter the project name. If you have access to several projects, you can also use **Search across all projects...** to broaden your search.

   - If the project appears in search results, select it and choose **Open Project Dashboard**.
   - If the project does not appear, confirm the spelling with the project owner and continue to Step 5.

5. **Check whether you have access to the correct organization and project.**

   A missing project can mean that your account is not a member of the organization that owns it, or that you do not have permission for that specific project. Ask the organization administrator or project owner to confirm:

   - Your membership is active.
   - Your invited email address matches your Atloria account.
   - You have been added to the required project.
   - The project has not been deleted or moved.

6. **Try opening the project from a shared project link.**

   If a colleague has provided a project link, open it while signed in. If you are returned to **Projects**, cannot open the dashboard, or still cannot find the project, your account likely needs access from an administrator.

7. **Contact support if access is still unavailable.**

   Select **Support Agent** or **🤖 AI Support**. Include the following information in your request:

   - The email address you use to sign in.
   - The organization name.
   - The project name.
   - Whether the invitation is expired, missing, or was accepted successfully.
   - The exact message or screen behavior you see.
   - Whether the project appears when using **Search projects...**.

   Do not include passwords or other confidential sign-in information.

## Tips and Best Practices

- **Use one consistent work email address.** Invitations and project membership should use the same address you use to sign in to Atloria.
- **Search before assuming a project is gone.** Use **Search projects...** and, where available, **Search across all projects...**. A project may be present but difficult to locate in a long list.
- **Request a new invitation instead of reusing an expired one.** A replacement invitation is the appropriate next step when the original invitation no longer opens or is no longer valid.
- **Ask for project-level access specifically.** Organization membership does not always mean that every project is visible to you. Provide the exact project name when requesting access.
- **Keep the invitation email until access is confirmed.** It can help your administrator or support team verify which address was invited and when.
- **Use the project dashboard to confirm successful access.** When access is restored, select **Open Project Dashboard** to verify that you can enter the project.

## Related Pages

- [Projects](../projects/) — Find, search, and open available projects.
- [Project Dashboard](../projects/project-dashboard/) — Use the dashboard after you have access.
- [Create a New Project](../projects/create-project/) — Create a project when you have the required permissions.
- [Support Agent](../support/support-agent/) — Request help with unresolved account or project access issues.

## Troubleshooting

### My invitation link has expired

**Problem:** The invitation link does not open, is no longer valid, or does not let you join the organization.

**Cause:** Invitations can expire, be replaced by a newer invitation, or be associated with a different email address.

**Solution:** Check that you are signed in with the email address that received the invitation. If the link is expired or invalid, ask your organization administrator to send a new invitation. Use the newest invitation email and complete the process while signed in to the matching account.

### I cannot see my organization or project

**Problem:** You open **Projects**, but the expected project does not appear.

**Cause:** Your account may not have organization membership, may not have been assigned to that project, or may be signed in with a different email address.

**Solution:** Use **Search projects...** and **Search across all projects...** first. If the project is still unavailable, ask the project owner to verify your membership and project access. Provide your sign-in email and the exact project name.

### I can find a project, but I cannot access its dashboard

**Problem:** The project appears in the list or from a shared link, but you cannot successfully open **Open Project Dashboard**.

**Cause:** Your project permission may be incomplete, changed, or unavailable for the account currently signed in.

**Solution:** Return to **Projects** using **← Back to Projects**, sign out and sign back in with the invited email address, then try again. If the issue continues, contact the project owner or use **Support Agent** with the project name and a description of what happens when you select **Open Project Dashboard**.

<!-- source: troubleshoot-plan-and-billing-problems.md -->

# Troubleshoot Plan and Billing Problems

This page helps you resolve common plan access, usage, and billing administration problems in Atloria. Use it when your expected plan features are unavailable, usage appears incorrect, or you need help with a billing-related question.

## Overview

Plan and billing problems can affect your ability to use Atloria features, manage access, or continue work without interruption. If you see an unexpected limitation, cannot use a feature you expect to have, or have a question about charges or credits, start by checking the information available to you and then contact support through Atloria.

Atloria provides support options through **🤖 AI Support** and **Support Agent**. These options are useful when you need help identifying whether a problem is related to access control, plan availability, usage, or billing administration. You can also use the **Billing** topic to keep your request focused on account and payment concerns.

For access-related problems, review your organization’s permissions as well. Atloria includes **👥 Access Control** and **👤 Role-Based Access Control (RBAC)** areas, which may determine whether you can view or manage plan and billing information.

> 📷 _Screenshot pending: The Support Agent area with the Billing topic available for plan and billing questions._

## Prerequisites

Before you begin, make sure you have:

- Access to your Atloria organization.
- A clear description of the problem, such as unavailable plan access, unexpected usage, or a billing question.
- The name of the feature or area affected.
- The approximate date and time when you first noticed the issue.
- Any relevant payment, invoice, credit, or usage details available to you.
- Permission to view or administer billing information, if your organization restricts this through **👤 Role-Based Access Control (RBAC)**.
- A support request that does not contain unnecessary sensitive payment information.

## Step-by-Step Instructions

1. **Confirm the type of problem you are experiencing.**

   Identify whether the problem is primarily related to:

   - **Plan access**, such as a feature being unavailable.
   - **Usage**, such as limits or credits appearing unexpected.
   - **Billing**, such as charges, invoices, payment questions, or commercial plan administration.
   - **Access control**, such as not being able to view the information needed to manage billing.

   Clearly identifying the category helps support investigate the correct area.

2. **Check whether access permissions may be the cause.**

   If you cannot see plan or billing information, the problem may be related to your assigned role rather than the plan itself. Review the applicable access settings with your organization administrator.

   Look for areas associated with **👥 Access Control** or **👤 Role-Based Access Control (RBAC)**. Ask your administrator to confirm that your role includes the access needed for billing or plan administration.

3. **Open support assistance in Atloria.**

   Select **🤖 AI Support** when you want immediate guidance about your issue. Describe the behavior you see, the affected feature, and whether the issue concerns plan access, usage, or billing.

   If you need assistance from a support representative, use **Support Agent**. When available, select the **Billing** topic so your request is categorized correctly.

4. **Provide a complete problem description.**

   Include the following in your message:

   - Your organization or workspace context.
   - The plan or commercial feature you expected to use, if known.
   - What you expected to happen.
   - What happened instead.
   - Whether the issue affects one person or multiple users.
   - Any usage, credit, charge, or invoice details relevant to the problem.
   - The date when the problem started.

   For example, explain that a feature expected under your plan is unavailable, rather than only stating that “billing is broken.”

5. **Use the appropriate support subject.**

   For questions about commercial configuration, plans, credits, or enterprise arrangements, describe the issue as a billing or commercial-readiness concern. Atloria support content identifies commercial topics as including “Stripe, credits, plans, enterprise.”

   For permission-related issues, state that the problem may involve access control or RBAC. This helps distinguish a missing permission from a plan limitation.

6. **Review and follow up on your support issue.**

   If your organization uses the Issues area, review the issue after submitting or discussing your concern. Check for responses, requests for additional details, and resolution updates.

   When the issue is resolved, use **Resolve** only after you have confirmed that plan access, usage information, or billing administration is working as expected.

> 📷 _Screenshot pending: An issue details screen showing the Resolve action after a plan or billing problem has been addressed._

## Tips and Best Practices

- **Describe what you see, not just what you believe caused it.** For example, state which feature is unavailable and the message or limitation you encounter.
- **Separate access issues from billing issues.** If only certain users cannot view billing information, review **👤 Role-Based Access Control (RBAC)** before assuming there is a plan problem.
- **Use the Billing topic for commercial questions.** This helps distinguish billing concerns from general product support.
- **Include timing details.** A date, time, and recent change—such as a role update or plan change—can help identify the cause.
- **Do not close an issue too early.** Select **Resolve** only after you verify the original problem no longer occurs.
- **Use AI Support for initial clarification.** **🤖 AI Support** can help you formulate a clear request before you contact a **Support Agent**.

## Related Pages

- [Use AI Support](#)
- [Contact a Support Agent](#)
- [Manage Access Control](#)
- [Understand Role-Based Access Control (RBAC)](#)
- [Manage Support Issues](#)

## Troubleshooting

### I cannot access a feature that I believe is included in my plan

**Problem:** A feature is unavailable or you cannot use an expected capability.

**Cause:** The issue may be caused by a plan limitation, an organization configuration issue, or missing permissions through **👤 Role-Based Access Control (RBAC)**.

**Solution:** First, ask your administrator to confirm your access permissions. If your role is correct, open **🤖 AI Support** or **Support Agent**, select **Billing** when appropriate, and provide the feature name, expected access, affected users, and when the issue began.

### I cannot view billing or plan administration information

**Problem:** Billing-related information is not visible to you.

**Cause:** Billing administration may be restricted to specific roles through **👥 Access Control** and **👤 Role-Based Access Control (RBAC)**.

**Solution:** Contact your organization administrator and request confirmation of your billing-related permissions. If permissions appear correct but the information remains unavailable, contact **Support Agent** and identify the issue as a billing-access problem.

### My usage, credits, or charges appear incorrect

**Problem:** Your usage, available credits, or billing details do not match what you expect.

**Cause:** The displayed information may need review in the context of your plan, commercial configuration, or recent organization changes.

**Solution:** Use **Billing** in **Support Agent** and provide the relevant dates, expected amount or usage, displayed amount or usage, and any recent plan or access changes. Keep the issue open until the explanation or correction is confirmed, then select **Resolve**.

<!-- source: troubleshoot-document-editing-problems.md -->

# Troubleshoot Document Editing Problems

This page helps you resolve common problems when creating, editing, translating, or organizing documents in Atloria. Use these checks to get back to your document quickly and avoid losing track of work.

## Overview

Atloria provides a central **Documents** area where you can find documents, create new ones, and return to existing work. Depending on your workspace, you may also see document-related options from a project dashboard, including recent documents.

When you cannot edit a document, cannot find it, or are unsure how to create or translate content, start by confirming that you are in the correct project and document area. The **Search documents...** field and **Search documents, categories, projects...** field can help you locate content without manually browsing every project or category.

> 📷 _Screenshot pending: The Documents area showing the document search field, project selection message, and document actions._

Document work may involve several activities: creating a new document, opening an existing document for editing, comparing versions, translating a document, or removing documents that are no longer needed. The available controls can vary based on the document you open and your access to the selected project.

## Prerequisites

Before troubleshooting, make sure you have:

- Access to the Atloria workspace and the appropriate project.
- The correct document name, category, or project name, if you are searching for an existing document.
- Permission to create, edit, translate, compare, export, or delete documents in the selected project.
- A stable internet connection so that the document workspace can load.
- Any source material you want to use when creating or importing documentation.
- Confirmed that you are in the intended project when the page displays **Select a project to view documents**.

## Step-by-Step Instructions

1. **Open the Documents area.**  
   Select **Documents** from the available navigation. If Atloria asks you to choose a project, select the project that contains the document you need.

2. **Search for the document before creating a duplicate.**  
   Use **Search documents...** to search within the document list. If you need to search more broadly, use **Search documents, categories, projects...**. Search by a distinctive word in the document title, its category, or the project name.

3. **Create a document if no existing document is available.**  
   Select **Create New Document** or **Create Document**, depending on the screen you are using. If you already have content outside Atloria, choose **Or import existing documentation** instead of recreating it manually.

4. **Open the correct document for editing.**  
   From the document list or a project’s recent documents, open the document you want to change. Verify its title and project before making edits, especially when several documents have similar names.

5. **Use the document-specific action you need.**  
   - Open the document’s editing view to update its content.  
   - Open the translation view when you need a translated version.  
   - Open the comparison view when you need to review differences between document versions or content states.  
   - Use **Export Documentation** when you need a copy outside Atloria.  
   - Use **Delete Documents** only when you are certain the selected documents are no longer required.

6. **Return to the document list if you opened the wrong item.**  
   Select **← Back to Documents** to return to the document list, then search again or select a different project.

> 📷 _Screenshot pending: An open document showing the option to return to Documents and the available editing, translation, comparison, export, or deletion actions._

## Tips and Best Practices

- **Search first, then create.**  
  Problem: You may create a second document because you cannot immediately see the first one.  
  Cause: The document may be in another project or category, or may be outside the currently filtered list.  
  Solution: Use **Search documents...** and then **Search documents, categories, projects...** before selecting **Create New Document**.

- **Confirm the active project before editing.**  
  Problem: You cannot see expected documents or edits appear to be missing.  
  Cause: You may be viewing a different project, or no project is selected.  
  Solution: Check for **Select a project to view documents**, select the correct project, and search again.

- **Use translation and comparison for different purposes.**  
  Problem: You are unsure whether to translate or compare a document.  
  Cause: Translation creates or manages language-specific document work, while comparison is intended for reviewing differences.  
  Solution: Open the translation option when working in another language. Use comparison when you need to inspect changes or differences before continuing your edits.

- **Treat deletion as a final cleanup step.**  
  Problem: A document disappears after organizing content.  
  Cause: **Delete Documents** may have been used on the wrong selection.  
  Solution: Review the selected documents carefully before deleting. If you only need to reorganize or review content, use search, comparison, or export instead.

## Related Pages

- [Create a New Document](#) — Learn how to start documentation from scratch.
- [Import Existing Documentation](#) — Bring existing documentation into Atloria.
- [Translate Documents](#) — Create and manage translated document content.
- [Compare Document Changes](#) — Review differences between document versions or states.
- [Export Documentation](#) — Export documentation for sharing or external use.
- [Manage Documents](#) — Find, organize, and remove documents from a project.

## Troubleshooting

### You cannot find a document

**Problem:** The document does not appear in the list.

**Cause:** You may be in the wrong project, the list may not include the document’s category, or the document title may differ from what you expect.

**Solution:** First, confirm that the correct project is selected. If you see **Select a project to view documents**, choose the appropriate project. Then use **Search documents...**. If the document is still not found, use **Search documents, categories, projects...** to search across document names, categories, and projects.

### You cannot create or edit a document

**Problem:** You cannot complete a new document or update an existing one.

**Cause:** The selected project may not be available, your access may not include editing privileges, or you may have opened the wrong document context.

**Solution:** Return using **← Back to Documents**, confirm the project, and reopen the intended document. If **Create New Document** or **Create Document** is unavailable or editing remains blocked, contact your workspace administrator to confirm your project permissions.

### You are unsure how to work with a translated document

**Problem:** You need another language version but do not know where to begin.

**Cause:** Translation work is separate from standard editing and may require opening the document’s translation view rather than editing the original content directly.

**Solution:** Open the document you want to translate and use its translation option. If you are looking for supported languages before starting, select **see the 24+ languages we support →** where available. Use the comparison view afterward if you need to review differences between document content versions.

<!-- source: troubleshoot-review-and-version-problems.md -->

# Troubleshoot Review and Version Problems

This page helps you resolve problems with reviews, feedback, version comparisons, and version approval or publishing actions. Use it when expected review information is missing or when you cannot continue from review to a version decision.

## Overview

Atloria provides review and version-management tools so you can evaluate generated or edited content before publishing it. From the review area, you can check the **Review Summary**, confirm whether items are resolved, return to the review workspace, and continue to version actions.

When you need to compare changes between versions, use **Compare Versions**. This helps you confirm which version contains the changes you want before selecting **Use V4 AI Version**, **Use All V4 AI Versions**, generating another version, or publishing.

You may also need this page when a review appears incomplete, feedback is not visible, a comparison does not show the expected differences, or the version you expect is not available for approval. In these situations, first confirm that you are viewing the correct project and version, then use the version-management controls to refresh your work context.

> 📷 _Screenshot pending: Review screen showing Review Summary, resolved-review status, and version actions._

## Prerequisites

Before you start, make sure you have:

- Access to the relevant project.
- A project that has at least one available version.
- The correct version selected for review.
- Permission to review, use, generate, or publish versions, as applicable to your organization.
- Any required feedback or review comments completed before attempting to publish.
- A stable connection while generating or switching versions.

## Step-by-Step Instructions

1. **Open the project’s version area.**

   In your project, open **Versions** to view the available versions and version-related actions. If you are working from a review screen, select **Go to Version Manager** to return to the full version list.

2. **Confirm that you are reviewing the intended version.**

   Check the version identifier and content shown on screen before taking action. If the review is for an AI-generated version, look for the available actions such as **Use V4 AI Version** or **Use All V4 AI Versions**.

   - Select **Use V4 AI Version** when you want to apply one available AI version.
   - Select **Use All V4 AI Versions** only when you intend to apply all listed V4 AI versions.

3. **Review the summary and resolution state.**

   Open or return to the review view and check **1 Review Summary**. Review the items presented there and verify whether the screen shows **4 All Resolved**.

   If the screen does not show all items as resolved, complete or address the outstanding review feedback before trying to publish. If you need to leave version management and return to the review workspace, select **Back to Review**.

4. **Compare versions when expected changes are missing.**

   Select **Compare Versions**. Choose the versions you need to evaluate and inspect the comparison for the expected content changes.

   If the comparison does not include the changes you expected, return to **Versions** and confirm that the correct version was generated or selected. Use **Manage all versions →** if you need to locate another version.

   > 📷 _Screenshot pending: Compare Versions screen with two versions selected for review._

5. **Generate a replacement version when needed.**

   If the current version does not include the needed updates, select **Generate Next Version** or **Generate New Version**. Wait for the generation process to finish before opening the new version for review.

   When a process reports completion, verify that it completed successfully. A completed process may also report warnings; review the result before using or publishing the new version.

6. **Review the new version before publishing.**

   Open the new version and repeat the review steps. Confirm the content, feedback, and comparison results. Use **Review & Publish** when you are ready to complete the final review and publication process.

7. **Publish only after review requirements are met.**

   When all required review items are resolved and you have confirmed the correct version, select the available publish action. For example, the button may read **Publish Version 4** for the version currently displayed.

   After publishing, return to **Versions** to confirm that the correct version is available in the project’s version history.

## Tips and Best Practices

- Always use **Compare Versions** before replacing a reviewed version with an AI version. This reduces the risk of applying changes you did not intend to keep.
- Treat **All Resolved** as a checkpoint, not just a label. Confirm that every required feedback item is addressed before you publish.
- Use **Back to Review** when you need to verify feedback after working in version management. Do not rely only on the version list when approval depends on review completion.
- Generate a new version instead of repeatedly switching between versions when the required edits are not present. Use **Generate Next Version** or **Generate New Version**, then review the result as a separate version.
- If generation completes with warnings, inspect the generated content carefully. Completion does not always mean the output is ready for publication.
- Use **Manage all versions →** to find older or alternate versions rather than assuming the currently open version is the most recent or approved one.

## Related Pages

- [Review and Publish Content](#)
- [Compare Project Versions](#)
- [Generate a New Version](#)
- [Manage Project Versions](#)
- [Use AI-Generated Versions](#)
- [Get Help from Support Agent](#)

## Troubleshooting

### Review feedback or the review summary is missing

**Problem:** You cannot find expected feedback, or **1 Review Summary** does not show the review information you expected.

**Cause:** You may be viewing a different version than the one that received feedback, or you may be in version management instead of the review workspace.

**Solution:** Confirm the active version in **Versions**, then select **Back to Review**. Check **1 Review Summary** again. If feedback belongs to another version, return to **Manage all versions →**, open that version, and review its feedback there.

### The comparison does not show the changes you expected

**Problem:** **Compare Versions** does not show a change that you expected to see.

**Cause:** The wrong versions may have been selected, or the expected change may exist only in a newly generated version that has not yet been opened.

**Solution:** Return to **Versions** and identify the versions you want to compare. Open **Compare Versions** again and select the correct pair. If no version contains the needed change, select **Generate Next Version** or **Generate New Version**, wait for completion, and compare the new version with the prior version.

### You cannot approve or publish a version

**Problem:** The publish action is unavailable, or you are not ready to select **Publish Version 4**.

**Cause:** Required review items may still be unresolved, you may be viewing the wrong version, or you may not have the required publishing permission.

**Solution:** Return to the review workspace and verify whether the screen shows **4 All Resolved**. Resolve outstanding feedback, then use **Review & Publish** to continue. If all review requirements are complete but publishing is still unavailable, contact your organization’s administrator or open **Support Agent** for assistance.

<!-- source: troubleshoot-publishing-and-branding-problems.md -->

# Troubleshoot Publishing and Branding Problems

This page helps you identify and resolve common problems that affect how your content appears to audiences in a public portal. Use it when published documents are missing, a portal looks unbranded, templates produce unexpected results, or public search does not return expected documents.

## Overview

Publishing and branding work together to control the public experience. Publishing determines whether content is available to the intended audience, while templates and branding determine how that content is presented in the portal.

You may need this process when users report that they cannot find a document, see outdated formatting, encounter an unexpected portal appearance, or receive incomplete search results. Start by confirming the affected audience and document, then review the publishing, template, branding, and search experience in that order.

Use the available search tools to locate the relevant project or document before making changes. Depending on where you are working, you may see **Search documents...**, **Search projects...**, **Search across all projects...**, or **Search documents, categories, projects...**.

> 📷 _Screenshot pending: The Publishing area used to review content availability for an audience._

## Prerequisites

Before you begin, make sure you have:

- Access to the project and audience where the issue occurs.
- The name, title, or identifying text of the affected document.
- The affected audience or public portal link, if available.
- Permission to review **Publishing**, **Template Settings**, and **Templates**.
- A way to compare the expected public result with the current portal result.
- Details from the user who reported the issue, including search terms, browser, language, and a screenshot when possible.

## Step-by-Step Instructions

1. **Identify whether the problem affects one document or the entire portal.**

   Open the affected public portal and check whether the problem is limited to a single document, a category of documents, search results, or the portal’s overall appearance.

   If you know the document title, use **Search docs...** in the public portal. In the authoring workspace, use **Search documents...** or **Search across all projects...** to locate the source document. For broader investigation, use **Global Search** or **Quick Search** and enter a distinctive document title, category name, or project name.

   If only one document is missing or looks incorrect, focus on that document’s publishing and template configuration. If multiple documents are affected, review the audience, template, and branding configuration first.

2. **Confirm that you are checking the correct audience and public portal.**

   A document can appear differently—or not appear at all—depending on the audience viewing it. Open the public portal for the audience reported by the user and compare it with the intended audience.

   In the authoring area, open **Publishing** and review the publication settings associated with the affected content. Confirm that you are working with the audience that users are actually visiting.

   **Problem:** Users can see the portal but cannot find the expected content.  
   **Cause:** The content may be available to a different audience, or you may be checking a different public portal than the user.  
   **Solution:** Return to **Publishing**, verify the intended audience, and then test the matching public portal again using **Search docs...**.

3. **Review the template used for the affected content.**

   Open **Templates** to locate the template associated with the affected document or content type. Then open **Template Settings** to review the presentation settings that apply to that template.

   Compare the affected document with a document that displays correctly in the same portal. Look for differences in the selected template or in the template settings that could explain changes to layout, headings, navigation, or other visible elements.

   **Problem:** The document is published but has unexpected formatting or structure.  
   **Cause:** The document may use a different template, or the template’s settings may not match the expected public presentation.  
   **Solution:** Review **Templates** and **Template Settings**, identify the expected template by comparing a working document, and correct the document or template configuration as appropriate. Recheck the public portal after the change is available.

> 📷 _Screenshot pending: The Templates and Template Settings areas used to compare public document presentation._

4. **Check portal branding and confirm the scope of the issue.**

   Review the public portal’s visible branding, such as its overall visual identity and the way shared portal elements appear around documents. Compare the affected portal with another portal that has the expected appearance.

   If the branding problem appears on every document in one portal, treat it as a portal-level issue rather than a document-level issue. If it appears only on documents using one template, return to **Templates** and **Template Settings** before escalating the issue.

   **Problem:** The portal branding looks wrong on every public page.  
   **Cause:** The issue is likely associated with the portal or audience configuration rather than one document.  
   **Solution:** Confirm the audience and portal being viewed, document the visible difference, and request assistance from the team responsible for portal branding if you cannot correct it through the available publishing and template settings.

5. **Test public search with the user’s exact search terms.**

   In the public portal, select **Search** or use **Search docs...**. Enter the same words the user entered, including spelling, product names, and phrases.

   Test a few variations:
   - The full document title.
   - A unique word from the title.
   - A phrase from the document body.
   - The category name, if relevant.

   Check whether the document is missing completely, appears under an unexpected title, or appears only for a different search phrase. Also confirm that you are testing the intended public portal and audience.

   **Problem:** A published document does not appear in public search.  
   **Cause:** The document may not be available to that audience, the search terms may not match the public document content, or the user may be searching a different portal.  
   **Solution:** Verify the audience in **Publishing**, test the document title and a unique phrase with **Search docs...**, and compare results with the expected portal. If the document is still unavailable, capture the search terms and escalate the issue.

6. **Use support tools when the cause is not clear.**

   If you cannot determine why publishing, templates, branding, or public search behaves unexpectedly, open **Support Agent** or select **🤖 AI Support**. Provide the project, audience, document title, public portal link, search terms used, and screenshots of the expected and actual result.

   For issues that require follow-up, use the available issue workspace. You can use **Search & Filter** to locate existing reports and select **Resolve** only after you have verified that the public portal now displays the expected result. The **All Resolved** view can help you check whether a similar problem was previously addressed.

## Tips and Best Practices

- Always test through the same audience and public portal used by the affected user. A correct result in one portal does not confirm a correct result in another.
- Use a working document as a comparison point when investigating template or branding problems. This is often faster than trying to identify every setting independently.
- Search using exact user-provided terms before trying alternatives. This helps distinguish a search issue from an audience or publication issue.
- Record the portal link, document title, audience, and visible symptoms before changing templates or publishing configuration.
- When reporting an issue, include whether the problem affects one document, one audience, or all documents in a portal.
- If content processing reports completion with warnings, review the affected content carefully before assuming it is ready for public use. A successful completion result does not replace a visual check of the public portal.

## Related Pages

- [Publish Content to an Audience](#)
- [Manage Templates](#)
- [Configure Template Settings](#)
- [Use Public Search](#)
- [Find Documents with Global Search](#)
- [Get Help with Support Agent](#)
- [Manage and Resolve Issues](#)

## Troubleshooting

### A document is visible to authors but missing from the public portal

**Problem:** You can locate the document in the workspace, but users cannot find it on the public site.

**Cause:** The document may not be available to the audience being tested, or the user may be viewing a different portal.

**Solution:** Use **Publishing** to verify the intended audience. Then open that audience’s public portal and search with **Search docs...** using the exact document title. If it remains unavailable, provide the document title, audience, and portal link to **Support Agent**.

### The public portal uses the wrong layout or appearance

**Problem:** Public documents display unexpected formatting, navigation, or portal presentation.

**Cause:** The affected document may use a different template, or the issue may affect portal-level branding for the audience.

**Solution:** Compare the document with a correctly displayed document. Review **Templates** and **Template Settings** for document-specific differences. If every document in the portal is affected, document the portal-wide symptom and escalate it as a branding issue.

### Search returns no results or unexpected results

**Problem:** Users search for known content but do not find it.

**Cause:** The search terms may not match the published content, the document may be unavailable to that audience, or the user may be searching the wrong portal.

**Solution:** Repeat the search with **Search** or **Search docs...** using the exact title and a unique phrase from the document. Confirm the audience in **Publishing**, then test the correct public portal. If results still differ from expectations, submit the exact search query and screenshots through **🤖 AI Support** or **Support Agent**.

<!-- source: troubleshoot-source-analysis-problems.md -->

# Troubleshoot Source Analysis Problems

This page helps you resolve problems with connected sources, analysis status, and source review. Keeping source analysis current helps you work from accurate findings and identify issues that still need attention.

## Overview

Source analysis reviews connected source material and presents the results for your workspace. You may need to troubleshoot it when a source is not connected, when an analysis remains in progress, when the results contain warnings, or when you need to review the underlying source for a finding.

Use the **Status** action to check the current state of your analysis. Analysis can appear as **QUEUED**, **IN PROGRESS**, **SUCCESS**, **PARTIAL**, **FAILED**, or **SKIPPED**. A successful result means the parse completed with no errors. A partial result means the parse completed with warnings, so some information may require review.

When you are reviewing an issue or result, select **View Source** to open the source context. In the source view, use **Source** to focus on the original source content. If a comparison is available, you can switch between source and diff views to understand what changed.

> 📷 _Screenshot pending: The Status action showing the current analysis state for a connected source_

## Prerequisites

Before you start, make sure that:

- You can access the workspace or issue where the source analysis appears.
- Your source connection has been completed. Connection indicators may include **GitHub Connected**, **All Connected**, or **Bitbucket Connected!**
- You know which source, issue, or analysis result needs attention.
- You have permission to review source content and resolve issues, if applicable.
- You allow time for a newly connected or updated source to move from **QUEUED** to **IN PROGRESS** and then to a completed status.

## Step-by-Step Instructions

1. **Confirm that your source is connected.**

   Open the relevant source or analysis area and look for the connection status. A connected source may display **GitHub Connected**, **All Connected**, or **Bitbucket Connected!**.

   If the screen indicates that an item “is not connected,” the analysis cannot use that source. Complete or restore the connection before investigating the analysis result.

2. **Check the analysis status.**

   Select **Status** to view the current analysis state.

   Interpret the status as follows:

   - **QUEUED**: The analysis is waiting to begin.
   - **IN PROGRESS**: The analysis is currently running.
   - **SUCCESS**: The parse completed successfully with no errors.
   - **PARTIAL**: The parse completed with warnings. Review the result and source context before relying on all findings.
   - **FAILED**: The analysis did not complete.
   - **SKIPPED**: The analysis did not run for the source or item.

   If the status is **QUEUED** or **IN PROGRESS**, wait for processing to finish, then check **Status** again.

3. **Open the source behind a result or issue.**

   For an issue or analysis result that needs investigation, select **View Source**.

   In the source panel, select **Source** to view the original content. If the screen also provides a diff view, compare it with the source view to identify whether a source change may have affected the analysis.

   > 📷 _Screenshot pending: The View Source action and Source view for investigating an analysis finding_

4. **Review partial or unexpected results.**

   If the status is **PARTIAL**, inspect the source material shown in **View Source**. Look for incomplete content, formatting that makes the source difficult to interpret, or recent changes that may explain the warning.

   A partial analysis is not necessarily unusable, but you should verify important findings against the displayed source before taking action.

5. **Resolve confirmed issues.**

   If you have reviewed the source and confirmed that an issue no longer requires attention, select **Resolve**.

   The issue area can show a resolved summary such as **All Resolved**. Use this status to confirm that the item is no longer listed as active work.

6. **Recheck analysis after source or connection changes.**

   After correcting a connection problem or updating the source, return to **Status** and monitor the analysis again. The result should progress through processing states such as **QUEUED** and **IN PROGRESS** before reaching a completed state.

   If your screen does not provide a visible option to start analysis again, do not assume that selecting **Resolve** reruns it. **Resolve** closes an issue; use the available analysis or source workflow in your workspace to initiate or wait for updated processing.

## Tips and Best Practices

- **Check connections first.** If a source is not connected, troubleshooting the parse status will not resolve the underlying problem. Confirm a connection indicator such as **GitHub Connected** or **Bitbucket Connected!** before waiting for results.

- **Treat `PARTIAL` as a review state.** A partial result indicates warnings rather than a clean completion. Open **View Source** and compare the available source content before making decisions based on the analysis.

- **Do not close issues before verifying the source.** Select **Resolve** only after you have checked the relevant content in **Source** and confirmed that the issue is addressed.

- **Allow processing time.** A source can remain in **QUEUED** while it waits to be processed and in **IN PROGRESS** while analysis is running. Repeatedly changing the source during this period can make it harder to determine which version produced the result.

- **Use source and diff views together when available.** The **Source** view shows the original content, while a diff view can help you identify changes that may explain new, missing, or unexpected analysis findings.

## Related Pages

- [Connect a Source Repository](#)
- [Review Source Analysis Results](#)
- [View and Resolve Issues](#)
- [Understand Analysis Statuses](#)
- [Manage Connected Sources](#)

## Troubleshooting

### The source is not connected

**Problem:** The screen indicates that the source is not connected, or you do not see a confirmation such as **GitHub Connected**, **All Connected**, or **Bitbucket Connected!**.

**Cause:** Analysis requires an available connected source. An incomplete, removed, or unavailable connection prevents the system from analyzing the source.

**Solution:** Restore or complete the source connection, then return to the analysis area and select **Status**. Wait for the item to enter **QUEUED** or **IN PROGRESS**, then check again for a completed status.

### Analysis stays in `QUEUED` or `IN PROGRESS`

**Problem:** The analysis does not yet show **SUCCESS**, **PARTIAL**, **FAILED**, or **SKIPPED**.

**Cause:** The source is waiting to be processed or is still being analyzed. Recent source updates can also mean the current analysis has not yet completed.

**Solution:** Wait and check **Status** again. Avoid resolving related issues while the analysis is still processing. Once the status is completed, use **View Source** to verify the content used by the analysis.

### Analysis is `PARTIAL`, `FAILED`, or `SKIPPED`

**Problem:** The result is not a clean **SUCCESS**.

**Cause:** **PARTIAL** means the parse completed with warnings; **FAILED** means it could not complete; **SKIPPED** means it did not run for that source or item.

**Solution:** Select **View Source**, then select **Source** to inspect the underlying content. For **PARTIAL**, verify important findings manually. For **FAILED** or **SKIPPED**, confirm that the source remains connected and review its status again after the connection or source content has been corrected.

<!-- source: troubleshoot-entity-and-flow-problems.md -->

# Troubleshoot Entity and Flow Problems

This page helps you resolve common problems with missing entities, relationships, source symbols, and captured flows. Use these checks to confirm that you are viewing the right information and to identify when an item needs attention.

## Overview

Source Intelligence helps you explore the entities and flows identified in your project. Entities can represent items such as components, hooks, pages, layouts, routes, contexts, providers, stores, controllers, services, repositories, and middleware. Flows show how related parts work together, such as user journeys, authentication sequences, and pipeline activity.

You may need this page when an expected entity does not appear in the entity list, a relationship is unclear or missing, the **View Source** option does not show the source information you expect, or a captured flow is not visible. For example, you might be looking for an **Authentication Flow**, an **OAuth 2.0 Flow**, or a relationship where one component **renders** another component.

Use the entity search and flow filters first. Then use the available source view and resolution controls to investigate the item further.

> 📷 _Screenshot pending: Entity list showing the Search entities… field, an entity selection, and the View Source action._

## Prerequisites

Before you begin, make sure that:

- You have opened the correct project.
- You know the approximate name of the missing entity or flow.
- You can access the entity list and captured flows for the project.
- You have permission to view the relevant project source information.
- You understand whether you are looking for an entity, a relationship, or a flow.
- You have allowed any current analysis or capture activity to finish before checking results.

## Step-by-Step Instructions

1. **Open the entity list for your project.**

   Start from the project’s technical documentation area and open the entity list. Look for the search field labeled **Search entities…** or **Search entities...**.

   If you are searching for a known item, enter part of its name. For example, search for **Authentication**, **OAuth**, **User Flow**, or **Help Widget**.

2. **Check whether the entity appears under a different type or name.**

   Entity names may be grouped according to their role. Common entity types include:

   - **COMPONENT**
   - **HOOK**
   - **PAGE**
   - **LAYOUT**
   - **ROUTE**
   - **CONTEXT**
   - **PROVIDER**
   - **STORE**
   - **CONTROLLER**
   - **SERVICE**
   - **REPOSITORY**
   - **MIDDLEWARE**

   For example, an expected UI element may appear as a component, while supporting behavior may appear as a hook, provider, or service. Search with a shorter term if an exact name does not return a result.

3. **Select the entity and inspect its details.**

   Select the matching item from the results. The details area may be identified as **Entity Detail**. Review the entity’s displayed relationships to understand how it connects to other items.

   Relationship descriptions can indicate actions such as one component **renders** another component or a component **uses** a hook. If you expected a direct connection but see an intermediate entity, inspect that intermediate entity before concluding that the relationship is missing.

4. **Use source view to verify a source symbol.**

   Select **View Source** for the entity you are investigating. In the source area, use the available display choice to switch between **Source** and any comparison view that is available.

   Confirm that the displayed source content corresponds to the entity you selected. If the source view is not what you expected, return to the entity list and verify that you selected the correct entity with a similar name.

   > 📷 _Screenshot pending: Source view with the View Source action and the Source display option._

5. **Check the entity’s resolution state.**

   Look for the **Resolve** action and the status summary such as **4 All Resolved**. A resolved status indicates that the listed items have been addressed; it does not necessarily mean every possible entity or relationship is present.

   If an item remains unresolved, select it and review the available details and source view before marking it resolved.

6. **Open captured flows and choose the appropriate flow group.**

   In the captured flows area, use the available flow options, such as **Loop Flows**, **Pipeline Flows**, and **User Flow**.

   Look for the flow that best matches your task. Examples may include:

   - **🔐 Authentication & Authorization Flow**
   - **OAuth 2.0 Flow**
   - **Authorization Code Flow**
   - **Authentication Flow**
   - **Agent Loop Flow Diagrams**
   - **Evolved Pipeline Flow**
   - **🛟 Atloria Help Widget**

   If a flow is not visible in one group, check the other flow options before assuming it was not captured.

7. **Recheck the flow from the relevant entity.**

   When a flow appears incomplete, return to the associated entity and inspect its relationships. A flow may span several entities, such as a page, component, hook, provider, service, and repository. Checking each related entity can reveal where the displayed path changes or stops.

   > 📷 _Screenshot pending: Captured flows area showing Loop Flows, Pipeline Flows, and User Flow options._

## Tips and Best Practices

- Search using distinctive keywords rather than full names. For example, use **Authorization** instead of entering a complete flow title.
- Check both entity types and relationships. An item that seems missing as a component may be represented as a hook, route, service, or provider.
- Treat relationship wording carefully. **Renders** and **uses** describe different connections, so they may lead you to different entities.
- Use **View Source** to validate the selected entity before acting on a suspected missing symbol.
- Review all available flow groups—**Loop Flows**, **Pipeline Flows**, and **User Flow**—when looking for captured activity.
- Do not use **Resolve** simply to remove an item from your attention. Resolve it after you have verified the entity, relationship, or flow information.

## Related Pages

- [Search and Review Entities](#)
- [Understand Entity Relationships](#)
- [View Source Information](#)
- [Review Captured Flows](#)
- [Resolve Source Intelligence Items](#)

## Troubleshooting

### An entity does not appear in search

**Problem:** You cannot find an expected component, hook, page, service, or other entity in **Search entities…**.

**Cause:** The entity may use a different displayed name, may be categorized under another entity type, or may be represented by a related item rather than the name you expect.

**Solution:** Search using a shorter or distinctive keyword. Then check related types such as **COMPONENT**, **HOOK**, **PAGE**, **ROUTE**, **CONTEXT**, or **SERVICE**. Select likely matches and review **Entity Detail** and relationships.

### A relationship appears to be missing

**Problem:** You expect one entity to connect directly to another, but the relationship is not shown.

**Cause:** The connection may be indirect. For example, a component can render another component through an intermediate entity, or it can use a hook that leads to additional related entities.

**Solution:** Open the first entity, review its displayed relationships, and follow each related entity in sequence. Look for relationship wording such as **renders** and **uses**. Use **View Source** to confirm that you are investigating the intended entity.

### A source symbol or flow is not visible

**Problem:** **View Source** does not show the expected source information, or a flow such as **Authentication Flow** is not listed.

**Cause:** You may have selected a similarly named entity, chosen the wrong source display option, or checked only one flow group.

**Solution:** Return to **Search entities…** and select the correct entity. Open **View Source**, confirm the **Source** display option, and then check **Loop Flows**, **Pipeline Flows**, and **User Flow** for the missing flow.

<!-- source: troubleshoot-ai-and-technical-documentation-problems.md -->

# Troubleshoot AI and Technical Documentation Problems

This page helps you resolve problems with AI-generated technical documentation, API references, code examples, and documentation that no longer matches your source. Addressing these issues helps keep your team’s Technical Docs accurate, useful, and ready to share.

## Overview

Atloria’s **Technical Docs** area helps you generate and maintain technical documentation from your project. You can start documentation generation, review API reference content, add code examples, inspect source material, and export completed documentation.

You may need this page when generation remains in progress, an API reference does not contain the expected details, a code snippet looks incorrect, or documentation appears outdated after changes to your project. Start by checking the generation status and reviewing the relevant source before making documentation changes.

Technical documentation can cover multiple parts of a project, including frontend components, backend services, databases, API schemas, configuration, documentation, and infrastructure. When a page is incomplete, the underlying source may not have been successfully analyzed, may have generated warnings, or may not yet be reflected in the current documentation.

> 📷 _Screenshot pending: The Technical Docs screen showing the Generation section, generation status, and documentation actions._

## Prerequisites

Before you begin troubleshooting, make sure you have:

- Access to the correct project’s **Technical Docs** area.
- Permission to view project documentation and source information.
- A completed or currently running documentation generation.
- The relevant project changes available for review if you are checking documentation freshness.
- A clear understanding of whether you are reviewing:
  - Generated technical documentation
  - An **API Reference**
  - A code example or snippet
  - Source information displayed through **View Source**
- Enough time for generation to complete before starting another generation attempt.

## Step-by-Step Instructions

1. **Open the project’s Technical Docs area.**

   Open your project and select **Technical Docs**. This is the central location for generated documentation, API reference content, source review, and export actions.

   If you are unsure whether documentation exists yet, look for **Generate Documentation →**. This indicates that you can begin a new documentation generation process.

2. **Check the current generation status.**

   Select **Generation** to review the documentation generation state. During processing, Atloria displays **4. Generation Running**.

   If generation is still running, wait for it to finish before judging whether content is missing or incomplete. Starting another generation while one is already running can make it harder to determine which result you are reviewing.

   If you need to stop the current process, select **■ Cancel Generation**. Use this only when the generation appears stuck or when you need to make major source changes before generating again.

3. **Review missing or incomplete generated content.**

   If expected documentation is absent after generation finishes, return to **Technical Docs** and identify the affected area. For example, determine whether the missing information belongs to frontend behavior, backend processing, a database area, API schema, configuration, or infrastructure.

   Documentation generation may process project information across these areas in stages. A successful parse can complete with no errors, while another result may complete with warnings. If you see incomplete coverage, review the affected source information and generate the documentation again after the relevant project content is available.

4. **Investigate API reference issues.**

   Select **API Reference** when endpoint or interface documentation appears incomplete, unclear, or inconsistent with the project.

   Review the generated API reference before exporting it. If an option for a compact presentation is available, select **compact** when you need a shorter view for quick review. Use the standard documentation view when you need more detail.

   If the API reference is missing expected information, inspect the related source content first. Then return to **Generation** and generate documentation again so the API reference can be refreshed from the latest available project information.

   > 📷 _Screenshot pending: The API Reference view with the compact style option and Generate button._

5. **Check code examples and snippets.**

   When documentation needs an example, select **Add code examples**. Review each example for relevance, completeness, and whether its language and formatting match the code you expect users to see.

   If a snippet appears incorrect, use **View Source** to compare the documentation with the source material. In the source review area, select **Source** to focus on the source version. If a comparison view is available, use it to identify differences between the displayed documentation content and the source content.

   Correct or update the source material as needed, then regenerate the documentation. Do not rely on an outdated snippet simply because it is formatted correctly; it must also reflect the current project behavior.

6. **Resolve documentation freshness problems.**

   If documentation was generated before recent project changes, treat it as potentially outdated. Check whether changed relationships or responsibilities are reflected in the documentation. For example, a component may render another component, use a hook or context, call an API, use a service, or query a model.

   Review the applicable source through **View Source**, then run generation again from **Generation**. After the new result is available, verify that the affected technical documentation, API reference, and code examples have been updated.

7. **Export only after review.**

   Select **Export Documentation** only after you have confirmed that generation has finished and the documentation is current. Exporting before resolving known problems can distribute incomplete API details, stale examples, or missing technical sections.

## Tips and Best Practices

- **Wait for generation to finish.** When **4. Generation Running** is displayed, content may not yet represent the final result. Avoid treating an in-progress result as a documentation defect.
- **Use source review to validate AI output.** Select **View Source** whenever generated text, an API reference, or a snippet appears questionable. This is especially important after recent project changes.
- **Regenerate after meaningful changes.** Refresh documentation after changes to components, hooks, contexts, services, API behavior, data access, configuration, or infrastructure. These changes can affect relationships described in technical documentation.
- **Check warnings carefully.** A generation process can complete with warnings rather than errors. In this case, review the affected content for gaps instead of assuming the entire documentation set is unusable.
- **Keep examples focused.** Use **Add code examples** for examples that clarify implementation or usage. Avoid adding examples that repeat information already clear in the surrounding documentation.
- **Review API references separately.** A complete general technical document does not guarantee that every API reference detail is present or easy to understand. Open **API Reference** and validate it independently.
- **Export last.** Use **Export Documentation** as the final step in your review process, not as a substitute for validating generated content.

## Related Pages

- [Generate Technical Documentation](#)
- [Review an API Reference](#)
- [Add Code Examples to Documentation](#)
- [View Documentation Source](#)
- [Export Technical Documentation](#)
- [Resolve Project Issues](#)

## Troubleshooting

### Generation remains on “4. Generation Running”

**Problem:** The **Generation** section continues to show **4. Generation Running**, and the documentation is not ready to review.

**Cause:** Generation is still processing project information, or the current generation may no longer be progressing as expected.

**Solution:** Wait briefly and refresh your view of **Generation**. If the status does not change and you need to stop the process, select **■ Cancel Generation**. Review any relevant source changes, then start documentation generation again using **Generate Documentation →**.

### The API Reference is incomplete or does not match the project

**Problem:** The **API Reference** does not include expected details or appears inconsistent with current project behavior.

**Cause:** The reference may have been generated before the latest project changes, or the relevant source information may not have been fully available during generation.

**Solution:** Select **View Source** and review the related source information. Confirm that the required API behavior is present, then return to **Generation** and generate the documentation again. Reopen **API Reference** and validate the updated result before exporting.

### A code snippet is outdated or incorrect

**Problem:** A code example does not match the current implementation or is not useful to readers.

**Cause:** The documentation may have been generated from earlier source information, or the example may not reflect changes in the component, service, API, or other related area.

**Solution:** Select **View Source**, then use **Source** to review the current source material. Update the underlying project content if needed, regenerate the documentation, and use **Add code examples** to include a clearer or more current example.

<!-- source: troubleshoot-screenshot-capture-problems.md -->

# Troubleshoot Screenshot Capture Problems

This page helps you resolve issues when screenshots are missing, do not recapture in bulk, or are not available for the version you are reviewing. Resolving these issues helps keep version reviews, comparisons, and captured flows accurate.

## Overview

Atloria uses screenshots to represent captured flows and version-specific visual assets. You may need to troubleshoot screenshot capture when a screen is not discovered, an expected image is missing, or a version does not show the screenshots you expect.

Start from the project’s **Versions** area when the issue is related to a specific version. From there, you can review version information, compare versions, and open screenshot-related views. Use **Manage Screenshots →** when you need to review or manage captured screenshots.

For larger capture problems, use the available recapture options. **Recapture** is intended for retrying a capture, while **3. Bulk Recapture** is useful when multiple screenshots need to be captured again. Check the capture or parse outcome after you run an action: a successful completion indicates that processing completed without errors, while a completion with warnings means you should review the affected items.

> 📷 _Screenshot pending: The Versions area showing the Manage Screenshots → action and screenshot-management options._

## Prerequisites

Before you begin, make sure you have:

- Access to the correct project and its **Versions** area.
- The correct version selected for the screenshots you want to review or recapture.
- Permission to use screenshot-management actions, including **Manage Screenshots →**, **Recapture**, or **3. Bulk Recapture**.
- A clear understanding of whether the issue affects one screenshot, several screenshots, or an entire version.
- The latest version available if you expect recently updated content to appear. If needed, use **⚡ Generate Next Version** before reviewing version-specific assets.
- Time for capture processing to finish before deciding that a screenshot is missing.

## Step-by-Step Instructions

1. **Open the affected project and select Versions.**

   Go to the project where the screenshot problem occurred, then select **Versions**. Identify the version associated with the missing or outdated screenshot.

   If you are not sure which version is current, use **Manage all versions →** or **🕘 Go to Version Manager** to review the available versions.

   > 📷 _Screenshot pending: The project Versions area with version-management actions._

2. **Confirm that you are reviewing the correct version.**

   Open the version that should contain the screenshot. If a newer version has been generated, make sure you are not reviewing an earlier version by mistake.

   When your team is preparing a new version, you may see actions such as **▶ Generate New Version**, **⚡ Generate Next Version**, or **🚀 Publish Version 4**. Generate or select the appropriate version before troubleshooting its screenshots.

3. **Open screenshot management.**

   Select **Manage Screenshots →** to review the screenshots associated with the selected version or captured flow.

   Look for the affected screen or flow. Compare what is displayed with what you expected to be captured. If the screenshot is present but appears outdated, the capture may need to be repeated rather than rediscovered.

4. **Retry a single affected screenshot.**

   If only one screenshot is missing or incorrect, select **Recapture** for that item.

   Wait for processing to complete, then refresh or reopen the screenshot view. Review the result before retrying again. Repeated recaptures are most useful when the underlying screen has changed or when the earlier capture did not complete successfully.

5. **Use bulk recapture for multiple affected screenshots.**

   If several screenshots are missing, outdated, or inconsistent, select **3. Bulk Recapture** instead of recapturing them one at a time.

   Use bulk recapture when the issue affects a group of screens, a captured flow, or a version’s visual assets. After the batch completes, review the results and identify any individual items that still require attention.

6. **Check the completion outcome.**

   Review the processing outcome after a capture or batch recapture. A successful parse completion indicates that processing finished successfully with no errors. A completion with warnings means that processing finished but one or more items may need review.

   If the outcome includes warnings, return to the screenshot list and locate the screenshots that remain missing, outdated, or incomplete.

7. **Compare versions when the issue is version-specific.**

   Select **Compare Versions** when you need to determine whether a screenshot changed between versions.

   This is especially useful when a screenshot appears correct in one version but missing or different in another. Confirm that you are comparing the intended versions, then use the results to decide whether to recapture the current version or generate a new version.

8. **Escalate through Operations or Support Agent if the issue persists.**

   If recapture does not resolve the problem, open **Operations** or **Support Agent** and provide the project, version, affected flow or screenshot, and the completion result you observed.

   Include whether the issue occurred during a single **Recapture** or **3. Bulk Recapture**, and whether processing completed successfully or completed with warnings.

> 📷 _Screenshot pending: Screenshot-management view showing Recapture, 3. Bulk Recapture, and the capture completion outcome._

## Tips and Best Practices

- **Start with the smallest fix.** Use **Recapture** for one incorrect screenshot before running **3. Bulk Recapture** for a larger set.
- **Always verify the version first.** Many apparent screenshot problems occur because you are viewing a different version than the one that was generated or published.
- **Use Compare Versions for visual differences.** Do not assume a screenshot is incorrect solely because it differs from another version; use **Compare Versions** to confirm whether the difference is expected.
- **Review warnings even when processing completes.** A completed process with warnings may leave some screenshots unavailable or incomplete.
- **Avoid publishing before checking assets.** Before selecting **🚀 Publish Version 4**, review the version’s screenshots to confirm that the expected captured flows are present.
- **Record the scope of the issue.** Note whether the problem affects one screen, a captured flow, or all screenshots in a version. This makes it easier to choose between single recapture, bulk recapture, or support escalation.

## Related Pages

- [Manage Screenshots](#) — Review and manage screenshots associated with a project version.
- [Manage Versions](#) — Generate, review, and publish project versions.
- [Compare Versions](#) — Compare content and visual changes between versions.
- [Review a Version](#) — Validate a version before publishing it.
- [Use Support Agent](#) — Request help for unresolved operational issues.
- [Operations Support](#) — Review operational tools and issue-resolution procedures.

## Troubleshooting

### A screenshot is missing from the selected version

**Problem:** You cannot find an expected screenshot after opening **Manage Screenshots →**.

**Cause:** You may be viewing the wrong version, the screenshot may not have been discovered for that version, or processing may have completed with warnings.

**Solution:** Return to **Versions** and confirm the correct version. Open **Manage Screenshots →**, then use **Recapture** for the missing item. If multiple screenshots are missing, use **3. Bulk Recapture**. Review the completion outcome and investigate warnings before retrying.

### Bulk recapture completed, but some screenshots are still unavailable

**Problem:** You selected **3. Bulk Recapture**, but one or more screenshots are still missing afterward.

**Cause:** Batch processing can complete with warnings, meaning that the overall operation finished but individual screenshots may still require review.

**Solution:** Check the completion outcome, then return to the screenshot list and identify the remaining affected items. Use **Recapture** for individual items that did not update. If the issue continues, contact **Operations** or **Support Agent** with the version and affected screenshot details.

### A screenshot does not match the expected version

**Problem:** The screenshot exists, but it looks outdated or differs from what you expected.

**Cause:** The screenshot may belong to an earlier version, or the current version may not have been recaptured after changes were made.

**Solution:** Select **Compare Versions** to identify where the difference occurred. Confirm that you are viewing the intended version, then use **Recapture** or **3. Bulk Recapture** as appropriate. If the updated work requires a new version, select **⚡ Generate Next Version** and review its screenshots before publishing.

<!-- source: troubleshoot-analytics-and-export-problems.md -->

# Troubleshoot Analytics and Export Problems

This page helps you resolve missing project analytics, unavailable version comparisons, and problems exporting reporting data. Use these steps before escalating an operations-support request so you can confirm that you are viewing the correct project and that its latest processing has completed.

## Overview

Atloria provides project-level analytics and version comparison views to help you understand project activity and changes over time. You may need these views when a project dashboard does not show expected data, when comparison results are incomplete, or when you need to download results for offline reporting.

Analytics and comparisons depend on the selected project and its available project versions. If you are looking at a different project than expected, or if the latest project processing has not completed successfully, the information you expect may not yet appear.

When reporting data is available, you can use **Export CSV** to download it. If the export does not contain the expected records, first confirm the active project and the information currently displayed on screen.

> 📷 _Screenshot pending: Project analytics screen showing project-level metrics and reporting information._

## Prerequisites

Before you begin, make sure you have:

- Access to the **Projects** area.
- Permission to open the relevant project dashboard.
- The correct project name or a distinctive search term.
- At least one completed project version if you need to use version comparison.
- A browser that permits file downloads for CSV exports.
- A completed or successfully processed project if you expect current analytics to be available.

## Step-by-Step Instructions

1. Open **Projects**.

   If you are not already in the project workspace, select **Projects** from the application navigation. If you are in another project view, select **← Back to Projects** to return to the project list.

2. Find the affected project.

   Use **Search projects...** to search within the project list. If you need to locate a project across your accessible work, use **Search across all projects...**.

   Confirm that the project you open is the one associated with the missing analytics or export. Similar project names are a common reason for reviewing the wrong dashboard.

3. Open the project dashboard.

   Select the project, then choose **Open Project Dashboard**. This opens the focused workspace for the selected project.

4. Check whether the project has completed processing.

   Review the project’s current processing outcome before relying on analytics or comparisons. A successful result is indicated when processing has completed successfully with no errors. A project can also complete with warnings; in that case, some results may require review before they are reflected as expected.

   If processing is still in progress, wait for it to finish, then refresh the dashboard and review the analytics again.

5. Open the project analytics view.

   From the selected project’s workspace, open the project analytics screen. Review the metrics currently shown for the active project.

   If analytics are missing, first verify:
   - You opened the intended project.
   - The project processing has completed.
   - You are not expecting data from a different version or another project.

6. Review version comparisons when analytics differ between releases.

   Open the project’s versions area, then open the version comparison screen. Select the versions you want to compare from the available project versions.

   If you cannot make a meaningful comparison, confirm that both versions exist and that each version has completed processing. A comparison can only reflect information available from the selected versions.

> 📷 _Screenshot pending: Version comparison screen with two project versions selected for review._

7. Export the visible reporting data.

   When the report or analytics results you need are displayed, select **Export CSV**.

   Your browser should download a CSV file. Open the downloaded file and verify that it contains the same information you expected to see in the current report or analytics view.

8. If the export does not download, try again after checking browser download settings.

   Confirm that your browser has not blocked the download or saved it to an unexpected location. Return to the report, select **Export CSV** again, and look for the browser’s download indicator.

9. Request support if the issue continues.

   If the project is correct, processing has completed, and analytics, comparisons, or exports are still unavailable, select **🤖 AI Support** or contact your operations support process. Include the project name, the affected version or versions, and a description of what you expected to see.

## Tips and Best Practices

- Start from **Projects** rather than relying on a previously opened browser tab. This helps ensure that you are working in the correct active project.
- Use **Search projects...** for a known project and **Search across all projects...** when you are unsure where the project is located.
- Wait for processing to complete before checking analytics. Results are most reliable after the project has completed successfully with no errors.
- Treat processing warnings as a reason to review results carefully. A completed project with warnings may not provide the same complete view you expect from a project completed without errors.
- For comparisons, verify both selected versions before drawing conclusions. Comparing an older version with a newly processed or incomplete version can make expected changes appear missing.
- Export only after you have verified the on-screen report. **Export CSV** downloads the information represented by the report you are viewing; it does not correct missing analytics or add data from another project.
- Keep the downloaded CSV with a clear name that includes the project and reporting date. This makes later reconciliation easier.

## Related Pages

- [Manage Projects](#)
- [Open and Review a Project Dashboard](#)
- [Review Project Versions](#)
- [Compare Project Versions](#)
- [Use Project Analytics](#)
- [Get Help from AI Support](#)

## Troubleshooting

### Analytics are missing or do not show expected project information

**Problem:** The project analytics screen is empty, incomplete, or does not match the information you expected.

**Cause:** You may be viewing the wrong project, the project may still be processing, or the most recent processing may have completed with warnings rather than without errors.

**Solution:** Return to **Projects** and use **Search projects...** to locate the intended project. Select **Open Project Dashboard**, confirm that processing has completed, and then reopen the analytics screen. If the result completed with warnings, review the project carefully and allow any outstanding work to finish before checking analytics again.

### Version comparison is unavailable or does not show expected changes

**Problem:** You cannot compare versions, or the comparison does not show the changes you expected.

**Cause:** The project may not have two appropriate versions available, one of the selected versions may not have completed processing, or the wrong versions may be selected.

**Solution:** Open the project’s versions area and confirm that both versions exist. Open the version comparison screen and select the intended versions again. Verify that each version has completed processing before reviewing the comparison results.

### Export CSV does not download or contains unexpected data

**Problem:** Selecting **Export CSV** does not create a file, or the downloaded CSV does not contain the records you expected.

**Cause:** Your browser may have blocked or redirected the download, or the report on screen may be for a different project or result set than intended.

**Solution:** Check your browser’s downloads list and download permissions. Then return to the report, confirm the active project and visible information, and select **Export CSV** again. If the exported data still differs from the on-screen report, contact support through **🤖 AI Support** and provide the project name, the time of export, and the expected versus actual result.

<!-- source: troubleshoot-integration-and-webhook-problems.md -->

# Troubleshoot Integration and Webhook Problems

This page helps you investigate integration connection failures, webhook delivery problems, privacy questions, and operational audit concerns. Use these steps to identify where a problem occurred and gather the information needed to resolve or escalate it.

## Overview

Integrations connect Atloria with external services such as GitHub, GitLab, and Bitbucket. When an integration is not working as expected, you may see missing updates, incomplete synchronization, or errors when attempting actions that depend on the connected service.

Webhooks send event notifications from Atloria to another system. The webhook area provides separate stages for configuration and delivery review: **1. Webhook Config** and **2. Delivery Log**. You can also use **⚡ Test Webhook** to check whether a configured destination can receive a test event.

For operational questions that require help, use **Support Agent** or **🤖 AI Support**. For questions about how information is handled, select **Privacy**. These areas help you distinguish a connection or delivery failure from a privacy, support, or audit-related concern.

> 📷 _Screenshot pending: The Integrations settings screen showing available GitHub, GitLab, and Bitbucket connections._

## Prerequisites

Before you begin troubleshooting, make sure you have:

- Access to the relevant Atloria project and its settings.
- Permission to view or manage the affected integration or webhook.
- The name of the connected service, such as **GitHub**, **GitLab**, or **Bitbucket**.
- Details of the expected result, such as the event that should have been delivered or the update that did not appear.
- The approximate time the issue occurred.
- Access to the external destination or service, if you need to verify whether it received a webhook.
- A clear understanding of whether your question is operational, privacy-related, or audit-related.

## Step-by-Step Instructions

1. **Open the integration settings.**

   Select **Settings → Integrations**. Review the available integration options, including **GitHub**, **GitLab**, and **Bitbucket**.

   Identify the service related to the problem. If the expected provider is not shown or does not appear connected, the issue may be with the integration setup rather than webhook delivery.

2. **Confirm the scope of the problem.**

   Determine whether the problem affects:
   - A single project or multiple projects
   - One integration provider or all providers
   - A single event or every expected event
   - Only new activity or also existing records

   This distinction matters because a missing update from GitHub, for example, may be an integration connection issue, while an event that was created but did not reach its destination is more likely a webhook delivery issue.

3. **Open the affected project’s Webhooks area.**

   In the project settings, select **Webhooks**. Start with **1. Webhook Config**.

   Review the configured webhook destination and confirm that it is the destination you expect. Check for obvious setup mistakes, such as using the wrong environment, an outdated destination, or a destination that is no longer active.

   > 📷 _Screenshot pending: The Webhooks screen with the “1. Webhook Config” section and the “⚡ Test Webhook” action._

4. **Send a test webhook.**

   Select **⚡ Test Webhook**. This lets you test the current configuration without waiting for a normal event to occur.

   After testing, verify whether the destination system received the test notification. If it did not, continue to the delivery records in the next step.

5. **Review delivery activity.**

   Select **2. Delivery Log**. Look for the test delivery and any failed or unexpected deliveries near the time the issue was reported.

   Compare successful and unsuccessful attempts when possible. A successful test usually indicates that the current webhook configuration can reach the destination. If normal events remain missing after a successful test, investigate whether the expected event was generated or whether it meets the destination’s processing requirements.

6. **Check the parse result when imported content is involved.**

   If the issue involves parsed or imported content, review the parse outcome. Atloria can show outcomes such as:

   - **Parse completed successfully with no errors**
   - **Parse completed with warnings**

   A successful parse with no errors indicates that parsing completed cleanly. A completion status with warnings means the process finished, but some content or details may need review. Warnings can explain partial or unexpected integration results even when the process did not fail outright.

7. **Use the right support channel for the issue.**

   For operational assistance, open **Operations** and select **Support Agent**, or use **🤖 AI Support** for guided help.

   Describe:
   - The integration provider or webhook involved
   - The affected project
   - The approximate time of the issue
   - Whether **⚡ Test Webhook** was successful
   - What you found in **2. Delivery Log**
   - Any parse result or warning you observed

   If you have a support item that is no longer active, use **Resolve** only after confirming the issue is fixed. The resolved view is available through **4 All Resolved**.

8. **Use Privacy for information-handling questions.**

   Select **Privacy** when your question is about what information is used, retained, shared, or processed. Do not treat a privacy question as a webhook failure unless you have confirmed that delivery or integration behavior is actually failing.

## Tips and Best Practices

- **Test before changing configuration.** Use **⚡ Test Webhook** first. This creates a clear current-state check and prevents unnecessary changes to a webhook that may already be working.

- **Review the Delivery Log immediately after testing.** Checking **2. Delivery Log** right after a test makes it easier to associate the result with your troubleshooting action.

- **Separate integration problems from webhook problems.** An integration controls the connection to services such as GitHub, GitLab, or Bitbucket. A webhook controls outbound event delivery. Check **Settings → Integrations** for connection concerns and **Webhooks** for delivery concerns.

- **Treat warnings as actionable information.** A parse status that completed with warnings is not the same as a clean completion. Review the affected content before assuming an integration issue is fully resolved.

- **Record times and expected outcomes.** When contacting **Support Agent**, include the time, the provider, the project, and the expected event. This helps operations teams compare your report with the delivery and audit history.

- **Use Privacy for privacy questions.** If your concern is whether data handling is appropriate, select **Privacy** rather than attempting to solve it by changing an integration or webhook configuration.

## Related Pages

- [Manage Integrations](#) — Connect and review GitHub, GitLab, and Bitbucket integrations.
- [Configure Project Webhooks](#) — Set up webhook destinations for a project.
- [Review Webhook Delivery Logs](#) — Interpret delivery history and test results.
- [Use Support Agent](#) — Request operational help for unresolved issues.
- [Privacy](#) — Review privacy information and submit privacy-related questions.
- [Resolve Support Items](#) — Manage resolved support work through **4 All Resolved**.

## Troubleshooting

### A webhook test does not reach the destination

**Problem:** You selected **⚡ Test Webhook**, but the receiving system did not show the test event.

**Cause:** The destination may be unavailable, the configured destination may be incorrect, or the receiving system may reject or ignore the event.

**Solution:** Open **Webhooks** and review **1. Webhook Config** to confirm the intended destination. Then check **2. Delivery Log** for the test attempt. If the configuration appears correct but delivery does not succeed, capture the test time and delivery details and contact **Support Agent** through **Operations**.

### An integration update is missing from GitHub, GitLab, or Bitbucket

**Problem:** You expected activity from **GitHub**, **GitLab**, or **Bitbucket** to appear in Atloria, but it is missing.

**Cause:** The integration may not be connected as expected, the expected activity may not have been generated, or imported content may have completed with warnings.

**Solution:** Go to **Settings → Integrations** and confirm the affected provider. If parsed or imported information is involved, check whether the result says **Parse completed successfully with no errors** or **Parse completed with warnings**. Include the provider, project, time, and parse outcome when requesting help from **Support Agent**.

### You need to know whether a delivery or integration creates a privacy concern

**Problem:** You are unsure whether information sent through an integration or webhook is handled appropriately.

**Cause:** This is a privacy and data-handling question, not necessarily a technical delivery failure.

**Solution:** Select **Privacy** and review the available privacy information. If you also have evidence of a failed delivery, separately review **2. Delivery Log** and report the technical details to **Support Agent**. Keeping privacy questions and delivery evidence separate helps ensure each concern is handled correctly.

<!-- source: contact-a-support-agent.md -->

# Contact a Support Agent

Use the Support Agent when you need help with a project, its documents, or an issue that requires additional investigation. Providing clear project and document details helps the support team understand your situation and respond more effectively.

## Overview

Atloria includes a **Support Agent** area for requesting help within your enterprise workspace. You can use it when you are working in a project and need assistance understanding documentation, locating information, or reporting an issue that affects your work.

Before contacting support, identify the project involved and gather the relevant document or issue details. For example, you may need help with a document listed under **Documents**, a project change, a version review, screenshots, analytics, or technical documentation.

The more specific you are about what you were doing when the issue occurred, the easier it is for a support agent to help. Include the project name, the document or page involved, what you expected to happen, and what happened instead.

> 📷 _Screenshot pending: The Support Agent area showing the location where you can request assistance._

## Prerequisites

Before you contact a support agent, make sure you have:

- Access to the Atloria workspace and the relevant project.
- The project name or project identifier available.
- The name of the affected document, if the request involves documentation.
- Details of the issue, including the action you took and the result you saw.
- Any useful context, such as the relevant change, version, screenshot, or technical documentation page.
- Permission to view the project content you are asking about.

## Step-by-Step Instructions

1. Open your project workspace.

   Select **Projects** to view the projects available to you. If you have many projects, use **Search projects...** to find the correct one.

   > 📷 _Screenshot pending: The Projects page with the “Search projects...” field used to locate a project._

2. Open the affected project.

   Select the project where the issue occurred. From the project area, review the section that relates to your request. For example, you may need information from **Documents**, changes, versions, screenshots, analytics, or technical documentation.

   If you need to return to the project list, select **← Back to Projects**.

3. Identify the affected document or area.

   If the problem concerns documentation, select **Documents**. Use **Search documents...** to locate the document by name.

   Record the document title and any details that help identify it. If the issue is not limited to a document, note the project area instead—for example, a specific change, version comparison, screenshot review, or technical documentation page.

4. Open the support area.

   Select **Support Agent** to access the support experience. Depending on your workspace configuration, you may also see **🤖 AI Support** as an available support action.

5. Describe your request clearly.

   In your support request, provide the following information in plain language:

   - The project name.
   - The affected document name, if applicable.
   - The project area where the issue occurred, such as **Documents** or a version review.
   - The steps you took before the problem appeared.
   - What you expected to happen.
   - What actually happened.
   - Any relevant details from the screen, including labels, statuses, or messages you saw.

   For example: “In the [project name] project, I opened **Documents** and searched for [document name]. I expected the document to appear, but I could not find it. Please help me confirm whether I have access.”

6. Include supporting context.

   If the request relates to a change or version, identify the specific item you were reviewing. If it relates to visual output, include the relevant screenshot context. If it concerns generated or technical content, state which technical documentation page or document is affected.

   Avoid sharing unrelated project information. Focus on the smallest set of details needed to reproduce or understand the issue.

7. Review your request before sending it.

   Confirm that the project and document names are correct and that your description distinguishes the expected result from the actual result. Then submit the request using the available action in the **Support Agent** area.

## Tips and Best Practices

- Start with the project name. Support requests are easier to investigate when the affected project is identified first.
- Use the exact document title shown in **Documents**. If necessary, use **Search documents...** before contacting support so you can provide the correct name.
- Describe one issue per request whenever possible. Separate requests make it easier to track different problems.
- State the expected and actual results separately. For example, write “I expected…” and “Instead…”.
- Mention the screen area you were using, such as **Projects**, **Documents**, or **Support Agent**.
- If you cannot locate the project, use **Search projects...** rather than guessing the project name.
- Do not use **Delete Project** or **Delete Documents** while trying to resolve a visibility or access problem. Contact support first if you are unsure whether content can be recovered.

> 📷 _Screenshot pending: An example support request that includes a project name, document name, expected result, and actual result._

## Related Pages

- [Manage Projects](#) — Find, open, and return to projects.
- [Work with Documents](#) — Search for and review project documents.
- [Review Project Changes](#) — View project changes and change details.
- [Compare Project Versions](#) — Review differences between versions.
- [Review Project Screenshots](#) — Use visual evidence when reporting a display issue.
- [Support Agent Settings](#) — Configure available support-agent options, if your role allows it.

## Troubleshooting

### I cannot find the project I need to mention

**Problem:** The project does not appear in the project list.

**Cause:** You may be viewing a long list of projects, searching with a different project name, or lacking access to the project.

**Solution:** Go to **Projects** and use **Search projects...** with the project name. If the project still does not appear, contact a support agent and provide the project name you expect to access. Explain that the project is missing from your available project list.

### I cannot identify the affected document

**Problem:** You know there is a document issue, but you cannot find the document title.

**Cause:** The document may be difficult to locate in a large document list, or you may be looking in the wrong project.

**Solution:** Open the correct project, select **Documents**, and use **Search documents...**. If you still cannot find it, tell the support agent the project name, the words you searched for, and where you expected the document to appear.

### My support request is too vague to investigate

**Problem:** You receive a request for more information, or the agent cannot reproduce the issue.

**Cause:** The request may not include the project, document, actions taken, or expected result.

**Solution:** Update your request with a concise sequence: project name, affected document or area, actions taken, expected result, and actual result. Include relevant change, version, screenshot, or technical documentation context when it directly relates to the issue.