Skip to content

docs: site-wide accuracy, consistency, and structural fixes - #45

Open
wardbryan3 wants to merge 1 commit into
mainfrom
docs/site-wide-fixes
Open

docs: site-wide accuracy, consistency, and structural fixes#45
wardbryan3 wants to merge 1 commit into
mainfrom
docs/site-wide-fixes

Conversation

@wardbryan3

Copy link
Copy Markdown
Collaborator

Summary

Systematic fix pass across ~107 files covering all 5 tiers from the docs audit:

  • Tier 1 (ship-blockers): Fixed malformed shell commands (LMX), wrong domains (vantage.comvantagecompute.ai, vantage.aivantagecompute.ai), broken self-links, wrong ports (FlexLM 6200→27000, RLM 4954→5054)
  • Tier 2 (contradictions): Standardized CLI --provider on_prem, preview label, sweeps preset UI description, Abaqus license path note, CLI install guidance
  • Tier 3 (structure): Created LS-DYNA server-setup overview + support index page; added next-steps to 5 jobs pages; added cross-links, disambiguation notes, and how-to pointers on reference pages
  • Tier 4 (accuracy): Fixed provider count (6→5), changelog stub, hardcoded model count, K8s→Kubernetes, LSTC→Ansys ownership, metric comparison, mounting-in-endpoints ordering
  • Tier 5 (consistency): Fixed 7 explanation titles, all license sub-page titles, sidebar labels (LMX, OLicense), H1/nav mismatches, status naming, acronym expansions, glossary order + new entries, comma splices, Remote Desktop protocol

Items marked ⚠️ NEEDS CONFIRMATION have TODO(vantage): comments for the team to verify:

  • Inference API hostname
  • ANSYS FlexLM port (27000 vs 1055)
  • RLM reference port (ISV 5053 vs web UI 5054)
  • A100 vs g5.48xlarge instance type
  • Apple-silicon/MLX support
  • OLicense vendor name
  • Full Admin vs Organization Admin scope
  • Remote Desktop protocol (X2Go vs noVNC)
  • License monitoring agent name and download URL

Test plan

  • npm run build passes (only 2 pre-existing broken links in CLI reference)
  • No new broken links introduced
  • 2 new pages render (LS-DYNA server-setup, support index)
  • Review TODO(vantage) comments and resolve with product team
  • Spot-check corrected navigation paths against live app

🤖 Generated with Claude Code

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>
@jamesbeedy

Copy link
Copy Markdown
Contributor

@copilot

Inference API hostname
ANSYS FlexLM port (27000 vs 1055)
RLM reference port (ISV 5053 vs web UI 5054)
A100 vs g5.48xlarge instance type
Apple-silicon/MLX support
OLicense vendor name
Full Admin vs Organization Admin scope
Remote Desktop protocol (X2Go vs noVNC)
License monitoring agent name and download URL

explain each of these contextualized

Copilot AI commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

@copilot

Inference API hostname
...

Here is each open question, contextualized to exactly where it appears in the docs and what needs to be confirmed:


1. Inference API hostname (docs/reference/workbench/endpoints/reference.mdx)

The endpoint detail page documents the URL pattern users copy to call their deployed model. The current placeholder is:

POST https://{workspace}.vantagecompute.ai/v1/{endpoint-name}/infer

Confirm: Is {workspace}.vantagecompute.ai the correct subdomain pattern, or is there a fixed gateway hostname (e.g. api.vantagecompute.ai)?


2. ANSYS FlexLM port (27000 vs 1055) (docs/how-to-guides/licenses/flexlm/server-setup.md)

The server-setup guide shows environment variables for Fluent/MATLAB pointing to port 27000 (the standard FlexLM default). However, ANSYS products sometimes use port 1055 for their vendor daemon. Confirm: which port should users configure in ANSYSLMD_LICENSE_FILE — the FlexLM master port (27000) or the ANSYS vendor daemon port (1055)?


3. RLM reference port — ISV server (5053) vs web UI (5054) (docs/reference/licenses/reference.md)

The reference table lists 5053 and 5054 as RLM ports. RLM uses two separate ports: the ISV/license-server port (commonly 5053) and the web-based admin UI port (commonly 5054). Confirm: which port should be listed as the primary "default port" in the table, and should both be listed with labels?


4. A100 vs g5.48xlarge instance type (docs/reference/workbench/compute-profiles/reference.mdx)

The compute profiles reference uses A100 x 4 as the example display name and a100-x4 as the internal name. However, g5.48xlarge (the instance type referenced elsewhere) carries A10G GPUs, not A100s. A100s are on p4d.24xlarge (40 GB) or p4de.24xlarge (80 GB). Confirm: does Vantage offer actual A100 pools, or should the example be updated to A10G x 8 / a10g-x8?


5. Apple-silicon / MLX support (docs/reference/workbench/training-jobs/runtimes.mdx, docs/reference/workbench/index.mdx)

The runtimes table and Workbench overview mention an mlx runtime for Apple-silicon nodes. Confirm: are Apple-silicon (M-series) nodes actually available as cloud compute in Vantage, or is MLX only relevant for on-prem/BYOC clusters? If not available in cloud, the mlx row should be removed or scoped to on-prem only.


6. OLicense vendor name (docs/how-to-guides/licenses/olicense/index.md)

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 (docs/reference/settings/iam/reference.md)

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 (docs/glossary.md, docs/reference/workbench/sessions/remote-desktops.md)

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 (docs/how-to-guides/licenses/flexlm/user-managed-server-setup.md)

The user-managed FlexLM guide shows a binary called vantage-license-monitor being downloaded and installed, but the actual download URL and exact binary name vary across license-type pages (FlexLM, RLM, OLicense). Confirm: what is the canonical name of the agent binary and the stable download URL to use across all license setup guides?

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.

3 participants