# configuration/constants/document.constants.ts

> 60 lines of code and 21 definitions.

Tree: GovLab Docs
Language: typescript
Layer: infrastructure
Canonical: https://banes-lab.com/anatomy/docs#file-docs-configuration-constants-document-constants-ts
Source text: https://banes-lab.com/source/docs/configuration/constants/document.constants.ts.txt

Listed in [configuration/constants](https://banes-lab.com/api/source/docs/configuration/constants.md), after [configuration/constants/concern.constants.ts](https://banes-lab.com/source/docs/configuration/constants/concern.constants.ts.md) and before [configuration/constants/figure.constants.ts](https://banes-lab.com/source/docs/configuration/constants/figure.constants.ts.md).

## Definitions

- `DEFAULT_ROOT_PREFIX` (lexical_declaration, line 3, exported)
- `HOW_TO_PREFIX` (lexical_declaration, line 4, exported)
- `MARKDOWN_SUFFIX` (lexical_declaration, line 5, exported)
- `GENERATED_MARKER` (lexical_declaration, line 6, exported)
- `INSTALL_ARTIFACT_SUFFIX` (lexical_declaration, line 7, exported)
- `README_FILE` (lexical_declaration, line 8, exported)
- `MANIFEST_FILE` (lexical_declaration, line 9, exported)
- `PACKAGE_FILE` (lexical_declaration, line 10, exported)
- `FRONTMATTER_FENCE` (lexical_declaration, line 11, exported)
- `MODULE_BARREL_KEY` (lexical_declaration, line 12, exported)
- `CATALOG_FILE` (lexical_declaration, line 13, exported)
- `BARREL_SUFFIX` (lexical_declaration, line 14, exported)
- `DOC_BOUNDARY_FILENAMES` (lexical_declaration, line 16, exported)
- `SPINE_KEYS` (lexical_declaration, line 27, exported)
- `REFERENCE_EXTENSIONS` (lexical_declaration, line 29, exported)
- `DRIFT_CODES` (lexical_declaration, line 50, exported)
- `WORKSPACE_MAP_DOC` (lexical_declaration, line 57, exported)
- `DOC_STATUSES` (lexical_declaration, line 64, exported)
- `GENERATED_DOC_MARKS` (lexical_declaration, line 66, exported)
- `GENERATED_SCAN_LINES` (lexical_declaration, line 68, exported)
- `GENERATED_SCAN_CLOSE_OFFSET` (lexical_declaration, line 70, exported)

## Contained in

- [configuration/constants](https://banes-lab.com/anatomy/docs/folder-docs-configuration-constants.md)

## Source

```typescript
import { relativePath } from "@ssot/paths";

export const DEFAULT_ROOT_PREFIX = `${relativePath("docArch")}/`;
export const HOW_TO_PREFIX = "HOW-TO-";
export const MARKDOWN_SUFFIX = ".md";
export const GENERATED_MARKER = "generated";
export const INSTALL_ARTIFACT_SUFFIX = "-INSTALL.md";
export const README_FILE = "README.md";
export const MANIFEST_FILE = "_manifest.json";
export const PACKAGE_FILE = "package.json";
export const FRONTMATTER_FENCE = "---";
export const MODULE_BARREL_KEY = "changelogs";
export const CATALOG_FILE = "catalog.generated.json";
export const BARREL_SUFFIX = ".generated.md";

export const DOC_BOUNDARY_FILENAMES: readonly string[] = [
    "README.md",
    "LICENSE",
    "LICENSE.md",
    "AI-CONTEXT.md",
    "SECURITY.md",
    "CONTRIBUTING.md",
    "CODE_OF_CONDUCT.md",
    "AGENTS.md",
];

export const SPINE_KEYS: readonly string[] = ["type", "name", "summary"];

export const REFERENCE_EXTENSIONS: ReadonlySet<string> = new Set([
    ".ts",
    ".mts",
    ".cts",
    ".tsx",
    ".js",
    ".mjs",
    ".cjs",
    ".jsx",
    ".json",
    ".jsonc",
    ".md",
    ".css",
    ".go",
    ".sh",
    ".html",
    ".yml",
    ".yaml",
    ".toml",
]);

export const DRIFT_CODES = {
    chartSyntax: "chart-syntax",
    charts: "charts-drift",
    doc: "doc-drift",
    readme: "readme-drift",
} as const;

export const WORKSPACE_MAP_DOC = {
    concern: "workspace",
    member: "project",
    name: "workspace-dependency-map",
    type: "reference",
} as const;

export const DOC_STATUSES: readonly string[] = ["planned", "building", "current", "superseded"];

export const GENERATED_DOC_MARKS: readonly string[] = ["auto-generated", "do not edit"];

export const GENERATED_SCAN_LINES = 5;

export const GENERATED_SCAN_CLOSE_OFFSET = 4;
```