docs: site-wide accuracy, consistency, and structural fixes - #45
docs: site-wide accuracy, consistency, and structural fixes#45wardbryan3 wants to merge 1 commit into
Conversation
Tier 1 (ship-blockers): - Fix malformed shell commands in LMX server-setup (uvx v8x pasted as values) - Fix wrong support email domain (vantage.com -> vantagecompute.ai) - Fix broken self-links on licenses index and inventory pages - Fix FlexLM port (6200 -> 27000) and placeholder domains - Fix RLM web_port typo (4954 -> 5054) - Fix wrong API domain in endpoints reference (vantage.ai -> vantagecompute.ai) Tier 2 (contradictions): - Standardize CLI provider flag to on_prem across all localhost pages - Fix CLI from-source command (uvx v8x -> uv run v8x) - Standardize "preview" label (was "early access" on some pages) - Reconcile sweeps preset UI vs API-only contradiction - Add Abaqus legacy note on FlexLM page (current versions use DSLS) Tier 3 (structure): - Create LS-DYNA server-setup overview page and sidebar entry - Create support index page linking ticket guides - Fix storage index title and add missing mounting guide links - Add next-steps sections to 5 jobs pages that ended abruptly - Add how-to cross-links on reference pages with procedural content - Add presets disambiguation notes, sweeps/trials cross-links - Add duplicate-content cross-reference on templates/using page Tier 4 (content accuracy): - Fix provider count (six -> five) - Fix changelog stub with GitHub releases link - Fix hardcoded NIM model count (277 -> "hundreds of") - Fix K8s -> Kubernetes in prose, Slurm+Kubernetes -> Slurm and Kubernetes - Fix mounting-in-endpoints outcome ordering - Fix observability hours-vs-dollars metric comparison - Clarify LS-DYNA duplicate exports and SMP settings - Update LSTC ownership (now part of Ansys) - Add TODO comments for items needing product confirmation Tier 5 (consistency/polish): - Fix 7 explanation page titles (generic "Concepts" -> specific names) - Prefix all license sub-page titles with product name - Fix sidebar labels: LM-X -> LMX, Olicense -> OLicense - Fix H1/nav mismatches (Quickstart -> Get started with X, etc.) - Fix status naming: "ready state" -> "Connected state" in storage guides - Standardize status casing across Kubernetes and Slurm reference - Fix singlenode -> single-node, comma splices, tutorial trailing period - Standardize Remote Desktop protocol naming - Expand acronyms on first use (SLA, PVC, DAG, OIDC, RBAC) - Fix glossary alphabetical order, add Slurm and Workbench entries - Add IAM roles vs permission groups disambiguation - Add vdeployer-web definition in CLI commands reference - Rename license tutorials page to FlexLM-specific Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Inference API hostname explain each of these contextualized |
Here is each open question, contextualized to exactly where it appears in the docs and what needs to be confirmed: 1. Inference API hostname ( The endpoint detail page documents the URL pattern users copy to call their deployed model. The current placeholder is: Confirm: Is 2. ANSYS FlexLM port (27000 vs 1055) ( The server-setup guide shows environment variables for Fluent/MATLAB pointing to port 3. RLM reference port — ISV server (5053) vs web UI (5054) ( The reference table lists 4. A100 vs g5.48xlarge instance type ( The compute profiles reference uses 5. Apple-silicon / MLX support ( The runtimes table and Workbench overview mention an 6. OLicense vendor name ( The page currently says OLicense is "developed by Optimal Computing Solutions." Confirm: is the vendor name "Optimal Computing Solutions," or is OLicense a product name for an "Open License Server" (a generic/open-source system)? The correct vendor name should appear in the intro paragraph and any SEO/description fields. 7. Full Admin vs Organization Admin scope ( The IAM reference lists two high-privilege roles — Full Admin and Organization Admin — but the scope distinction between them is unclear from the existing docs. Confirm: what is each role allowed to do that the other cannot? For example, can Organization Admin cross workspace boundaries, manage billing, or invite users, while Full Admin is scoped to a single workspace? 8. Remote Desktop protocol — X2Go vs noVNC ( The glossary entry for "Service" and most how-to pages say Remote Desktop uses noVNC (browser-based VNC). The dedicated remote-desktops reference page says X2Go. These are different protocols with different client requirements. Confirm: which protocol does Vantage Remote Desktop actually use, so the conflicting page can be corrected? 9. License monitoring agent name and download URL ( The user-managed FlexLM guide shows a binary called |
Summary
Systematic fix pass across ~107 files covering all 5 tiers from the docs audit:
vantage.com→vantagecompute.ai,vantage.ai→vantagecompute.ai), broken self-links, wrong ports (FlexLM 6200→27000, RLM 4954→5054)--provider on_prem,previewlabel, sweeps preset UI description, Abaqus license path note, CLI install guidanceItems marked⚠️ NEEDS CONFIRMATION have
TODO(vantage):comments for the team to verify:Test plan
npm run buildpasses (only 2 pre-existing broken links in CLI reference)🤖 Generated with Claude Code