- Format (like text, engineering references or video)
- Style of learning (hands-on, reading, visual)
- Content depth (ELI5 to advanced technical)
- AI helpers and search preferences
Documentation Ethos
These docs aim to make it easy for all users to:- Find the information they are looking for - through intuitive navigation, powerful search, and AI assistance
- Understand the Livepeer protocol & products - with clear explanations from zero to hero
- Navigate the Livepeer ecosystem - discover tools, services, and community resources
- Build on the Livepeer protocol - with comprehensive guides, API references, and code examples
- Use Livepeer & Ecosystem products - step-by-step tutorials and quickstarts
Documentation Philosophy
- Documentation is not static. It is infrastructure
- AI is the new search, and discoverable products are AI-first
- Agents are the new docs consumers and information should be atructured accordingly
User Journeys
These docs are intended to provide a clear zero-to-hero user journey for the many talented folks in the Livepeer Ecosystem.Recommended Paths
-
Understanding Livepeer - All users interested in understanding the Livepeer Network, Protocol & Ecosystem
- Start with: About Livepeer → Core Concepts
-
End-Users - Looking for Livepeer Realtime Video or AI plug & play products
- Start with: Get Started → Quickstarts
-
Developers - Building on the Livepeer Video or AI Protocol from tinkerers to founders & enterprise clients
- Start with: Developers Portal → Building on Livepeer
-
GPU Providers & Data Centres - Bringing compute to the Livepeer Network
- Start with: Orchestrators Portal → Setting Up an Orchestrator
-
Livepeer Token Holders - Looking to stake LPT or participate in open governance
- Start with: LP Token Portal → Staking & Delegation
-
Gateway Operators - Running infrastructure to route jobs on the network
- Start with: Gateways Portal → Run a Gateway
Documentation Features
The Livepeer documentation includes multiple features designed to enhance your experience:- 🔍 Powerful Search - Find content quickly with semantic search
- 🤖 AI Assistant - Get answers to your questions directly in the docs
- 📱 Responsive Design - Access docs on any device
- 🌓 Dark & Light Themes - Choose your preferred viewing mode
- 📑 Tab Navigation - Organised by user role and interest
- 🔗 Version Switching - Access both v1 (legacy) and v2 (current) documentation
- 💬 Feedback Mechanisms - Share your thoughts on any page
- 📚 Component Library - Reference for all custom components