| sidebarTitle | Overview | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| title | Documentation Overview | |||||||||
| description | This page outlines the ethos, objectives & features of the docs, giving you a clear navigational roadmap | |||||||||
| keywords |
|
|||||||||
| og:image | /snippets/assets/domain/SHARED/LivepeerDocsLogo.svg |
import DocsPhilosophy from '../../internal/overview/docs-philosophy.mdx'
Learning is different for everyone, with user preferences as unique as the community across the following:
- 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
These docs aim to cater, as much as possible, to all segments of the vibrant Livepeer Community.
Have a suggestion for improvement? Check out our [Contribute to the Docs](./contribute-to-the-docs) page to share feedback or submit contributions.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
The documentation utilises a streamlined setup and the Mintlify format, providing a modern, responsive, and accessible experience.
These docs are intended to provide a clear zero-to-hero user journey for the many talented folks in the Livepeer Ecosystem.
-
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
The Livepeer documentation includes several 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
For detailed information about these features, see the Documentation Guide and Features & AI Integrations pages.