Skip to content
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

Merged
merged 3 commits into from
May 31, 2024
Merged

Fixes over 500 broken links in docs #13734

merged 3 commits into from
May 31, 2024

Conversation

discdiver
Copy link
Contributor

@discdiver discdiver commented May 31, 2024

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

  • This pull request references any related issue by including "closes <link to issue>"
    • If no issue exists and your change is not a small fix, please create an issue first.
  • If this pull request adds new functionality, it includes unit tests that cover the changes
  • This pull request includes a label categorizing the change e.g. maintenance, fix, feature, enhancement, docs.

For documentation changes:

  • This pull request includes redirect settings in mint.json for files that are removed or renamed.

For new functions or classes in the Python SDK:

  • This pull request includes helpful docstrings.
  • If a new Python file was added, this pull request contains a stub page in the Python SDK docs and an entry in docs/mint.json navigation.

@discdiver discdiver added the docs label May 31, 2024
@discdiver discdiver marked this pull request as ready for review May 31, 2024 18:17
@discdiver discdiver requested a review from a team as a code owner May 31, 2024 18:17
@serinamarie
Copy link
Contributor

serinamarie commented May 31, 2024

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 2.x?

@discdiver
Copy link
Contributor Author

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 2.x?

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.

@serinamarie
Copy link
Contributor

Gotcha, will the docs still be versioned then? As in when 3.1 is released you can still toggle to 3.0?

@discdiver
Copy link
Contributor Author

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!

Copy link
Contributor

@billpalombi billpalombi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@discdiver discdiver merged commit 0806200 into main May 31, 2024
8 checks passed
@discdiver discdiver deleted the urls branch May 31, 2024 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants