Repository navigation
Add an overview page at the Sprites API root - #261
Merged
Merged
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
kcmartin
marked this pull request as ready for review
October 8, 2026 18:23
kcmartin
changed the title
/sprites/api redirected to the first connector endpoint, so every link into the reference cost an extra hop and an agent fetching it landed on one operation rather than an entry point. It is the most-linked URL we have for the API. Content comes from api/openapi.json: base URL, bearer auth, and a link to the spec. Verified on a preview that the root serves 200 and the generated operation pages are unaffected.
kcmartin
force-pushed
the
test-sprites-api-overview
branch
from
October 8, 2026 18:28
a78a627 to
c610454
Compare
jbellerb
approved these changes
Oct 8, 2026
Merged
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
2 participants
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.
Fixes the root half of superfly/docs-tracking#347.
/sprites/apiwas a 307 to/sprites/api/connectors/list-connectors, so every link into the reference cost an extra hop and an agent fetching it landed on one connector endpoint rather than an entry point. It is the most-linked URL in the chain: 11 references assprites.dev/apiin ui-ex, 4 as/sprites/api, 3 as the full docs URL, plus landing and sprites-docs.Verified on the preview:
/sprites/apireturns 200 with zero redirects, the content renders, and all four sampled operation pages still serve 200, so adding the index did not disturb the OpenAPI generation. The group roots still 307 to their first operation, unchanged.One limitation. The page is served at that URL but does not appear in the tab's sidebar: preview and live both have the same 51 nav links, neither including
/sprites/api. So it fixes links and agent fetches, not human browsing. Asked Mintlify whether a non-generated page can be shown in an OpenAPI tab's navigation.Content comes from
api/openapi.json: base URLhttps://api.sprites.devandbearerAuth. Someone who knows the API may want a different opening paragraph, and the spec also carriesversion: 0.1.12across 31 paths if either is worth mentioning.The five group roots are still 307 and nothing much links them, so they are left for a decision on whether they are worth pages at all.