Skip to content

feature-map.mdx

Latest commit

 

History

History
115 lines (83 loc) · 3.74 KB

feature-map.mdx

File metadata and controls

115 lines (83 loc) · 3.74 KB
title Feature Map
sidebarTitle Feature Map
description This map captures repository capabilities as an internal maintainer index.
keywords
livepeer
feature map
internal
map
repository
capabilities

1) Frontend Docs Experience

  • Mintlify-based documentation site with role-oriented navigation in docs.json.
  • Shared component system in snippets/components/.
  • Structural/style enforcement through style-guide tests and hook checks.
  • Route and page index synchronization via tools/scripts/generate-pages-index.js.

Primary references:

  • v2/resources/documentation-guide/style-guide.mdx
  • v2/resources/documentation-guide/component-library.mdx
  • tools/scripts/generate-pages-index.js

2) Backend-Like Operational Layer (Docs Ops)

  • Unified CLI entrypoint: lpd.
  • Validation and enforcement scripts across tests/, .githooks/, and tools/scripts/.
  • Staged and full WCAG accessibility audits for v2/ docs with conservative autofix support for common raw-tag issues.
  • Intake and governance artifacts:
    • issue templates in .github/ISSUE_TEMPLATE/
    • PR templates in .github/pull-request-template-v2.md and .github/pull_request_template.md
  • Pre-commit validations including style, MDX, links/imports, scripts docs, and staged audits.

Primary references:

3) AI + Automation + Pipelines

  • Automated ingestion/update flows for forum, blog, YouTube, releases, showcase data.
  • n8n workflow JSON assets and GitHub Actions alternatives coexist.
  • Community pipeline features including showcase and content aggregation/trending patterns.

Primary references:

4) Product + Content System

  • Product-oriented docs copy and information architecture under v2/pages/.
  • “Zero-to-hero” progression across portals, quickstarts, and deep references.
  • Editorial and governance standards in docs guide + contribution docs.

Primary references:

  • content-system.md
  • v2/resources/documentation-guide/documentation-guide.mdx
  • contribute/CONTRIBUTING/README.md

5) Technical Guides + Domain Coverage

  • Operational guides for gateways, orchestrators, delegators, developers, resources.
  • Long-form reference and troubleshooting paths in role-specific sections.

Primary references:

  • v2/pages/04_gateways/
  • v2/orchestrators/
  • v2/pages/06_delegators/
  • v2/pages/03_developers/

6) Future-Proof Maintenance Automation

  • Script templates enforce self-documenting headers.
  • Script inventory and audit generation are automated.
  • Index generation and SEO/AEO/glossary-supporting scripts live under tools/scripts/.

Primary references:

  • tools/scripts/new-script.js
  • tools/scripts/audit-scripts.js
  • tools/scripts/snippets/generate-seo.js
  • tools/scripts/snippets/generate-data/scripts/generate-glossary.js

7) Data Integrations and APIs

  • OpenAPI and related API specs in api/.
  • Integrated reference datasets and snippets data in snippets/data/.
  • External feed ingestion supports docs freshness and cross-linking.

Primary references:

8) Documentation Automation About Documentation

  • Generated script/workflow/template indexes in docs-guide/.
  • Guardrail checks for docs-guide coverage and README pointers.

Primary references: