chore(docs): remove dead Mintlify-compat site builder (resolves Dependabot #3)#232
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
b5ecca6 to
53c79cb
Compare
There was a problem hiding this comment.
Pull request overview
Removes the abandoned Mintlify-compatible docs site builder scaffolding from this repository (while preserving the docs/*.md documentation corpus), eliminating the unused gray-matter → js-yaml@3.x dependency chain that triggered Dependabot alert #3.
Changes:
- Deleted the local docs site build/smoke/watch/index scripts under
docs/scripts/docs-site/. - Removed Mintlify navigation/config + static site assets (
docs/docs.json,docs/style.css, sidebar/nav JS). - Removed the docs-site-only Node manifest + lockfile (
docs/package.json,docs/package-lock.json).
Reviewed changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/style.css | Removes unused CSS for the deleted local docs site. |
| docs/STRUCTURE.md | Removes builder-specific meta-documentation for the deleted site tooling. |
| docs/sidebar-nav.js | Removes unused sidebar behavior JS for the deleted local docs site. |
| docs/scripts/docs-site/watch.mjs | Removes unused local rebuild watcher script. |
| docs/scripts/docs-site/source-index.mjs | Removes unused search index generator (and gray-matter usage). |
| docs/scripts/docs-site/smoke.mjs | Removes unused local docs-site smoke tests. |
| docs/scripts/docs-site/build.mjs | Removes unused Mintlify-compatible static renderer. |
| docs/README.md | Removes builder-specific docs README and obsolete local build instructions. |
| docs/package.json | Removes docs-site-only Node manifest (source of gray-matter/js-yaml). |
| docs/package-lock.json | Removes docs-site-only lockfile containing vulnerable js-yaml versions. |
| docs/nav-tabs-underline.js | Removes unused UI enhancement JS for the deleted docs site. |
| docs/docs.json | Removes Mintlify navigation config consumed only by the deleted tooling. |
| docs/AGENTS.md | Removes builder-specific authoring/workflow guidance tied to the deleted tooling. |
Files not reviewed (1)
- docs/package-lock.json: Generated file
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
CI status noteAll checks introduced or affected by this PR are green:
The two failing checks are pre-existing on
This PR is safe to merge once you're happy with the diff. The Rust break should be addressed in its own PR. |
Documentation lives in OpenCoven/coven-docs (canonical, shipping since 2026.5.24). The local docs/ site builder was abandoned tooling: no CI, no script, no workflow referenced it, and no runtime imports the dead `docs/scripts/docs-site` ESM modules. Removing the scaffold drops the transitive `gray-matter@4.0.3 -> js-yaml@3.14.2` dependency entirely, resolving Dependabot alert #3 (GHSA-h67p-54hq-rp68 / CVE-2026-53550, js-yaml DoS) at the root rather than papering over it with an override or a dismissal. The `docs/*.md` corpus is intentionally preserved (architecture, concepts, glossary, etc.). Only files that exclusively described or powered the dead builder are removed: - docs/scripts/docs-site/{build,smoke,source-index,watch}.mjs - docs/docs.json (Mintlify navigation config consumed only by the deleted build scripts) - docs/style.css, docs/nav-tabs-underline.js, docs/sidebar-nav.js (visual treatment for the dead site) - docs/package.json, docs/package-lock.json (devDependency manifest + lockfile for the dead site) - docs/{README,STRUCTURE,AGENTS}.md (meta-docs whose entire subject matter was the deleted Mintlify-compatible build, including `npm run docs:build / docs:smoke / docs:check` instructions that no longer have backing scripts) Co-authored-by: Nova <nova@openclaw.ai>
53c79cb to
78f6a33
Compare
Why
Documentation lives in
OpenCoven/coven-docs(canonical, shipping since2026.5.24). The localdocs/site builder inOpenCoven/covenis abandoned tooling — no CI, no script, no workflow references it, and no runtime imports the deaddocs/scripts/docs-siteESM modules.Removing the scaffold drops the transitive
gray-matter@4.0.3 → js-yaml@3.14.2dependency entirely, resolving Dependabot alert #3 at the root rather than papering over it with anoverrideshack, apatch-package, or a dismissal.js-yaml ≤ 4.1.14.2.0gray-matter@4.0.3is dead and pinsjs-yaml@^3.13.1, so a normalpnpm upcannot resolve this — the only clean fix is removing the consumer.What stays
The
docs/*.mdcorpus is intentionally preserved (architecture, concepts, glossary, etc.). Only files that exclusively described or powered the dead builder are removed.What goes
docs/scripts/docs-site/{build,smoke,source-index,watch}.mjsdocs/docs.jsondocs/style.css,docs/nav-tabs-underline.js,docs/sidebar-nav.jsdocs/package.json,docs/package-lock.jsongray-matter/js-yaml)docs/{README,STRUCTURE,AGENTS}.mdnpm run docs:build / docs:smoke / docs:checkinstructions that no longer have backing scriptsVerification
git grepacross the repo confirms zero remaining references togray-matter,docs/scripts, or any of thedocs:*npm scripts after this change..github/workflows/ci.yml) is Rust + secret-guard +cargo-deny— no docs build step exists or breaks.git diff --checkclean; pre-commit gitleaks hook passed (no secrets detected).Diff size
13 files changed, 4,749 deletions(-). Pure deletion, no replacements.Co-authored-by: Nova nova@openclaw.ai