Skip to content

[Doc] Rewrite GenAI 'Overview'#19207

Merged
kevin-lyn merged 8 commits intomlflow:masterfrom
kevin-lyn:doc-landing-overview
Dec 9, 2025
Merged

[Doc] Rewrite GenAI 'Overview'#19207
kevin-lyn merged 8 commits intomlflow:masterfrom
kevin-lyn:doc-landing-overview

Conversation

@kevin-lyn
Copy link
Member

@kevin-lyn kevin-lyn commented Dec 4, 2025

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

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

Related Issues/PRs

#xxx

Would like to get feedback first - have some TODOs in the PR, will clean up later.
Marking this "ready to review" to trigger CI and doc preview.

Trying to solve couple of issues from the previous version of overview by achieving the following:

  • Remove header & tiles, which take too much space and don't really present the value props.
  • Make sure value props are presented upfront - reframed & updated some content.
  • Add details for each core component and link video and quick start guide to give a quick overview of capabilities.
  • Move "Request Feature" section to a separate page since it does not provide lots of value for new users.

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 marked this pull request as ready for review December 4, 2025 09:16
Copilot AI review requested due to automatic review settings December 4, 2025 09:16
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR rewrites the MLflow GenAI overview documentation page to provide a more focused, streamlined introduction to MLflow's GenAI capabilities. The author has marked it as a draft with TODOs that need to be addressed before final review.

  • Simplified the main GenAI landing page with clearer feature highlights and quickstart links
  • Added a new "Request Features" page to collect community feedback through GitHub issues
  • Updated community page description to be more inclusive of different user types

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.

File Description
docs/sidebarsGenAI.ts Adds the new "Request Features" page to the GenAI sidebar navigation
docs/docs/genai/references/request-features.mdx Creates a new page for users to vote on and request GenAI features via GitHub issues
docs/docs/genai/index.mdx Complete rewrite of the GenAI overview page with simplified content, new structure focusing on observability and evaluations quickstarts, and placeholder TODOs for Prompt Registry and AI Gateway sections
docs/docs/community/index.mdx Updates the welcome message to explicitly include software engineers and Agent/GenAI application builders

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

@github-actions
Copy link
Contributor

github-actions bot commented Dec 4, 2025

Documentation preview for 5f9ec44 is available at:

Changed Pages (3)

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.

@github-actions github-actions bot added area/docs Documentation issues rn/none List under Small Changes in Changelogs. labels Dec 4, 2025
kevin-lyn and others added 5 commits December 4, 2025 20:15
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kevin Lin <kevin_lyn@outlook.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kevin Lin <kevin_lyn@outlook.com>
Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
@kevin-lyn kevin-lyn changed the title [Draft][Doc] Rewrite GenAI 'Overview' [Doc] Rewrite GenAI 'Overview' Dec 5, 2025
@kevin-lyn kevin-lyn enabled auto-merge December 5, 2025 14:43
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.

Overall looks great!

kevin-lyn and others added 2 commits December 9, 2025 12:17
Signed-off-by: Kevin Lin <kevin.lin@databricks.com>
@kevin-lyn kevin-lyn added this pull request to the merge queue Dec 9, 2025
Merged via the queue into mlflow:master with commit 50358bc Dec 9, 2025
46 checks passed
@kevin-lyn kevin-lyn deleted the doc-landing-overview branch December 9, 2025 03:55
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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants