fix(preview): regen reference MDX for fork docs2mdx PRs - #657
Open
alexeagle wants to merge 1 commit into
Open
Conversation
Fork PR previews skipped gen_mdx_reference_docs (trust_upstream_code: false) and synced stale pre-built reference MDX from upstream/docs/. For fork PRs changing scripts/docs/**, build HTML inputs from the trusted PR base commit, then run the PR's docs2mdx.py via Python to produce fresh reference MDX for Mintlify preview.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Collaborator
|
@alexeagle can we create a test PR to show this is working as expected? |
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
2 participants
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.
Summary
Fixes stale reference docs in Mintlify previews for fork PRs that change
scripts/docs/docs2mdx.py(e.g. bazelbuild/bazel#30708).Root cause: Preview sets
trust_upstream_code: falsefor fork PRs, which skippedgen_mdx_reference_docsbut still rsync'd pre-built reference MDX fromupstream/docs/— so converter fixes never appeared in preview.Fix: Split-trust regen for fork PRs changing
scripts/docs/**:docs2mdx.pyvia Python (no Bazel on fork BUILD files)Limitations
Fork PRs changing docgen inputs still cannot rebuild reference HTML from fork code.
Test plan
/reference/command-line-referenceflag links in preview