Repository navigation
docs(runtimes): show required schema version in gateway TOML examples - #3910
Merged
johntmyers merged 1 commit intoOct 12, 2026
Merged
Conversation
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>
fede-kamel
requested review from
a team,
derekwaynecarr,
mrunalp and
sjenning
as code owners
September 29, 2026 21:44
Contributor
Author
|
LGTM. Simple but important fix — the missing version table was silently failing users who copied the examples. Ready for maintainer review. |
Collaborator
|
/ok to test 1215594 |
johntmyers
reviewed
Oct 12, 2026
johntmyers
left a comment
johntmyers
left a comment
Collaborator
There was a problem hiding this comment.
gator-agent
PR Review Status
Thanks @fede-kamel, I checked your point about copied runtime examples failing without the version table. The added table matches the schema-v2 parser and gateway configuration reference, and the note makes the remaining snippets clearly partial. The independent review found no blocking findings.
Blocking findings: None.
Carried findings: None.
Gator metadata
- Validation: Focused documentation fix for accepted issue #3881; its required acceptance criterion is met.
- Docs: Existing Fern runtimes page updated; no navigation change needed.
- Checks: DCO and vouch pass. Current-head Branch Checks, Helm Lint, and Trivy Changes are queued after authorized test dispatch.
- E2E: No test label required for this documentation-only change; runtime behavior is unchanged.
- Head SHA:
12155947878231460274d1674e4283d369842ec8 - Base SHA:
0ea0d3102089ebaa4e891a12389056f545b48415 - Merge base SHA:
c0eb3dbd30b50e7e24666af857b8320e9d83a6cc - Patch ID:
9f3ca0db2c59fceb8190cfff353c53a941d6e5d8 - Gator payload:
12 - Review mode:
initial - Previous reviewed SHA: none
- Review budget exhausted: no
- Maintainer decision required: no
- Next state:
gator:watch-pipeline
johntmyers
added
gator:watch-pipeline
johntmyers
approved these changes
Oct 12, 2026
johntmyers
added
gator:blocked
Collaborator
Monitoring CompleteMonitoring is complete because this PR has merged. Final status: The documentation fix received a Gator review with no blocking findings and maintainer approval. The remaining blocked label is stale after the merge. I removed the active Gator metadata
|
johntmyers
removed
the
gator:blocked
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
The runtimes page TOML examples omit the
[openshell] version = 2table, so a copied snippet fails preflight withmissing_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 = 2to the first example and clarify the rest are partial.Testing
mise run docs(nav check +fern check) passes with 0 errors on this branch merged with main.mise run pre-commitpassesChecklist