Skip to content

Add Versioning section to Environments docs page#668

Merged
jklein24 merged 2 commits into
mainfrom
07-08-docs-versioning-section-environments
Jul 8, 2026
Merged

Add Versioning section to Environments docs page#668
jklein24 merged 2 commits into
mainfrom
07-08-docs-versioning-section-environments

Conversation

@jklein24

@jklein24 jklein24 commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

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

Environments page with new Versioning section

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(#1) | Feedback

Original PR: #667

@ls-bolt ls-bolt Bot added the bolt label Jul 8, 2026
@jklein24 jklein24 marked this pull request as ready for review July 8, 2026 00:24

akanter commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

This stack of pull requests is managed by Graphite. Learn more about stacking.

@jklein24 jklein24 requested review from pengying and shreyav July 8, 2026 00:24
@greptile-apps

greptile-apps Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

        /\
   ____/  \____
  /  _  \/  _  \   ⚡ DOCS OF STEEL ⚡
 /__/ \____/ \__\
    \_||__||_/
      /_\  /_\

This PR adds API versioning guidance to the Environments docs page.

  • Adds a new Versioning section after the Base API URL.
  • Explains date-based version pinning in the URL.
  • Documents additive changes, breaking changes, and deprecation notice timing.

Confidence Score: 4/5

The docs change has a contained contract-language issue around deprecated version support.

  • The new section is docs-only and does not affect runtime behavior.
  • The deprecation sentence can promise more availability than the MSA language supports.
  • The suggested wording keeps the same user guidance while matching the documented legal terms.

mintlify/api-reference/environments.mdx

Important Files Changed

Filename Overview
mintlify/api-reference/environments.mdx Adds a Versioning section; the deprecation wording should be narrowed to match the legal support commitment.
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
mintlify/api-reference/environments.mdx:21
**Deprecation Support Overpromised**

When a version is deprecated, this says it will keep working for at least three months after notice. The MSA only commits to commercially reasonable efforts during the migration period and allows shorter Critical Update timelines, so integrators can rely on a stronger availability guarantee than the contract supports.

```suggestion
**Deprecation.** When we deprecate a version, we notify your account contact email with the migration steps and a timeline. We use commercially reasonable efforts to maintain support for deprecated versions during the migration period, which is at least three months after that notice unless a shorter Critical Update timeline applies.
```

Reviews (1): Last reviewed commit: "docs: add Versioning section to Environm..." | Re-trigger Greptile

Comment thread mintlify/api-reference/environments.mdx Outdated
Deprecated-version support is stated as a migration window (normally at
least three months, shorter for security/compliance-critical updates)
instead of an unconditional three-month availability guarantee.
@vercel

vercel Bot commented Jul 8, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments
Project Deployment Actions Updated (UTC)
grid-flow-builder Ignored Ignored Preview Jul 8, 2026 12:30am
grid-wallet-demo Ignored Ignored Preview Jul 8, 2026 12:30am

Request Review

@ls-bolt

ls-bolt Bot commented Jul 8, 2026

Copy link
Copy Markdown

Revision 2

  • Reworded the Deprecation paragraph per Greptile's P1: deprecated-version support is now framed as a migration window (normally at least three months, faster for security/compliance-critical updates) instead of an unconditional three-month availability guarantee, matching MSA §7.2–7.3. Kept plain integrator-facing language rather than the suggested contract phrasing.

🤖 forked-diode(#1) | Feedback

@jklein24 jklein24 merged commit f44537f into main Jul 8, 2026
9 checks passed
@jklein24 jklein24 deleted the 07-08-docs-versioning-section-environments branch July 8, 2026 04:36
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.

4 participants