Skip to content

docs: Fix inconsistent link paths in backends overview table#19244

Open
AswaniSahoo wants to merge 2 commits intopytorch:mainfrom
AswaniSahoo:fix/backends-overview-link-consistency
Open

docs: Fix inconsistent link paths in backends overview table#19244
AswaniSahoo wants to merge 2 commits intopytorch:mainfrom
AswaniSahoo:fix/backends-overview-link-consistency

Conversation

@AswaniSahoo
Copy link
Copy Markdown

Summary

Fix backend table links in docs/source/backends-overview.md to use relative paths consistently.

Several entries in the backends overview table used absolute paths starting with / (e.g., /backends/cuda/cuda-overview.md) while others used relative paths (e.g., backends/xnnpack/xnnpack-overview.md). Absolute paths can break when the documentation is served from a non-root URL.

This change standardizes all links to use relative paths, consistent with the toctree directives in the same file. Also removes a trailing space in the Vulkan link text.

cc @GregoryComer

Test plan

Verified all target files exist at their relative paths under docs/source/:

  • backends/cuda/cuda-overview.md
  • backends/coreml/coreml-overview.md
  • backends/mps/mps-overview.md
  • backends/vulkan/vulkan-overview.md
  • backends/arm-ethos-u/arm-ethos-u-overview.md
  • backends/arm-cortex-m/arm-cortex-m-overview.md
  • backends/arm-vgf/arm-vgf-overview.md
  • backends/samsung/samsung-overview.md

Fix backend table links to use relative paths consistently. Several
entries used absolute paths (starting with /) while others used relative
paths. Absolute paths can break when the documentation is served from a
non-root URL. This change standardizes all links to use relative paths,
consistent with the toctree directives in the same file.

Also removes a trailing space in the Vulkan link text.
Copilot AI review requested due to automatic review settings May 1, 2026 04:43
@AswaniSahoo AswaniSahoo requested a review from mergennachin as a code owner May 1, 2026 04:43
@pytorch-bot
Copy link
Copy Markdown

pytorch-bot Bot commented May 1, 2026

🔗 Helpful Links

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

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

⚠️ 11 Awaiting Approval

As of commit d2205c7 with merge base 3be4546 (image):

AWAITING APPROVAL - The following workflows need approval before CI can run:

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

@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented May 1, 2026

Hi @AswaniSahoo!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In 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 CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Standardizes backend documentation links in the backends overview table to use relative paths, preventing broken links when the docs are hosted under a non-root base URL.

Changes:

  • Replaced leading-slash (/backends/...) links with relative (backends/...) links in the backends overview table.
  • Removed a trailing space in the “Vulkan” link text.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@AswaniSahoo
Copy link
Copy Markdown
Author

@pytorchbot label "release notes: none"

@pytorch-bot pytorch-bot Bot added the release notes: none Do not include this in the release notes label May 1, 2026
@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented May 1, 2026

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@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 May 1, 2026
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. release notes: none Do not include this in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants