Central index of key documentation in the ODH Dashboard monorepo.
| Doc | Description |
|---|---|
| CONTRIBUTING.md | Contribution guidelines |
| README.md | Project overview |
| Dev Setup | Development environment setup |
| Doc | Description |
|---|---|
| Architecture | Overall system architecture |
| Architecture Decisions | Key architecture decisions (monorepo, Module Federation, Turbo) |
| Module Federation | Module Federation implementation |
| Extensibility | Plugin/extension system |
| Quality Gates | Modular architecture quality standards |
| Doc | Description |
|---|---|
| PR Review Guidelines | PR review process |
| Pre-Commit Hooks | Pre-commit hook details |
| Best Practices | Coding best practices |
| Code Examples | Code examples and patterns |
| Multi-Agent Workflows | Running parallel agents locally and remotely |
| Large Tasks with Claude Code Goals | Using /goal for autonomous, multi-step development tasks |
| Prototype Reading Skills | /prototype-tickets and /prototype-spec — extracting PF component details from UX prototype forks |
| Upstream Sync | How to sync upstream changes into monorepo packages |
| Doc | Description |
|---|---|
| Testing Guide | Comprehensive testing guide |
| Cypress Tutorial | Cypress testing tutorial |
| Doc | Description |
|---|---|
| OWNERS Management | OWNERS file management |
| Definition of Ready | DoR for features |
| Definition of Done | DoD for tasks |
| SMEs | Subject matter experts |
| Doc | Description |
|---|---|
| Release Steps | Release process |
| Environment Variables | Environment configuration |
| Observability | Monitoring and observability |
| Onboarding Modules | Onboarding new modules |
Active frontend areas in
frontend/src/pages/. Model Registry, Model Serving, and Model Catalog are deprecated in the main frontend — see Package docs below.
| Doc | Description |
|---|---|
| Pipelines | Pipeline runs, DAG viewing, artifact tracking, Kubeflow Pipelines integration |
| Workbenches | Notebook creation, JupyterLab, gateway-based routing (v3.0+), notebookController |
| Projects | Data Science Projects hub — primary entry point for workbenches, pipelines, serving, storage, connections |
| Distributed Workloads | Kueue workload management, distributed training job monitoring |
| Gen AI / LLM | Host-side LLM feature flags and type definitions; actual UI lives in federated packages (gen-ai, eval-hub) |
| Home / Applications | Application tile dashboard, enabled apps, learning center |
| Admin Settings | Cluster settings, group management, storage classes, hardware profiles, BYON images, connection types |
| Doc | Description |
|---|---|
| Backend Overview | Authentication strategies, proxy/pass-through architecture, k8s integration, service account calls, environment config |
| Doc | Description |
|---|---|
| Operator Architecture | CRD design, reconciliation pipeline, module registry, dependency resolution, manifest management, local development, cluster deployment, troubleshooting |
| Controller AGENTS.md | Go operator conventions, controller-runtime patterns, CRD types, Makefile targets, reconciliation pipeline |
| Doc | Description |
|---|---|
| Core BFF AGENTS.md | Core BFF development guide — contract-first workflow, BFF rules, frontend rules, deployment modes, testing |
| Core BFF Frontend Docs | Frontend dev setup, testing, and styling guides |
| Core BFF BFF Docs | Go BFF documentation |
| Core BFF OpenAPI Spec | OpenAPI specification (contract-first source of truth) |
| Base Distribution README | App shell setup, dev environment, environment variables |
| Doc | Description |
|---|---|
| Model Registry | Model Registry UI — canonical doc (replaces deprecated frontend area); upstream Go BFF, model versioning |
| Model Serving | Model Serving UI — canonical doc (replaces deprecated frontend area); KServe/ModelMesh runtimes |
| KServe | KServe-specific serving package; InferenceService CRDs, serving runtime management |
| AutoML | AutoML pipeline optimization; Go BFF; Kubeflow Pipelines orchestration |
| AutoRAG | Automated RAG configuration optimization; Go BFF; three deployment modes |
| Eval Hub | Model evaluation hub; Go BFF; eval metrics; model-registry integration |
| Gen AI | Gen AI / LLM chatbot package; Go BFF with MCP/LSD clients; model serving interactions |
| MaaS | Model as a Service; Material UI (Kubeflow); Go BFF; LLM endpoint management |
| MLflow | MLflow experiment tracking integration; experiment/run browsing UI |
| MLflow Embedded | Embedded MLflow UI variant; Module Federation config |
| Model Training | Training job management; pipeline integration; resource configuration |
| Notebooks | Notebook management package; workbenches frontend area interactions |
| Observability | Embedded Perses dashboards for metrics and monitoring; DSCI-gated visibility, SAR-based RBAC, embeddable API |
| Feature Store | Feature store management UI; dataset versioning; see also README and AGENTS.md |
| LLMD Serving | LLM-dedicated serving; interactions with gen-ai frontend area |
| Doc | Description |
|---|---|
| App Config | Shared runtime and build-time configuration utilities |
| ESLint Config | Shared ESLint rules and configurations |
| ESLint Plugin | Custom ESLint plugin rules |
| Jest Config | Shared Jest test runner configurations |
| Plugin Core | Core plugin infrastructure and extension-point definitions |
| Plugin Template | Starter template for new modular packages |
| TSConfig | Shared TypeScript compiler configurations |