Open
Conversation
…g links, reformatting structure
* clean up folders * Backup: Snippets verification and component fixes Changes include: - Fixed import paths in video.jsx, zoomable-diagram.jsx, coingecko.jsx - Removed unnecessary React imports (Mintlify provides hooks globally) - Fixed gateways.jsx and lists.jsx import paths - Fixed ListSteps.jsx children handling - Moved gateway-specific components to domain/gateways/ - Updated page imports for relocated components - Added mintlify-behaviour.mdx documentation - Created v2/tests/reports directory structure * Add verification reports and fix quickstartTabs import path Reports added: - v2/tests/reports/mdx-issues-report.md - 13 parsing errors, 7 missing imports, 38 nav warnings - v2/tests/reports/snippets-verification-report.md - Full snippets audit Fixes: - snippets/components/domain/04_GATEWAYS/quickstartTabs.jsx - Changed relative import to absolute path * Fix latestVersion imports to use globals.mdx * remove unknown scripts * remove unused files * document components, provide examples, document scripts
…les and run script
* feat(about): add missing Network pages (marketplace, technical-architecture, interfaces) - Add marketplace.mdx from CONTEXT DATA/Network (routing, pricing, settlement) - Add technical-architecture.mdx from CONTEXT DATA (stack, orchestrator, gateway, APIs) - Add interfaces.mdx from CONTEXT DATA (REST, gRPC, GraphQL, SDK, CLI) - Fix docs.json nav: interfaces? -> interfaces - Add docs/ABOUT review reports and style guide (00-NAV, COPY-REVIEW, STYLE-GUIDE) - Add docs/ABOUT/CONTEXT DATA for Protocol, Network, References * feat(platforms): add full Livepeer Studio section under Platforms - Add overview, quickstart, and Studio CLI (Get started) - Add Livestream: overview, create/playback, OBS, browser, multistream, clip, health, latency - Add VOD: overview, upload, playback, encrypted assets, thumbnails, transcode - Add Access control: overview, webhooks, JWT - Add Events & analytics: webhooks, listen-to-events, analytics - Add Player & embed and Reference (API overview, SDKs, managing projects) - Update docs.json with new Livepeer Studio nav structure - Add LIVEPEER-STUDIO-V1-INVENTORY-AND-IA.md and LIVEPEER-STUDIO-GAPS-AND-VERACITY.md - Redirect legacy livepeer-studio.mdx to overview * Add docs/PLAN: 18 agent briefs for parallel execution - README with task-to-branch table and how-to for parallel Cursor agents - 18 task briefs (01-18) with Objective, Scope, Deliverables, References - Each brief includes: Branch, First step (git checkout -b), Report path, PR target - reports/ folder for agent completion reports - Agents create their own branch, write report, open PR * docs/PLAN: Set docs-v2-preview as main branch (create-from and PR target) - README: create branch from docs-v2-preview, open PR into docs-v2-preview - All 18 briefs: First step run from docs-v2-preview; PR target docs-v2-preview
* feat(about): add missing Network pages (marketplace, technical-architecture, interfaces) - Add marketplace.mdx from CONTEXT DATA/Network (routing, pricing, settlement) - Add technical-architecture.mdx from CONTEXT DATA (stack, orchestrator, gateway, APIs) - Add interfaces.mdx from CONTEXT DATA (REST, gRPC, GraphQL, SDK, CLI) - Fix docs.json nav: interfaces? -> interfaces - Add docs/ABOUT review reports and style guide (00-NAV, COPY-REVIEW, STYLE-GUIDE) - Add docs/ABOUT/CONTEXT DATA for Protocol, Network, References * feat(platforms): add full Livepeer Studio section under Platforms - Add overview, quickstart, and Studio CLI (Get started) - Add Livestream: overview, create/playback, OBS, browser, multistream, clip, health, latency - Add VOD: overview, upload, playback, encrypted assets, thumbnails, transcode - Add Access control: overview, webhooks, JWT - Add Events & analytics: webhooks, listen-to-events, analytics - Add Player & embed and Reference (API overview, SDKs, managing projects) - Update docs.json with new Livepeer Studio nav structure - Add LIVEPEER-STUDIO-V1-INVENTORY-AND-IA.md and LIVEPEER-STUDIO-GAPS-AND-VERACITY.md - Redirect legacy livepeer-studio.mdx to overview * Add docs/PLAN: 18 agent briefs for parallel execution - README with task-to-branch table and how-to for parallel Cursor agents - 18 task briefs (01-18) with Objective, Scope, Deliverables, References - Each brief includes: Branch, First step (git checkout -b), Report path, PR target - reports/ folder for agent completion reports - Agents create their own branch, write report, open PR * docs/PLAN: Set docs-v2-preview as main branch (create-from and PR target) - README: create branch from docs-v2-preview, open PR into docs-v2-preview - All 18 briefs: First step run from docs-v2-preview; PR target docs-v2-preview * feat(styling): homogenise styling across repo - Update CardCarousel.jsx to use theme CSS variables - Replace fallback colors with proper theme variables - Use --card-background, --accent, --border, --text - Update theme-colors.mdx wiki documentation - Document full ThemeData object with all properties - Add Global CSS Variables section documenting style.css - Update color values to match actual implementation - Update best practices section - Add completion report Closes task 05-homogenise-styling * Add Task 02: Unused Components Audit Report - Audited 77 exports across 27 component files - Identified 24 definitely unused components for removal - Identified 10+ components with low/example-only usage - Found 2 consolidation opportunities (duplicate files) - Documented usage locations for all 58 actively used components * feat(styling): homogenise styling across repo - Update CardCarousel.jsx to use theme CSS variables - Replace fallback colors with proper theme variables - Use --card-background, --accent, --border, --text - Update theme-colors.mdx wiki documentation - Document full ThemeData object with all properties - Add Global CSS Variables section documenting style.css - Update color values to match actual implementation - Update best practices section - Add completion report Closes task 05-homogenise-styling * feat(components): consolidate components with documentation and examples - Update steps.jsx to use ThemeData for theme-aware colors - Delete obsolete gateways/ folder (duplicate of domain/04_GATEWAYS/) - Fix import reference in data/gateways/index.jsx - Add comprehensive READMEs for each category - Add 12 new example MDX files for components missing examples - Update main components/README.md with full reference * Task 14: V1 to V2 documentation coverage audit report - Inventoried 279 v1 MDX files across 9 sections - Inventoried 339 v2 MDX files across 11 sections - Created comprehensive mapping table for each section - Identified coverage status: Covered (23%), Partial (20%), Missing (47%), Excluded (10%) - Key gaps: API Reference (75 files), SDKs (63 files), Self-hosting (4 files) - Documented exclusion criteria for Studio-specific content - Provided recommendations for addressing gaps * Task 14: V1 to V2 documentation coverage audit report - Inventoried 279 v1 MDX files across 9 sections - Inventoried 339 v2 MDX files across 11 sections - Created comprehensive mapping table for each section - Identified coverage: Covered (23%), Partial (20%), Missing (47%), Excluded (10%) - Key gaps: API Reference (75 files), SDKs (63 files), Self-hosting (4 files) - Documented exclusion criteria for Studio-specific content - Provided recommendations for addressing gaps * refactor(components): remove ThemeData imports, use global CSS variables - Remove ThemeData imports from all components - Update components to use global CSS variables (var(--accent), var(--hero-text), var(--text), var(--border)) - Update steps.jsx to use CSS variables instead of hardcoded colors - Remove ThemeData from frameMode.jsx PageHeader and H1 components - Remove unused ThemeData import from links-examples.mdx - Fix merge conflict in data/gateways/index.jsx * refactor(components): remove all ThemeData imports, use global CSS variables - Remove ThemeData imports from all component files - Replace ThemeData references with global CSS variables: - var(--accent) for accent colors - var(--hero-text) for hero/title text - var(--text) for body text - var(--muted-text) for muted text - var(--border) for borders - var(--card-background) for card backgrounds - Update steps.jsx to use CSS variables instead of hardcoded colors - Remove ThemeData style blocks from all components - Remove unused ThemeData import from links-examples.mdx - Fix merge conflict in data/gateways/index.jsx * feat(docs): add comprehensive component library wiki - Create component-library.mdx with full documentation for all custom components - Include live examples with Tabs for each component - Add Mintlify built-ins cheat sheet - Link from documentation-guide.mdx and contribute-to-the-docs.mdx - Update internal components.mdx to link to the library - Add completion report * Update Task 14 report: Add Livepeer Studio section recommendations - Clarified that v2 is network-focused - Identified that Studio content should live in products section - Created comprehensive structure recommendation for Livepeer Studio section - Prioritized 166 files to migrate (API Reference, SDKs, Guides, Tutorials, etc.) - Provided priority-based migration plan (P1-P4) - Estimated file counts by category - Recommended structure and navigation updates * Update Task 14 report: Add Livepeer Studio section recommendations - Clarified that v2 is network-focused - Identified that Studio content should live in products section - Created comprehensive structure recommendation for Livepeer Studio section - Prioritized 166 files to migrate (API Reference, SDKs, Guides, Tutorials, etc.) - Provided priority-based migration plan (P1-P4) - Estimated file counts by category - Recommended structure and navigation updates * refactor(components): remove all ThemeData imports, use global CSS variables - Remove all ThemeData imports from component files - Replace ThemeData references with global CSS variables: - var(--accent) for accent colors - var(--hero-text) for hero/title text - var(--text) for body text - var(--muted-text) for muted text - var(--border) for borders - var(--card-background) for card backgrounds - Update all components to use global CSS variables directly - Remove ThemeData style blocks from all components - Fix duplicate variable declaration in H1 component - Delete obsolete gateways/ folder (duplicate of domain/04_GATEWAYS/) * refactor(components): remove all ThemeData imports, use global CSS variables - Remove all ThemeData imports from component files - Replace ThemeData references with global CSS variables: - var(--accent) for accent colors - var(--hero-text) for hero/title text - var(--text) for body text - var(--muted-text) for muted text - var(--border) for borders - var(--card-background) for card backgrounds - Update all components to use global CSS variables directly - Remove ThemeData style blocks from all components - Fix duplicate variable declaration in H1 component - Delete obsolete gateways/ folder (duplicate of domain/04_GATEWAYS/) * Consolidate duplicate components - Delete duplicate gateways directory (components/gateways/) - All imports now use domain/04_GATEWAYS/callouts.jsx - Updated snippets/data/gateways/index.jsx to use correct import - Updated snippets/snippetsWiki/README.md - Remove duplicate card components from layout/cards.jsx - Removed PostCard, CardColumnsPostLayout, BlogCard, CardBlogDataLayout - Kept only ScrollBox (unique to this file) - Added React imports (useRef, useState, useEffect) for ScrollBox - Update all imports to use content/data.jsx - Updated v2/pages/00_home/home/trending-layout-tests.mdx - Updated snippets/components/layout/examples/cards-examples.mdx All components now have single source of truth. * Update Task 14 report: Identify existing placeholder pages - Documented 4 existing placeholder pages that reference Studio content - Added recommendations for handling placeholders (redirect vs fill) - Updated file count estimates to account for existing placeholders - Added specific section on handling existing placeholders with example content * Update Task 14 report: Identify existing placeholder pages - Documented 4 existing placeholder pages that reference Studio content - Added recommendations for handling placeholders (redirect vs fill) - Updated file count estimates to account for existing placeholders - Added specific section on handling existing placeholders with example content * feat(platforms): add full Livepeer Studio section to docs-v2-preview - Overview, quickstart, studio-cli; full Livestream, VOD, access control, events, player, reference - docs.json: full Livepeer Studio nav (Platforms tab) - docs/LIVEPEER-STUDIO-V1-INVENTORY-AND-IA.md, LIVEPEER-STUDIO-GAPS-AND-VERACITY.md - Redirect legacy livepeer-studio.mdx to overview PR #2 merge had only 2 files in-tree; this commit adds the full 28 new pages + nav. * chore: merge all local changes - gateways, developers, docs, ai-pipelines - Gateways: resolve merge conflicts in code.jsx, flags.jsx, index.jsx, quickstart.jsx (keep upstream, remove stashed duplicates) - About: fix LinkArrow import path (snippets -> /snippets) in livepeer-protocol/overview.mdx - Developers: dev-programs placeholder (Content coming soon), developer-guide JSX fix (> -> />) - AI pipelines: add overview.mdx, byoc.mdx, comfystream.mdx (nav already in docs.json) - Docs: DEVELOPERS/ (nav index, context data, style/copy guides), DRY/MDX/RFP/audit reports * Consolidate Livepeer Studio section - Removed duplicate: getting-started/quick-start.mdx (kept root level quickstart.mdx) - Updated placeholder: technical-references/sdks.mdx to point to Studio SDKs - Updated placeholder: technical-references/apis.mdx to point to Studio API - Added API reference structure (71 files) with organized endpoints - Added getting-started structure (2 files: overview, authentication) Total: 98 files in products/livepeer-studio section * Fix broken links in getting-started overview - Updated quick-start link to point to root level quickstart.mdx - Updated guides link to point to overview page - All consolidation complete * Add consolidation summary report - Documented all consolidation actions - Identified remaining work (103 files to migrate) - Verified structure and file counts * Organize Livepeer Studio root files into proper structure Moved 22 guide files from root to guides/ directory: - 17 general guides → guides/ - 3 access-control guides → guides/access-control/ - 1 analytics guide → guides/analytics/ - 1 studio-cli → getting-started/studio-cli.mdx Root level now contains only overview/navigation pages: - overview.mdx (main overview) - quickstart.mdx (quick start) - api-overview.mdx (API intro) - sdks-overview.mdx (SDKs intro) - livestream-overview.mdx (use case overview) - vod-overview.mdx (use case overview) - client-use-cases.mdx (use cases) - livepeer-studio.mdx (redirect) Total: 8 root files (navigation/overview), 21 guide files organized * Add file organization summary report * Move all root files to overview/ section Moved 8 root-level files to overview/ directory: - overview.mdx → overview/overview.mdx - quickstart.mdx → overview/quickstart.mdx - api-overview.mdx → overview/api-overview.mdx - sdks-overview.mdx → overview/sdks-overview.mdx - livestream-overview.mdx → overview/livestream-overview.mdx - vod-overview.mdx → overview/vod-overview.mdx - client-use-cases.mdx → overview/client-use-cases.mdx - livepeer-studio.mdx → overview/livepeer-studio.mdx Root level is now clean with no .mdx files * Fix broken links after moving files to overview/ section - Updated all links in overview/overview.mdx to point to correct paths - Fixed links in getting-started/overview.mdx - Fixed links in api-reference/overview.mdx - Fixed links in overview/api-overview.mdx - Fixed links in guides/transcode-video.mdx - Fixed links in guides/encrypted-assets.mdx All links now correctly reference the new file structure * Merge docs-plan/01-components-consolidate into docs-v2-preview - Resolved merge conflicts in frameMode.jsx (removed unnecessary <> wrappers) - Updated CSS variables: var(--divider-color) -> var(--border), var(--p-text-color) -> var(--text) - Added CSS globals comment to Portals.jsx - All components now use global CSS variables instead of ThemeData * feat(nav): add component library to Documentation Guide navigation * Update docs.json navigation for Livepeer Studio reorganization - Updated all paths to reflect new file structure: - overview/ files moved to overview/ subdirectory - getting-started/ files organized properly - guides/ files moved to guides/ subdirectory - access-control/ files moved to guides/access-control/ - analytics moved to guides/analytics/ - Added API reference overview to Reference section - All navigation paths now match actual file locations * Add RFP goals assessment report - Comprehensive assessment of all RFP goals from docs-v2-rfp-task-list-and-plan.md - Evaluated Progress Trackers (ii, iii, iv), Planning Overview phases, Req's Task List, and Success Criteria - Identified critical gaps: quickstarts incomplete, migration guides missing, contribution workflow incomplete - Provided prioritized recommendations with timelines - Overall status: 33% fully met, 46% partially met, 21% not met * Add audit report for v2 missing and incomplete pages - Audited all 254 v2 pages referenced in docs.json - Identified 22 missing files - Identified 22 placeholder files (Coming soon, TODO, TBD, WIP) - Identified 172 incomplete files (minimal content, empty sections) - Created comprehensive report with recommendations * Add audit report for v2 missing and incomplete pages - Audited all 254 v2 pages referenced in docs.json - Identified 22 missing files - Identified 22 placeholder files (Coming soon, TODO, TBD, WIP) - Identified 172 incomplete files (minimal content, empty sections) - Created comprehensive report with recommendations * Add Task 13: Audit repeated content report - Identified 100+ files with repeated callout imports - Found duplicate glossary files (01_about vs 07_resources) - Documented 30+ files with 'Broadcaster' deprecation note - Identified API endpoint duplication across 8+ files - Found technical architecture descriptions in 5+ locations - Provided concrete recommendations for consolidation - Linked to existing DRY recommendations document * Update Task 13 report: Focus on actual content duplication - Removed component/code repetition sections (not content) - Added exact text duplications (Protocol/Network definitions) - Documented duplicate glossary files (400+ lines) - Identified 30+ files with exact 'Broadcaster' note duplication - Found duplicate actor definitions in 10+ locations - Added API endpoint description duplications - Focused on actual text/paragraph repetition, not code patterns * Complete documentation guide in Resources section - Fill in documentation-overview.mdx with ethos, objectives, and user journeys - Complete documentation-guide.mdx with comprehensive navigation and usage instructions - Complete docs-features-and-ai-integrations.mdx with all features and AI capabilities - Complete contribute-to-the-docs.mdx with feedback and contribution pathways - Enhance resources-portal.mdx with links to documentation guide pages All four documentation guide pages now have comprehensive content describing: - Documentation features (tabs, nav, search, AI assistant, feedback) - How to use the site effectively - User journeys and recommended paths - Contribution pathways (technical and non-technical) Task 10 complete. * Complete documentation guide in Resources section - Fill in documentation-overview.mdx with ethos, objectives, and user journeys - Complete documentation-guide.mdx with comprehensive navigation and usage instructions - Complete docs-features-and-ai-integrations.mdx with all features and AI capabilities - Complete contribute-to-the-docs.mdx with feedback and contribution pathways - Enhance resources-portal.mdx with links to documentation guide pages All four documentation guide pages now have comprehensive content describing: - Documentation features (tabs, nav, search, AI assistant, feedback) - How to use the site effectively - User journeys and recommended paths - Contribution pathways (technical and non-technical) Task 10 complete. * Add documentation guide resources report * Fix MDX errors: remove invalid imports and fix syntax - Fix extra closing brace in primitives.mdx line 125 - Remove @mintlify/components imports (components are global) - Fix ListSteps import path in layout.mdx * Export RefCardContainer from Portals.jsx * test valid file * Update hook to skip style-guide.mdx * Save work in progress: component library updates, plan docs, and test scripts - Updated component library documentation and pages - Updated plan documentation (03-component-library-wiki) - Added test scripts and workflows for v2 pages - Updated various documentation pages - Cleaned up old plan files Note: Some style guide warnings in documentation examples (prop defaults), not actual code violations. Test files excluded from commit. * feat: add v2 pages browser test workflow and scripts - Add Puppeteer-based test script for all v2 pages - Add GitHub Actions workflow to test pages on commits/PRs - Add workflow documentation - Update package.json with test script - Fix technical-architecture.mdx imports for merge compatibility - Add component library updates and plan docs * Backup: Component library with duplicate headers removed --------
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Public View Page for Docs-v2
See the live docs here: https://na-36-docs-v2-preview.mintlify.app/v2/
Feedback Requested
Please leave any feedback in this quick form!
Help Wanted!
Want to contribute? (YAY!)
Check out the issues section of this github repo for docs-v2 tagged issues or submit your own / fork these docs (fork branch docs-v2-preview) or get in touch with me!
Related Issues
Contact Me
I'm
_alisonwonderlandon discord :)