Skip to content

Move backend docs to new locations #8413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

GregoryComer
Copy link
Member

Summary

This PR moves backend docs into their new location under Backends/. This doesn't make any content changes yet, but it done in preparation for doing so.

Test plan

Built docs locally and validated.

Copy link

pytorch-bot bot commented Feb 12, 2025

🔗 Helpful Links

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

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 facebook-github-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 Feb 12, 2025
@GregoryComer GregoryComer marked this pull request as ready for review February 12, 2025 13:57
@GregoryComer GregoryComer changed the title BuiltMove backend docs Move backend docs to new locations Feb 12, 2025
@mergennachin
Copy link
Contributor

Have you done git mv command? It seems like you did copy and delete?

That way, we can preserve the git history for these files.

Copy link
Contributor

@mergennachin mergennachin left a comment

Choose a reason for hiding this comment

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

Sorry, it's a bit annoying to do this -- but it would be really great to preserve git history with git mv command. This is especially important as these docs are written by our partners.

@GregoryComer
Copy link
Member Author

Sorry, it's a bit annoying to do this -- but it would be really great to preserve git history with git mv command. This is especially important as these docs are written by our partners.

It's a good point. I'll re-do this to make sure history is explicitly maintained.

@GregoryComer GregoryComer merged commit 6310e65 into pytorch:executorch-just-works Feb 18, 2025
28 checks passed
GregoryComer added a commit to GregoryComer/executorch that referenced this pull request Feb 23, 2025
* Temporarily remove new backend pages

* Move backend docs to new locations

* Update backend titles and inline contents
GregoryComer added a commit that referenced this pull request Feb 23, 2025
* Temporarily remove new backend pages

* Move backend docs to new locations

* Update backend titles and inline contents
GregoryComer added a commit that referenced this pull request Feb 26, 2025
* Temporarily remove new backend pages

* Move backend docs to new locations

* Update backend titles and inline contents
GregoryComer added a commit that referenced this pull request Feb 26, 2025
* 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
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants