Skip to content

[Doc] Improve readablity by adjusting sidebar layout & style#18937

Merged
kevin-lyn merged 2 commits intomlflow:masterfrom
kevin-lyn:doc-sidebar-layout-style
Nov 21, 2025
Merged

[Doc] Improve readablity by adjusting sidebar layout & style#18937
kevin-lyn merged 2 commits intomlflow:masterfrom
kevin-lyn:doc-sidebar-layout-style

Conversation

@kevin-lyn
Copy link
Member

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

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

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

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

Why this is needed: we are planning to restructure the sections in the sidebar to create a more connected getting-started doc experience for each key component.
So:

  • Moving the sidebar closer the main doc content so that sidebar and content stay connected within a reasonable readable content width - this is especially important for bigger screen.
  • Add additional spacing in sidebar items to create better visual hierarchy.

Before:
Screenshot 2025-11-20 at 17 49 39

After:
Screenshot 2025-11-20 at 17 50 22

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>
@github-actions
Copy link
Contributor

@kevin-lyn Thank you for the contribution! Could you fix the following issue(s)?

⚠ DCO check

The DCO check failed. Please sign off your commit(s) by following the instructions here. See https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md#sign-your-work for more details.

@github-actions github-actions bot added the area/docs Documentation issues label Nov 20, 2025
Copy link
Collaborator

@B-Step62 B-Step62 left a comment

Choose a reason for hiding this comment

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

LGTM, you can run npm run prettier:fix to fix the CI

@harupy
Copy link
Member

harupy commented Nov 20, 2025

/autoformat


Interesting. Didn't work

@github-actions github-actions bot added the rn/documentation Mention under Documentation Changes in Changelogs. label Nov 20, 2025
Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
@github-actions
Copy link
Contributor

Documentation preview for 2a211b8 is available at:

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.

@kevin-lyn kevin-lyn added this pull request to the merge queue Nov 21, 2025
Merged via the queue into mlflow:master with commit e2d3704 Nov 21, 2025
45 of 46 checks passed
@kevin-lyn kevin-lyn deleted the doc-sidebar-layout-style branch November 21, 2025 00:11
kevin-wangg pushed a commit to kevin-wangg/mlflow that referenced this pull request Nov 21, 2025
…18937)

Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
Signed-off-by: Kevin Wang <kevinwang2040@gmail.com>
Tian-Sky-Lan pushed a commit to Tian-Sky-Lan/mlflow that referenced this pull request Nov 24, 2025
…18937)

Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
Signed-off-by: Tian Lan <sky.blue266000@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation issues rn/documentation Mention under Documentation 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