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.
Docs Guide
Single source of truth for working in this repo. Read the section that matches what you are doing, then follow the pointer to the named framework, policy, or decision.
Pick your path
I am a human contributor
Onboarding, local preview, git hooks, and procedures. Start at contributing, then read the framework for the surface you are editing.
I am an AI agent
Agent governance and adapter contract. Then read the decision rules below for the kind of file you are touching.
I am reviewing a PR
Quality gates, governance approval, and Required Reading. The PR template auto-fills citations from changed paths.
Authority tiers
Files in docs-guide/ follow a six-tier precedence model. When two governance docs disagree, the higher tier wins. Every file declares its tier in the authority: frontmatter field.
| Tier | Folder | What it holds | Example |
|---|
| T0 | decisions/ | Locked precedent with IDs and supersession chains | D-DG-01..13: docs-guide structure |
| T1 | policies/ | Enforced rules; each policy declares consumers and a validator | Source-of-truth policy |
| T2 | frameworks/ | Subject models, taxonomies, lifecycles | Component framework |
| T3 | standards/ | Rules about form (voice, frontmatter, naming) | Voice rules |
| T4 | contributing/ | Procedures (how to do work) | Contributing |
| T5 | reference/, catalog/ | Look-up only, never normative | Feature map (currently under features/; moves to reference/features/ per D-DG-03) |
AGENTS.md, .claude/CLAUDE.md, .github/AGENTS.md, .cursor/rules/, .windsurf/rules/, .augment/rules/) point UP into docs-guide/. They surface canonical truth for specific consumers but hold no authority. Any rule stated only in an adapter file is invalid and must canonicalise into a T0–T3 source. Locked by D-DG-11.
Source-of-truth model
Where each kind of truth lives. Read the policy for the full boundaries.
| Surface | Source of truth |
|---|
| Runtime behaviour | Code and tests under operations/, snippets/, tools/ |
| Repo features and operations navigation | This docs-guide/ section |
| Public docs UX and content | Mintlify pages under v2/ |
| Generated catalogs and indexes | Generator scripts under operations/scripts/generators/; outputs are read-only |
| Decisions registries | docs-guide/decisions/ (master index) plus per-domain logs cross-referenced from it |
| Glossary | operations/scripts/generators/content/data/glossary-terms.json is the corpus; both internal (reference/internal-glossary.mdx) and public (v2/resources/glossary.mdx) glossaries derive from it |
Frameworks and standards by concern
The most-referenced surfaces, organised by what you are about to do. Citation counts will be auto-injected once the index generator lands; for now, this list is curated.
| Surface | Authority | Read before |
|---|
| Source-of-truth policy | T1 | Editing any cross-cutting boundary; deciding what “canonical” means for a new surface |
| Content system | T2 | Adding or restructuring content sections |
| Component framework | T2 | Writing or moving any component under snippets/components/ |
| Page taxonomy framework | T2 | Adding a new page; choosing pageType, pagePurpose, audience tokens |
| Authoring standard | T3 | Authoring any MDX page |
| Script framework | T2 | Adding a new script under operations/scripts/ |
| Repo structure | T2 (LOCKED) | Adding a top-level folder; restructuring root |
| Voice rules | T3 | Writing or rewriting prose; per-audience voice rules; banned phrases |
| Frontmatter spec | T3 | Authoring or migrating any frontmatter |
| File placement | T2 | Moving files; deciding where a new file belongs |
Decision rules – read before doing X
Before writing or moving any governed file, read the listed documents.
Before writing a component
- Component framework – category taxonomy, 7-tag JSDoc header
- File placement – folder placement rules
docs-guide/canonical/collation-data/Mintlify/mintlify-repo-best-practices.md – platform constraints
Before writing a script
- Script framework – type, concern, niche taxonomy; 11-tag JSDoc header
- File placement – folder placement rules
Before writing a docs page
- Content writing pipeline – pipeline phases, page taxonomy
- Voice rules – per-audience voice rules
- Frontmatter spec – required frontmatter fields
docs-guide/canonical/collation-data/Mintlify/mintlify-repo-best-practices.md – Mintlify platform constraints
Before writing a workflow
- GitHub Actions framework – type, concern taxonomy; naming convention; pipeline tags
.github/workspace/decisions-log.mdx – locked decisions D-ACT-01 through D-ACT-10operations/governance/config/governance-approval-policy.json – required approval labels
Before moving files
- Repo structure – root folder structure (LOCKED)
- File placement – component and script placement
- Docs guide structure policy – docs-guide folder rules
- Run the
/propagate skill for any file with more than five incoming references
Before adding or changing a decision
- Decisions registry – master index of all decision logs
- Docs guide structure decision log – example of the locked format
- ID grammar:
D-{SCOPE}-{NN} where SCOPE is one of NAV, ACT, GOV, SCRIPT, OWN, CONTENT, ORCH, GW, DG, GLOS
Governed surfaces
Major areas of this repo are governed. Each has a canonical framework, a root path, and a freshness status. The full live count is auto-generated at repo-governance-map.
| # | Area | Root path | Framework | Status |
|---|
| 1 | Components | snippets/components/ | Component framework | Current |
| 2 | Scripts | operations/scripts/ | Script framework | Current |
| 3 | AI tools and skills | ai-tools/ai-skills/ | AI tools framework | Current |
| 4 | Repo structure | Root folders | Repo structure | Current (LOCKED) |
| 5 | Content writing | v2/ | Content writing | Active |
| 6 | Documentation | docs-guide/ | Doc item model | Locked |
| 7 | Snippets root governance | snippets/ | snippets/guide.mdx | Current |
| 8 | Mintlify platform constraints | Platform-wide | docs-guide/canonical/collation-data/Mintlify/mintlify-repo-best-practices.md | Current |
| 9 | File placement | Cross-cutting | File placement | Current |
| 10 | GitHub Actions | .github/workflows/ | GitHub Actions framework | Current |
| 11 | Styles governance | style.css, v2/**/*.mdx, snippets/components/**/*.jsx | Styles engineering guide | Current |
node operations/scripts/generators/governance/generate-governance-map.js --check to verify all folders are governed and no frameworks are stale.
Did you mean
Common misroutes. If you landed here looking for one of these, follow the pointer.
| You wanted | Go to |
|---|
| Public protocol or product docs | v2/ (under docs.livepeer.org nav) |
| Component source code | snippets/components/ |
| Script source code | operations/scripts/ |
| AI skills source | ai-tools/ai-skills/ |
| Public glossary | v2/resources/glossary |
| Internal contributor or agent terminology | Internal glossary |
| In-flight working specs and plans | workspace/plan/active/ |
| Archived working specs | workspace/plan/archive/ |
| Mintlify platform notes | Mintlify best practices |
| Generated catalogs | docs-guide/catalog/ (do not edit; regenerated from source) |
| Configuration registries | operations/governance/config/ |
Update rules
- Update manual docs when behaviour, process, canonical boundaries, or architecture changes. Bump
lastVerified on save.
- Regenerate generated catalogs when scripts, workflows, or templates change:
node operations/scripts/generators/governance/catalogs/generate-docs-guide-indexes.js --writenode operations/scripts/generators/governance/catalogs/generate-docs-guide-pages-index.js --writenode operations/scripts/generators/governance/catalogs/generate-docs-guide-components-index.js --writenode operations/scripts/generators/components/library/generate-ui-templates.js --writenode operations/tests/unit/script-docs.test.js --write --rebuild-indexesnode operations/scripts/validators/content/structure/enforce-generated-file-banners.js --check
- Re-run the docs audit pipeline when docs, scripts, reports, or routing paths change:
node operations/scripts/dispatch/governance/repo/repo-audit-orchestrator.js --mode static --scope fullnode operations/scripts/integrators/ai/agents/cross-agent-packager.js --agent-pack all
- Keep
README.md high-level. Link to canonical docs-guide pages for deep detail.
- Keep generator scripts, generated outputs, and downstream consumers in sync whenever a catalog path or title changes. Use the
/propagate skill on any move or rename of a file with more than five incoming references.
Standards index
Published authoring and style standards in docs-guide/standards/.
| Standard | What it covers |
|---|
| Authoring standard | Page composition, structure, headings, sections |
| Voice rules | Per-audience voice, banned words and phrases, UK English |
| Voice and copy | Copy patterns, brand voice across audiences |
| Naming conventions | File, folder, component, script, workflow naming |
| Frontmatter spec | Required and optional frontmatter fields per authority tier |
Decision registry
All decision registries are indexed at decisions/registry. Per-domain registries live under workspace/plan/active/<DOMAIN>/decisions/ and are cross-referenced from the master index. The decisions pipeline (D-DG-01 ID grammar plus generator and validator) is documented in decisions/docs-guide-structure.
