Skip to content

Livepeer network docs: orchestrators & delegators under /network#1

Merged
adamsoffer merged 2 commits into
mainfrom
feat/network-docs
Jul 1, 2026
Merged

Livepeer network docs: orchestrators & delegators under /network#1
adamsoffer merged 2 commits into
mainfrom
feat/network-docs

Conversation

@adamsoffer

@adamsoffer adamsoffer commented Jun 30, 2026

Copy link
Copy Markdown
Collaborator

What this is

The initial version of the new Livepeer docs site (Mintlify), built from scratch. It ships the Network section — running the network as an orchestrator (GPU operator) or delegator (LPT staker) — rebuilt from first principles off the v2 docs and heavily simplified.

Structure

URL namespacing, built for expansion. All pages live under /network (from the network/ folder, not nav chrome), so a future demand-side /build (developer) section can be added without moving or breaking a single URL. The root (/) redirects to /network until then. Demand-side visitors aren't left stranded in the meantime: the homepage, the "Which path is yours?" page, and the network explanation all acknowledge the coming developer platform and route builders to Discord.

Diátaxis. The sidebar is organized by reader need:

Section Need Pages
Tutorials Learning by doing Run your first orchestrator · Delegate your first LPT
How-to guides A specific task Configure · Activate · Batch AI · Real-time AI (Cascade) · Pricing · Monitoring · Acquire LPT · Choose an orchestrator · Manage delegation · Vote on a proposal · Submit a protocol LIP · Submit a treasury proposal
Explanation Understanding Orchestrators · Delegators · How the network works · Economics · Governance & the treasury
Reference Exact facts Hardware/GPU · CLI flags · Protocol parameters · Contract addresses · FAQ · Glossary

Reference values verified on-chain

Reference pages carry a "Last verified: 1 July 2026" convention, with values read directly from the contracts on Arbitrum One (eth_call, round 4253) rather than inherited from prior docs. Two findings reviewers should know about, since they contradict the currently published docs:

  • The treasury reward cut is paused. LIP-92's 10% cut hit its 750,000 LPT balance ceiling — treasuryRewardCutRate() and nextRoundTreasuryRewardCutRate() both read 0. These docs describe the design (10% + ceiling) and the live state (paused).
  • The governance voting period is 10 rounds (~9 days). LivepeerGovernor.votingPeriod() returns 10; the "30-round (~3.75 days)" figure in existing guides doesn't match the chain on either number.

Also corrected: the active-set getter is getTranscoderPoolMaxSize() (docs elsewhere cite numActiveTranscoders(), which doesn't exist), and the contract-addresses page lists the full Controller-resolved set with per-address Arbiscan links and no-trust verification steps.

Branding

Official LIVEPEER DOCS wordmark (light + dark), the livepeer.org favicon, and brand-green theme (#18794E / #40BF86 / #115C3B), with the navbar logo sized to match livepeer.org.

CI

.github/workflows/docs-checks.yml validates navigation integrity and internal links (scripts/check-docs.mjs, also runnable as npm run check) plus mint broken-links on every PR. Note: it activates once this merges to main.

Review notes

  • The treasury-paused and voting-period corrections are worth a maintainer's confirmation, since they'll disagree with the live site until it's updated.
  • Pool references are omitted (pools are no longer used on the network).
  • Run locally: npm install && npm run dev.

🤖 Generated with Claude Code

adamsoffer and others added 2 commits June 30, 2026 19:45
A from-scratch Mintlify documentation site for the supply side of the
Livepeer network, rebuilt and simplified from the v2 docs and scoped to
two roles: orchestrators (GPU operators) and delegators (LPT stakers).

- Organized with the Diátaxis framework: Tutorials, How-to guides,
  Explanation, and Reference.
- Namespaced under /network so a future demand-side (developer) docs
  section can be added without breaking these URLs; root redirects to
  /network for now.
- Official Livepeer branding: wordmark, favicon, and brand-green theme.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…AI guides, and orient demand-side visitors

Reference accuracy (verified 1 Jul 2026 via eth_call on Arbitrum One):
- Protocol parameters rewritten from live contract reads with a
  'last verified' convention; voting period pinned at 10 rounds,
  resolving contradictory upstream claims (30 rounds / ~3.75 days).
- Treasury cut corrected: LIP-92's 10% is currently paused at the
  750k LPT balance ceiling (rate reads 0 on-chain); all pages that
  claimed a live 10% updated.
- Active set getter corrected to getTranscoderPoolMaxSize().
- Contract addresses page now lists the full Controller-resolved set.

New content:
- Governance & the treasury explanation, plus vote-on-a-proposal,
  submit-a-protocol-lip, and submit-a-treasury-proposal how-tos
  (two proposal tracks, one shared vote).
- Monitor your orchestrator (Prometheus, dashboards, reward-call alert).
- Serve real-time AI (Cascade / ComfyStream / live-video-to-video).
- Pricing guide gains a worked wei-per-pixel earnings example.
- Activate guide warns Fee Cut displays inverted as Fee Share.

Orientation & polish:
- Homepage callout, 'I want to build' path, and 'Where demand comes
  from' passage route demand-side visitors to Discord until the
  developer platform ships.
- Pool references removed (no longer used on the network).
- LIVEPEER DOCS wordmark lockup sized to match livepeer.org.
- README reframed for future expansion; CI workflow + check script
  validate nav and internal links.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@adamsoffer adamsoffer changed the title Add Livepeer network docs (orchestrators & delegators) Livepeer network docs: orchestrators & delegators under /network Jul 1, 2026
@adamsoffer adamsoffer merged commit 1efdb01 into main Jul 1, 2026
1 check passed
@adamsoffer adamsoffer deleted the feat/network-docs branch July 1, 2026 23:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant