Docs v2 Preview

.augment-guidelines

@@ -0,0 +1,17 @@
+# Standard Operating Procedure for Scripts
+
+<!-- ## 1. Documentation & Testing Requirements
+- Whenever creating or modifying a script, you MUST:
+  - Generate documentation in the `/docs` folder (x folder).
+  - Generate comprehensive tests in the `/tests` folder (y folder).
+  - Use the naming convention `[script_name].test.js` (or applicable extension). -->
+
+## 1. Safety & Verification Workflow
+
+- Before applying changes to existing files, you MUST:
+  1. Create a "checkpoint" backup using the internal checkpoint tool.
+  2. Create a new git branch named `agent/[feature-name]`.
+  3. Verify the script's logic by applying it to a temporary copy of the target
+     file first.
+  4. Only after verification and user approval, apply the changes to the project
+     files in the new branch.

.augment/rules/git-safety.md

@@ -0,0 +1,5 @@
+# GIT WRITE PROTOCOL
+- **ENFORCEMENT:** You MUST verify the existence of local Git hooks in `.git/hooks/` before initiating any write command (commit, push, rebase).
+- **FORBIDDEN:** You are STRICTLY FORBIDDEN from using `--no-verify` or `-n`.
+- **BEHAVIOR:** When a write command is initiated, you MUST announce: "Initiating [action]. Please approve the safety checkpoint in your terminal."
+- **RECOVERY:** If a command fails, suggest restoring from the latest `checkpoint/` branch.

.github/AGENTS.md

@@ -0,0 +1,39 @@
+# 🤖 PROJECT AGENT RULES & SAFETY PROTOCOLS
+
+## 🛠️ CRITICAL BOUNDARIES (READ FIRST)
+
+- **ALWAYS** check for the existence of local Git hooks in `.git/hooks/` before
+  initiating a write command.
+- **NEVER** use `--no-verify` or `-n` flags to bypass safety checks. These are
+  hard project constraints.
+- **NEVER** perform a `git reset --hard` or `git push --force` without an
+  explicit, multi-turn plan confirmed by the user.
+- **NEVER** perform a `git reset --hard` or `git push --force` without a saved
+  branch to revert to in case of failure.
+
+## 📦 GIT WORKFLOW & CHECKPOINTS
+
+This project enforces a "Human-in-the-Loop" (HitL) verification for all
+destructive or history-altering actions.
+
+- **Automatic Checkpoints:** Every `commit`, `push`, and `rebase` triggers a
+  safety hook that creates a branch named `checkpoint/YYYY-MM-DD_HHMMSS`.
+- **Pre-Write Announcement:** Before executing a write command, you MUST state:
+  _"I am initiating [COMMAND]. A safety checkpoint will be created. Please
+  switch to your terminal to type 'yes' when prompted."_
+- **Recovery:** If a command fails, the latest pre-failure state is stored in
+  the most recent `checkpoint/` branch.
+
+## 🧪 VALIDATION COMMANDS
+
+Before asking for a commit, you should ideally run these to ensure code quality:
+
+```bash
+# Verify build
+mint dev
+```
+
+# Run local test suite
+
+Make a test for mintlify in the v2/tests file. DO NOT EVER run a script without
+testing it on a local branch first.

.github/copilot-instructions.md

@@ -13,7 +13,7 @@ containerized with Docker.
   - 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 `v2/scripts/` (see
+  - 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
@@ -32,10 +32,10 @@ containerized with Docker.
     `docker buildx build --platform linux/amd64 --load -t livepeer/docs .`
   - Makefile: `make all`
 - **API Docs Generation:**
-  - Use `v2/scripts/generate-api-docs.sh` to convert OpenAPI specs to MDX/API
-    docs and navigation JSON. Example:
+  - Use `snippets/scripts/generate-api-docs.sh` to convert OpenAPI specs to
+    MDX/API docs and navigation JSON. Example:
     ```bash
-    ./v2/scripts/generate-api-docs.sh ai/worker/api/openapi.yaml v2/pages/04_gateways/guides-references/api-reference/AI-API "AI API"
+    ./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:**
@@ -72,8 +72,8 @@ containerized with Docker.
 - **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 `v2/scripts/` automate API doc generation and
-  external data sync.
+- **Automations:** Scripts in `snippets/scripts/` automate API doc generation
+  and external data sync.
 
 ## Key Files & Directories
 
@@ -83,7 +83,7 @@ containerized with Docker.
 - `openapi.yaml`, `ai/worker/api/openapi.yaml` — API reference
 - `Dockerfile`, `Makefile` — Build/deploy
 - `README.md`, `README_V2.md` — Developer notes, protocol/architecture
-- `v2/scripts/` — Automation scripts (API docs, data fetching)
+- `snippets/scripts/` — Automation scripts (API docs, data fetching)
 
 ---
 

.github/workflows/update-livepeer-release.yml

@@ -0,0 +1,60 @@
+name: Update Livepeer Release Version
+
+on:
+  schedule:
+    # Run every 30 minutes
+    - cron: "*/30 * * * *"
+  workflow_dispatch:
+
+jobs:
+  check-and-update:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout docs repository
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get latest go-livepeer release
+        id: get_release
+        run: |
+          LATEST_RELEASE=$(curl -s https://api.github.com/repos/livepeer/go-livepeer/releases/latest | jq -r .tag_name)
+          echo "release=${LATEST_RELEASE}" >> $GITHUB_OUTPUT
+          echo "Latest release: ${LATEST_RELEASE}"
+
+      - name: Read current version from globals.mdx
+        id: current_version
+        run: |
+          CURRENT=$(grep -oP 'latestVersion\s*=\s*["'"'"']?\K[^"'"'"']+' snippets/automationData/globals/globals.mdx || echo "")
+          echo "current=${CURRENT}" >> $GITHUB_OUTPUT
+          echo "Current version: ${CURRENT}"
+
+      - name: Update globals.mdx if needed
+        if:
+          steps.get_release.outputs.release !=
+          steps.current_version.outputs.current
+        run: |
+          # Create backup
+          cp snippets/automationData/globals/globals.mdx snippets/automationData/globals/globals.mdx.bak
+
+          # Update the latestVersion value
+          sed -i "s/latestVersion[[:space:]]*=[[:space:]]*[\"'][^\"']*[\"']/latestVersion = \"${{ steps.get_release.outputs.release }}\"/" snippets/automationData/globals/globals.mdx
+
+          # Update the latestVersionUrl value
+          sed -i "s|latestVersionUrl[[:space:]]*=[[:space:]]*[\"'][^\"']*[\"']|latestVersionUrl = \"https://github.com/livepeer/go-livepeer/releases/download/${{ steps.get_release.outputs.release }}\"|" snippets/automationData/globals/globals.mdx
+
+          # Verify the changes
+          echo "Updated content:"
+          grep "latestVersion" snippets/automationData/globals/globals.mdx
+
+      - name: Commit and push if changed
+        if:
+          steps.get_release.outputs.release !=
+          steps.current_version.outputs.current
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          git add snippets/automationData/globals/globals.mdx
+          git commit -m "chore: update latest release to ${{ steps.get_release.outputs.release }}"
+          git push

AI_GUIDELINES.md

@@ -0,0 +1,42 @@
+# 🛡️ 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.