docs: rewrite Workbench how-to guides to match current UI flow#39
Open
wardbryan3 wants to merge 2 commits into
Open
docs: rewrite Workbench how-to guides to match current UI flow#39wardbryan3 wants to merge 2 commits into
wardbryan3 wants to merge 2 commits into
Conversation
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
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.
Summary
Rewrote the Workbench how-to guides section against the
vantage-uisourceof truth. The previous guides described stale wizard steps, navigation paths,
and button labels that no longer matched the product.
Changes
Rewrote from scratch (were sparse or inaccurate)
Deploy Inference Endpointwizard (Identity, Model source, Tuning)Preset/Custom mode dialog with correct fields
covering HuggingFace, S3, URL, and local source types
describes autoscaling driven by inference presets
realistic read-only traffic-display description
Aligned navigation, labels, and fields with the current UI
Workbench > Develop,Workbench > Compute > Pools,Workbench > Train > Training > Runtimes, etc.New Compute Pool,Deploy endpoint,Launch job,New cloud shell, etc.actual fields (Compute Profile, Slurm Cluster, Advanced Options)
lifecycle (Cloud Shell, Remote Desktop, PVC Viewer)
Compute > Presets, not a Training-only page(base image, ML policy fields per framework, compute pool)
dialog
alongside the SDK path
Formatting and consistency fixes
observability.mdxrewritten with properguide-intropatternsidebars-main.jsaligned with H1 headingstroubleshooting.mdxcreate-pool.mdxLeft unchanged (already accurate)
creating-a-session.mdxcreating-a-preset.mdx(session presets)managing-sessions.mdxpipelines/creating,running,scheduling)troubleshooting.mdx(aside from minor fixes above)Testing
node scripts/fetch-v8x-cli-docs.js && yarn build— should succeedyarn spellcheck docs/how-to-guides/workbench— only expectedtechnical terms flagged (ttyd, CUDA, cuda, cudnn, rstudio,
gaudi, millicores, etc.)
Notes
compute profilesvscompute poolsterminology conflictpredates this change and is tracked across the broader docs tree.
reference/developer-tools/cli/*) andyarn.lockappear in the diff from the build step but have nomeaningful changes.