[Docs] Interactive UI components for Installation and TPU Setup pages - #3297
Merged
Merged
Conversation
mtsokol
requested review from
QiliangCui,
bvrockwell,
kyuyeunk and
vipannalla
as code owners
July 30, 2026 17:34
RobMulla
self-requested a review
July 30, 2026 18:32
…pages Adds reusable interactive components for the MkDocs site: - interactive.js: command generator (installation method picker), TPU provision generator, and per-tab table search - interactive.css: styles for the generator components - extra.css: nav section styling, card grid, and cg-badge styles Uses them in the Installation and TPU Setup pages and registers the assets in mkdocs.yml. Split out of vllm-project#2064. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Mateusz Sokół <mat646@gmail.com>
Runtime-injected snippets are not colored by build-time Pygments, so add a minimal shell tokenizer that wraps comments, strings, and variables in Pygments token classes, styled with the theme's code-highlight palette. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Mateusz Sokół <mat646@gmail.com>
- Simplify installation methods comparison into a clean bulleted list - Rename 'Interactive Installation' header to 'Installation Commands' - Add release (latest) vs. nightly Docker image selector - Unify TPU provisioning into a single generator supporting Standard vs. Flex-start (DWS) modes - Use Compute Engine API (gcloud compute instances create) for modern TPU v6e and v5p provisioning - Use ZONE placeholder variable in generated commands and add ZONE to parameter reference table - Remove TPU v7x button from standalone command generator and add GKE provisioning admonition - Document that TPU v7x, v4, and v3 do not support Flex-start (DWS) capacity model - Add dynamic button greying-out for unsupported chip counts and Flex-start models across TPU generations - Fix TPU accelerator-type generation for TensorCore-named generations (v3, v4) - Add parameter reference table to TPU setup guide - Clean up Table of Contents headings in TPU setup guide - Upgrade shell snippet syntax highlighter to color keywords, subcommands, flags, and operators - Switch table search filter from keyup to input event and restrict to tabbed tables Signed-off-by: Rob Mulla <rob.mulla@gmail.com>
RobMulla
force-pushed
the
docs-interactive-components
branch
from
July 30, 2026 19:33
96d968c to
8eb8402
Compare
RobMulla
reviewed
Jul 30, 2026
Collaborator
There was a problem hiding this comment.
Thanks for adding these interactive UI components! I rebased the branch and pushed a few improvements:
- TPU Setup: Combined Queued Resources and Flex-start into a single interactive generator.
- Compute Engine API: Updated
v6eandv5pto usegcloud compute instances create(keeping legacyqueued-resourcesfor older generations likev5e). - Generator UX: Greyed out unsupported chip sizes per generation and disabled Flex-start for older TPUs (
v3,v4) and preview hardware (v7x). Also switched to aZONEplaceholder to prevent quota errors. - TOC & UI Polish: Cleaned up the Table of Contents sidebar headings, added a latest/nightly Docker toggle on the installation page, and refined syntax highlighting.
RobMulla
added
documentation
RobMulla
self-requested a review
July 31, 2026 17:04
RobMulla
enabled auto-merge (squash)
July 31, 2026 17:15
QiliangCui
approved these changes
Jul 31, 2026
mtsokol
added a commit
to mtsokol/tpu-inference
that referenced
this pull request
Aug 4, 2026
The TPU v7x hardware button in tpu_setup.md needs the is_gce_only handling that was part of this branch before the interactive components were split into vllm-project#3297, since PROVISION_DATA in the merged interactive.js does not include v7x. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Mateusz Sokół <mat646@gmail.com>
RobMulla
pushed a commit
to mtsokol/tpu-inference
that referenced
this pull request
Aug 7, 2026
The TPU v7x hardware button in tpu_setup.md needs the is_gce_only handling that was part of this branch before the interactive components were split into vllm-project#3297, since PROVISION_DATA in the merged interactive.js does not include v7x. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Mateusz Sokół <mat646@gmail.com>
helloworld1
pushed a commit
that referenced
this pull request
Aug 17, 2026
…#3297) Signed-off-by: Mateusz Sokół <mat646@gmail.com> Signed-off-by: Rob Mulla <rob.mulla@gmail.com> Co-authored-by: Rob Mulla <rob.mulla@gmail.com> Co-authored-by: Rob Mulla <RobMulla@users.noreply.github.com>
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
3 participants
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.
Split out of #2064 to keep that PR focused on the ToC reorganization.
This PR adds the new interactive UI components for the MkDocs site and the two pages that use them:
New assets
docs/mkdocs/javascripts/interactive.js— command generator (installation method picker), TPU provision generator, and a per-tab search box for support tablesdocs/mkdocs/stylesheets/interactive.css— styles for the generator componentsdocs/mkdocs/stylesheets/extra.css— nav section styling, three-column card grid, andcg-badgestylesUsage
docs/getting_started/installation.md— rewritten around the command generatordocs/getting_started/tpu_setup.md— rewritten around the provision generatormkdocs.yml— registers the new CSS/JS assets (nav changes stay in Reorganization of ToC and docs linting #2064)The homepage persona cards (which use the card grid) remain in #2064 because they link to pages introduced there; with
strict: truethose links would fail the docs build here. Verifiedmkdocs buildpasses in strict mode on this branch.🤖 Generated with Claude Code