Fix CLI link missing api_reference prefix in documentation sidebars#18893
Merged
Fix CLI link missing api_reference prefix in documentation sidebars#18893
Conversation
Contributor
|
@Copilot Thank you for the contribution! Could you fix the following issue(s)? ⚠ Invalid PR templateThis PR does not appear to have been filed using the MLflow PR template. Please copy the PR template from here and fill it out. |
- Fixed docs/sidebarsClassicML.ts: Changed CLI href from cli.html to api_reference/cli.html - Fixed docs/sidebars.ts: Changed CLI href from cli.html to api_reference/cli.html - Both CLI links now match the pattern used by REST API link Co-authored-by: harupy <17039389+harupy@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix missing api_reference prefix in CLI link
Fix CLI link missing api_reference prefix in documentation sidebars
Nov 18, 2025
Contributor
|
Documentation preview for 0e7582e is available at: More info
|
harupy
approved these changes
Nov 18, 2025
mprahl
pushed a commit
to opendatahub-io/mlflow
that referenced
this pull request
Nov 21, 2025
…lflow#18893) Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: harupy <17039389+harupy@users.noreply.github.com>
Tian-Sky-Lan
pushed a commit
to Tian-Sky-Lan/mlflow
that referenced
this pull request
Nov 24, 2025
…lflow#18893) Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: harupy <17039389+harupy@users.noreply.github.com> Signed-off-by: Tian Lan <sky.blue266000@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issues/PRs
Resolves https://github.com/mlflow/mlflow/issues/xxx
What changes are proposed in this pull request?
The CLI link in both sidebar configuration files was missing the
api_reference/prefix, causing incorrect URL generation. All other API reference links (REST API, Python API, Java API, R API) correctly include this prefix.Changes:
docs/sidebars.ts: Updated CLI href fromcli.htmltoapi_reference/cli.htmldocs/sidebarsClassicML.ts: Updated CLI href fromcli.htmltoapi_reference/cli.htmlThis aligns with the path mapping defined in
docs/scripts/update-api-modules.tswheremlflow.server.climaps toapi_reference/cli.html.How is this PR tested?
Validated TypeScript syntax, prettier formatting, and consistency with other API reference links.
Does this PR require documentation update?
Release Notes
Is this a user-facing change?
Fixed broken CLI documentation link in sidebar navigation.
What component(s), interfaces, languages, and integrations does this PR affect?
Components
area/tracking: Tracking Service, tracking client APIs, autologgingarea/models: MLmodel format, model serialization/deserialization, flavorsarea/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registryarea/scoring: MLflow Model server, model deployment tools, Spark UDFsarea/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflowsarea/gateway: MLflow AI Gateway client APIs, server, and third-party integrationsarea/prompts: MLflow prompt engineering features, prompt templates, and prompt managementarea/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionalityarea/projects: MLproject format, project running backendsarea/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev serverarea/build: Build and test infrastructure for MLflowarea/docs: MLflow documentation pagesHow 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" sectionrn/breaking-change- The PR will be mentioned in the "Breaking Changes" sectionrn/feature- A new user-facing feature worth mentioning in the release notesrn/bug-fix- A user-facing bug fix worth mentioning in the release notesrn/documentation- A user-facing documentation change worth mentioning in the release notesShould this PR be included in the next patch release?
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.