RFP — Documentation Restructure

RFP Applications
12

Note: I will share a live link at the end of the week for community review

:blue_book: Documentation Restructure – Project Update

Hi everyone! Happy 2026! :partying_face:

Sharing a more complete update following the original Documentation Restructure RFP and the subsequent updates in Q4.

Over the past period, I’ve been working through a broad restructure of the Livepeer documentation, with a focus on making it more usable day-to-day for builders, operators, and community members - and easier to maintain as the protocol and products evolve. I’ve particularly been focused on making data accurate, up-to-date, easily referenced & digested by AI’s and a canonical HUB for projects, tooling and builders to add to with automations.

You can follow along with the progress in this Github PR in real time (I welcome your feedback!)

:sparkles: What’s Changed

Easier onboarding

The docs now emphasise clearer entry points and more intentional learning paths. Setup flows have been simplified, repetition reduced, and related concepts grouped so new users can move from “getting something running” to understanding how things fit together without jumping across unrelated pages.

Component & layout homogenisation

Documentation now uses a consistent set of shared components and layouts. This improves readability, reduces cognitive load while navigating, and makes future updates less fragile by avoiding one-off page patterns. It also makes community contribution easier (guide coming soon).

More structured, data-driven content

Where appropriate, content is now backed by structured data instead of static text. This helps keep references accurate over time and reduces the risk of documentation quietly drifting out of sync.

Community & Builder hub automations

The Community and Builder sections now rely more on lightweight automation to surface forum posts, blog content, and external references. The goal is to keep these hubs current without constant manual upkeep as well as to create easy pathways for community to contribute and share their tool, projects & docs.

Clearer reference documentation

API and protocol-level reference material is now more clearly separated from guides and conceptual content, making it easier to either quickly look something up or take the time to understand how something works.

:compass: Focus Areas

Newcomers, product discussion, and community

A core goal of this restructure is to better support people who are new to Livepeer - not just at the technical level, but in understanding what the network is, what problems it’s good at, and where to engage. More space has been created for product-level explanation, ecosystem context, and community-facing content so newcomers don’t have to infer intent purely from low-level technical docs.

The Community sections are designed to surface relevant discussions, updates, and examples more naturally, helping people move from curiosity to participation.

Clearer builder & developer documentation

Builder and developer docs are now more explicitly structured around workflows and use cases. Conceptual explanations, guides, and reference material are more clearly separated, making it easier to either learn progressively or jump straight to implementation details.

The intent here is clarity over cleverness: fewer assumptions about prior knowledge, clearer language around roles and responsibilities, and documentation that supports both experimentation and production use.

:loudspeaker: Documentation PR Stats

PR #730 represents 830 file changes & introduces systematic improvements across all documentation areas.

:bullseye: Easier User Onboarding

  • Streamlined Installation Guides: New automated release tracking ensures users always get the latest version

  • Interactive Setup Components: Custom dropdown components for platform-specific instructions (Docker, Linux, Mac, Windows)

  • Automations: Automations that keep content current and enable easier community contributions

  • AI: Deep focus on AI & LLM searches, queries, integrations and discoverability of accurate information

:building_construction: Component & Layout Homogenization

All documentation now uses consistent, reusable components:

New Component Library (snippets/components/):

  • custom-view-dropdown.jsx - Platform/environment switchers

  • cards.jsx - Blog posts, forum posts, and content cards

  • code. jsx - Standardized code examples with placeholder support

  • chainlist.jsx - Live blockchain RPC endpoint fetching

  • coingecko.jsx - Real-time exchange data

  • buttons.jsx, divider.jsx, embed.jsx - UI consistency

Benefits:

  • Consistent visual language across all docs

  • Easier maintenance (update once, apply everywhere)

  • Easier community additions

:bar_chart: Data Integration & Automation

New automated data fetching eliminates stale content:

Forum Integration (automationData/forum/):

  • Live forum post fetching

  • Automatic reply counts and dates

  • Rich preview cards

Blog Integration (automationData/blog/):

  • Ghost CMS data fetching

  • Reading time estimates

  • Author attribution

  • Scrollable post previews

GitHub Release Tracking (automationData/globals/):

  • Auto-updates to latest Livepeer version (v0.8.8 currently)

  • n8n workflow for continuous monitoring

  • Eliminates manual version updates

Real-time External Data:

  • CoinGecko API for exchange listings

  • Chainlist API for RPC endpoints

:robot: Community & Builder Hub Automations

Community Hub Features:

  • Automated forum post cards with live data

  • Rich media support (images, videos)

  • Scroll hints for long content

Builder Resources:

  • External repository embeds with syntax highlighting

  • GitHub integration for live examples

  • Automated API reference generation

  • Custom workflow examples

Example: Forum posts now display with live reply counts, dates, and author info—all fetched automatically. Github md files update in the docs as the reference does.

:books: Full Reference Docs

Complete API Documentation:

  • Gateway API (gateway.openapi.yaml)

  • AI Worker API (ai/worker/api/openapi.yaml) with full pipeline specs

  • OpenAPI specs for SDK generation

  • Full configuration flag explanations

Developer Resources:

  • Structured navigation in docs. json (3,274 lines)

  • Copilot instructions for AI-assisted development

  • Automated script documentation

Technical Improvements:

  • Accurate guides for Gateways & Orchestrators

  • Delegator and governance information

:wrench: Infrastructure Improvements

Build System:

  • Mintlify v2 config (docs. json replaces mint.json)

  • Docker support with Makefile

  • CI/CD ready with GitHub Actions support

  • .gitignore expanded for cleaner repo

Documentation Management:

  • README with clear setup instructions

  • README_V2.md with architecture details

  • SEO optimization guidance

  • Custom 404 support preparation

Scripts (v2/scripts/):

  • generate-api-docs.sh - Auto-generate API docs from OpenAPI

  • fetch-openapi-specs.sh - Sync specs from external repos

  • Automation for data fetching

:memo: Content Organization

The restructure includes:

  • Versioning: Clear v1 (legacy) vs v2 (current) separation

  • Mintlify Migration: Old config preserved as mintOld.json

  • Asset Management: Organized images, logos, static assets

  • External Docs: Fetched at build time, never stale

:rocket: What This Means

  1. For New Users: Onboarding is easier and clearer

  2. For Developers: Always-current API docs with live examples

  3. For Community: Rich, engaging content with automated updates

  4. For Contributors: Consistent patterns make contributions easier

:link: Important Links

:tada: Next Steps

  • Continuing the core work on accurate development guides for gateways, orchestrators and delegators.
2 Likes
Transformation SPE Release Notes