VersionGate
Version availability card for introducing features, beta capabilities, and version-specific documentation paths.
For isolated previews, theme switching, and sandbox editing, open the VersionGate playground on holydocs.com .
When to use
Use this component when endpoint documentation needs explicit request, response, schema, or lifecycle metadata.
Live Examples
Every example below renders the real component directly inside HolyDocs, followed by the exact MDX you can paste into a page.
GA Feature
Availability notice for a new stable feature.
Use this block to tell readers exactly when a field or endpoint becomes available and whether it is safe to depend on in production.
mdx<VersionGate title="Available in the v2 API" version="v2" since="2026-03-20" stability="GA">Use this block to tell readers exactly when a field or endpoint becomes available and whether it is safe to depend on in production.</VersionGate>
Props
| Prop | Type | Default | Description |
|---|---|---|---|
version | string | -- | Version or release train label. |
since | string | -- | Release date or semantic version when it became available. |
stability | string | -- | Stability marker like GA, Beta, or Preview. |
Usage
Start from this baseline shape and then tailor the copy, data, or nesting to the page you are writing.
mdx<VersionGate title="Available in the v2 API" version="v2" since="2026-03-20" stability="GA">Use this block to tell readers exactly when a field or endpoint becomes available and whether it is safe to depend on in production.</VersionGate>
Tips
- Keep naming and ordering consistent across fields, examples, and lifecycle notes so readers do not have to re-parse the endpoint surface on every page.
- Document the happy path and the sharp edges together. Request shape alone is not enough without auth, errors, and retry guidance.
- If a component renders into the right panel, verify the page on desktop width so you can confirm the supporting example is visible where readers expect it.
Related Components
Documents a request parameter — path, query, or body — with type, requirement status, and description.
More
- Interactive playground: VersionGate on holydocs.com
- Component library index: /components