[Doc] Re-arrange tracing sidebar by kevin-lyn · Pull Request #19329 · mlflow/mlflow

kevin-lyn · 2025-12-11T08:21:24Z

🛠 DevTools 🛠

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19329/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19329/merge#subdirectory=libs/skinny

For Databricks, use the following command:

%sh curl -LsSf https://raw.githubusercontent.com/mlflow/mlflow/HEAD/dev/install-skinny.sh | sh -s pull/19329/merge

Related Issues/PRs

#xxx

This PR improves the structure of the "Tracing" sidebar by:

Moving all guides into one single "Guides" section.
Rename guides title to start with verb so that the user intention clear.
Order the guides by trace ingestion -> trace metadata usage -> trace viewing -> others.
Remove redundant pages in tracing sidebar.

This PR is intentionally NOT to(so that the scope of the PR is not overwhelmed):

Improve the content inside the guides.
Remove all duplicate content.
Mapping guides to a clear JTBD since it's not yet aligned and we are not sure if it makes sense for tracing.

What changes are proposed in this pull request?

How is this PR tested?

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

Does this PR require documentation update?

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.

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

Components

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 should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?

Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
Bug fixes, doc updates and new features usually go into minor releases.
Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
Bug fixes and doc updates usually go into patch releases.

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)

Signed-off-by: Kevin Lin <kevin.lin@databricks.com>

Copilot

Pull request overview

This PR reorganizes the MLflow Tracing documentation sidebar to improve navigation and clarity. The main objective is to consolidate scattered guides into a single "Guides" section, rename guides with action-oriented verbs, and remove redundant documentation pages.

Key Changes:

Consolidated all tracing guides under a single "Guides" section with verb-based titles (e.g., "Enable Automatic Tracing", "Tag Traces")
Removed the standalone typescript-sdk.mdx and app-instrumentation/index.mdx pages with proper redirects configured to the quickstart page
Updated all TypeScript library documentation links to point to the unified quickstart guide

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
`docs/sidebarsGenAI.ts`	Restructured the tracing sidebar by consolidating guides, adding verb-based labels, removing nested category structure, and deleting redundant sections
`docs/docusaurus.config.ts`	Added redirects for removed pages (`typescript-sdk`, `app-instrumentation`) to the quickstart page, consolidated duplicate redirect rules
`libs/typescript/*/README.md`	Updated documentation links from the old typescript-sdk page to the quickstart page across all TypeScript packages
`libs/typescript/integrations/openai/docs/index.html`	Updated HTML documentation link to point to the quickstart page
`docs/docs/genai/tracing/integrations/contribute.mdx`	Updated internal documentation reference from the old app-instrumentation page to the automatic tracing guide
`docs/docs/genai/tracing/app-instrumentation/opentelemetry.mdx`	Removed redundant sidebar label property
`docs/docs/genai/tracing/app-instrumentation/typescript-sdk.mdx`	Deleted page with redirect configured to quickstart
`docs/docs/genai/tracing/app-instrumentation/index.mdx`	Deleted page with redirect configured to quickstart

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

github-actions · 2025-12-11T08:29:58Z

Documentation preview for a4ef780 is available at:

https://pr-19329--mlflow-docs-preview.netlify.app/docs/latest/

Changed Pages (8)

genai/eval-monitor (modified)
genai/mcp (modified)
genai/tracing (modified)
genai/tracing/app-instrumentation (removed, ✅ redirect exists)
genai/tracing/app-instrumentation/opentelemetry (modified)
genai/tracing/app-instrumentation/typescript-sdk (removed, ✅ redirect exists)
genai/tracing/integrations/contribute (modified)
genai/tracing/quickstart (modified)

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.

Signed-off-by: Kevin Lin <kevin.lin@databricks.com>

serena-ruan · 2025-12-12T02:32:17Z

docs/sidebarsGenAI.ts

@@ -47,29 +47,69 @@ const sidebarsGenAI: SidebarsConfig = {
        },
        {


Could we also add concepts section and move them into this folder? Currently it's in https://pr-19329--mlflow-docs-preview.netlify.app/docs/latest/genai/concepts/trace/ and I feel like users may never check that

I think for "reference" like documentation, "Concepts" in this case, it should not be a required page for user. Users should be able to under stand what "trace" is by reading through quick start and other guides.

Users should be able to under stand what "trace" is by reading through quick start and other guides.

Why do you think so? I think having a page explaining what it is is more straightforward than asking users to get a sense of what it is after reading through a bunch of guides. Basically in landing page (https://pr-19329--mlflow-docs-preview.netlify.app/docs/latest/genai/tracing/) it never explains what traces/spans are

I think having a page explaining what it is is more straightforward

I agree on this one but for new users, I don't think reading a "concept" explanation is what they are looking for. What new users are looking for is to understand the value props of MLflow as quick as possible.
I see your point in terms of discoverability of the "Concepts" since it's currently at the bottom. But moving "Concepts" into "Guides" also defeats the purpose of guides though.

Oh I'm not proposing adding it into 'Guides', but just within 'tracing' -> 'concepts' -> trace/span

Got it. we can revisit this separately, if we can align on having "Concepts" as a sub-category, then we should have it for all other core components, so that it's consistent.

docs/docs/genai/tracing/app-instrumentation/typescript-sdk.mdx

docs/docs/genai/tracing/collect-user-feedback/index.mdx

docs/docs/genai/tracing/app-instrumentation/index.mdx

docs/sidebarsGenAI.ts

Signed-off-by: Kevin Lin <kevin.lin@databricks.com>

serena-ruan · 2025-12-12T06:13:11Z

docs/sidebarsGenAI.ts

-        },
        {
          type: 'category',
          label: 'OpenTelemetry',


Happy to discuss but personally I feel it's unexpected that OpenTelemetry is at the same level as guides/integrations etc. We can probably combine it with https://pr-19329--mlflow-docs-preview.netlify.app/docs/latest/genai/tracing/app-instrumentation/opentelemetry/?

ya ideally we should have one. I don't have strong opinion on this one. Thoughts @B-Step62 ?

kevin-lyn · 2025-12-12T06:27:34Z

Updated tracing sidebar to group guides into sub-categories. cc @B-Step62

B-Step62

LGTM!

Signed-off-by: Kevin Lin <kevin.lin@databricks.com>

Re-arrange tracing sidebar

6e634cd

Signed-off-by: Kevin Lin <kevin.lin@databricks.com>

Copilot AI review requested due to automatic review settings December 11, 2025 08:21

github-actions bot added area/docs Documentation issues rn/none List under Small Changes in Changelogs. labels Dec 11, 2025

Copilot started reviewing on behalf of kevin-lyn December 11, 2025 08:21 View session

Copilot AI reviewed Dec 11, 2025

View reviewed changes

kevin-lyn and others added 2 commits December 11, 2025 17:40

Fix build.

f2d5370

Signed-off-by: Kevin Lin <kevin.lin@databricks.com>

Merge branch 'master' into doc-tracing-sidebar

9de08e1

kevin-lyn requested review from B-Step62, daniellok-db and serena-ruan December 11, 2025 21:59

Remove collect feedback doc from tracing guides

86ad855

Signed-off-by: Kevin Lin <kevin.lin@databricks.com>

kevin-lyn added the v3.8.0 label Dec 12, 2025

serena-ruan reviewed Dec 12, 2025

View reviewed changes

github-actions bot assigned serena-ruan Dec 12, 2025

B-Step62 reviewed Dec 12, 2025

View reviewed changes

kevin-lyn and others added 2 commits December 12, 2025 13:11

Merge branch 'master' into doc-tracing-sidebar

aeb3d30

Group guides into sub-category.

976aa63

Signed-off-by: Kevin Lin <kevin.lin@databricks.com>

github-actions bot assigned B-Step62 Dec 12, 2025

serena-ruan reviewed Dec 12, 2025

View reviewed changes

Merge branch 'master' into doc-tracing-sidebar

a4ef780

B-Step62 approved these changes Dec 16, 2025

View reviewed changes

kevin-lyn enabled auto-merge December 16, 2025 05:50

kevin-lyn added this pull request to the merge queue Dec 16, 2025

Merged via the queue into mlflow:master with commit db4fc95 Dec 16, 2025
53 of 54 checks passed

kevin-lyn deleted the doc-tracing-sidebar branch December 16, 2025 06:11

WeichenXu123 pushed a commit to WeichenXu123/mlflow that referenced this pull request Dec 19, 2025

[Doc] Re-arrange tracing sidebar (mlflow#19329)

71afdaa

Signed-off-by: Kevin Lin <kevin.lin@databricks.com>

WeichenXu123 pushed a commit that referenced this pull request Dec 19, 2025

[Doc] Re-arrange tracing sidebar (#19329)

b36a2b3

Signed-off-by: Kevin Lin <kevin.lin@databricks.com>

		@@ -47,29 +47,69 @@ const sidebarsGenAI: SidebarsConfig = {
		},
		{

Conversation

kevin-lyn commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Install mlflow from this PR

Related Issues/PRs

What changes are proposed in this pull request?

How is this PR tested?

Does this PR require documentation update?

Release Notes

Is this a user-facing change?

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

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

Should this PR be included in the next patch release?

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

github-actions bot commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kevin-lyn commented Dec 12, 2025

Uh oh!

B-Step62 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kevin-lyn commented Dec 11, 2025 •

edited

Loading

github-actions bot commented Dec 11, 2025 •

edited

Loading