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.
Frontmatter
Key
pageType: [landing, overview, tutorial, quickstart, how_to, concept, reference, faq, troubleshooting, changelog, glossary, guide] audience: [developer, gateway-operator, orchestrator, delegator, platform-builder, community, internal, general, everyone] TBD: (opt) persona: developer [], gateway-operator [], orchestrator [solo operator, pool operator, new node runner, production operator], delegators [], platform-builder [], community [], internal [], general [], everyone [] purpose: orient, explain, choose, start, build, configure, operate, troubleshoot, optimize, integrate, verify, compare, reference, learn, update complexity: beginner, intermediate, advanced lifecycleStage: discover, evaluate, setup, build, operate, troubleshoot, optimise-
pageType should guide structural fit
Example:
referencecan be more literal;conceptshould name the idea cleanly;how_toshould sound task-oriented. -
purpose should guide the title’s job
Example:
comparemay allow contrast framing;explainshould prefer concept labels;chooseshould help orient a decision. - audience should guide terminology and specificity Example: technical audiences may support more specialized language; broad audiences may need clearer plain-language titles.
Values
pageType “format”
Domain: Presentation / IA Definition: Presentation Contract Decription: what it does Defines: How is this page structured? Governs:- Structural Format & Page Taxonomy
- UX
- Success Metrics
- Time to do x
- Outcome Type / Success Metrics Defines: How is this page structured? Categories:
- landing
- overview
- tutorial
- quickstart
- how_to
- concept
- reference
- faq
- troubleshooting
- changelog
- glossary
- guide
audience “who”
Domain: Reader segmentation Definition: Intended reader class Description: Who this page is for Defines: Governs:- terminology
- assumptions
- framing
- examples
- depth Governs:
- Content Voice / Language
- Content Terminology Categories: audience:
- developer
- gateway-operator
- orchestrator
- delegator
- platform-builder
- community
- internal
- general
- everyone
purpose “why”
Domain: Content Strategy / Reader Intent Definition: Content Intent Decription: why it exists Defines: What should this page help the reader do, decide, understand, or find? Governs:- Content Need
- Content (audience) Outcomes Current Categories: purpose:
- landing
- overview
- concept
- how_to
- tutorial
- reference
- faq
- glossary
- changelog
- troubleshooting Categories:
- orient → help user understand where they are / what exists
- explain → clarify a concept or system
- choose → support a decision
- start → get going quickly
- build → create or implement something
- configure → set up options/parameters
- operate → run/manage in practice
- troubleshoot → diagnose/fix problems
- optimize → improve performance/cost/reliability
- integrate → connect with other systems/tools
- verify → validate setup, behavior, or results
- compare → distinguish between options/models/paths
- reference → look up exact facts/syntax/values
- learn → learn terminology/foundations
- update → communicate changes/new features Enum: [ “orient”, // help user understand where they are / what exists “explain”, // clarify a concept or system “choose”, // support a decision “start”, // get going quickly “build”, // create or implement something “configure”, // set up options/parameters “operate”, // run/manage in practice “troubleshoot”, // diagnose/fix problems “optimize”, // improve performance/cost/reliability “integrate”, // connect with other systems/tools “verify”, // validate setup, behavior, or results “compare”, // distinguish between options/models/paths “reference”, // look up exact facts/syntax/values “learn”, // learn terminology/foundations “update” // communicate changes/new features ]
Title
Title
hello