Skip to content

Rebuild docs from scratch: orchestrator, delegator, and governance docs under /network#941

Open
adamsoffer wants to merge 4 commits into
livepeer:docs-v3from
adamsoffer:feat/network-docs
Open

Rebuild docs from scratch: orchestrator, delegator, and governance docs under /network#941
adamsoffer wants to merge 4 commits into
livepeer:docs-v3from
adamsoffer:feat/network-docs

Conversation

@adamsoffer

@adamsoffer adamsoffer commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

What this PR does

This is a rebuild of the docs from scratch. New information architecture, every page rewritten (content sourced from the existing docs), scoped to the supply side of the network — orchestrators, delegators, and governance/treasury. A few hundred pages come down to 27 focused ones, with deprecated products and unused features (i.e. Livepeer Studio) dropped entirely.

Preview: https://livepeerfoundation-d4522ba3.mintlify.site/network

What's covered

Organized with the Diátaxis framework — each sidebar group serves one reader need:

Section Pages
Tutorials Run your first orchestrator (install go-livepeer → activate → reward call) · Delegate your first LPT
How-to guides Configure · Activate on Arbitrum · Batch AI · Real-time AI (Cascade) · Pricing · Monitoring · Acquire LPT · Choose an orchestrator · Manage your delegation · Vote on a proposal · Submit a protocol LIP · Submit a treasury proposal
Explanation What an orchestrator is · What a delegator is · How the network works · Economics · Governance & the treasury
Reference Hardware/GPU · CLI flags · Protocol parameters · Contract addresses · FAQ · Glossary

Reference values verified on-chain

Reference pages carry a "Last verified" date, with values read directly from the contracts on Arbitrum One (eth_call) rather than copied forward — unbonding period, active-set size, governance thresholds, voting period, treasury cut state, and the full Controller-resolved contract address table with Arbiscan links and no-trust verification steps. Reviewers may want to double-check the stated values against current chain state before merge.

URL structure

Everything lives under /network (from the folder structure, not nav chrome), anticipating the supply/demand split: when the developer platform ships, a /build section can be added without moving or breaking a single /network URL. The root (/) redirects to /network until then, and builder-curious visitors are routed to Discord in the meantime.

Repo hygiene

  • Built on the clean-slate orphan branch: no binaries beyond three small SVGs, keeping docs-v3 free of the media history on main.
  • CI workflow (.github/workflows/docs-checks.yml) validates navigation integrity and internal links on every PR (npm run check locally).
  • Official brand assets: LIVEPEER DOCS wordmark (light/dark), the livepeer.org favicon, brand-green theme.

Run locally

npm install && npm run dev

🤖 Generated with Claude Code

Replaces the starter scaffold with the revamped supply-side docs:
content sourced from the v2 docs, heavily simplified, and organized
with the Diátaxis framework (tutorials / how-to guides / explanation /
reference) — 27 pages under /network so a future /build (developer)
section can be added without breaking URLs. Root redirects to /network.

Highlights:
- Reference values verified on-chain (1 Jul 2026): voting period is
  10 rounds; treasury cut is paused at the 750k LPT ceiling (reads 0);
  full Controller-resolved contract address table.
- Guides across the operator lifecycle: setup, activation, batch and
  real-time AI (Cascade), pricing (with worked wei/pixel math), and
  monitoring; delegator guides from acquiring LPT to governance voting
  and LIP/treasury proposals.
- Official Livepeer branding (wordmark, favicon, brand greens) sized
  to match livepeer.org.
- CI workflow validates navigation and internal links on every PR.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@adamsoffer adamsoffer changed the title Livepeer network docs: orchestrators & delegators under /network Rebuild docs from scratch: orchestrator, delegator, and governance docs under /network Jul 2, 2026
adamsoffer and others added 3 commits July 3, 2026 13:21
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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