Skip to content

[Doc] Re-organize sidebar sections#18950

Merged
kevin-lyn merged 5 commits intomlflow:masterfrom
kevin-lyn:doc-sidebar-sections
Nov 24, 2025
Merged

[Doc] Re-organize sidebar sections#18950
kevin-lyn merged 5 commits intomlflow:masterfrom
kevin-lyn:doc-sidebar-sections

Conversation

@kevin-lyn
Copy link
Member

@kevin-lyn kevin-lyn commented Nov 21, 2025

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/18950/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/18950/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/18950/merge

Re-organize sidebar sections based on reading priority. The goal is to make sure users, especially if they are new, don't get lost when going through the "table of content". And users should be able to understand what are the minimal set of docs they need to read based on the new section structure.
Couple of things that are somewhat related in this PR:

  • Removal of AI Gateway/Guides since they are more or less the same content as the AI Gateway/Setup and AI Gateway/Usage.
  • Remove "Governance" and move "AI Gateway" as top level category because that is the only thing inside governance.
  • Move "App Packaging & Deployment" as top level category since it's a broader enough topic.
image

Related Issues/PRs

#xxx

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?

  • 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.

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 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>
@kevin-lyn kevin-lyn added the team-review Trigger a team review request label Nov 21, 2025
@github-actions github-actions bot added area/docs Documentation issues rn/none List under Small Changes in Changelogs. labels Nov 21, 2025
Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
@github-actions
Copy link
Contributor

github-actions bot commented Nov 21, 2025

Documentation preview for ae491d6 is available at:

Changed Pages (8)
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.

@serena-ruan
Copy link
Collaborator

serena-ruan commented Nov 21, 2025

Could we change the font back? It looks a bit ugly now imo 😅 it's too big and the space between each section is big
image
image

@serena-ruan
Copy link
Collaborator

Another issue found on ML docs page sidebar (seems not related to this PR), is the indent of 'webhook' intentional?
image

id: 'flavors/index',
},
},
{
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thoughts on updating Model Serving category to Agent Serving?

Copy link
Member Author

Choose a reason for hiding this comment

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

I love the idea, do we need wider refactoring of the docs & apis to make things consistent?

@B-Step62
Copy link
Collaborator

B-Step62 commented Nov 21, 2025

Could we change the font back? It looks a bit ugly now imo 😅 it's too big and the space between each section is big

+1, it renders a bit too big in my Mac screen (does not fit to single scroll).

@kevin-lyn
Copy link
Member Author

sure, will reduce the font size and spacing.

Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
@kevin-lyn kevin-lyn requested a review from B-Step62 November 24, 2025 02:17
@kevin-lyn
Copy link
Member Author

@serena-ruan new commit brought back the previous font size and reduce the vertical spacing. The ML doc indentation issue is also fixed.

@serena-ruan
Copy link
Collaborator

@serena-ruan new commit brought back the previous font size and reduce the vertical spacing. The ML doc indentation issue is also fixed.

Thanks! While I still think the space between each section is big: e.g. between 'overview' and 'Getting started'. Could we still use the old layout but only make each section title bold?
image

Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
@kevin-lyn
Copy link
Member Author

@serena-ruan great feedback! fixed in the latest commit and it looks much better now.

Copy link
Collaborator

@serena-ruan serena-ruan left a comment

Choose a reason for hiding this comment

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

LGTM!

@kevin-lyn kevin-lyn added this pull request to the merge queue Nov 24, 2025
Merged via the queue into mlflow:master with commit 5388ea0 Nov 24, 2025
49 of 51 checks passed
@kevin-lyn kevin-lyn deleted the doc-sidebar-sections branch November 24, 2025 06:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation issues rn/none List under Small Changes in Changelogs. team-review Trigger a team review request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants