Open
Conversation
Contributor
📊 V2 Browser Sweep Results❌ Test report not found. The test may have failed before report generation.
|
There was a problem hiding this comment.
Pull request overview
Switches the documentation site’s primary experience to Docs V2 by introducing new content, repository structure rules, automation scripts, and GitHub workflows to support ongoing maintenance.
Changes:
- Adds OpenAPI specs for Gateway AI endpoints and local CLI HTTP API.
- Introduces AI tool setup guides and assistant “contract” files for repo-grounded docs help.
- Adds/updates CI workflows + local git hooks for validation, content sync, and automated data updates.
Reviewed changes
Copilot reviewed 57 out of 1602 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| api/gateway.openapi.yaml | Adds auto-generated OpenAPI spec for Gateway AI endpoints. |
| api/cli-http.yaml | Adds OpenAPI spec for Livepeer node local CLI HTTP API. |
| ai-tools/windsurf.mdx | Adds Windsurf setup guide and suggested workspace rules. |
| ai-tools/cursor.mdx | Adds Cursor setup guide and suggested project rules. |
| ai-tools/claude-code.mdx | Adds Claude Code setup guide and sample CLAUDE.md. |
| ASSISTANT.md | Adds assistant contract / conventions for repo-grounded answers. |
| .mintlify/ASSISTANT.md | Duplicates assistant contract under Mintlify directory. |
| .whitelist | Adds root allowlist for structure enforcement. |
| .speakeasy/workflow.yaml | Removes Speakeasy workflow config. |
| .prettierrc.yaml | Changes appear corrupted (contains a fatal error string). |
| .mintignore | Adds ignore rules for Mintlify build/publish. |
| .lpdignore | Adds ignore rules for LP CLI tool. |
| .github/workflows/update-youtube-data.yml | Adds scheduled workflow to refresh YouTube automation data. |
| .github/workflows/update-livepeer-release.yml | Adds scheduled workflow to sync latest go-livepeer release into globals. |
| .github/workflows/update-ghost-blog-data.yml | Adds scheduled workflow to refresh Ghost blog automation data. |
| .github/workflows/update-forum-data.yml | Adds scheduled workflow to refresh forum automation data. |
| .github/workflows/update-blog-data.yml | Adds combined blog/forum updater workflow (uses placeholder API key). |
| .github/workflows/test-v2-pages.yml | Adds Puppeteer-based workflow to render-test V2 pages and comment on PRs. |
| .github/workflows/test-suite.yml | Adds test-suite workflow (currently appears invalidly indented). |
| .github/workflows/sync-large-assets.yml | Adds workflow to mirror large assets to a dedicated branch. |
| .github/workflows/project-showcase-sync.yml | Adds workflow to sync project showcase data/assets via scripts. |
| .github/workflows/broken-links.yml | Minor formatting change. |
| .github/workflows/README-test-v2-pages.md | Documents the V2 pages browser-test workflow. |
| .github/scripts/project-showcase-sync.js | Adds Node script for syncing showcase submissions/reviews + publishing assets/data. |
| .github/scripts/fetch-youtube-data.js | Adds reusable Node script for updating YouTube data file. |
| .github/scripts/fetch-ghost-blog-data.js | Adds Node script for fetching Ghost posts and exporting to JSX. |
| .github/scripts/fetch-forum-data.js | Adds Node script for fetching forum topics and exporting to JSX. |
| .github/scripts/embed-table.js | Adds placeholder script (no-op). |
| .github/scripts/gen-table.js | Adds placeholder script (no-op). |
| .github/scripts/gen-textareas.js | Adds placeholder script (no-op). |
| .github/script-index.md | Adds generated index of .github/scripts/*. |
| .github/pull_request_template.md | Adds PR template tailored to docs changes. |
| .github/copilot-instructions.md | Adds Copilot guidance for repo conventions/structure. |
| .github/augment-instructions.md | Adds Augment guidance for safe operations and structure/style rules. |
| .github/ISSUE_TEMPLATE/feature_internal.yml | Adds internal feature request template (contains merge conflict markers). |
| .github/ISSUE_TEMPLATE/docs-review.yml | Adds docs review template (YAML appears malformed). |
| .github/CODEOWNERS | Expands CODEOWNERS to route reviews by docs sections. |
| .github/AGENTS.md | Adds agent safety + workflow guardrails. |
| .githooks/pre-commit | Adds pre-commit hook enforcing structure/style checks + running tests. |
| .githooks/pre-commit-no-deletions | Adds hook to block deletions. |
| .githooks/verify.sh | Adds verification script for staged files + optional browser validation. |
| .githooks/verify-browser.js | Adds Puppeteer-based staged-page render validation. |
| .githooks/server-manager.js | Adds helper to start/detect mint dev server for browser validation. |
| .githooks/install.sh | Adds installer for hooks into .git/hooks. |
| .githooks/README.md | Adds quick reference for hook behavior. |
| .githooks/BYPASS.md | Documents bypass flags/trailers for hooks. |
| .githooks/script-index.md | Adds generated index of .githooks/*. |
| .githooks/verify-browser-README.md | Documents browser validation behavior and troubleshooting. |
| .gitattributes | Adds Git LFS rules for media + large audit reports. |
| .cursorrules | Adds Cursor editor rules referencing repo style/structure constraints. |
18 tasks
* Rewrite developer journey page with structured paths Replace the skeleton table/mermaid page with an actionable developer journey defining three clear paths: Workload Provider, Workload Consumer, and Core Contributor — each with sub-paths, role definitions, and links to existing docs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Clarify Workload Provider role and both path options - Better define workload provider as creating workloads that run on orchestrators - Traditional route: reorder steps (understand BYOC → build container → run gateway → deploy) - Smart contract path: explain direct contract interaction for orchestrator onboarding, remote node control, and payments — with livepeer-ops as the recommended fork - Update mermaid diagram to show sequential BYOC flow Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Fix BYOC deploy step: orchestrators must be contacted directly BYOC containers can't be pushed to the network automatically — providers need to coordinate with orchestrators to get containers running on their nodes before routing jobs through the gateway. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Add livepeer-app-pipelines as BYOC examples reference Link to ad-astra-video/livepeer-app-pipelines in the BYOC build step for example implementations and integrations. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Add Orchestrator as Path 3 in developer journey Two options for running an orchestrator: - Option A: Full go-livepeer setup (install, register on-chain, process workloads) - Option B: OrchestratorSiphon + go-livepeer split setup (secure keystore management on one box, workload processing on another — avoids missing rewards) Links to go-livepeer repo/docs and Stronk-Tech/OrchestratorSiphon. Core Contributor moves to Path 4. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Move orchestrator path to its own page in orchestrators section - Remove orchestrator content from developer journey (back to 3 paths) - Add tip linking to orchestrators section from developer journey - Create v2/orchestrators/orchestrator-journey.mdx with two setup options: A) Full go-livepeer (single machine, register on-chain, process workloads) B) Split setup (OrchestratorSiphon for rewards + go-livepeer for workloads) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
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
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.
Description
Switches the
mainbranch docs experience to Docs V2 and brings in the new docs structure, navigation, automation, and contributor workflow updates needed to support it.Type of Change
Other: Repository-wide Docs V2 migration and tooling/workflow updates.
Related Issues
Fixes #
Related to #
Changes Made
Testing
npm run devScreenshots (if applicable)
N/A (large content and structure migration).
Checklist
Additional Notes
This PR is intentionally broad to land Docs V2 as the new primary docs baseline. Follow-up PRs can further refine content quality, link validation, and section-level polish.