Pin every endpoint's documentation URL, and fix the orange dark mode - #111
Open
leowilkin wants to merge 2 commits into
Open
Pin every endpoint's documentation URL, and fix the orange dark mode#111leowilkin wants to merge 2 commits into
leowilkin wants to merge 2 commits into
Conversation
Mintlify derives an endpoint page's URL from the operation's tag and summary, which quietly makes summaries load-bearing: retitling "Create a mobile token" moves its page and 404s every link to it. Nothing in the spec said so, and the document has no operationIds either, so summaries were the only thing holding 36 URLs up. Pin each one with `x-mint.href` instead. The values were generated from the summaries as they stood and verified against the live site before landing, so all 36 match the URLs already in the wild — this freezes today's paths rather than moving them. Pinning is only worth anything if it holds for endpoints added later, so two specs enforce it: every operation carries an href, and no two operations claim the same one. Both were mutation-tested — dropping a pin and duplicating an href each fail the suite. Claude-Session: https://claude.ai/code/session_01PtsTSgKVNFXJiUEErUbA6h
Mintlify's colors.light is the accent it uses in dark mode, and colors.dark the accent in light mode — not a lighter and darker shade of one brand colour, which is how I read them. Hack Club orange went into the light slot, so dark mode came out orange throughout. Use a lighter red instead, so the accent reads as Hack Club red in both modes. It clears AA against a dark background at 7.0:1, and the light-mode accent stays the darker red at 4.9:1 on white. Claude-Session: https://claude.ai/code/session_01PtsTSgKVNFXJiUEErUbA6h
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
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.
Two fixes to the docs config, one commit each.
Pin every endpoint's documentation URL
Mintlify derives an endpoint page's URL from the operation's tag and summary. That quietly makes summaries load-bearing: retitling "Create a mobile token" moves its page and 404s every link to it. Nothing in the spec said so, and the document has no
operationIds either — so summaries were the only thing holding 36 URLs up.Each operation now pins its own with
x-mint.href:The values were generated from the summaries as they stood, then verified against the live site before landing — all 36 returned 200, so this freezes today's paths rather than moving them. There's a comment above
paths:explaining the convention where someone editing the file will actually meet it.Pinning is only worth anything if it holds for endpoints added later, so two specs enforce it:
x-mint.hrefBoth were mutation-tested — dropping a pin and duplicating an href each fail the suite, so they're not tests that can only pass.
Stop the docs rendering orange in dark mode
colors.lightis the accent Mintlify uses in dark mode, andcolors.darkthe accent in light mode — not a lighter and darker shade of one brand colour, which is how I read them when I wrote the originaldocs.json. Hack Club orange went into thelightslot, so dark mode came out orange throughout.Now a lighter red, so the accent reads as Hack Club red in both modes:
#ff6b7d#d42f46Both clear AA.
https://claude.ai/code/session_01PtsTSgKVNFXJiUEErUbA6h