Skip to content

docs(runtimes): show required schema version in gateway TOML examples - #3910

Open
fede-kamel wants to merge 1 commit into
NVIDIA:mainfrom
fede-kamel:docs/3881-runtimes-toml-version
Open

fede-kamel wants to merge 1 commit into
NVIDIA:mainfrom
fede-kamel:docs/3881-runtimes-toml-version

Conversation

@fede-kamel

@fede-kamel fede-kamel commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The runtimes page TOML examples omit the [openshell] version = 2 table, so a copied snippet fails preflight with missing_version. Add it to the first example and note that later examples show only the tables they change.

Related Issue

Closes #3881

Changes

  • docs/how-it-works/sandboxes/runtimes.mdx: add [openshell] version = 2 to the first example and clarify the rest are partial.

Testing

  • Docs-only change; no code paths affected.
  • mise run docs (nav check + fern check) passes with 0 errors on this branch merged with main.
  • Checked the documented behavior against the source at current main (see Changes).
  • mise run pre-commit passes
  • Unit tests added/updated (N/A, docs only)
  • E2E tests added/updated (N/A, docs only)

Checklist

The runtimes page examples omit the [openshell] version = 2 table, so a
snippet copied into a new gateway.toml fails preflight with
missing_version. Add the table to the first example and state that the
remaining examples show only the tables they change.

Closes NVIDIA#3881

Signed-off-by: fede-kamel <fkamelhar@gmail.com>
@copy-pr-bot

copy-pr-bot Bot commented Sep 29, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(runtimes): driver TOML examples omit [openshell] version = 2 and fail preflight

1 participant