Skip to content

[DOC] Fix outdated version-pinned doc URLs#19325

Open
XAheli wants to merge 2 commits intopytorch:mainfrom
XAheli:fix/update-outdated-doc-links
Open

[DOC] Fix outdated version-pinned doc URLs#19325
XAheli wants to merge 2 commits intopytorch:mainfrom
XAheli:fix/update-outdated-doc-links

Conversation

@XAheli
Copy link
Copy Markdown

@XAheli XAheli commented May 6, 2026

Summary

Replace version-pinned GitHub blob/tree URLs (specific commit hashes and release/0.4, release/0.6, release/1.0, release/1.2 branches) with /main/ references across 10 doc files. Update docs.pytorch.org/executorch/0.4/ URL to use /stable/. Update all line number anchors to match the current main branch.

Fixes #19257

Test plan

  • All 29 updated URLs verified to return HTTP 200 via curl
  • All file paths confirmed to exist on main locally
  • All 21 line number references verified to point to the correct code (class/function definitions)
  • lintrunner -a passes with no lint issues

cc @mergennachin @AlannaBurke @digantdesai @freddan80 @per @zingo @oscarandersson8218 @mansnils @Sebastian-Larsson @robell

Copilot AI review requested due to automatic review settings May 6, 2026 06:28
@XAheli XAheli requested a review from mergennachin as a code owner May 6, 2026 06:28
@pytorch-bot
Copy link
Copy Markdown

pytorch-bot Bot commented May 6, 2026

🔗 Helpful Links

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

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

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

@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented May 6, 2026

Hi @XAheli!

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!

@github-actions github-actions Bot added the module: arm Issues related to arm backend label May 6, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

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.

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

This PR updates ExecuTorch documentation to remove outdated, version-pinned GitHub URLs (commit hashes and release branches) in favor of main references, and refreshes line anchors / docs-site version links so references remain accurate on the current codebase.

Changes:

  • Replace pinned github.com/pytorch/executorch blob/tree links with .../main/... across multiple docs.
  • Update various GitHub line-number anchors to current main locations.
  • Update an old docs.pytorch.org/executorch/0.4/... reference to the stable docs site.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
docs/source/using-executorch-android.md Update workflow link for AAR generation to point at main.
docs/source/compiler-memory-planning.md Update greedy memory-planning implementation link to main with a refreshed line anchor.
docs/source/compiler-custom-compiler-passes.md Refresh main links/anchors for pass/partitioner references (ExecuTorch + PyTorch).
docs/source/bundled-io.md Update example-runner links from release branches to main (with anchors preserved).
docs/source/backends/xnnpack/xnnpack-partitioner.rst Update XNNPACK partitioner/config links from release/0.6 to main and adjust anchors.
docs/source/backends/nxp/nxp-partitioner.rst Update NXP Neutron links from release/1.2 to main.
docs/source/backends/nxp/nxp-overview.md Update NXP example script link from release/1.0 to main.
docs/source/backends/arm-ethos-u/arm-ethos-u-troubleshooting.md Update bundled-io docs link from a versioned docs path to stable.
docs/source/backends-qualcomm.md Update Qualcomm backend links from pinned commit trees to main.
docs/source/api-life-cycle.md Update PyTorch/ExecuTorch example links to main with refreshed anchors.
Comments suppressed due to low confidence (2)

docs/source/api-life-cycle.md:111

  • There is an unmatched closing </ul> tag inside this table cell (no <ul> exists anywhere in the file). This produces invalid HTML and can break rendering in some doc toolchains. Please remove the stray </ul> (or add the missing opening tag if a list is intended).
Use <code>.. warning::</code> in the docstrings of deprecated and experimental
APIs. See
<a href="https://github.com/pytorch/pytorch/blob/main/torch/nn/utils/stateless.py#L176">example
usage</a>.

</ul>
   </td>

docs/source/api-life-cycle.md:124

  • There is an unmatched closing </ul> tag in this table cell (no <ul> exists in the file). Please remove this stray closing tag (or add the missing opening tag) to keep the generated HTML valid.
Use the <code>ET_DEPRECATED</code> annotation macro. See <a href="https://github.com/pytorch/executorch/blob/main/runtime/executor/program.h#L92">example usage</a>.

<p>
<p>
Use the <code>ET_EXPERIMENTAL</code> annotation macro.
</ul>
   </td>

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


- ``configs``: Control which operators are delegated to XNNPACK. By default, all available operators all delegated. See `../config/__init__.py <https://github.com/pytorch/executorch/blob/release/0.6/backends/xnnpack/partition/config/__init__.py#L66>`_ for an exhaustive list of available operator configs.
- ``config_precisions``: Filter operators by data type. By default, delegate all precisions. One or more of ``ConfigPrecisionType.FP32``, ``ConfigPrecisionType.STATIC_QUANT``, or ``ConfigPrecisionType.DYNAMIC_QUANT``. See `ConfigPrecisionType <https://github.com/pytorch/executorch/blob/release/0.6/backends/xnnpack/partition/config/xnnpack_config.py#L24>`_.
- ``configs``: Control which operators are delegated to XNNPACK. By default, all available operators all delegated. See `../config/__init__.py <https://github.com/pytorch/executorch/blob/main/backends/xnnpack/partition/config/__init__.py#L76>`_ for an exhaustive list of available operator configs.

This section lists the Edge operators supported by the Neutron backend.
For detailed constraints of the operators see the conditions in the ``is_supported_*`` functions in the `Node converters <https://github.com/pytorch/executorch/blob/release/1.2/backends/nxp/neutron_partitioner.py#L202>`_
For detailed constraints of the operators see the conditions in the ``is_supported_*`` functions in the `Node converters <https://github.com/pytorch/executorch/blob/main/backends/nxp/neutron_partitioner.py#L202>`_
Comment thread docs/source/backends-qualcomm.md Outdated

### Debugging tips
- Before trying any complicated models, try out [a simple model example](https://github.com/pytorch/executorch/tree/f32cdc3de6f7176d70a80228f1a60bcd45d93437/examples/qualcomm#simple-examples-to-verify-the-backend-is-working) and see it if works one device.
- Before trying any complicated models, try out [a simple model example](https://github.com/pytorch/executorch/tree/main/examples/qualcomm#simple-examples-to-verify-the-backend-is-working) and see it if works one device.
Comment thread docs/source/bundled-io.md Outdated
### Runtime Example

Please checkout our [example runner](https://github.com/pytorch/executorch/blob/release/0.6/examples/devtools/README.md#bundledprogram) for a bundled program. You could run these commands to test with the BundledProgram binary (`.bpte`) file you generated in the previous step:
Please checkout our [example runner](https://github.com/pytorch/executorch/blob/main/examples/devtools/README.md#bundledprogram) for a bundled program. You could run these commands to test with the BundledProgram binary (`.bpte`) file you generated in the previous step:
class is used by
the partitioner to determine if a specific node in the graph belongs in the
partition. This is done by overriding the `is_node_supported` function. You can
chain multiple `OperatorSuppportBase` by using
@XAheli
Copy link
Copy Markdown
Author

XAheli commented May 6, 2026

@pytorchbot label "module: doc"

@pytorch-bot pytorch-bot Bot added the module: doc Issues related to documentation, both in docs/ and inlined in code label May 6, 2026
@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented May 6, 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 6, 2026
@XAheli XAheli changed the title [DOCS] Fix outdated version-pinned doc URLs [DOC] Fix outdated version-pinned doc URLs May 6, 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. module: arm Issues related to arm backend module: doc Issues related to documentation, both in docs/ and inlined in code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Outdated versions in links on ET Doc page

3 participants