Implementation:Mlflow Mlflow Sidebars
| Knowledge Sources | |
|---|---|
| Domains | Documentation, Navigation, Frontend |
| Last Updated | 2026-02-13 20:00 GMT |
Overview
Defines the main (legacy) sidebar navigation structure for the MLflow documentation site.
Description
sidebars.ts exports a SidebarsConfig object that defines the docsSidebar, the primary navigation hierarchy for the legacy MLflow documentation layout. This sidebar predates the split into separate Classic ML and GenAI documentation sections and provides a unified view of all MLflow documentation.
The sidebar is organized into the following top-level categories:
- Getting Started -- Quickstart guide, introduction, running notebooks, Databricks trial, and additional tutorials including hyperparameter tuning, model registry tutorial, and tracking server overview
- Machine Learning -- Three subcategories: LLM/GenAI (with OpenAI, LangChain, DSPy, LlamaIndex, Transformers, Sentence Transformers integrations), Deep Learning, and Traditional ML
- Build -- MLflow Tracking (with autolog, search, system metrics), MLflow Model, and MLflow Prompts
- Evaluate & Monitor -- MLflow Evaluation, MLflow Tracing (Observability), and MLflow Dataset
- Deploy -- Model Registry, MLflow Serving, and MLflow AI Gateway
- Team Collaboration -- Self-Hosting, Managed Services, Access Control, and MLflow Projects
- API References -- Links to Python, Java, R, REST API, and CLI documentation
- More -- Contributing guide, blog links, and plugins
Each category uses a combination of doc items (linking to specific pages), category items (grouping related pages), link items (external or cross-section links), and autogenerated items (auto-discovering pages from directory structures). The apiReferencePrefix() helper function is used to construct correct URLs for API reference links.
Usage
This sidebar configuration is referenced by the legacy documentation plugin. For new documentation work, prefer modifying sidebarsClassicML.ts or sidebarsGenAI.ts instead.
Code Reference
Source Location
- Repository: Mlflow_Mlflow
- File: docs/sidebars.ts
- Lines: 1-545
Signature
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
import { apiReferencePrefix } from './docusaurusConfigUtils';
const sidebars: SidebarsConfig = {
docsSidebar: [
// ... sidebar items ...
],
};
export default sidebars;
Import
// Referenced in docusaurus.config.ts via sidebarPath option
// Not directly imported by application code
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| N/A | N/A | N/A | This is a static configuration file with no runtime inputs |
Outputs
| Name | Type | Description |
|---|---|---|
| sidebars | SidebarsConfig | Configuration object consumed by Docusaurus to render navigation sidebar |
Sidebar Structure
Top-Level Categories
| Category | Collapsed | Key Contents |
|---|---|---|
| Getting Started | No | Quickstart, Introduction, Running Notebooks, Databricks Trial, Tutorials |
| Machine Learning | No | LLM/GenAI, Deep Learning, Traditional ML |
| Build | No | Tracking, Model, Prompts |
| Evaluate & Monitor | No | Evaluation, Tracing, Dataset |
| Deploy | No | Model Registry, Serving, AI Gateway |
| Team Collaboration | Yes | Self-Hosting, Managed Services, Access Control, Projects |
| API References | Yes | Python, Java, R, REST, CLI |
| More | Yes | Contributing, Blog, Plugins |
Usage Examples
Adding a New Documentation Page
// To add a new page to the "Build" section:
{
type: 'doc',
id: 'new-feature/index',
label: 'New Feature',
}