CON-1518: Host docs IA mockup updates#152
Conversation
Expand the host docs IA mockup with populated setup, verification, pricing, operations, and common-question pages. Add local-only review helpers for change review and old-content lineage highlighting. These review helpers are for the fork/demo branch and should be removed before a production docs PR.
…-mockup # Conflicts: # host/payment.mdx
| createdAt: "Tue Jan 14 2025 01:09:17 GMT+0000 (Coordinated Universal Time)" | ||
| updatedAt: "Fri Jul 11 2025 22:44:42 GMT+0000 (Coordinated Universal Time)" | ||
| "canonical": "/host/hosting-overview" | ||
| personas: |
There was a problem hiding this comment.
What is this personas list for?
There was a problem hiding this comment.
it was one of the required tasks on jira to add personas
There was a problem hiding this comment.
Keeping this. The personas: frontmatter is the source-of-truth metadata for the CON-1518 persona overlay: Pro Operator, Headless/DC, Business, and Hobbyist. The sidebar stays lifecycle-based, but this metadata lets docs/search/support/LLM retrieval identify which host audience a page primarily serves without duplicating the IA into separate persona sidebars.
| - hobbyist | ||
| --- | ||
|
|
||
| <div className="persona-chips"><span className="persona-chip">All host personas</span></div> |
There was a problem hiding this comment.
What would be the purpose of having the persona tag on all pages?
There was a problem hiding this comment.
it was one of the required tasks on jira to add personas
There was a problem hiding this comment.
The visible chips are intentional for the same reason: they give hosts a quick lane marker while they scan the lifecycle sidebar. A Hobbyist can follow the Quickstart/Supported Hardware path, a Headless/DC operator can spot SSH/fleet/maintenance pages, and a Business owner can identify pricing/earnings/payout docs. It is a lightweight overlay on the lifecycle IA, not a separate navigation system.
| You must create a new account for hosting. If you are using Vast.ai as a client, do not use the same account. A single client and hosting account is not supported and you will quickly run into issues. | ||
|
|
||
| Once your account is created, open the [host setup guide](https://cloud.vast.ai/host/setup/). There is a link in the first paragraph to the hosting agreement. Read through the agreement. Once you accept, your account will then be converted to a hosting account. You will notice there is now a link to Machines in the navigation, along with some other changes. Your account can now list machines that are running the daemon software. | ||
| You must create a dedicated account for hosting — do not reuse your client account. For account conversion, the agreement flow, and Machines-tab troubleshooting, see [Account & Hosting Agreement](/host/account-hosting-agreement). |
There was a problem hiding this comment.
Using a more positive tone, I would suggest simply directing users to sign up for a dedicated hosting account and pointing them to the setup page. Once they sign up, we can provide the full documentation and onboarding details.
The goal is to make it as easy as possible for new hosts to find the hosting account sign-up link and get started quickly. Most users are looking for a simple TL;DR rather than a long document upfront.
584b8c2 to
0cb28ff
Compare
|
CON-1531 progress update from this branch:
Validation: Caveat before treating this as ready for CON-1531: the page is intentionally conservative because the backend source files named in the ticket are not accessible from this workspace/account. I found secondary support-tools evidence for |
|
CON-1531 update: I found stronger secondary evidence in support-tools/reporting for the vericode mapping. It says vericode bit 8 means a host-facing machine error_msg is present; Port Networking Issues is one possible error_msg, not the definition of all vericode=8 cases. I pushed a wording correction in a8a935c so the docs now tell hosts to use the exact visible machine error text, with Port Networking Issues treated as the port-specific case. Backend/source-owner confirmation is still needed for the complete raw-string registry, clearing/TTL behavior, and deverification semantics. |
|
CON-1531 closeout audit update: I added a local completion audit and refreshed evidence packet. Current state is: public Machine Error Reference draft is implemented and validated; paid dogfood and live CLI probes are captured; vericode=8 wording is corrected. Remaining blockers are explicitly backend/source-owner items: complete raw error registry, clearing/TTL behavior, and exact VM-only vs general deverification semantics. Live CLI probes confirm public/client-readable CLI paths do not expose raw machine error strings, so backend/source confirmation is required before this can become a source-derived/generated reference. |
|
Update from this pass:
Validation:
Remaining owner-review gates are still real and should stay visible before production merge: Gobind/business listing review, CON-1531 source-owner confirmation for machine-error catalog/TTL/UI fields, approved installer screenshot, and product/source-owner review for GPU-family, installer, payment/tax, and datacenter edge cases. |
Summary
% Rented (30D Avg)plus$/HR MEDas a rough compute-income estimateCON-1256 Business / Pricing / Listing Optimization Coverage
This PR also addresses the major CON-1256 topics inside the broader host-docs IA update:
Is Vast for Me?,Earnings & Pricing Model,Pricing Your Listing,Optimize Your Earnings,GPU Market Metrics,Datacenter Status, andHost Payouts.Hosting Overview, including offers, accepted rental contracts, active contract behavior, offer end dates, and why edits affect future rentals only.Hosting Overview,Workload Policy,Maintenance Windows, andReliability & Uptime.Hosting Overview,Pricing Your Listing, andOptimize Your Earnings.Pricing Your Listingthroughdiscount_rateandprice_min_bid/ minimum-bid guidance.min_gpu/min_chunkinPricing Your Listing,Optimize Your Earnings, and the glossary.Verification Stages,Understanding Verification, andDatacenter Status.Discord & Community,Common Errors & Diagnostics, and setup/overview pages that distinguish community help from account/platform escalation.Remaining review item for CON-1256: add Gobind as reviewer / content reviewer and confirm whether any exact wording from the attached
vast_optimization_guide_for_hosts.htmlshould be preserved or credited before production merge.Human Review
All 33 Common Host Questions were reviewed with a human reviewer on 2026-06-19. For each question, the review compared the current public answer, source evidence, and recommended rewrite before accepting or changing the public wording.
The docs were updated to avoid AI-style filler and unsupported claims. Stale wiki/internal details were excluded unless supported by current docs, current CLI/self-test behavior, or explicit product/dev feedback. Remaining uncertain areas are left as owner-review topics instead of being guessed into public docs.
Reviewed changes include:
% Rented (30D Avg)multiplied by$/HR MEDgives a better starting estimate than price aloneCON-1531 Machine Error Reference Update
This PR now also includes the current CON-1531 Machine Error Reference draft work:
host/machine-errors.mdxas a host-facing reference for Machines-page errors, direct-port failures, Docker/NVIDIA runtime errors, GPU/PCIe/ECC symptoms, storage quota errors, VM-offer errors, and rental-attempt messages.Listing Impactmatrix that distinguishes whole-machine deverify errors, VM-offer-only errors, and logged-only rental-attempt messages based on Hanran Yang's source-owner feedback.<admin-set>entry framed as a manual Vast admin investigation flag, not an automatic self-test result.Quick Error Lookuptable tohost/self-test-reference.mdxso hosts can map common self-test messages/stages to immediate next actions.send_mach_info.py --speedtest,--reset-machine, machine-ID recovery workflows, missing API-key/keepalive internals, and manual verification claims.Related source PRs for the paired self-test work:
Remaining CON-1531 review caveats:
error_msg,error_note,error_description,vm_error_msg,vm_error_level, and UI display surfaces.Host Market GPU Overview Update
Added a new
GPU Overview Income Estimatesection underhost/market-metrics.mdx, with cross-links fromhost/earning.mdxandhost/pricing-your-listing.mdx. The new wording explains that hosts can estimate rough gross compute revenue by combining 30-day average rental utilization with median hourly price.Example included from the Host Market view:
The docs explicitly frame this as a rough compute-only planning estimate. It does not include storage, bandwidth, volume revenue, power, cooling, hardware cost, taxes, payout timing, downtime, or the fact that earnings are not guaranteed.
Notes
This remains a draft/demo PR for review of the proposed host docs structure and content direction. The Host Installer Wizard screenshot should be replaced with an approved product screenshot before production merge if marketing/product wants canonical assets.
Owner-review topics still called out in the review ledger: exact GPU-family coverage, installer owner wording/assets, OS-specific cgroup guidance, payment/tax edge cases, datacenter requirements, any future full
vericodetable expansion, and final business/listing review by Gobind for CON-1256.Validation
git diff --checknpx mint validate