GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — ci: local docs checks (mintlify validate + broken-links + EN/KO parity), optional Actions workflow by NetVar1337 · Pull Request #3 · BitterSecurity/docs

Conversation

@NetVar1337

@NetVar1337 NetVar1337 commented Oct 26, 2026

Copy link
Copy Markdown
Member

What

Adds docs checks that run locally, plus an optional Actions workflow that calls them.

  • scripts/check-parity.mjs (Node, no dependencies): compares EN and KO by
    1. page files under en/ and ko/ (same relative paths),
    2. docs.json navigation for each language,
    3. nav ↔ files (every nav entry has a file, every page file is in the nav).
      It exits 1 and lists every mismatch.
  • scripts/ci.sh: runs mintlify validate, mintlify broken-links and the parity check, and prints a PASS/FAIL summary. Logs go to /workspace/out/local-ci-<short-sha>/, or ./ci-logs/ when $CI is set. You can change this with CI_OUT_ROOT. The mintlify CLI is pinned to 4.2.1126; set MINTLIFY_VERSION to use a different version.
  • README: covers local preview and running the checks.
  • .github/workflows/docs-ci.yml (in its own commit, 34aeb0d): on pull_request, sets up Node 20, runs scripts/ci.sh and uploads the logs. We don't pay for Actions, so running scripts/ci.sh locally is the main way to run these checks. If Actions stays off, drop this commit.

Local results (box, 2026-10-26)

Check Result Log
mintlify validate PASS /workspace/out/local-ci-34aeb0d/validate.log
mintlify broken-links PASS /workspace/out/local-ci-34aeb0d/broken-links.log
EN/KO parity PASS (31/31 files, 31/31 nav) /workspace/out/local-ci-34aeb0d/parity.log

Tests that the checks catch problems (the files were restored afterwards):

  • Removed ko/vision/why-open-source.mdx. Parity exited 1 and reported both the missing file and the nav entry with no page.
  • Added a link to /en/does-not-exist. broken-links failed, and so did ci.sh.

How to run

scripts/ci.sh

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
NetVar1337 added 2 commits October 26, 2026 09:10
@NetVar1337
ci: add local docs checks (mintlify validate, broken-links, EN/KO par…
af07f79 
…ity)

- scripts/check-parity.mjs: compares en/ vs ko/ page files, docs.json nav
  per language, and nav <-> files; exits 1 listing every mismatch
- scripts/ci.sh: runs validate, broken-links and parity; logs to
  /workspace/out/local-ci-<short-sha>/ (local CI is the primary path)
- README: preview + running checks
@NetVar1337
ci: add optional GitHub Actions workflow calling scripts/ci.sh
34aeb0d 
Kept as a separate commit so it can be dropped if Actions stays unpaid.
@NetVar1337
NetVar1337 marked this pull request as ready for review October 26, 2026 10:11
@NetVar1337
NetVar1337 merged commit 8b0bb0e into main Oct 26, 2026
2 checks passed

Uh oh!

There was an error while loading. Please reload this page.
@NetVar1337
NetVar1337 deleted the ci/docs-build-linkcheck branch October 26, 2026 10:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

1 participant

@NetVar1337
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.