Repository navigation
ci: local docs checks (mintlify validate + broken-links + EN/KO parity), optional Actions workflow - #3
Merged
Conversation
…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
Kept as a separate commit so it can be dropped if Actions stays unpaid.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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 byen/andko/(same relative paths),docs.jsonnavigation for each language,It exits 1 and lists every mismatch.
scripts/ci.sh: runsmintlify validate,mintlify broken-linksand the parity check, and prints a PASS/FAIL summary. Logs go to/workspace/out/local-ci-<short-sha>/, or./ci-logs/when$CIis set. You can change this withCI_OUT_ROOT. The mintlify CLI is pinned to4.2.1126; setMINTLIFY_VERSIONto use a different version..github/workflows/docs-ci.yml(in its own commit, 34aeb0d): onpull_request, sets up Node 20, runsscripts/ci.shand uploads the logs. We don't pay for Actions, so runningscripts/ci.shlocally is the main way to run these checks. If Actions stays off, drop this commit.Local results (box, 2026-10-26)
/workspace/out/local-ci-34aeb0d/validate.log/workspace/out/local-ci-34aeb0d/broken-links.log/workspace/out/local-ci-34aeb0d/parity.logTests that the checks catch problems (the files were restored afterwards):
ko/vision/why-open-source.mdx. Parity exited 1 and reported both the missing file and the nav entry with no page./en/does-not-exist.broken-linksfailed, and so didci.sh.How to run