Skip to content

Commit fb0b063

Browse files
committed
content upgrades
1 parent bc29271 commit fb0b063

File tree

120 files changed

+77393
-804390
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

120 files changed

+77393
-804390
lines changed

docs-guide/contributing/contributing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ Use visual-explainer when you need high-signal review artifacts for structural c
3030

3131
For full details and corrected repo path references, see:
3232

33-
- [`v2/x-experimental/visual-explainer-livepeer-guide.md`](../../v2/x-experimental/visual-explainer-livepeer-guide.md)
33+
- [`docs-guide/feature-guides/visual-explainer-workflows.mdx`](../feature-guides/visual-explainer-workflows.mdx)

v2/x-experimental/visual-explainer-livepeer-guide.md renamed to docs-guide/feature-guides/visual-explainer-workflows.mdx

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
---
2+
title: 'Visual Explainer Workflows'
3+
sidebarTitle: 'Visual Explainer'
4+
description: 'Pilot workflow guidance for using visual-explainer in docs maintenance, review, and reporting.'
5+
keywords:
6+
[
7+
'livepeer',
8+
'visual explainer',
9+
'docs guide',
10+
'feature guide',
11+
'pilot workflow',
12+
'diff review',
13+
'plan review',
14+
'fact check',
15+
'project recap',
16+
]
17+
---
18+
119
# Visual Explainer — Livepeer docs-v2 Implementation Guide
220

321
> **What this is:** A practical guide to implementing [nicobailon/visual-explainer](https://github.com/nicobailon/visual-explainer) as a developer/maintainer tooling layer for the `livepeer/docs` `docs-v2` branch. This is not a content authoring tool — it operates alongside the docs, not inside Mintlify.
@@ -277,6 +295,19 @@ If these conditions are not met, keep this workflow internal to maintainers.
277295

278296
---
279297

298+
## Operator Runbook (Planning Only)
299+
300+
Use this checklist after the relocation is complete. Do not execute these commands as part of this migration change.
301+
302+
1. `/diff-review`: run for structural PRs (`docs.json`, `snippets/components/**`, `.github/workflows/**`) and capture one artifact per review.
303+
2. `/plan-review`: run once against the AI-first plan document and save a single gap-analysis artifact.
304+
3. `/fact-check`: run on delivery/retrospective docs before stakeholder circulation.
305+
4. `/project-recap`: run once per onboarding/handoff cycle to generate orientation context.
306+
307+
Outputs should remain out-of-repo and follow the naming convention in this guide.
308+
309+
---
310+
280311
## Quick Reference: Commands
281312

282313
| Command | Best Use in This Repo |

docs-guide/indexes/ai-tools.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,21 @@ Produced assets:
5050
2. Pick the target pack from `ai-tools/agent-packs/<agent>/`.
5151
3. Add the pack file to the agent's local rules/skills location.
5252
4. Run `node tools/scripts/repo-audit-orchestrator.js --mode static --scope full` as the first verification run.
53+
54+
## Codex Skill Portability
55+
56+
- Canonical source: `ai-tools/ai-skills/templates/*.template.md`
57+
- Local install target: `$CODEX_HOME/skills` (fallback: `~/.codex/skills`)
58+
- Sync behavior: safe upsert only (creates/updates managed skills; no deletion)
59+
60+
Runbook:
61+
62+
```bash
63+
node tools/scripts/sync-codex-skills.js --check
64+
node tools/scripts/sync-codex-skills.js
65+
node tools/scripts/sync-codex-skills.js --skills lpd-bootstrap-and-doctor,staged-test-suite-runner --dry-run
66+
```
67+
68+
Generated metadata:
69+
70+
- `agents/openai.yaml` is generated deterministically for each synced skill.

docs-guide/indexes/pages-index.mdx

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,10 @@ Run command: node tools/scripts/generate-docs-guide-pages-index.js --write
168168
<Tree.File name="community-guides.mdx" />
169169
<Tree.File name="community-projects.mdx" />
170170
</Tree.Folder>
171+
<Tree.Folder name="quickstart">
172+
<Tree.File name="AI-prompt.mdx" />
173+
<Tree.File name="gateway-setup.mdx" />
174+
</Tree.Folder>
171175
<Tree.Folder name="references">
172176
<Tree.Folder name="api-reference">
173177
<Tree.Folder name="AI-API">
@@ -228,10 +232,6 @@ Run command: node tools/scripts/generate-docs-guide-pages-index.js --write
228232
<Tree.Folder name="monitor">
229233
<Tree.File name="monitor-and-optimise.mdx" />
230234
</Tree.Folder>
231-
<Tree.Folder name="quickstart">
232-
<Tree.File name="get-AI-to-setup-the-gateway.mdx" />
233-
<Tree.File name="quickstart-a-gateway.mdx" />
234-
</Tree.Folder>
235235
<Tree.Folder name="requirements">
236236
<Tree.File name="setup.mdx" />
237237
</Tree.Folder>
@@ -388,12 +388,10 @@ Run command: node tools/scripts/generate-docs-guide-pages-index.js --write
388388
<Tree.File name="start-egress.mdx" />
389389
<Tree.File name="stop-egress.mdx" />
390390
<Tree.File name="update-user.mdx" />
391-
<Tree.File name="update.mdx" />
392391
</Tree.Folder>
393392
<Tree.Folder name="sessions">
394393
<Tree.File name="get-all.mdx" />
395394
<Tree.File name="get-clip.mdx" />
396-
<Tree.File name="get-recording.mdx" />
397395
<Tree.File name="get.mdx" />
398396
<Tree.File name="overview.mdx" />
399397
</Tree.Folder>
@@ -707,6 +705,10 @@ Run command: node tools/scripts/generate-docs-guide-pages-index.js --write
707705
<Tree.File name="community-projects.mdx" />
708706
<Tree.File name="faq.mdx" />
709707
</Tree.Folder>
708+
<Tree.Folder name="quickstart">
709+
<Tree.File name="AI-prompt.mdx" />
710+
<Tree.File name="gateway-setup.mdx" />
711+
</Tree.Folder>
710712
<Tree.Folder name="references">
711713
<Tree.Folder name="api-reference">
712714
<Tree.Folder name="AI-API">
@@ -767,10 +769,6 @@ Run command: node tools/scripts/generate-docs-guide-pages-index.js --write
767769
<Tree.Folder name="monitor">
768770
<Tree.File name="monitor-and-optimise.mdx" />
769771
</Tree.Folder>
770-
<Tree.Folder name="quickstart">
771-
<Tree.File name="get-AI-to-setup-the-gateway.mdx" />
772-
<Tree.File name="quickstart-a-gateway.mdx" />
773-
</Tree.Folder>
774772
<Tree.Folder name="requirements">
775773
<Tree.File name="setup.mdx" />
776774
</Tree.Folder>
@@ -928,12 +926,10 @@ Run command: node tools/scripts/generate-docs-guide-pages-index.js --write
928926
<Tree.File name="start-egress.mdx" />
929927
<Tree.File name="stop-egress.mdx" />
930928
<Tree.File name="update-user.mdx" />
931-
<Tree.File name="update.mdx" />
932929
</Tree.Folder>
933930
<Tree.Folder name="sessions">
934931
<Tree.File name="get-all.mdx" />
935932
<Tree.File name="get-clip.mdx" />
936-
<Tree.File name="get-recording.mdx" />
937933
<Tree.File name="get.mdx" />
938934
<Tree.File name="overview.mdx" />
939935
</Tree.Folder>
@@ -1176,6 +1172,10 @@ Run command: node tools/scripts/generate-docs-guide-pages-index.js --write
11761172
<Tree.File name="community-projects.mdx" />
11771173
<Tree.File name="faq.mdx" />
11781174
</Tree.Folder>
1175+
<Tree.Folder name="quickstart">
1176+
<Tree.File name="AI-prompt.mdx" />
1177+
<Tree.File name="gateway-setup.mdx" />
1178+
</Tree.Folder>
11791179
<Tree.Folder name="references">
11801180
<Tree.Folder name="api-reference">
11811181
<Tree.Folder name="AI-API">
@@ -1236,10 +1236,6 @@ Run command: node tools/scripts/generate-docs-guide-pages-index.js --write
12361236
<Tree.Folder name="monitor">
12371237
<Tree.File name="monitor-and-optimise.mdx" />
12381238
</Tree.Folder>
1239-
<Tree.Folder name="quickstart">
1240-
<Tree.File name="get-AI-to-setup-the-gateway.mdx" />
1241-
<Tree.File name="quickstart-a-gateway.mdx" />
1242-
</Tree.Folder>
12431239
<Tree.Folder name="requirements">
12441240
<Tree.File name="setup.mdx" />
12451241
</Tree.Folder>
@@ -1397,12 +1393,10 @@ Run command: node tools/scripts/generate-docs-guide-pages-index.js --write
13971393
<Tree.File name="start-egress.mdx" />
13981394
<Tree.File name="stop-egress.mdx" />
13991395
<Tree.File name="update-user.mdx" />
1400-
<Tree.File name="update.mdx" />
14011396
</Tree.Folder>
14021397
<Tree.Folder name="sessions">
14031398
<Tree.File name="get-all.mdx" />
14041399
<Tree.File name="get-clip.mdx" />
1405-
<Tree.File name="get-recording.mdx" />
14061400
<Tree.File name="get.mdx" />
14071401
<Tree.File name="overview.mdx" />
14081402
</Tree.Folder>
@@ -1610,10 +1604,14 @@ Run command: node tools/scripts/generate-docs-guide-pages-index.js --write
16101604
<Tree.Folder name="monitor">
16111605
<Tree.File name="monitor-and-optimise.mdx" />
16121606
</Tree.Folder>
1607+
<Tree.Folder name="payments">
1608+
<Tree.File name="payment-clearinghouse.mdx" />
1609+
</Tree.Folder>
16131610
<Tree.Folder name="requirements">
16141611
<Tree.File name="setup.mdx" />
16151612
</Tree.Folder>
16161613
<Tree.File name="run-a-gateway.mdx" />
1614+
<Tree.File name="transcoding.mdx" />
16171615
<Tree.File name="why-run-a-gateway.mdx" />
16181616
</Tree.Folder>
16191617
<Tree.Folder name="using-gateways">
@@ -1717,6 +1715,7 @@ Run command: node tools/scripts/generate-docs-guide-pages-index.js --write
17171715
<Tree.Folder name="about-orchestrators">
17181716
<Tree.File name="architecture.mdx" />
17191717
<Tree.File name="economics.mdx" />
1718+
<Tree.File name="job-types.mdx" />
17201719
<Tree.File name="orchestrator-functions.mdx" />
17211720
<Tree.File name="overview.mdx" />
17221721
</Tree.Folder>
@@ -1736,9 +1735,11 @@ Run command: node tools/scripts/generate-docs-guide-pages-index.js --write
17361735
<Tree.File name="orchestrator-tools.mdx" />
17371736
</Tree.Folder>
17381737
<Tree.Folder name="quickstart">
1738+
<Tree.File name="batch-ai-quickstart.mdx" />
17391739
<Tree.File name="join-a-pool.mdx" />
17401740
<Tree.File name="orchestrator-setup.mdx" />
17411741
<Tree.File name="overview.mdx" />
1742+
<Tree.File name="realtime-ai-quickstart.mdx" />
17421743
</Tree.Folder>
17431744
<Tree.Folder name="references">
17441745
<Tree.File name="cli-flags.mdx" />
@@ -1806,12 +1807,10 @@ Run command: node tools/scripts/generate-docs-guide-pages-index.js --write
18061807
<Tree.File name="start-egress.mdx" />
18071808
<Tree.File name="stop-egress.mdx" />
18081809
<Tree.File name="update-user.mdx" />
1809-
<Tree.File name="update.mdx" />
18101810
</Tree.Folder>
18111811
<Tree.Folder name="sessions">
18121812
<Tree.File name="get-all.mdx" />
18131813
<Tree.File name="get-clip.mdx" />
1814-
<Tree.File name="get-recording.mdx" />
18151814
<Tree.File name="get.mdx" />
18161815
<Tree.File name="overview.mdx" />
18171816
</Tree.Folder>

docs-guide/indexes/scripts-index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ Run command: node tests/unit/script-docs.test.js --write --rebuild-indexes
5656
| `tests/integration/v2-wcag-audit.selftest.js` | Script-level self-tests for the v2 WCAG audit (local HTTP + Puppeteer axe run, and temp-file fix/stage behavior without Mintlify). | `node tests/integration/v2-wcag-audit.selftest.js` | docs |
5757
| `tests/run-all.js` | Utility script for tests/run-all.js. | `node tests/run-all.js` | docs |
5858
| `tests/run-pr-checks.js` | Run changed-file scoped validation checks for pull request CI. | `node tests/run-pr-checks.js --base-ref main` | docs |
59+
| `tests/unit/codex-skill-sync.test.js` | Validate template-driven Codex skill sync behavior including check drift, safe upsert, subset sync, and openai.yaml generation. | `node tests/unit/codex-skill-sync.test.js` | docs |
5960
| `tests/unit/docs-guide-sot.test.js` | Validate docs-guide source-of-truth coverage, README pointers, and generated index freshness. | `node tests/unit/docs-guide-sot.test.js` | docs |
6061
| `tests/unit/docs-navigation.test.js` | Validate docs.json page-entry syntax in check-only mode by default, with optional report writing and approved remaps. | `./lpd tests unit docs-navigation.test` | docs |
6162
| `tests/unit/docs-usefulness-accuracy-verifier.test.js` | Validate source-weighted 2026 accuracy verification rules (GitHub vs DeepWiki precedence, freshness, fallback, and cache reuse). | `node tests/unit/docs-usefulness-accuracy-verifier.test.js` | docs |
@@ -156,6 +157,7 @@ Run command: node tests/unit/script-docs.test.js --write --rebuild-indexes
156157
| `tools/scripts/snippets/test-scripts.sh` | Utility script for tools/scripts/snippets/test-scripts.sh. | `bash tools/scripts/snippets/test-scripts.sh` | docs |
157158
| `tools/scripts/snippets/update-component-library.sh` | Utility script for tools/scripts/snippets/update-component-library.sh. | `bash tools/scripts/snippets/update-component-library.sh` | docs |
158159
| `tools/scripts/style-and-language-homogenizer-en-gb.js` | Enforce EN-GB style and terminology profile for English v2 docs in phase 1. | `node tools/scripts/style-and-language-homogenizer-en-gb.js --scope full` | docs |
160+
| `tools/scripts/sync-codex-skills.js` | Sync canonical skill templates into local Codex skills using safe upsert and deterministic openai.yaml generation. | `node tools/scripts/sync-codex-skills.js` | docs |
159161
| `tools/scripts/test-all-pages-browser.js` | Utility script for tools/scripts/test-all-pages-browser.js. | `node tools/scripts/test-all-pages-browser.js` | docs |
160162
| `tools/scripts/test-all-pages-comprehensive.js` | Utility script for tools/scripts/test-all-pages-comprehensive.js. | `node tools/scripts/test-all-pages-comprehensive.js` | docs |
161163
| `tools/scripts/test-v2-pages.js` | Utility script for tools/scripts/test-v2-pages.js. | `node tools/scripts/test-v2-pages.js` | docs |

docs-guide/source-of-truth-policy.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ This document defines canonical ownership boundaries to prevent drift across REA
2828
| Script/runtime behavior | Code + tests | Behavioral truth always lives in executable code and validation tests. |
2929
| Script metadata and inventory | Script headers + generated indexes | Script headers feed script index generation. |
3030
| Repo feature navigation map | `docs-guide/*.mdx` (manual canonical files) | Internal maintainer source of truth. |
31+
| Codex skill portability | `ai-tools/ai-skills/templates/*.template.md` | Local installs are synced from templates via `sync-codex-skills.js`. |
3132
| Public user-facing docs content | `v2/pages/**` | Mintlify docs in `docs.json` navigation. |
3233
| CI/test execution behavior | Workflow files + test runner scripts | Narrative summaries must link to these files. |
3334
| Issue/PR intake behavior | `.github/ISSUE_TEMPLATE/*` + PR templates + workflows | Generated templates index summarizes usage. |
@@ -110,3 +111,4 @@ It should not duplicate deep procedures that already exist in:
110111
1. Any meaningful process change must update the relevant docs-guide canonical file in the same PR.
111112
2. Any script/workflow/template change must regenerate indexes in the same PR.
112113
3. If README and docs-guide disagree, docs-guide canonical files are considered authoritative for operational navigation.
114+
4. Codex skill installs must be generated from templates using `node tools/scripts/sync-codex-skills.js` (manual edits in local skill folders are non-canonical).

0 commit comments

Comments
 (0)