Docs v2 preview

.augment/rules/imported/AI_GUIDELINES.md

@@ -0,0 +1,46 @@
+---
+type: "always_apply"
+---
+
+# 🛡️ AI SAFETY PROTOCOL: GIT WRITE OPERATIONS
+
+## 1. MANDATORY SAFETY HOOKS
+
+This repository uses custom Git hooks for "Human-in-the-Loop" (HitL)
+verification.
+
+- **ENFORCEMENT:** You SHALL NOT attempt to bypass hooks.
+- **FORBIDDEN:** The use of `--no-verify`, `-n`, or any environment variable
+  designed to skip Git hook execution is STRICTLY PROHIBITED.
+- **BEHAVIOR:** When you initiate a `commit`, `push`, or `rebase`, the hook will
+  pause and wait for manual input in the user's terminal. You MUST wait for the
+  user to confirm.
+
+## 2. AUTOMATED CHECKPOINTING
+
+Every write command triggers an automatic checkpoint branch.
+
+- **FORMAT:** `checkpoint/YYYY-MM-DD_HHMMSS`
+- **ACTION:** Before running a write command, you MUST state: _"I am initiating
+  [COMMAND]. A safety checkpoint will be created. Please approve the prompt in
+  your terminal."_
+
+## 3. CATASTROPHIC FAILURE RECOVERY
+
+In the event of a destructive operation (e.g., accidental file deletion,
+corrupted rebase, or broken merge):
+
+- **DO NOT** attempt to "fix" the state with further complex Git commands.
+- **PROCEDURE:**
+  1. Identify the latest `checkpoint/` branch using
+     `git branch --list 'checkpoint/*'`.
+  2. Suggest a `git reset --hard` to that specific checkpoint branch to restore
+     the repository to its pre-failure state.
+  3. Notify the user immediately of the failure and the recovery path.
+
+## 4. SCOPE LIMITATIONS
+
+- **READS:** You have full permission for `git status`, `git diff`, and
+  `git log`.
+- **WRITES:** Every `commit`, `push`, and `rebase` is a high-stakes action.
+  Treat them as irreversible without human oversight.

.augment/rules/imported/copilot-instructions.md

@@ -0,0 +1,96 @@
+---
+type: "agent_requested"
+description: "Example description"
+---
+
+docs. The docs are built and previewed using Mintlify CLI, and can be
+containerized with Docker.
+
+# Copilot Instructions for Livepeer Docs (2026)
+
+## Big Picture & Architecture
+
+- **Multi-version Docs:**
+  - `v1/` = legacy, `v2/` = current. Navigation in `docs.json`/`docs_v2.json`.
+- **Component System:**
+  - Custom React/TSX/JSX components in `snippets/components/` (see
+    README-custom-view.md for advanced usage).
+  - Use `.tsx` for new components; `.jsx` is legacy but supported.
+- **Automations & Scripts:**
+  - All dynamic, AI, and data-fetching logic in `automations/` and `ai-tools/`.
+  - Scripts for API doc generation and external data in `snippets/scripts/` (see
+    generate-api-docs.sh, fetch-openapi-specs.sh).
+- **API Reference:**
+  - OpenAPI spec in `openapi.yaml` (AI API: see ai/worker/api/openapi.yaml). Use
+    scripts to generate MDX/API docs.
+- **Assets:**
+  - Images/logos in `images/`, `logo/`, and static assets in `assets/`.
+
+## Developer Workflows
+
+- **Preview Locally:**
+  1. Install Mintlify CLI: `npm i -g mintlify`
+  2. Run: `mint dev` (from repo root, where `mint.json` or `mint_v1.json`
+     exists)
+- **Build/Deploy:**
+  - Docker:
+    `docker buildx build --platform linux/amd64 --load -t livepeer/docs .`
+  - Makefile: `make all`
+- **API Docs Generation:**
+  - Use `snippets/scripts/generate-api-docs.sh` to convert OpenAPI specs to
+    MDX/API docs and navigation JSON. Example:
+    ```bash
+    ./snippets/scripts/generate-api-docs.sh ai/worker/api/openapi.yaml v2/pages/04_gateways/guides-references/api-reference/AI-API "AI API"
+    ```
+  - Output: MDX files + navigation snippet for `docs.json`.
+- **External Data Fetching:**
+  - Use `fetch-openapi-specs.sh` and `fetch-external-docs.sh` for syncing
+    specs/docs from other repos.
+- **Component Usage:**
+  - Import with relative paths from `snippets/components/` in `.mdx` files.
+  - For custom dropdowns, see `CustomViewDropdown` in
+    `snippets/components/custom-view-dropdown.jsx` and its README.
+
+## Project Conventions & Patterns
+
+- **MDX-First:** All docs are `.mdx` (Markdown + JSX/TSX components).
+- **Versioning:** New docs in `v2/`, legacy in `v1/` or
+  `deprecated-references/`.
+- **AI/Dynamic Content:** All AI-generated or dynamic content in `automations/`
+  or `ai-tools/`.
+- **SEO & Metadata:** Add SEO tags/metadata in page frontmatter (see
+  `README_V2.md`).
+- **No Formal Test Suite:** Preview changes locally before merging.
+- **Architecture:**
+  - Docs mirror protocol architecture: Gateway, Orchestrator, Transcoder, AI
+    Worker. See `README_V2.md` for detailed flows and node roles.
+  - Gateways do not process video; they route jobs to orchestrators. Node roles
+    are mutually exclusive (see `README_V2.md`).
+- **Custom Views:**
+  - Use `CustomViewDropdown` for Mintlify-style view switching. See
+    `snippets/components/README-custom-view.md` for migration and usage.
+
+## Integration Points
+
+- **Mintlify:** All build/preview flows use Mintlify CLI and config files
+  (`mint.json`, `docs.json`).
+- **OpenAPI:** API docs generated from `openapi.yaml` (see also
+  `ai/worker/api/openapi.yaml`).
+- **Docker:** Containerized builds for CI/CD and local dev.
+- **Automations:** Scripts in `snippets/scripts/` automate API doc generation
+  and external data sync.
+
+## Key Files & Directories
+
+- `docs.json`, `docs_v2.json` — Navigation/config
+- `snippets/components/` — Custom components (see README-custom-view.md)
+- `automations/`, `ai-tools/` — Scripts, AI, dynamic content
+- `openapi.yaml`, `ai/worker/api/openapi.yaml` — API reference
+- `Dockerfile`, `Makefile` — Build/deploy
+- `README.md`, `README_V2.md` — Developer notes, protocol/architecture
+- `snippets/scripts/` — Automation scripts (API docs, data fetching)
+
+---
+
+If any conventions or workflows are unclear, review the latest `README.md`,
+`README_V2.md`, or automation READMEs, or ask for clarification.

.github/augment-instructions.md

@@ -0,0 +1,128 @@
+# Augment Instructions for Livepeer Docs
+
+## ⛔ CRITICAL RULES - VIOLATION = CATASTROPHIC FAILURE ⛔
+
+### NEVER PERFORM GIT OPERATIONS WITHOUT EXPLICIT PERMISSION
+
+- **NEVER** run `git commit` without explicit user permission
+- **NEVER** run `git push` without explicit user permission
+- **NEVER** run `git reset` (soft/hard/mixed) without explicit user permission
+- **NEVER** use `--no-verify` flag to bypass hooks
+- **NEVER** modify git history or remote state
+- **ALWAYS** ask before ANY git operation that could lose work
+
+### INCIDENT LOG - LEARN FROM THESE FAILURES
+
+**2026-01-06 00:52 UTC**: AI assistant performed unauthorized
+`git reset --hard HEAD~1`
+
+- Destroyed hours of user work across 11 files
+- Violated explicit "NEVER commit/push without permission" rule
+- Required emergency recovery from VSCode Augment checkpoints
+- User lost focus, workflow, and trust
+- **THIS MUST NEVER HAPPEN AGAIN**
+
+## User Rules (CRITICAL - FOLLOW ALWAYS)
+
+1. **Never make code edits without permission that cannot be reverted**
+2. **Don't ask for read/grep/view command permissions** - just do it
+3. **Before implementing fixes** - explain the issue and proposed solution first
+4. **Don't repeat past errors** - if something failed, try a different approach
+5. **Keep context minimal** - only load files needed for the task
+6. **Always have a backup before risky changes** - THIS IS CRITICAL. If testinga
+   change, ensure you can revert first
+7. **Easily reversible code changes** - OK to make without asking
+8. **Never make irreversible changes** - always ensure changes can be undone
+
+## Repository Structure
+
+### Multi-Version Docs
+
+- `v1/` - Legacy documentation
+- `v2/` - Current documentation
+- Navigation configs: `docs.json` (v1), `docs_v2.json` (v2)
+
+### Key Directories
+
+- `snippets/components/` - Custom React/JSX/TSX components
+- `snippets/data/` - Data files (gateways.jsx, etc.)
+- `automations/` - Dynamic/AI/data-fetching logic
+- `ai-tools/` - AI-related tooling
+- `v2/scripts/` - API doc generation, data fetching scripts
+- `images/`, `logo/`, `assets/` - Static assets
+
+### Important Files
+
+- `mint.json`, `docs.json` - Mintlify config/navigation
+- `openapi.yaml` - API reference spec
+- `ai/worker/api/openapi.yaml` - AI API spec
+- `Dockerfile`, `Makefile` - Build/deploy
+- `README.md`, `README_V2.md` - Developer documentation
+
+## Development Workflows
+
+### Local Preview
+
+```bash
+npm i -g mintlify
+mint dev
+```
+
+### Docker Build
+
+```bash
+docker buildx build --platform linux/amd64 --load -t livepeer/docs .
+```
+
+### API Docs Generation
+
+```bash
+./v2/scripts/generate-api-docs.sh ai/worker/api/openapi.yaml v2/pages/04_gateways/guides-references/api-reference/AI-API "AI API"
+```
+
+## Component System
+
+- All docs are `.mdx` (Markdown + JSX)
+- Custom components in `snippets/components/`
+- Use `.tsx` for new components (`.jsx` is legacy)
+- Import with relative paths from `snippets/components/`
+
+### Key Components
+
+- `CustomCodeBlock` - Code blocks with variable interpolation
+- `CustomViewDropdown` - Mintlify-style view switching
+- Various callout/warning components in `snippets/components/gateways/`
+
+## Architecture Context
+
+Livepeer protocol node roles:
+
+- **Gateway** - Routes jobs, doesn't process video
+- **Orchestrator** - Coordinates work
+- **Transcoder** - Processes video
+- **AI Worker** - Handles AI inference
+
+Node roles are mutually exclusive.
+
+## Data Files
+
+### snippets/data/gateways.jsx
+
+Contains Docker Compose configurations:
+
+- `DOCKER_YML.offChain.{videoMin, video, aiMin, ai, dualMin, dual}`
+- `DOCKER_YML.onChain.{video, ai, dual}`
+
+Use with `CustomCodeBlock`:
+
+```jsx
+<CustomCodeBlock language="yaml" codeString={DOCKER_YML.offChain.videoMin} />
+```
+
+## Conventions
+
+- MDX-first documentation
+- New docs go in `v2/`
+- Legacy/deprecated content in `v1/` or `deprecated-references/`
+- No formal test suite - preview locally before merging
+- SEO tags/metadata in page frontmatter