docs: explain Windows link-check false positives and WSL workflow (bounty claim) - #69
Open
MaxKerkula wants to merge 1 commit into
Open
Conversation
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.
The contributor guide asks Windows users to run
mint broken-links, but native Windows CLI 4.2.876 reports an existing nested page as broken. On this repository's current base (bfa65868ddd1152ec46406eb896e6f4baad29061), it reports 232 links in 70 files. Running the same CLI version with Linux Node in WSL on the same checkout reports none. This is consistent with Mintlify issue #5680.Add a focused Windows troubleshooting section to the existing contributor guide. It shows how to identify the Linux toolchain, keep the npm cache separate, check the edited checkout, and interpret the exit code without suppressing failures. It also explains the cost of a separate Linux installation and the limits of a link check. No navigation or application code changes are included.
Validation:
npm_config_cache=... npx --yes mint@4.2.876 broken-linkscommand passes on the edited documentation tree, with exit 0.git diff --checkpasses.Both installations use Mint 4.2.876. Windows uses Node 22.23.2; WSL uses Node 22.22.0, so the runtime patch versions are not held constant. The public verification report gives the fixture and scope limits. The full
mint validatebuild and a rendered Mintlify preview are not verified. No provider API calls, credentials, or customer data were used.Bounty claim: Please consider the Silver tier under the documentation bounty program. This is a small troubleshooting tutorial of about 320 words, with executed instructions and a negative control. PayPal is preferred if an award is approved after merge; payment details will be shared privately. No award, reservation, payment, or maintenance agreement is assumed.
This is AI-assisted work. It is separate from the optional-provider example in #68. The newer link-check evidence was also used to correct that PR's validation description.