Skip to content

Overhaul desktop/laptop platform docs: platform-specific guides for m…#19101

Open
AlannaBurke wants to merge 3 commits intopytorch:mainfrom
AlannaBurke:desktop-platform-overhaul
Open

Overhaul desktop/laptop platform docs: platform-specific guides for m…#19101
AlannaBurke wants to merge 3 commits intopytorch:mainfrom
AlannaBurke:desktop-platform-overhaul

Conversation

@AlannaBurke
Copy link
Copy Markdown
Contributor

Summary

Refocuses the Desktop & Laptop Platform section on native execution across
macOS, Linux, and Windows. Replaces thin {include} wrappers and a duplicate
landing page with clear, platform-specific guides grounded in the official
ExecuTorch source docs.

Changes

New Files (3 )

  • docs/source/desktop-macos.md — macOS guide covering prerequisites
    (Xcode, macOS version requirements), Apple Silicon vs Intel considerations,
    all three backends (Core ML, MPS, XNNPACK), and build steps using the macos
    CMake preset.
  • docs/source/desktop-linux.md — Linux guide covering prerequisites
    (supported distros, compiler requirements), XNNPACK and OpenVINO backends,
    and build steps using the linux CMake preset.
  • docs/source/desktop-windows.md — Windows guide covering prerequisites
    (Visual Studio 2022 + Clang-CL), the critical symlinks setup step, XNNPACK
    and OpenVINO backends, and WSL as an alternative.

Modified Files (2)

  • docs/source/desktop-section.md — Overhauled landing page with a 3-card
    OS selector grid, a backend-by-platform support table, and a clean toctree
    pointing to the three new platform guides.
  • docs/source/edge-platforms-section.md — Updated Desktop section
    description to reflect the new platform-specific structure.

Deleted Files (6)

  • desktop-backends.md — Replaced by the three platform-specific guides.
  • desktop-coreml.md, desktop-mps.md, desktop-xnnpack.md, desktop-openvino.md
    Thin {include} wrappers removed; content is now properly linked from the
    platform guides.
  • platforms-desktop.md — Duplicate of the landing page; removed.

What's Sourced

All content is derived directly from the authoritative ExecuTorch source docs:

  • System requirements and OS versions from using-executorch-building-from-source.md
  • CoreML requirements from backends/coreml/coreml-overview.md
  • MPS requirements from backends/mps/mps-overview.md
  • XNNPACK target requirements from backends/xnnpack/xnnpack-overview.md
  • OpenVINO setup from build-run-openvino.md
  • CMake presets from using-executorch-building-from-source.md

Manus Agent added 2 commits April 22, 2026 01:11
- Bump header_links_before_dropdown from 8 to 9 so all nav items
  display without overflow into a More dropdown
- Remove shared docs (using-executorch-cpp, building-from-source,
  raspberry_pi_llama_tutorial) from desktop-section toctree so
  Sphinx assigns them to their primary section, fixing missing
  left sidebar on those pages
- Desktop section now owns only the three platform guides
@pytorch-bot
Copy link
Copy Markdown

pytorch-bot Bot commented Apr 23, 2026

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/19101

Note: Links to docs will display an error until the docs builds have been completed.

❗ 1 Active SEVs

There are 1 currently active SEVs. If your PR is affected, please view them below:

❌ 2 New Failures, 2 Unrelated Failures

As of commit f394e11 with merge base eef7921 (image):

NEW FAILURES - The following jobs have failed:

BROKEN TRUNK - The following jobs failed but were present on the merge base:

👉 Rebase onto the `viable/strict` branch to avoid these failures

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Apr 23, 2026
@github-actions
Copy link
Copy Markdown

This PR needs a release notes: label

If your change should be included in the release notes (i.e. would users of this library care about this change?), please use a label starting with release notes:. This helps us keep track and include your important work in the next release notes.

To add a label, you can comment to pytorchbot, for example
@pytorchbot label "release notes: none"

For more information, see
https://github.com/pytorch/pytorch/wiki/PyTorch-AutoLabel-Bot#why-categorize-for-release-notes-and-how-does-it-work.

@AlannaBurke AlannaBurke marked this pull request as ready for review April 24, 2026 04:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant