Merge updated documentation into master #8638
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/8638
Note: Links to docs will display an error until the docs builds have been completed. ⏳ No Failures, 38 PendingAs of commit 03e724c with merge base 84273f4 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
added
the
CLA Signed
GregoryComer
added
release notes: misc
GregoryComer
force-pushed
the
executorch-just-works
branch
from
831f3ee to
ace450d
Compare
|
I think when you moved/renamed a page, there are some references in the repo and doc that is now broken: Here's an example: https://github.com/search?q=repo%3Apytorch%2Fexecutorch%20build-run-mps&type=code Can you double check all the existing references to the links are not broken by searching "git grep"? |
|
Chatted offline, Gregory is doing a few necessary changes in #8672 before merging into main |
GregoryComer
requested review from
shoumikhin and
kirklandsign
as code owners
|
@mergennachin I've hopefully addressed the remaining items. I've created a follow-up task on the stable docs issue (#8728), since it's slightly tricky. Any additional requests before approving this PR? Thanks! |
|
Make sure to resolve conflict with #8690 during rebase |
WIP New getting started
Add placeholder top-level doc pages
Write new top-level export and lowering documentation
* Move cmake and faq docs to new location * Rename CMake build to Building from Source
* Temporarily remove new backend pages * Move backend docs to new locations * Update backend titles and inline contents
Add backend template, update XNNPACK docs
Add runtime integration doc
* Temporarily remove using-executorch-ios.md * Move Apple runtime docs to new location
… 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 quotes in getting started code snippets
Clean up a few more broken links and sections in new doc flow
Add CMake example to xnnpack backend doc
GregoryComer
force-pushed
the
executorch-just-works
branch
from
bcec8f6 to
03e724c
Compare
Summary
This PR brings the updated documentation flow from the executorch-just-works branch into master. This is part of a larger effort (#8048 and #8391) to overhaul the ET documentation, with a focus on improving the content, conciseness, and overall documentation flow. The initial work for this effort has been done on a branch, to avoid breaking the nightly docs while we make larger changes. The overall documentation on the branch is now in a sufficiently mature state that we can move back to working on master as we continue to fill out and refine the documentation.
Test plan
The constituent commits were reviewed on the executorch-just-works branch. I've also locally built the documentation to verify that content and formatting appear correct.
cc @mergennachin @byjlw