docs: fix CLI flag accuracy in user documentation#452
Merged
Conversation
|
Welcome to AICR, @nvidiajeff! Thanks for your first pull request. Before review, please ensure:
A maintainer will review this soon. |
Correct verified errors in user docs against source code: - Fix --namespace default from gpu-operator to default (snapshot.go) - Remove fake -d alias from --debug; fix --format alias to -t (root.go) - Add 16 missing validate flags and 4 missing bundle flags - Add --image-pull-secret and --require-gpu to snapshot flags - Add -d alias for --deployer in bundle flags - Fix numbered list in installation.md (1,1,3 → 1,2,3)
nvidiajeff
force-pushed
the
docs/fix-user-doc-accuracy
branch
from
cef64d8 to
cb5f135
Compare
- Fix nonexistent `-i` alias for `--intent` in example (no short alias exists) - Fix "four steps" to "five steps" in bundle attestation (lists 5 items) - Remove `NO_COLOR` from env var table (not used by AICR directly) - Rewrite exit codes table to match pkg/errors/exitcode.go
- Add missing /v1/query endpoint documentation (exists in OpenAPI spec since #445) - Add /v1/query to feature comparison table and routes example - Add missing gke-nccl-tcpxo to bundler table - Fix content type application/yaml to application/x-yaml in curl example
nvidiajeff
force-pushed
the
docs/fix-user-doc-accuracy
branch
from
9e9b82d to
12f234b
Compare
mchmarny
approved these changes
Mar 21, 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
--namespacedefault fromgpu-operatortodefaultacross snapshot docs (verified againstsnapshot.go)-dalias from--debugand fix--formatalias from-fto-t(verified againstroot.go)--image-pull-secret,--require-gpu,--runtime-class)-dalias for--deployerin bundle flagsinstallation.md(1,1,3 → 1,2,3)Test plan
make build) and verify all flag tables matchaicr snapshot --help,aicr validate --help,aicr bundle --help--namespacedefault isdefaultviaaicr snapshot --help--formatshort alias is-tviaaicr snapshot --help--runtime-classpresent in latest build