Repository navigation
Migrate the compare hub decision tree to the unified Mermaid design system - #367
Conversation
…ystem Convert the Quick Decision Guide from graph TD with legacy classDef colors to flowchart TD with question decisions, labeled exits and a start terminal, so the shared site renderer owns its look. The tree now covers the hardware and performance choice its intro sentence describes.
|
👋 Hello @glenn-jocher, thank you for submitting a
For more guidance, please refer to our Contributing Guide. Don't hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! 🚀 |
UltralyticsAssistant
left a comment
There was a problem hiding this comment.
🔍 PR Review
Made with ❤️ by Ultralytics Actions
Reviewed the Quick Decision Guide diagram migration in docs/en/compare/index.md. The revised cascade is consistent with the guidance on the page and removes the legacy styling as intended. LGTM.
|
Excited to see this PR merged—thank you, @glenn-jocher! The streamlined decision cascade guides readers through existing pipelines, deployment hardware, and accuracy priorities, while reducing the diagram’s measured width from 1,377 px to 437 px.
|
Migrates the one Mermaid diagram in this repo to the unified Ultralytics Mermaid design system. The site renderer (ultralytics/portal#4537) now owns all diagram colors and styles, so content sets none and uses shape, order and layout to carry meaning.
What changed
The Quick Decision Guide on
docs/en/compare/index.mdusedgraph TD, legacy:::start/:::decide/:::outclasses with hardcodedclassDefcolors, Title Case labels, and-- "text" -->edge labels. It rendered 1377 px wide.It is now a
flowchart TDcascade:([Define project needs])start terminal, with each outcome also a([ ])terminal{Existing YOLO11 pipeline?}: yes leads to YOLO11, matching the page's guidance that YOLO11 suits existing pipelines{Edge or mobile?}: yes leads to YOLO26n or YOLO26s{Accuracy first?}: yes leads to YOLO26l or YOLO26x, no leads to YOLO26mThe separate "Specialized Features" branch (NMS-free, multitask, video) is removed. Its leaves all resolve to YOLO26, the YOLO26 section below already covers them, and the diagram's intro sentence describes a hardware and performance choice.
docs/en/compare/index.mdThe remaining WARN is width only. A decision tree with four outcomes and labeled exits cannot fit 395 px with the site config. Listing
yesfirst at every decision keeps the reading order consistent; the narrowest exit ordering tested (430 px) mixes sides for a 7 px gain. Lint findings: none.🛠️ PR Summary
Made with ❤️ by Ultralytics Actions
🌟 Summary
The Quick Decision Guide now uses an unstyled
flowchart TDcascade, relying on node shapes and decision order instead of diagram-specific colors and classes.📊 Key Changes
graph TD,classDefstyles, and labeled-edge syntax with terminal-shaped start and outcome nodes andyes/noexits.🎯 Purpose & Impact