Overhaul desktop/laptop platform docs: platform-specific guides for m…#19101
Overhaul desktop/laptop platform docs: platform-specific guides for m…#19101AlannaBurke wants to merge 3 commits into
Conversation
…acOS, Linux, Windows
- 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
🔗 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 SEVsThere are 1 currently active SEVs. If your PR is affected, please view them below: ❌ 2 New Failures, 2 Unrelated FailuresAs of commit f394e11 with merge base eef7921 ( 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. |
This PR needs a
|
|
Hi @AlannaBurke! Thank you for your pull request. We require contributors to sign our Contributor License Agreement, and yours needs attention. You currently have a record in our system, but the CLA is no longer valid, and will need to be resubmitted. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
Summary
Refocuses the Desktop & Laptop Platform section on native execution across
macOS, Linux, and Windows. Replaces thin
{include}wrappers and a duplicatelanding 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
macosCMake preset.
docs/source/desktop-linux.md— Linux guide covering prerequisites(supported distros, compiler requirements), XNNPACK and OpenVINO backends,
and build steps using the
linuxCMake 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-cardOS 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 sectiondescription 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 theplatform guides.
platforms-desktop.md— Duplicate of the landing page; removed.What's Sourced
All content is derived directly from the authoritative ExecuTorch source docs:
using-executorch-building-from-source.mdbackends/coreml/coreml-overview.mdbackends/mps/mps-overview.mdbackends/xnnpack/xnnpack-overview.mdbuild-run-openvino.mdusing-executorch-building-from-source.md