docs(cli/sdk): regenerate CLI and SDK reference baseline - #949
Open
Gobind-Vast wants to merge 1 commit into
Open
Gobind-Vast wants to merge 1 commit into
Gobind-Vast wants to merge 1 commit into
Conversation
Bootstrap baseline for re-landing the vast-cli auto-docs pipeline. Docs main has been unmanaged since the pipeline was reverted (#453), so it had drifted 25 CLI commands / 24 SDK methods / 55 parameter mismatches behind vast-cli master. Merging this first means the re-landed verify-docs check is green on its first run instead of firing the same red alarm that caused the revert. Generated with vast-cli master's scripts (NOT PR #473's stale copies): python scripts/generate_cli_sdk_docs.py \ --output-dir <docs> --cli-subdir cli/reference \ --sdk-subdir sdk/python/reference --manifest manifest.json python scripts/patch_docs_nav.py --docs-json docs.json --manifest manifest.json 135 CLI pages, 137 SDK pages, 48 added to nav, 2 nav entries removed (search-instances, show-instances-v1 — both removed from the CLI). Nav patcher exited 0; its exit-2 unmatched-name guard did not fire. Includes the effect of vast-cli #497: create_instance's SDK reference now documents 29 parameters, all 29 of which the api layer accepts. Previously 11 of 27 documented params raised TypeError when called as documented. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
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
1 participant
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.
Bootstrap baseline for re-landing the vast-cli auto-docs pipeline (vast-cli PR to follow).
Why this exists
Docs
mainhas been unmanaged since the CLI/SDK docs pipeline was reverted in vast-cli #453. Measured against vast-cli master today, it had drifted:The re-landed
verify-docsworkflow compares the CLI against docsmainand fails on drift. Merging this first is what makes its first run green — otherwise the re-land produces a red CI run that looks exactly like the alarm that triggered revert #453.How it was generated
vast-cli master's scripts, not PR #473's stale copies:
search-instances,show-instances-v1, both removed from the CLI)sdk/python/reference/vastai.mdxpreservedWorth a reviewer's attention
Includes the effect of vast-cli #497:
create_instance's SDK reference now documents 29 parameters, all 29 of which the api layer accepts. Previously 11 of 27 documented params raisedTypeErrorwhen called as documented.🤖 Generated with Claude Code