Skip to content

Task 14: V1 to V2 Documentation Coverage Audit#8

Merged
DeveloperAlly merged 4 commits intodocs-v2-previewfrom
docs-plan/14-audit-v1-to-v2-coverage
Feb 16, 2026
Merged

Task 14: V1 to V2 Documentation Coverage Audit#8
DeveloperAlly merged 4 commits intodocs-v2-previewfrom
docs-plan/14-audit-v1-to-v2-coverage

Conversation

@DeveloperAlly
Copy link
Owner

@DeveloperAlly DeveloperAlly commented Feb 16, 2026

Summary

This PR contains the V1 to V2 documentation coverage audit report, mapping all 279 v1 MDX files to their v2 counterparts (339 MDX files).

Key Findings

Status Count Percentage
Covered ~65 23%
Partial ~55 20%
Missing ~130 47%
Excluded/Deprecated ~29 10%

Major Gaps Identified

  1. API Reference (75 files) - V2 relies on external livepeer.studio/docs
  2. SDKs (63 files) - V2 has placeholder pages only
  3. Self-hosting (4 files) - Missing from V2 (Studio-specific)

Strategic Insight

V2 represents a deliberate shift from Studio-centric to Network-centric documentation:

  • V1: Livepeer Studio APIs, SDKs, React components, developer guides
  • V2: Gateways, Orchestrators, AI inference, protocol documentation

Deliverables

  • Complete coverage audit table by section (9 tables)
  • Status categorization for each v1 page
  • Exclusion criteria documentation
  • Recommendations for addressing gaps
  • Follow-up task list

Report Location

docs/PLAN/reports/14-audit-v1-to-v2-coverage-report.md

References

  • docs/ORCHESTRATORS/00-V1-TO-V2-IA-MAPPING-AND-RECOMMENDATIONS.md

Note

Low Risk
Documentation-only addition with no runtime or build impact; risk is limited to planning accuracy/misclassification in the audit report.

Overview
Adds docs/PLAN/reports/14-audit-v1-to-v2-coverage-report.md, a new V1→V2 documentation coverage audit that inventories file counts, maps sections/pages to counterparts, and categorizes coverage as Covered/Partial/Missing/Excluded.

The report calls out major gaps (notably Studio API reference, SDK docs, and self-hosting) and includes exclusion criteria, recommendations, and a follow-up task list to drive future documentation work.

Written by Cursor Bugbot for commit 992b7cc. This will update automatically on new commits. Configure here.

- 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
- 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
- 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
- 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
@DeveloperAlly DeveloperAlly merged commit 49264e6 into docs-v2-preview Feb 16, 2026
@DeveloperAlly DeveloperAlly deleted the docs-plan/14-audit-v1-to-v2-coverage branch February 16, 2026 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant