Skip to content

CON-1513/CON-1515: Auto-generate Host Self-Test Reference docs#145

Draft
jjziets wants to merge 1 commit into
vast-ai:mainfrom
jjziets:CON-1515-self-test-reference
Draft

CON-1513/CON-1515: Auto-generate Host Self-Test Reference docs#145
jjziets wants to merge 1 commit into
vast-ai:mainfrom
jjziets:CON-1515-self-test-reference

Conversation

@jjziets

@jjziets jjziets commented Jun 3, 2026

Copy link
Copy Markdown

Summary

  • add a generated Host Verification / Self-test Reference page
  • add a docs generator that reads Vast CLI diagnostics and self-test runtime metadata
  • wire the generated page into Host docs navigation and link it from existing self-test guidance
  • add a docs workflow that regenerates the page and fails when committed MDX is out of sync

Jira

  • CON-1515: Host Docs: Verification / Self-test Reference
  • CON-1513: Self-Test: Auto-generate Verification docs from Self-Test code
  • Epic: CON-1187

Supporting Source PRs

Validation

  • PYTHONDONTWRITEBYTECODE=1 npm run generate-self-test-reference -- --vast-cli ../vast-cli-main-validate --self-test ../self-test-main-validate
  • python3 -m py_compile scripts/generate_self_test_reference.py
  • git diff --check
  • verified no __pycache__ / .pyc artifacts remain
  • local preview: http://localhost:3001/host/self-test-reference

npx mint validate still fails on the existing unrelated guides/teams/overview navigation warning.

Note: this PR is currently from a fork because the local GitHub token cannot push branches directly to vast-ai/docs. Fork PRs cannot access the private VAST_DOCS_SOURCE_TOKEN, so the workflow skips private source checkout in that case. The full sync check still runs for upstream branches, manual workflow runs, and repository dispatch events.

@jjziets jjziets force-pushed the CON-1515-self-test-reference branch from 76cba12 to cf6d402 Compare June 3, 2026 11:35
@robballantyne robballantyne requested a review from vastzuby June 4, 2026 10:19
@jjziets jjziets force-pushed the CON-1515-self-test-reference branch from cf6d402 to 5442059 Compare June 8, 2026 05:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant