docs(readme): improve clarity, structure, and contributor discoverability#336
Merged
docs(readme): improve clarity, structure, and contributor discoverability#336
Conversation
…lity Reorder sections so How It Works follows Quickstart. Add Security Policy and Good First Issues badges. Add contributing callout after alpha notice. Add Getting Help section. Add providers blurb under How It Works. Link Supported Agents source column to the community base image. Move Explore with Your Agent before Built With Agents. Update Full Documentation URL to docs.nvidia.com.
Add dedicated Providers section explaining credential management. Add GPU Support section covering --gpu flag, auto-inference, host requirements, and custom image note. Move Providers after Protection Layers. Link to BYOC example for GPU sandbox images.
pimlock
approved these changes
Mar 16, 2026
Update alpha notice to say 'gateway' instead of 'cluster'. Clarify auto-bootstrap language. Add link to base sandbox source after tools table. Simplify GPU inference note.
drew
added a commit
that referenced
this pull request
Mar 16, 2026
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
good first issuelabelsbaseimage instead of "Built-in"docs.nvidia.comChanges
README.md— all changes scoped to this fileTesting
mise run pre-commitpasses