Site Layout & Navigation
Header Features
The header provides quick access to essential tools:- Search Bar / AI Assistant - Located at the top of every page. Type your question or search term to find relevant content or get AI-powered answers.
- Version Selector - Switch between v2 (current) and v1 (legacy) documentation. All historical information is preserved in v1.
- Social Icons - Quick links to Livepeer’s social media and community channels.
Top Navigation Tabs
The main navigation is organised into tabs based on user roles and interests:- Home - Overview, introduction, and getting started
- About - Core concepts, protocol details, and mental models
- Community - Community resources, events, and engagement
- Developers - Building on Livepeer, APIs, SDKs, and guides
- Gateways - Running gateway infrastructure
- Orchestrators - Setting up and operating orchestrator nodes
- Delegators - Staking and delegation guides
- Resources - Reference hub, glossary, and additional resources
- Portal Page - Landing page with quick intro and key links
- Groupings - Organised sections (Overview, Get Started, Build, Tools, Guides)
- Pages - Individual documentation pages
Left Sidebar Navigation
The sidebar provides section-specific navigation:- Anchors - Quick access to Quickstarts and Reference Hub
- Main Tab Navigation - Expandable groups and pages for the current tab
- Language Selector - Currently English only (multilingual support planned)
- Theme Selector - Toggle between light and dark themes
Page Layouts
Pages use multiple layout components to organise information:- Tabs - Separate content by context (e.g., AI vs Video, on-chain vs off-chain)
- Views - Show different content based on operating system or user path
- Steps - Sequential instructions for processes
- Card Groups - Visual groupings for portals, hubs, and related content
- Accordions - Expandable sections for detailed information
- Callouts - Important notes, tips, warnings, and information boxes
Finding Information
Using Search
The search bar in the header provides:- Semantic Search - Understands context and meaning, beyond keywords
- Instant Results - See suggestions as you type
- Page Previews - Quick preview of matching content
- Keyword Matching - Pages with relevant keywords in metadata are prioritised
Using the AI Assistant
The AI Assistant (integrated with the search bar) can:- Answer questions about Livepeer
- Explain concepts and terminology
- Help you find relevant documentation
- Provide code examples and guidance
Navigation Tips
- Start with Portals - Each tab has a portal page that provides an overview and key entry points
- Use Breadcrumbs - The breadcrumb trail shows your current location
- Check Related Pages - Many pages include links to related content
- Follow User Journeys - Content is organised in a logical zero-to-hero flow
Documentation Features
Version Switching
All documentation from the original v1 docs is preserved. Use the version selector in the header to:- Access legacy content
- Compare v1 and v2 approaches
- Find historical information
Theme Selection
Choose your preferred viewing experience:- Dark Theme (default) - Optimised for low-light viewing
- Light Theme - Traditional light background
Responsive Design
The documentation is fully responsive and works on:- Desktop computers
- Tablets
- Mobile devices
Getting Help
If you can’t find what you’re looking for:- Use Search - Try different search terms or questions
- Ask the AI Assistant - Get instant answers to your questions
- Check Related Pages - Look for links at the bottom of pages
- Browse by Tab - Navigate through the relevant tab for your use case
- Provide Feedback - Use the feedback mechanism on any page
Contributing to the Docs
We welcome contributions! See the Contribute to the Docs page for:- How to provide feedback
- Contribution pathways (technical and non-technical)
- Resources for contributors
Developer Resources
Component Library
Complete reference of all custom components with live examples and copy-paste code snippets.
Style Guide
Styling conventions, Mintlify gotchas, and best practices for documentation.
Snippets Inventory
Complete inventory of all files and folders in the snippets directory.
Docs Index Generation
Canonical documentation for automatic
v2/pages index.mdx generation and root aggregation behavior.Automations & Workflows
Complete guide to all automation scripts, GitHub Actions, n8n workflows, and pre-commit hooks.
Research & Fact Checking
Evidence-backed contributor workflow for reviewing factual claims, contradictions, and dependent docs pages.
Mintlify Documentation
Official Mintlify documentation for built-in components like Tabs, Cards, and Callouts.
Next Steps
- Learn about Features & AI Integrations
- Use the Research & Fact Checking workflow when a page needs evidence-backed factual review
- Review the Style Guide for styling and Mintlify gotchas
- Check the Snippets Inventory for available components and data
- Review Automatic Page Index Generation
- Discover how to Contribute to the Docs
- Explore the Component Library for developers
- Learn about Automations & Workflows for maintaining the docs