[Docathon] Fix docathon content issues#19444
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/19444
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: ❌ 1 New Failure, 6 Unrelated FailuresAs of commit a99414a with merge base e25369b ( NEW FAILURE - The following job has failed:
FLAKY - The following jobs failed but were likely due to flakiness present on trunk:
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. |
|
Hi @ozgecinko! Thank you for your pull request and welcome to our community. Action RequiredIn 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. 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! |
|
@pytorchbot label "docathon-2026" |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
|
@pytorchbot label "release notes: none" |
|
This PR only changes documentation files, including documentation text under XNNPACK, so I believe these CI failures are unrelated to the doc changes. Could someone please rerun the failed jobs or help clarify whether any action is needed from my side? @psiddh @mergennachin |
The failed CI jobs are unrelated to the ongoing changes |
|
Rebasing the PR now. Overall the changes lgtm |
5938045 to
a99414a
Compare
|
@claude review the doc changes |
|
Claude finished @psiddh's task in 1m 56s —— View job Documentation Review
Overall this is a solid documentation cleanup PR. The changes fix real broken references and improve content clarity. Here's my detailed review: Wrapper pages (desktop-coreml, desktop-mps, embedded-arm-ethos-u, android-samsung-exynos) ✅All four wrapper pages correctly point to the actual backend overview files that exist in the repo. The old targets ( Removed tutorial index pages ✅Deleting Heading fix in
|
|
Thanks for the PR, @ozgecinko! Just wanted to confirm few of the changes with the file owners, such as the deprecation details in the API Life Cycle table and Backend Dialect for Export IR. |
| ## Backend Dialect | ||
|
|
||
| See this [doc](compiler-backend-dialect.md) | ||
| Backend dialect is the optional, target-aware stage after Edge dialect. It is |
There was a problem hiding this comment.
The content looks accurate to me. It lines up with what we have in the existing docs, so no concerns from me.
psiddh
left a comment
There was a problem hiding this comment.
I will go over this change one more time before +1
| </td> | ||
| <td>Stable | ||
| </td> | ||
| <td> |
There was a problem hiding this comment.
we need to take a closer look at this table and see if it helps the doc readers now that we are refactoring ...
The other way could be to leave the changes of this file as-is as before.
Will lean on @GregoryComer for some feedback here
There was a problem hiding this comment.
Sure, the live version is a bit unclear. Content-wise, I think having extra column is good. We maybe can do some formatting updates to de-clutter the page. I'd lean slightly towards dropping the two "All" rows, but I don't feel strongly about it. I don't have any blocking concerns.
Summary
Fixes #19258
Updated several documentation pages from the docathon issue:
quantize_typo in XNNPACK quantization docs.visualize.md.Test plan
git diff --check.rg.cc @mergennachin @AlannaBurke @digantdesai @freddan80 @per @zingo @oscarandersson8218 @mansnils @Sebastian-Larsson @robell @rascani