Clean up a few more doc sections and links #8672
Conversation
GregoryComer
requested review from
shoumikhin,
kirklandsign,
mergennachin and
SS-JIA
as code owners
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/8672
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. |
facebook-github-bot
added
the
CLA Signed
GregoryComer
force-pushed
the
more-doc-updates
branch
from
37b1ecc to
7ee7942
Compare
|
|
||
| ## Runtime Integration | ||
|
|
||
| To run the model on-device, use the standard ExecuTorch runtime APIs. See [Running on Device](getting-started.md#running-on-device) for more information. | ||
|
|
There was a problem hiding this comment.
In this section, (maybe as a follow-up), please remember to add an example CMake file and c++ example runner code that uses XNNPACK (our current xnnpack_runner is too tied our repo, so not that one)
On top of that, we can also add to pytorch-labs/executorch-examples to showcase how it is used from out-of-tree repo.
There was a problem hiding this comment.
I added the CMake example here: #8730. I'll take the examples as the runner examples as a follow-up task.
|
Are the links fixed in https://github.com/pytorch/executorch/tree/executorch-just-works/examples/xnnpack? I think bunch of links that has "stable/..." will stop working on the next release I think it makes sense to move from hard-coded "stable/..." prefix to relative path, at least for the links you changed and modify the link name accordingly. There are a few https://github.com/search?q=repo%3Apytorch%2Fexecutorch%20stable%2F&type=code |
Good point on the stable docs. Those don't show up as warnings in the doc build, which I've been relying on to catch broken links. I'll see if I can replace all of the stable links with relative links. |
|
@mergennachin Thinking more about the stable links, this is a little tricky. Relative paths don't work as well, since the readmes are hosted in the repo, not in the docs. I did fix the remaining couple of stable links in the docs, though. If I change the readme links now, it will break the nightly docs. I'm kind of wondering if we either (a) fix them immediately prior to 0.6 release, or (b) set up redirects for the moved pages. I'm leaning towards (b). I'm tracking here: #8728, and I added to the 0.6 milestone. I'll figure out a solution before 0.6 release. |
GregoryComer
force-pushed
the
more-doc-updates
branch
from
7ee7942 to
a195551
Compare
GregoryComer
merged commit c0b6b23
into
pytorch:executorch-just-works
Clean up a few more broken links and sections in new doc flow
* New Getting Started documentation (#8179) WIP New getting started * Update documentation flow and add placeholders (#8287) Add placeholder top-level doc pages * Add new export + lowering docs, update getting started (#8412) Write new top-level export and lowering documentation * More doc placeholders (#8523) * Move cmake and faq docs to new location * Rename CMake build to Building from Source * Move backend docs to new locations (#8413) * Temporarily remove new backend pages * Move backend docs to new locations * Update backend titles and inline contents * Backend doc template (#8524) Add backend template, update XNNPACK docs * Add runtime integration documentation (#8516) Add runtime integration doc * Move iOS docs to top, add Android placeholders (#8511) * Temporarily remove using-executorch-ios.md * Move Apple runtime docs to new location * Clean up documentation placeholders and links, add top-level docs for C++ APIs, Android, and troubleshooting (#8618) * Clean up getting-started.md, remove placeholders * Move Android pre-built AAR info into top-level Android page * Add placeholder backend overview * Add placeholder troubleshooting docs * Populate top-level C++ API doc * Clean up additional doc placeholders and fix broken links * Add env setup instructions for source build * Fix getting started code snippet (#8637) Fix quotes in getting started code snippets * Clean up a few more doc sections and links (#8672) Clean up a few more broken links and sections in new doc flow * Fix QNN link, typo (#8729) * Add a CMake snippet to the XNNPACK backend doc build section (#8730) Add CMake example to xnnpack backend doc
Summary
Clean up a few remaining placeholders, orphaned pages, and broken links.
Test plan
Built docs locally to verify changes.