Repository navigation
SO-80: stop the docs drift checker failing on correct docs - #515
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
Against a freshly regenerated docs baseline, verify_cli_sdk_docs.py still exited 1, so the weekly verify-docs run would go red once the re-land (#510) merges. That is the signal that caused the #453 revert. Causes: - --help hides host-only commands unless the stored role is "host" (#484). The checker scraped --help under the default client role and reported 24 published host commands as removed. It now scrapes with XDG_CONFIG_HOME pointing at a throwaway dir whose role file says host. - The generator and main() kept separate command-module lists. register_all_commands() lacked repl, update and uninstall, so `update` had no docs page. main() now calls register_all_commands(), so there is one list. - With every module loaded, the generator would publish the hidden (unannounced) repl and uninstall commands. It now skips hidden commands, matching --help. - The hand-written SDK overview page (vastai.mdx) was reported as a stale method page. It is now skipped. Also files set-role, update, uninstall and repl under Accounts in the nav patcher instead of the default group. After this change the checker reports no drift against a baseline regenerated from this branch. Co-Authored-By: Claude Opus 5.5 (1M context) <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
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.
Why
Against a freshly regenerated docs baseline,
scripts/verify_cli_sdk_docs.py --check-paramsstill exits 1.verify-docs.ymltreats that as a failure, so once the docs workflows are re-landed (#510) the weekly run would go red on correct docs. That is the signal that caused the #453 revert. This should merge before #510.What was reported, and why
host_onlycommands from--helpunless the stored role ishost, and the checker scrapes--help--helpwithXDG_CONFIG_HOMEpointing at a throwaway dir whose role file sayshostupdate"missing"register_all_commands()(used by the generator) lackedrepl,updateanduninstall, whichmain()imported separatelymain()now callsregister_all_commands(), so there is one listrepl,uninstallpages published--help. Their pages appear once they are unhiddenvastai"removed"vastai.mdx(kept by the CI wipe step) was treated as a method pageThe nav patcher also files
set-role,update,uninstallandreplunder Accounts instead of the default group (Instances). That grouping is a judgement call; happy to move them.Verification
pytest tests/scripts: 135 passed (8 new tests).pytest tests/cli: 583 passed.Merge order: this PR → vast-ai/docs#949 → #510.
🤖 Generated with Claude Code