Fix 23 broken links in docs/ guides and references#2
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Fix 23 broken links in docs/ guides and references#2mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Convert relative .md links to absolute Mintlify paths and replace CONTRIBUTING.md references with GitHub URLs since the file is excluded from Mintlify via .mintignore. Generated-By: mintlify-agent
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.
Summary
Fixed 23 broken links across 10 files in
docs/guides/anddocs/reference/.What was wrong
All internal links used relative
.mdpaths (e.g.,02-adding-descriptions.md,../reference/style-guide.md) which Mintlify's link checker cannot resolve. Additionally, 3 links pointed to../../CONTRIBUTING.mdwhich is excluded from Mintlify via.mintignore.Fixes applied
docs/guides/01-adding-parameters.md02-adding-descriptions.md,03-parameter-exceptions.md/docs/guides/...)docs/guides/02-adding-descriptions.md04-documenting-errors.md,01-adding-parameters.mddocs/guides/03-parameter-exceptions.md01-adding-parameters.md,04-documenting-errors.mddocs/guides/04-documenting-errors.md02-adding-descriptions.mddocs/guides/05-adding-new-endpoints.md01-adding-parameters.md(x2),02-adding-descriptions.md,04-documenting-errors.mddocs/reference/common-pitfalls.mdvalidation.md,../../CONTRIBUTING.mddocs/reference/file-structure.mdquick-reference.mddocs/reference/quick-reference.mdstyle-guide.md,file-structure.md,validation.md,common-pitfalls.mddocs/reference/style-guide.mdquick-reference.md,common-pitfalls.md,../../CONTRIBUTING.mddocs/reference/validation.md../../CONTRIBUTING.md,common-pitfalls.mdLink type conversions
02-adding-descriptions.md) -> absolute Mintlify path (/docs/guides/02-adding-descriptions)../reference/style-guide.md) -> absolute Mintlify path (/docs/reference/style-guide).mintignored) -> GitHub URL (https://github.com/whitebit-exchange/docs/blob/main/CONTRIBUTING.md)Validation
Both
mint validateandmint broken-linkspass with zero errors.