Link the OpenAPI spec on the Machines API overview - #2531
Merged
Merged
Conversation
The page had <SpecDownload />, a component that exists nowhere in the repository. Mintlify drops an unknown component without erroring, so the page ran straight from "visit the complete Machines API docs." to "Base URL" with nothing in between, and nobody reports a gap that renders as nothing. A markdown link rather than a Card: a Card renders no anchor, so a crawler or an assistant asked where to get the spec would not see it. The wording and the absolute URL match machines/api/index.mdx, which already points at the same file.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
This branch was successfully deployed
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
1 participant
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.
Closes superfly/docs-tracking#318.
api/machines/index.mdxline 11 was<SpecDownload />, a component that exists nowhere in the repository. It came in with the content import in8f45520c, which shipped several other snippets, so this one was named and never delivered.The failure mode is why this sat for weeks. Mintlify drops an unknown component without erroring, so there was no build failure and nothing in the HTML. The live page reads straight from "visit the complete Machines API docs." to "Base URL" with nothing between them. A reader cannot report a gap that renders as nothing, and the page is the entry point to the generated Machines API reference.
A markdown link rather than a Card, deliberately. Mintlify's
<Card href="...">renders no anchor, so the link only works client side and a crawler or an assistant asked "where do I get the Machines API spec" would not see it. Given the pricing work this week was about exactly that class of invisibility, using a Card here would have reintroduced it.The wording and the absolute URL match
machines/api/index.mdxline 30, which already points readers at the same file to generate a client. Verified the target serves 200 asapplication/json.