Skip to content

architecture-map.mdx

Latest commit

 

History

History
75 lines (58 loc) · 2.54 KB

architecture-map.mdx

File metadata and controls

75 lines (58 loc) · 2.54 KB
title Architecture Map
sidebarTitle Architecture Map
description Internal systems map for how content, tooling, validation, and automation interact
keywords
livepeer
architecture map
internal
systems map
content
tooling
validation
automation

This is an internal systems map for how content, tooling, validation, and automation interact.

Top-Level Components

  • Content source: v2/pages/**, snippets/**, docs.json
  • Runtime UX: Mintlify dev/build + hosted docs deployment
  • Local operator tooling: lpd, .githooks/*, tools/scripts/*, tests/*
  • CI/automation: .github/workflows/*, .github/scripts/*, snippets/automations/*
  • Governance docs: README.md, docs-guide/*, contribute/CONTRIBUTING/*

Data + Control Flow

flowchart TD
  A["Author edits content (v2/pages, snippets)"] --> B["Local commands (lpd dev, lpd test)"]
  B --> C["Pre-commit checks (.githooks/pre-commit)"]
  C --> D["Unit + integration validation (tests/*)"]
  D --> E["Index and metadata sync (tools/scripts/*)"]
  E --> F["Pull request + CI workflows (.github/workflows)"]
  F --> G["Deployment + runtime docs experience"]

  H["External sources (forum/blog/youtube/releases)"] --> I["Automation scripts/workflows"]
  I --> J["Generated data in snippets/automations + snippets/data"]
  J --> A
Loading

Execution Layers

Layer 1: Authoring + Content System

  • Markdown/MDX pages and snippets are the editable content primitives.
  • docs.json defines navigation and routing context.

Layer 2: Local Enforcement

  • lpd orchestrates setup/dev/tests/hooks/scripts.
  • Pre-commit hook runs fast safety gates and staged audits.
  • Test runners validate style, MDX, links/imports, quality, docs navigation, and script docs.

Layer 3: CI + Automation

  • Workflows run changed-file quality checks and browser checks for PRs.
  • Scheduled/manual workflows refresh external data and supporting assets.
  • Template and intake workflows enforce issue/PR quality and labeling.

Layer 4: Documentation Governance

  • docs-guide/ defines internal navigation source of truth.
  • README.md provides high-level orientation and points to canonical docs-guide pages.

Key Contract Edges

  1. Script metadata contract:
    • Script headers -> script index generation -> docs-guide scripts catalog.
  2. Workflow/template contract:
    • .github/workflows/* + .github/ISSUE_TEMPLATE/* -> docs-guide generated indexes.
  3. Content validity contract:
    • Content changes -> hooks/tests -> CI -> deployable docs.