You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> **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.
277
295
278
296
---
279
297
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.
|`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 |
60
61
|`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 |
61
62
|`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
156
157
|`tools/scripts/snippets/test-scripts.sh`| Utility script for tools/scripts/snippets/test-scripts.sh. |`bash tools/scripts/snippets/test-scripts.sh`| docs |
157
158
|`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 |
158
159
|`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 |
159
161
|`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 |
160
162
|`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 |
161
163
|`tools/scripts/test-v2-pages.js`| Utility script for tools/scripts/test-v2-pages.js. |`node tools/scripts/test-v2-pages.js`| docs |
@@ -110,3 +111,4 @@ It should not duplicate deep procedures that already exist in:
110
111
1. Any meaningful process change must update the relevant docs-guide canonical file in the same PR.
111
112
2. Any script/workflow/template change must regenerate indexes in the same PR.
112
113
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