Skip to content

Sync Python/TypeScript tab selections in tracing quickstart docs#19184

Merged
harupy merged 3 commits intomasterfrom
copilot/sync-tabs-for-python-typescript
Dec 3, 2025
Merged

Sync Python/TypeScript tab selections in tracing quickstart docs#19184
harupy merged 3 commits intomasterfrom
copilot/sync-tabs-for-python-typescript

Conversation

Copy link
Contributor

Copilot AI commented Dec 3, 2025 •
edited
Loading

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Added groupId="programming-language" to both <Tabs> components in the tracing quickstart documentation. This enables Docusaurus tab syncing - when users select Python or TypeScript in the "Dependency" section, the "Start Tracing" section automatically updates to match, and vice versa. The selection persists in localStorage across page visits.

Changed file:

  • docs/docs/genai/tracing/quickstart/index.mdx: Added groupId prop to both tab groups

How is this PR tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests

Verified by starting the Docusaurus dev server and confirming tab selections sync between both sections on the page.

Screenshot: https://github.com/user-attachments/assets/c5acf777-50fb-4c9b-bcf5-09dc8019d49b

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

Improved UX in tracing quickstart documentation: Python/TypeScript tab selections now sync across the page.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/tracking: Tracking Service, tracking client APIs, autologging
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflows
  • area/gateway: MLflow AI Gateway client APIs, server, and third-party integrations
  • area/prompts: MLflow prompt engineering features, prompt templates, and prompt management
  • area/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionality
  • area/projects: MLproject format, project running backends
  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages

How should the PR be classified in the release notes? Choose one:

  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Should this PR be included in the next patch release?

  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)
Original prompt

Sync tab choices in docs/docs/genai/tracing/quickstart/index.mdx for python/typescript. Here is the relevant documentation from Docusaurus:

https://docusaurus.io/docs/markdown-features/tabs#syncing-tab-choices

You may want choices of the same kind of tabs to sync with each other. For example, you might want to provide different instructions for users on Windows vs users on macOS, and you want to change all OS-specific instructions tabs in one click. To achieve that, you can give all related tabs the same groupId prop. Note that doing this will persist the choice in localStorage and all instances with the same groupId will update automatically when the value of one of them is changed. Note that group IDs are globally namespaced.

<Tabs groupId="operating-systems">
  <TabItem value="win" label="Windows">Use Ctrl + C to copy.</TabItem>
  <TabItem value="mac" label="macOS">Use Command + C to copy.</TabItem>
</Tabs>

<Tabs groupId="operating-systems">
  <TabItem value="win" label="Windows">Use Ctrl + V to paste.</TabItem>
  <TabItem value="mac" label="macOS">Use Command + V to paste.</TabItem>
</Tabs>

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@harupy harupy requested a review from kevin-lyn December 3, 2025 05:17
@harupy harupy marked this pull request as ready for review December 3, 2025 05:17
Copilot AI and others added 2 commits December 3, 2025 05:24
@harupy
Add groupId to sync Python/TypeScript tabs in tracing quickstart
bd68f04 
Co-authored-by: harupy <17039389+harupy@users.noreply.github.com>
@harupy
Remove screenshots/ from .gitignore
d9f2539 
Co-authored-by: harupy <17039389+harupy@users.noreply.github.com>
Copilot AI changed the title [WIP] Sync tab choices for Python and TypeScript in quickstart Sync Python/TypeScript tab selections in tracing quickstart docs Dec 3, 2025
Copilot AI requested a review from harupy December 3, 2025 05:28
@github-actions github-actions bot added v3.7.0 area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. labels Dec 3, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 3, 2025

Documentation preview for d9f2539 is available at:

Changed Pages (1)

More info
  • Ignore this comment if this PR does not change the documentation.
  • The preview is updated when a new commit is pushed to this PR.
  • This comment was created by this workflow run.
  • The documentation was built by this workflow run.

@harupy harupy enabled auto-merge December 3, 2025 05:54
kevin-lyn
kevin-lyn approved these changes Dec 3, 2025
View reviewed changes
Copy link
Member

@kevin-lyn kevin-lyn left a comment

Choose a reason for hiding this comment

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

Nice!

@harupy harupy disabled auto-merge December 3, 2025 06:12
@harupy harupy merged commit 8a0c3f0 into master Dec 3, 2025
54 of 80 checks passed
@harupy harupy deleted the copilot/sync-tabs-for-python-typescript branch December 3, 2025 06:12
@github-actions github-actions bot added v3.7.1 and removed v3.7.0 labels Dec 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kevin-lyn kevin-lyn kevin-lyn approved these changes

@harupy harupy Awaiting requested review from harupy

Assignees

@harupy harupy

Copilot code review Copilot

Labels

area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. v3.7.1

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kevin-lyn @harupy