Restructure nav: Products | Get Started | Reference | Release Notes | Support#2518
Merged
Conversation
Collapse the five per-product horizontal tabs (Models, Weave, Inference,
Training, Sandboxes) into a single Products tab and add new Get Started
and Reference tabs. The product tabs are preserved as hidden tabs so
users still get an isolated product left-nav when browsing a specific
product's docs.
Nav changes
- Visible top tabs: Products | Get Started | Reference | Support.
- Products tab merges the old Platform content. Left nav is: a Products
group (links to each product home page), Platform Details (release
notes, configure W&B, monitoring & usage, deployment options), and
Resources. The index page serves as the tab landing.
- Get Started tab (new) contains get-started, MCP server, wb-skills,
and the new examples page.
- Reference tab (new) is a signpost: left nav lists one stub-redirect
entry per reference doc set (Models: Python SDK, Public API, CLI,
Query Expression Language, Reports and Workspaces API; Weave: Python
SDK, TypeScript SDK, Service API; Inference: API Reference; Training:
API Reference). Clicking any entry lands users in the owning product
tab, which holds the full reference sub-tree.
- Support tab is defined before the hidden tabs so it renders before
any active hidden product tab.
- W&B Models, Weave, Inference, Training, and Sandboxes tabs are marked
hidden: true; their reference sub-trees remain inside each tab.
New landing pages
- reference.mdx: a by-product overview of all reference offerings
(one card per reference doc set).
- examples.mdx: a comprehensive index of hands-on content, grouped by
product, including every tutorial, walkthrough, and colab-bearing
page in docs.json. Starts with a Quickstarts section covering the
cross-product get-started page and each product's quickstart.
New stub files
- product-sandboxes.mdx: Products tab redirect to /sandboxes.
- models/ref-link-{python,public-api,cli,query-panel,workspaces}.mdx
- weave/ref-link-{python,typescript,service-api}.mdx
- inference/ref-link-api.mdx
- training/ref-link-api.mdx
Each stub is a tiny MDX with url: frontmatter that redirects to the
corresponding page in the owning product's hidden tab.
Scope
- English (en) nav only; fr/ja/ko locales are unchanged and should be
updated in a follow-up PR.
- No content changes to any existing reference page; URLs preserved.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
📚 Mintlify Preview Links✨ Added (13 total)📄 Pages (13)
📝 Changed (3 total)📄 Pages (2)
⚙️ Other (1)
🤖 Generated automatically when Mintlify deployment succeeds |
Contributor
🔗 Link Checker Results✅ All links are valid! No broken links were detected. Checked against: https://wb-21fd5541-ia-products.mintlify.app |
Contributor
There was a problem hiding this comment.
Pull request overview
Restructures the Mintlify docs top navigation to consolidate product docs under a single Products tab while adding Get Started and Reference tabs, keeping per-product navigation experiences via hidden product tabs and redirect stubs.
Changes:
- Updates
docs.jsonto implement the new top-nav tabs (Products | Get Started | Reference | Support) and mark product tabs as hidden. - Adds new landing pages for Reference (
reference.mdx) and Example Code & Notebooks (examples.mdx). - Introduces multiple frontmatter-only MDX redirect stubs (
*-ref-link-*.mdx,product-sandboxes.mdx) to route users into the correct product-owned sections.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs.json | Reworks nav tabs/groups; adds Get Started + Reference tabs; hides product tabs. |
| reference.mdx | Adds Reference landing page with by-product card grid to canonical reference destinations. |
| examples.mdx | Adds consolidated examples/tutorials index grouped by product for the Get Started tab. |
| product-sandboxes.mdx | Adds Products-tab redirect stub to /sandboxes. |
| models/ref-link-python.mdx | Reference-tab redirect stub into Models Python reference. |
| models/ref-link-public-api.mdx | Reference-tab redirect stub into Models Public API reference. |
| models/ref-link-cli.mdx | Reference-tab redirect stub into Models CLI reference. |
| models/ref-link-query-panel.mdx | Reference-tab redirect stub into Models QEL reference. |
| models/ref-link-workspaces.mdx | Reference-tab redirect stub into Reports/Workspaces API reference. |
| weave/ref-link-python.mdx | Reference-tab redirect stub into Weave Python SDK reference. |
| weave/ref-link-typescript.mdx | Reference-tab redirect stub into Weave TypeScript SDK reference. |
| weave/ref-link-service-api.mdx | Reference-tab redirect stub into Weave Service API reference. |
| inference/ref-link-api.mdx | Reference-tab redirect stub into Inference API reference. |
| training/ref-link-api.mdx | Reference-tab redirect stub into Training API reference. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
johndmulhausen
force-pushed
the
ia-products
branch
from
April 22, 2026 17:36
3ac500a to
8cbd464
Compare
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
… and navigation. Introduced new groupings for Python SDK, CLI, and various functionalities, improving clarity and accessibility of reference materials.
…title for improved navigation. Enhanced organization by introducing new groupings and pages, while renaming the support page to 'Support Home' for clarity.
…clarity in navigation.
…clarity in navigation and enhance documentation structure for better organization.
…tation structure and navigation. This update restores the previous grouping of release notes for W&B Server and SDK, enhancing clarity and accessibility for users.
johndmulhausen
enabled auto-merge (squash)
April 23, 2026 21:44
johndmulhausen
changed the title
mdlinville
approved these changes
Apr 27, 2026
3 tasks
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
Collapses the five per-product horizontal tabs (W&B Models, Weave, Inference, Training, Sandboxes) into a single Products tab and introduces two new top tabs: Get Started and Reference. The old per-product tabs are preserved as hidden tabs so users still get an isolated product left-nav when they navigate into a specific product's docs.
New visible top nav (English)
What each visible tab contains
Products: redirect cards to each product home (/models,/weave,/inference,/training,/sandboxes)Platform Details: Release Notes, Configure W&B, Monitoring & Usage, Deployment OptionsResources: Pricing, Blog, Courses, Security/(uses existingindex.mdx)get-started,platform/mcp-server,platform/wb-skills, and the newexamplespage/referencewith a by-product card grid.Hidden tabs
W&B Models,W&B Weave,W&B Inference,W&B Training,W&B Sandboxesare marked"hidden": true. Their full reference sub-trees remain in each tab as the canonical home for that product's reference content. Existing hidden tabs (W&B Launch,Support: W&B Models/Weave/Inference) are unchanged.New files
reference.mdx: by-product overview of all reference offerings (one card per reference doc set)examples.mdx: comprehensive index of hands-on content, grouped by product, including every tutorial, walkthrough, and colab-bearing page in the nav. Starts with a Quickstarts section covering cross-product + per-product quickstarts.product-sandboxes.mdx: Products tab redirect to/sandboxesmodels/ref-link-{python,public-api,cli,query-panel,workspaces}.mdxweave/ref-link-{python,typescript,service-api}.mdxinference/ref-link-api.mdx,training/ref-link-api.mdxEach stub is a small MDX file with a
url:frontmatter redirect to the corresponding page in the owning product's hidden tab.Non-goals / scope
en) nav is changed.fr,ja,kolocales are unchanged and should be updated in a follow-up PR.Test plan
mint devbuilds cleanly and the visible tabs render asProducts | Get Started | Reference | Supportmint broken-linksreports no broken links/; Get Started on/get-started; Reference on/reference; Support on/supportPublic API→/models/ref/python/public-apiwith Models' Python group expanded)/referencelands on a working page/exampleslands on a working page, and every page with a live colab link that is present indocs.jsonis represented in/examples/models,/weave) still shows the isolated product left-nav and a top-nav ofProducts | Get Started | Reference | Support | <active product>