Skip to content

chore(docs): remove dead Mintlify-compat site builder (resolves Dependabot #3)#232

Merged
BunsDev merged 1 commit into
mainfrom
chore/remove-dead-docs-site-builder
Jun 16, 2026
Merged

chore(docs): remove dead Mintlify-compat site builder (resolves Dependabot #3)#232
BunsDev merged 1 commit into
mainfrom
chore/remove-dead-docs-site-builder

Conversation

@BunsDev

@BunsDev BunsDev commented Jun 16, 2026

Copy link
Copy Markdown
Member

Why

Documentation lives in OpenCoven/coven-docs (canonical, shipping since 2026.5.24). The local docs/ site builder in OpenCoven/coven is abandoned tooling — no CI, no script, no workflow references 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 at the root rather than papering over it with an overrides hack, a patch-package, or a dismissal.

Alert Advisory Severity Vulnerable Patched
#3 GHSA-h67p-54hq-rp68 / CVE-2026-53550 moderate js-yaml ≤ 4.1.1 4.2.0

gray-matter@4.0.3 is dead and pins js-yaml@^3.13.1, so a normal pnpm up cannot resolve this — the only clean fix is removing the consumer.

What stays

The docs/*.md corpus is intentionally preserved (architecture, concepts, glossary, etc.). Only files that exclusively described or powered the dead builder are removed.

What goes

Path Why
docs/scripts/docs-site/{build,smoke,source-index,watch}.mjs The Mintlify-compat static site builder itself
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 (sole source of gray-matter/js-yaml)
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

Verification

  • git grep across the repo confirms zero remaining references to gray-matter, docs/scripts, or any of the docs:* npm scripts after this change.
  • CI (.github/workflows/ci.yml) is Rust + secret-guard + cargo-deny — no docs build step exists or breaks.
  • git diff --check clean; 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

Copilot AI review requested due to automatic review settings June 16, 2026 00:19
@mintlify

mintlify Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
OpenCoven 🔴 Failed Jun 16, 2026, 12:20 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@BunsDev BunsDev force-pushed the chore/remove-dead-docs-site-builder branch from b5ecca6 to 53c79cb Compare June 16, 2026 00:20

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@BunsDev

BunsDev commented Jun 16, 2026

Copy link
Copy Markdown
Member Author

CI status note

All checks introduced or affected by this PR are green:

Check Result
CodeQL (Analyze actions / JS-TS / Python / Rust)
Secret guard
Dependency audit (cargo-deny)

The two failing checks are pre-existing on main and unrelated to this PR:

  • Rust checks (ubuntu-latest) and Rust checks (windows-latest)coven-memory fails with error[E0277]: the trait bound 'Array<u8, UInt<...>>: LowerHex' is not satisfied. This same failure is present on every recent main commit going back at least 5 (e.g. 2b65a37, e0d8036, 5f0426b, 5cfd3ac, 934d122). It looks like a digest / generic-array version drift introduced by a recent dependency bump. Tracked separately.
  • Mintlify Deployment — expected to fail (and correctly so) because this PR is the very deletion of the Mintlify-compatible scaffolding.

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>
@BunsDev BunsDev force-pushed the chore/remove-dead-docs-site-builder branch from 53c79cb to 78f6a33 Compare June 16, 2026 06:54
@BunsDev BunsDev merged commit 6eb4cb1 into main Jun 16, 2026
11 of 12 checks passed
@BunsDev BunsDev deleted the chore/remove-dead-docs-site-builder branch June 16, 2026 07:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants