> ## Documentation Index
> Fetch the complete documentation index at: https://docs.livepeer.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Naming Conventions

> Canonical naming conventions for files, folders, components, scripts, workflows, and documentation pages across the Livepeer docs repo.

# Naming Conventions

Canonical naming conventions for all file types in this repo.

***

## Files

| Type                 | Convention                                           | Example                                                |
| -------------------- | ---------------------------------------------------- | ------------------------------------------------------ |
| MDX pages            | kebab-case                                           | `getting-started.mdx`                                  |
| Components (JSX)     | PascalCase                                           | `ContractVerifier.jsx`                                 |
| Scripts (JS)         | kebab-case                                           | `fetch-contract-addresses.js`                          |
| Data files (JSON/JS) | kebab-case                                           | `contract-addresses.json`                              |
| Workflows (YAML)     | `type-concern-verb-name.yml`                         | `integrator-maintenance-update-contract-addresses.yml` |
| Policy docs          | kebab-case                                           | `root-allowlist-governance.mdx`                        |
| Framework docs       | kebab-case with `-canonical` suffix for locked specs | `component-framework-canonical.md`                     |

***

## Folders

| Location             | Convention               | Example                                  |
| -------------------- | ------------------------ | ---------------------------------------- |
| v2/ sections         | kebab-case, plural       | `orchestrators/`, `gateways/`            |
| Component categories | lowercase singular       | `elements/`, `wrappers/`                 |
| Component sub-niches | lowercase plural         | `buttons/`, `callouts/`                  |
| Script types         | lowercase plural         | `audits/`, `generators/`                 |
| Script concerns      | lowercase singular       | `content/`, `governance/`                |
| Workspace folders    | UPPERCASE for plan names | `SCRIPT-GOVERNANCE/`, `CONTENT-WRITING/` |

***

## Domain Terms

| Use                         | Never                                      |
| --------------------------- | ------------------------------------------ |
| LPT                         | "tokens", "crypto"                         |
| orchestrator                | "miner", "node" generically                |
| gateway                     | "API gateway"                              |
| active set                  | "top orchestrators"                        |
| reward cut / fee cut        | "commission"                               |
| probabilistic micropayments | "payments" generically                     |
| on-chain / off-chain        | payment MODE, never workload type          |
| dual                        | WORKLOAD config, not a payment type        |
| pool worker                 | Must be defined at first use on every page |

***

## Reserved Prefixes

| Prefix        | Meaning                          |
| ------------- | -------------------------------- |
| `_workspace/` | Working directory, not published |
| `_archive/`   | Archived content                 |
| `x-archive/`  | Superseded files (scripts)       |
| `_dep-`       | Deprecated content               |