> ## 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 Overview

> Internal source of truth for repository features and functionality

# Docs Guide (Internal Source of Truth)

This section is the canonical landing page for repository features, operating rules, and supporting catalogs. Use it as the repo systems map, not as a replacement for executable code, tests, or generated indexes.

## Source-of-Truth Model

* Runtime behavior: source of truth is code and tests.
* Feature and operations navigation: source of truth is this `docs-guide/` section.
* Public docs UX/content: source of truth is Mintlify pages under `v2/`.
* Generated catalogs: source of truth is generator scripts; generated files are read-only outputs.

See [source-of-truth-policy.mdx](./policies/source-of-truth-policy.mdx) for full boundaries.

## Section Routes

| Section      | Purpose                                                                                         | Canonical entry points                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Contributing | How to work in the repo safely and consistently                                                 | [contributing.mdx](./contributing/contributing.mdx), [mintlify.mdx](./contributing/mintlify.mdx)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Features     | Major repo systems, automation surfaces, functional maps, and implementation-ready gap analysis | [feature-map.mdx](./features/feature-map.mdx), [ai-features.mdx](./features/ai-features.mdx), [automations.mdx](./features/automations.mdx), [data-integrations.mdx](./features/data-integrations.mdx), [adaptive-architecture.mdx](./features/adaptive-architecture.mdx), [ui-system.mdx](./features/ui-system.mdx), [contributor-tools.mdx](./features/contributor-tools.mdx), [gap-analysis.mdx](./features/gap-analysis.mdx), [visual-explainer-workflows.mdx](./features/visual-explainer-workflows.mdx)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Tooling      | CLI, developer tooling support, and reusable authoring reference maps                           | [lpd-cli.mdx](./tooling/lpd-cli.mdx), [lpd-mdx-preview.mdx](./tooling/lpd-mdx-preview.mdx), [content-brief-template.md](./tooling/content-brief-template.md), [icon-map.mdx](./tooling/reference-maps/icon-map.mdx), [ai-tools.mdx](./tooling/ai-tools.mdx)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Frameworks   | Decision models, structural guides, and improvement workflows (no enforcement language)         | [content-writing.mdx](./frameworks/content-writing.mdx), [checks-framework.mdx](./frameworks/checks-framework.mdx), [content-system.mdx](./frameworks/content-system.mdx), [research-skill-workflow.mdx](./frameworks/research-skill-workflow.mdx)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Policies     | Enforced rules, prohibited actions, gate-owned controls, and audit standards                    | [source-of-truth-policy.mdx](./policies/source-of-truth-policy.mdx), [generated-artifact-and-hook-governance.mdx](./policies/generated-artifact-and-hook-governance.mdx), [v2-folder-governance.mdx](./policies/v2-folder-governance.mdx), [quality-gates.mdx](./policies/quality-gates.mdx), [audit-system-overview.mdx](./policies/audit-system-overview.mdx), [skill-pipeline-map.mdx](./policies/skill-pipeline-map.mdx), [cleanup-quarantine-policy.mdx](./policies/cleanup-quarantine-policy.mdx), [component-layout-decisions.mdx](./policies/component-layout-decisions.mdx), [infrastructure-principles.mdx](./policies/infrastructure-principles.mdx), [ownerless-governance.mdx](./policies/ownerless-governance.mdx), [root-allowlist-governance.mdx](./policies/root-allowlist-governance.mdx), [agent-governance-framework.mdx](./policies/agent-governance-framework.mdx), [docs-guide-structure-policy.mdx](./policies/docs-guide-structure-policy.mdx), [workspace-lifecycle-policy.mdx](./policies/workspace-lifecycle-policy.mdx), [script-governance.mdx](./policies/script-governance.mdx), [snippets-assets-policy.mdx](./policies/snippets-assets-policy.mdx) |
| Repo Ops     | Operational reference: config files, enforcement maps, secrets                                  | [repo-config-map.mdx](./repo-ops/config/repo-config-map.mdx), [enforcement-map.mdx](./repo-ops/maps/enforcement-map.mdx), [solutions-secrets.mdx](./repo-ops/secrets/solutions-secrets.mdx)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Catalog      | Generated catalogs – read-only outputs; never edit manually                                     | [ui-templates.mdx](./catalog/ui-templates.mdx), [pages-catalog.mdx](./catalog/pages-catalog.mdx), [components-catalog.mdx](./catalog/components-catalog.mdx), [scripts-catalog.mdx](./catalog/scripts-catalog.mdx), [workflows-catalog.mdx](./catalog/workflows-catalog.mdx), [templates-catalog.mdx](./catalog/templates-catalog.mdx)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |

## Frameworks vs Policies

Use `Frameworks` for guides, helpers, warnings, models, and other improvement-oriented operating guidance. Use `Policies` for enforced rules, prohibited actions, canonical path contracts, and other constraints owned by hooks, validators, or audit gates.

Agent governance remains in `Policies`, not `Frameworks`, because approved instruction-file locations, overlap boundaries, and retirement targets are part of the repository's enforced operating contract. The same applies to V2 folder lanes because publishability, reserved paths, and workspace boundaries are path-governance rules enforced across routing, Mint, and audit tooling.

Archives remain under `docs-guide/_workspace/archive/`. Archived pages are not canonical entry points and should not be surfaced in active navigation.

## Update Rules

1. Update manual docs when behavior, process, canonical boundaries, or architecture changes.
2. Regenerate generated catalogs when scripts, workflows, or templates change:
   * `node operations/scripts/generators/governance/catalogs/generate-docs-guide-indexes.js --write`
   * `node operations/scripts/generators/governance/catalogs/generate-docs-guide-pages-index.js --write`
   * `node operations/scripts/generators/governance/catalogs/generate-docs-guide-components-index.js --write`
   * `node operations/scripts/generators/components/library/generate-ui-templates.js --write`
   * `node operations/tests/unit/script-docs.test.js --write --rebuild-indexes`
   * `node operations/scripts/validators/content/structure/enforce-generated-file-banners.js --check`
3. 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 full`
   * `node operations/scripts/integrators/ai/agents/cross-agent-packager.js --agent-pack all`
4. Keep `README.md` high-level and link to canonical docs-guide pages for deep detail.
5. Keep generator scripts, generated outputs, and downstream consumers in sync whenever a catalog path or title changes.

## Related Areas

* Root orientation: [`README.md`](../README.md)
* Public docs guide: [`v2/resources/documentation-guide/`](../v2/resources/documentation-guide/)
* Contributor procedures: [`docs-guide/contributing/`](./contributing/contributing)
* Test matrices and CI behavior: [`operations/tests/README.md`](../operations/tests/README.md)
