Add Versioning section to Environments docs page#667
Closed
ls-bolt[bot] wants to merge 1 commit into
Closed
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
jklein24
added a commit
that referenced
this pull request
Jul 8, 2026
## Summary Adds a **Versioning** section to the Environments page in the Mintlify docs, right after the Base API URL it explains. Integrator-facing policy it documents: - The date in the base URL (`2025-10-13`) is the API's major version; a pinned version's behavior doesn't change. - Backwards-compatible (additive) changes land in the current version — with tolerant-reader guidance (ignore unknown fields, handle new enum values). - Breaking changes ship only in a new dated version; existing versions are unaffected and you upgrade on your own schedule. - Deprecation: notice to the account contact email with migration steps, and at least **three months** of continued support after notice. The three-month window and notice mechanism deliberately match the MSA (`mintlify/legal/msa.mdx` §7.1–7.2, three-month Migration Period) and the existing "notify the account contact email" language used for Service IP changes on the same page — no new commitments invented. ## Rendered page  ## Test plan - Rendered locally with `mint dev` (pinned CLI 4.2.284) — screenshot above. - `mint broken-links`: no new findings (pre-existing broken links in untouched files only). - Docs-only change; OpenAPI spec untouched. Slack thread: https://lightsparkgroup.slack.com/archives/D0AHLSKKV8R/p1783469743603179 --- 🤖 [forked-diode](https://zeus.dev.dev.sparkinfra.net/#/arc?id=forked-diode)[(#1)](https://zeus.dev.dev.sparkinfra.net/#/instance?id=forked-diode) | [Feedback](https://zeus.dev.dev.sparkinfra.net/feedback) Original PR: #667 --------- Co-authored-by: Jeremy <jeremy@lightspark.com>
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.
Summary
Adds a Versioning section to the Environments page in the Mintlify docs, right after the Base API URL it explains.
Integrator-facing policy it documents:
2025-10-13) is the API's major version; a pinned version's behavior doesn't change.The three-month window and notice mechanism deliberately match the MSA (
mintlify/legal/msa.mdx§7.1–7.2, three-month Migration Period) and the existing "notify the account contact email" language used for Service IP changes on the same page — no new commitments invented.Rendered page
Test plan
mint dev(pinned CLI 4.2.284) — screenshot above.mint broken-links: no new findings (pre-existing broken links in untouched files only).Slack thread: https://lightsparkgroup.slack.com/archives/D0AHLSKKV8R/p1783469743603179
🤖 forked-diode(#1) | Feedback