Skip to content

[Docs] Fix broken {include} paths rendering 3 empty pages (desktop-coreml, desktop-mps, embedded-arm-ethos-u) #19445

@AswaniSahoo

Description

@AswaniSahoo

📚 The doc issue

Three documentation pages render as completely empty pages (no title, no content) on the live docs site because their {include} directives reference files that don't exist.

Affected pages:

Page Live URL Status
desktop-coreml.md desktop-coreml.html Empty (<no title>)
desktop-mps.md desktop-mps.html Empty (<no title>)
embedded-arm-ethos-u.md embedded-arm-ethos-u.html Empty (<no title>)

Root cause: When backend docs were reorganized from flat files (e.g. backends-coreml.md) into subdirectories (e.g. backends/coreml/coreml-overview.md), these three platform-specific redirect pages were not updated. They still include files at the old flat paths, which no longer exist.

User impact: The Quick Start Pathway Backend Selection Guide table links directly to desktop-coreml (for Desktop → Apple Silicon) and embedded-arm-ethos-u (for Embedded → Arm Cortex-M / Ethos-U). Users following the Quick Start guide land on blank pages — a broken first-time experience.

Suggest a potential alternative/fix

Fix the include paths to point to the correct files. The working equivalents (ios-coreml.md, ios-mps.md, embedded-arm-cortex-m.md) already use the correct paths:

# desktop-coreml.md
-```{include} backends-coreml.md
+```{include} backends/coreml/coreml-overview.md

# desktop-mps.md
-```{include} backends-mps.md
+```{include} backends/mps/mps-overview.md

# embedded-arm-ethos-u.md
-```{include} backends-arm-ethos-u.md
+```{include} backends/arm-ethos-u/arm-ethos-u-overview.md

cc @mergennachin @AlannaBurke

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions