Repository navigation
docs: Document installing runpodctl with Nix - #910
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
@Promptless Doc style: sentence case, active voice, second person, no em dashes |
|
In reply to this discussion Thanks, I'll fix the comma in the Note, simplify the lead-in, and align this tab with the other install tabs, following sentence case, active voice, second person, and no em dashes. I'll reply here when the changes are on this branch. |
|
In reply to this discussion All four points are addressed in commit
One em dash remains on the page, outside the Nix tab, in the shell completion section ("The command is idempotent—running it again…"). It was there before this PR, so I left it unchanged. PR: #910 |
Open in Promptless
runpod/runpodctl#373 added a Nix flake, so Nix users can now install or run
runpodctlstraight from GitHub. This PR adds a Nix tab to the installation methods on the Runpod CLI overview page. The tab coversnix profile install github:runpod/runpodctl, one-off use withnix run, the supported platforms (Linux x86_64/aarch64 and macOS arm64), and a note thatrunpodctl updatedoesn't work on Nix installs, so users should upgrade withnix profile upgradeinstead.The Nix tab follows the same structure as the other install tabs: a one-sentence intro with supported platforms, then bold labels above each command.
The rest of the flake (dev shell, checks, static analysis, and OCI images) is contributor tooling, so it isn't documented here.
Review feedback applied (@lavanya-gunreddi):
runpodctlfrom its Nix flake... You need Nix with flakes enabled."), and listed platforms in the same format as the conda tab. The tab uses sentence case and contains no em dashes.Verification: the commands, supported platforms, and the update caveat come from
flake.nixandnix/README.mdin runpodctl.Trigger Events
Tip: Tag @Promptless in GitHub PR comments to guide documentation changes during code review 🐙