Skip to content

Mintlify import#1727

Merged
johndmulhausen merged 1683 commits into
mainfrom
mintlify-import
Oct 21, 2025
Merged

Mintlify import#1727
johndmulhausen merged 1683 commits into
mainfrom
mintlify-import

Conversation

@mdlinville

@mdlinville mdlinville commented Oct 20, 2025

Copy link
Copy Markdown
Contributor

Description

Migrate docs to Mintlify

  • Convert content in wandb/docs to Mintlify
  • Convert wandb/weave docs to Mintlify and import them into wandb/docs
  • Information architecture updates
  • Style updates
  • CI/CD updates
    • Port existing Github actions and scripts
    • Create Github actions and scripts to support generating wandb/weave reference docs
  • TODO finish drafting the description

Cut from here down during squash and merge

Potential cut-over scenario

To go live on Mintlify, we would:

  1. Sign in to Cloudflare Console and remove the production and PR deploys. The Cloudflare checks disappear from all existing PRs and pushing to main no longer triggers a Cloudflare deploy.
  2. Sign into Mintlify Console and adjust the repo and branch in https://dashboard.mintlify.com/wb-21fd5541/wb-21fd5541/settings/deployment/git-settings to point at wandb/docs and the branch where the import is. To check, I just set it to wandb/docs at the mintlify-import branch. Also adjust the site title at the same time. The Mintlify PR checks start running.
  3. Just before merging the import branch, sign back into the Mintlify Console and change the deploy branch to main.
  4. Merge the import branch to main. (do not squash and merge). The cut-over is complete.
  5. Remove or archive the mintlifytest repo in Github.

Notes:
- The Files Changed and Commits tabs will probably not load in the Git UI. Check out the branch locally to review it.
- DO NOT MERGE. For this test PR, we are importing the Mintlify content as of the tip of https://github.com/wandb/mintlifytest/pull/42, which is not yet fully approved and is not yet merged.
- When we do merge an equivalent PR, we should not squash and merge. Otherwise, the commit history of each file will be compressed into a single commit, defeating the purpose.
- In this PR, it is expected to that the Cloudflare checks fail.
- While the Mintlify Console is configured to look at this branch in wandb/docs, merging changes in mintlifytest will not trigger a Mintlify deploy. We should switch it back if we want to continue more iteration in that repo.

Testing

  • Locally, imported content looks right, builds, serves, and introduces no broken links
  • PR tests succeed

…d to ko/models/core/registry/model_registry/model-lineage.mdx
…models/core/automations/automation-events.mdx
… to ko/models/core/automations/create-automations/slack.mdx
…md to models/automations/create-automations/webhook.mdx
…ko/models/reports/clone-and-export-reports.mdx
…o training/serverless-rl/available-models.mdx
… to training/serverless-rl/use-trained-models.mdx
johndmulhausen and others added 2 commits October 21, 2025 11:18
## Summary
This PR adds the necessary redirects configuration for Mintlify to the
docs.json file.

## Changes
- Added `redirects` array to docs.json with comprehensive redirect rules
- Includes redirects for:
  - Models documentation paths
  - Guides and tutorials
  - Platform and app paths
  - Japanese and Korean localized content
  - Launch documentation
  - Weave documentation paths

## Purpose
These redirects ensure that users accessing old URLs are properly
redirected to the new Mintlify documentation structure, maintaining link
integrity and improving user experience during the migration.
## Description

Fixes casing in docs.json to correspond to filenames.

<!-- Uncomment and add a description of the change -->


<!-- Optionally, uncomment the heading and add details about how you
tested the change and how reviewers should test it. For example:
## Testing
- [ ] Local build succeeds without errors or broken internal links
(`hugo server`)
- [ ] PR tests succeed
- [ ] The Lychee Github action run against the PR branch reports no
broken links

Replace the `[ ]` with `[x]` to check off the item instead of leaving it
unchecked.

Otherwise, delete this entire section from opening to closing comment.
-->

<!-- Optionally, uncomment the heading and add one or more lines like
these. Otherwise, delete this entire section from opening to closing
comment.

## Related issues

- Fixes DOCS-12345
- Fixes #12345
-->
…ble via direct URLs (#1740)

## Summary

This PR moves the W&B Launch documentation section to a separate hidden
tab, making it accessible only via direct URLs while removing it from
the main site navigation.

## Changes

1. **Removed W&B Launch from Platform tab** - The entire Launch section
has been removed from the Platform tab navigation
2. **Created separate W&B Launch tab** - All Launch documentation and
navigation structure has been moved to its own tab
3. **Added `hidden: true` flag** - Attempting to hide the tab from the
main navigation bar

## Intent

The goal is to make the W&B Launch section:
- ✅ Accessible via direct URLs (e.g., `/platform/launch`,
`/platform/launch/walkthrough`)
- ✅ Maintain full navigation structure when accessed
- ✅ Hidden from the main documentation navigation

## Note

The `hidden: true` flag on tabs may not be fully supported by Mintlify.
This PR proposes the configuration for testing and discussion.
Alternative approaches may be needed such as:
- Custom CSS to hide the tab
- Keeping the section in the Platform tab but using other visibility
controls
- Moving to a separate documentation instance

## Testing

- Access any Launch URL directly to verify the pages are still
accessible
- Check if the Launch tab appears in the main navigation (it should be
hidden if Mintlify supports it)
- Verify all internal Launch navigation works when on Launch pages
## Description

#1731 removed a bunch of redirects, which seem to have been masking
broken links especially in localized content. Fix them.
## Description

Removes "https://weave-docs.wandb.ai" from Models and Inference docs.
With the exception of Models -> evaluate-models.mdx because I couldn't
find the corresponding page in the new Weave docs.

## Note
* There are about 12 weave pages (`docs/weave/*`) that need to be
updated.
* 1 Release notes page needs updating
<!-- Uncomment and add a description of the change -->


<!-- Optionally, uncomment the heading and add details about how you
tested the change and how reviewers should test it. For example:
## Testing
- [ ] Local build succeeds without errors or broken internal links
(`hugo server`)
- [ ] PR tests succeed
- [ ] The Lychee Github action run against the PR branch reports no
broken links

Replace the `[ ]` with `[x]` to check off the item instead of leaving it
unchecked.

Otherwise, delete this entire section from opening to closing comment.
-->

<!-- Optionally, uncomment the heading and add one or more lines like
these. Otherwise, delete this entire section from opening to closing
comment.

## Related issues

- Fixes DOCS-12345
- Fixes #12345
-->

---------

Co-authored-by: Matt Linville <matt.linville@wandb.com>
## Description

Some of the integration docs were missing and/or repeated within
multiple locations in docs.json

<!-- Uncomment and add a description of the change -->


<!-- Optionally, uncomment the heading and add details about how you
tested the change and how reviewers should test it. For example:
## Testing
- [ ] Local build succeeds without errors or broken internal links
(`hugo server`)
- [ ] PR tests succeed
- [ ] The Lychee Github action run against the PR branch reports no
broken links

Replace the `[ ]` with `[x]` to check off the item instead of leaving it
unchecked.

Otherwise, delete this entire section from opening to closing comment.
-->

<!-- Optionally, uncomment the heading and add one or more lines like
these. Otherwise, delete this entire section from opening to closing
comment.

## Related issues

- Fixes DOCS-12345
- Fixes #12345
-->
## Description

- Fixed some important links to point to correct anchors
- Fixed awkward list formatting in privacy page
- Update the MS Entra setup instructions
  - Fixed awkward list formatting
  - Fixed excessive # of images
  - Validated instructions against current official Entra docs
dbrian57 and others added 2 commits October 21, 2025 15:15
## Description
This PR replaces hard-coded Weave links and replaces them with internal
references. This also fixes WEave reference links across the docs that
were using an old schema.
## Summary

This PR adds analytics integration for Mintlify documentation with
proper consent management.

## Changes

- **Added OneTrust cookie consent management**: Integrates with OneTrust
for GDPR-compliant cookie consent
- **Segment Analytics integration**: Uses self-hosted Segment build at
`wandb.ai/sa-docs.min.js`
- **Microsoft Clarity analytics**: Added for user behavior insights
- **Consent-based loading**: Analytics scripts only load when users
grant marketing or statistics consent
- **User engagement tracking**: Added user engagement tracking script

## Key Features

1. **Privacy-first approach**: Analytics only loads after user consent
2. **Consent synchronization**: Implements `wpConsentSync` to manage
different consent categories:
   - Statistics
   - Marketing  
   - Functional
   - Preferences
3. **Performance**: Scripts load asynchronously to minimize impact on
page load

## Implementation Details

The implementation follows these steps:
1. Load the user engagement and OneTrust scripts
2. Wait for user consent via OneTrust
3. Only load analytics (Segment & Clarity) if marketing or statistics
consent is granted
4. Fire analytics.page() when Segment is ready

## Testing

- Verify OneTrust banner appears correctly
- Confirm analytics only loads with proper consent
- Check that Segment and Clarity are tracking correctly when consent is
given

@johndmulhausen johndmulhausen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

@johndmulhausen johndmulhausen enabled auto-merge (squash) October 21, 2025 19:32
@johndmulhausen johndmulhausen merged commit c0a249c into main Oct 21, 2025
9 checks passed
@johndmulhausen johndmulhausen deleted the mintlify-import branch October 21, 2025 19:32
johndmulhausen added a commit that referenced this pull request Jun 5, 2026
The intro said "Select the button below to try a PyTorch Quickstart
example project on MNIST data" but no button ever followed it (dangling
since the original Mintlify import in #1727).

Supply the missing button using the existing <ColabLink> snippet
component (the same one used in Weave quickstarts and integration
guides), pointing at the W&B Tables Quickstart Colab in wandb/examples —
the PyTorch-on-MNIST notebook the text describes. Verified it resolves.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

4 participants