Draft
Conversation
- Fix API key generation link to point to Keys page - Change search sort to dlperf_per_dphtotal, increase limit to 5 - Add cost estimate, disk size clarification, instance_api_key description - Add SSH connection step (step 6), reorder clean up to step 7 - Swap destroy/stop order, add onstart callback mention - Link to Search Offers reference, consolidate Next Steps Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace the minimal API introduction with the Hello World guide content, remove the now-redundant hello-world.mdx, and add a redirect. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add Python code tabs alongside curl for all API steps using CodeGroup. Restore advanced-users-only warning that was on main.
…sh_direct, show instance link - Expand intro to describe full API scope - Add scoped API keys tip with link to Create API Key endpoint - Switch auth step to /users/current/ endpoint - Add template-based instance creation with link to Templates guide - Add ssh_direct runtype to create params - Fix instance_api_key description to include GET access - Add Show Instance endpoint link in polling section
Add auto-generated CLI command reference (131 pages) and SDK method reference (150+ pages) with sidebar navigation matching API docs category order. Add guide pages for Authentication, Permissions, and Templates across CLI and SDK tabs. Rework SDK quickstart into a step-by-step walkthrough. Restructure all tabs to use "Get Started" with book icon, nest Authentication/Permissions as subpages under an Authentication group. Order command groups to match OpenAPI tags with Machines (host-only) last. Add redirects for removed pages. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ted reference - Add help text to 6 empty `help=""` args in vast-cli (--tail on endpt/wrkgrp-logs, --limit on launch-instance/search-offers/search-volumes/search-network-volumes) - Add SDK_TO_CLI_PARAM_MAP in generator to resolve create_instance.price → CLI bid_price - Add Args: docstrings to 7 SDK-only methods in vastai_base (create_autogroup, create_endpoint, create_instances, update_autoscaler, update_endpoint, create_workergroup, update_workergroup) - Regenerate all 133 CLI reference pages and 150 SDK reference pages Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…strings Generator fixes: - %(default)s / %(default).Nf in help strings now expanded at generation time - Custom argparse type functions (parse_day_cron_style, loads) now render as human-readable type names (integer, object) instead of function names - Dynamic date defaults (start_date, end_date) suppressed from static docs vast.py source fixes (12 corrections): - get wrkgrp-logs: id arg said "endpoint group" not "worker group"; example showed wrong command; help had double "group"; usage was "workergroup create" - search offers: --new help was cryptic "New search exp" - cancel sync: example used "vast" not "vastai" - update team-role: --name help said "template" not "role" - search network-volumes: example used wrong command name - tfa regen-codes: malformed --code example fixed vastai_base.py (22 methods updated): - Added docstrings + Args: sections to all methods with bare param names: create_instance, launch_instance, search_offers, self_test_machine, generate_pdf_invoices, invite_team_member, remove_team_member, scp_url, tfa_activate, tfa_delete, tfa_login, tfa_regen_codes, update_template, show_deposit - Added missing docstrings: delete_autoscaler, destroy_instance, destroy_instances, detach_ssh, create_subaccount, delete_api_key, delete_endpoint, delete_ssh_key, destroy_team Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Fix overstated SSH key warnings across API/CLI/SDK hello worlds — account-level keys apply at creation time, but running Docker instances can receive keys via UI button or instance-specific API without recreating - Renumber hello world steps to clean integers (no more 3b/4b) - Add SSH key registration step to CLI and SDK hello worlds - Add onstart 4048-char limit note to CLI and SDK hello worlds - Add agents.mdx: AI agent quick-start guide (auth, SSH, VRAM units, onstart, response format, execute-don't-plan with --raw recommendation) - Fix VRAM MB/GB note in search-offers.mdx - Fix cold_workers/min_workers terminology in serverless-parameters.mdx - Fix onstart limit Warning in template-settings.mdx - Renumber API hello world steps 1-9 (SSH key registration is now step 4) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
guthrie-vast
force-pushed
the
willbrennan/sdk-cli-api-docs-ia-proposal
branch
from
2802493 to
e82f962
Compare
guthrie-vast
changed the title
…leshooting - cli/authentication: add VAST_API_KEY env var section for CI/CD, XDG path, legacy key migration note - cli/reference/set-api-key: add storage/env var section - docs.json: add agents page, template-selection, ollama-on-vast example, preflight-check and verification-requirements host pages; move virtual-machines under Advanced - host/verification-stages: add Warning clarifying 10 Mbps listing vs 500 Mbps verification threshold - host/vms: replace typo-ridden VM premium claim with accurate recommendation - instances/virtual-machines: add Warning about ~25% VM creation failure rate - instances/storage/data-movement: add Troubleshooting Stuck Transfers section - serverless/comfy-ui, vllm: minor edits - linux-virtual-desktop, linux-virtual-machines: small additions - cli/commands.mdx: delete (replaced by generated reference pages) - api-reference/openapi.json: update with clean spec (disable_bundling removed, instances v1 added) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace placeholder intro with a full end-to-end walkthrough: authenticate, search for a GPU, rent it, wait for boot, connect, and clean up — pulled from stash on main. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
cli/get-started,cli/commands)agents.mdx) — auth, SSH, VRAM units, onstart, response format, --raw recommendationReference page quality fixes
help=""args in vast-cli (--tailon endpt/wrkgrp-logs,--limiton launch-instance/search-offers/search-volumes/search-network-volumes)%(default)s/%(default).Nfplaceholders — now expanded at generation time instead of rendered literallyparse_day_cron_style,loads) now render as human-readable type names (integer,object) instead of raw function namesstart_date,end_date) suppressed from static docsSDK_TO_CLI_PARAM_MAPin generator to resolvecreate_instance.price→ CLIbid_pricevast.pyhelp strings (get wrkgrp-logs id arg, search offers --new, cancel sync example, update team-role, search network-volumes example, tfa regen-codes)Args:docstrings to 29 SDK methods invastai_base.pythat had bare param names or no docstrings at allHello world / guide fixes
search-offers.mdxcold_workers/min_workersterminology inserverless-parameters.mdxtemplate-settings.mdxTest plan
🤖 Generated with Claude Code