-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fixes over 500 broken links in docs #13734
Conversation
Sorry if I'm not understanding but isn't there a way to keep the version out of the link rather than hardcode it? Like we had in |
That would be nice. I've read the docs, searched the docs with the LLM, and asked about relative links (relative to the file path of the object in question) twice. Doesn't appear so. I requested they add the feature, but get that it might be tricky. Preveioulsy, 2e built full versions of our docs with 2.0 for each release. Mike took care of the version management for the most part. Mintlify doesn't do that. Ideally, if there isn't a relative link solution in the future, we will automate regex parsing to create new URLs. We don't plan to build new versions on every patch, fwiw. |
Gotcha, will the docs still be versioned then? As in when 3.1 is released you can still toggle to 3.0? |
That's the plan! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
Spot checked locally. Much improved.
Update down to 159 broken links, and redirect rules, should we add them, and changing how some API docs are built will likely take care of most of the remaining links..
Example
Checklist
<link to issue>
"maintenance
,fix
,feature
,enhancement
,docs
.For documentation changes:
mint.json
for files that are removed or renamed.For new functions or classes in the Python SDK:
docs/mint.json
navigation.