docs — Code View¶
← Back to Container | ← Back to System
Component Information¶
| Field | Value |
|---|---|
| Component | docs |
| Container | Application |
| Type | module |
| Description | Documentation stage of the AAC pipeline | Markdown documentation generator |
| --- |
Code Structure¶
Class Diagram¶
Code Elements¶
6 code element(s)
#### Functions ##### `run()` Execute the documentation stage | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Async** | Yes || **Returns** | `Promiseimport("C:/Users/chris/git/archlette/src/core/types").PipelineContext — - Pipeline context with configuration, logging, IR, and rendered diagrams
---
##### `markdownDocs()`
Generate markdown documentation
| Field | Value |
| --- | --- |
| **Type** | `function` |
| **Visibility** | `public` |
| **Async** | Yes || **Returns** | `Promiseimport("C:/Users/chris/git/archlette/src/core/types").PipelineContext
---
##### `findDiagramsForView()`
Find diagram files for a specific view type
| Field | Value |
| --- | --- |
| **Type** | `function` |
| **Visibility** | `private` |
| **Returns** | `string[]` || **Location** | `C:/Users/chris/git/archlette/src/docs/builtin/markdown-docs.ts:262` |
**Parameters:**
- `rendererOutputs`: import("C:/Users/chris/git/archlette/src/core/types").RendererOutput[]- `diagramsDir`: string- `docsDir`: string- `viewType`: string- `log`: import("C:/Users/chris/git/archlette/src/core/logger").Logger
---
##### `findDiagramsForContainer()`
Find component diagrams for a specific container
| Field | Value |
| --- | --- |
| **Type** | `function` |
| **Visibility** | `private` |
| **Returns** | `string[]` || **Location** | `C:/Users/chris/git/archlette/src/docs/builtin/markdown-docs.ts:295` |
**Parameters:**
- `rendererOutputs`: import("C:/Users/chris/git/archlette/src/core/types").RendererOutput[]- `diagramsDir`: string- `docsDir`: string- `container`: { id: string; name: string; }
---
##### `findClassDiagramsForComponent()`
Find class diagrams for a specific component
| Field | Value |
| --- | --- |
| **Type** | `function` |
| **Visibility** | `private` |
| **Returns** | `string[]` || **Location** | `C:/Users/chris/git/archlette/src/docs/builtin/markdown-docs.ts:334` |
**Parameters:**
- `rendererOutputs`: import("C:/Users/chris/git/archlette/src/core/types").RendererOutput[]- `diagramsDir`: string- `docsDir`: string- `component`: z.infer
---
##### `sanitizeFileName()`
| Field | Value |
| --- | --- |
| **Type** | `function` |
| **Visibility** | `private` |
| **Returns** | `string` || **Location** | `C:/Users/chris/git/archlette/src/docs/builtin/markdown-docs.ts:369` |
**Parameters:**
- `name`: string
---