Repository navigation
[FIX] Split build-docs into validate and publish jobs - #1283
Merged
Merged
Conversation
Validate the Mintlify build with `mint validate` on every PR (forks included, no secrets), and only publish to docs-preview/docs after validation passes.
mkdocstrings_parser turns failures into HTML comments, which to_mdx.py then strips, so broken ::: references silently vanished from the docs.
The notebook was removed in #1117 but its navigation entry was kept.
Mariana Menchero García (MMenchero)
approved these changes
Oct 13, 2026
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.
Why
build-docspublishes whatevermake all_docsproduces, so broken MDX, a baddocs.json, or an unresolvable:::docstring reference ships silently. The first two only fail later in the Nixtla/docs deploy, and the last one never fails at all: the section just disappears from the page. Fork PRs also fail outright, because the docs token is minted before any fork check.What changed
validate-docsjob: builds the docs and runsmint validate. It runs for everyone, including forks, with no secrets and read-only access.publish-docsjob: runs only after validation passes and is skipped for forks and dependabot. It publishes the docs and triggers the docs repo workflow.docs/production.ymlfor releases and manual production runs,docs-preview/preview.ymlotherwise), which replaces the duplicated deploy and trigger steps.to_mdx.pynow fails the build when the parser emits<!-- Error ... -->comments. Before, those comments were stripped, so any:::reference the parser couldn't resolve was silently dropped from the docs.docs.jsonnav entry forAutoArima_vs_Prophet, whose notebook was deleted in [FIX] Add missing tutorial for AutoARIMAProphet adapter #1117.mint validateflagged it on this PR.Same change as Nixtla/neuralforecast#1639.