Add FAQs and Common Issues doc page #7547
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/7547
Note: Links to docs will display an error until the docs builds have been completed. ⏳ No Failures, 1 PendingAs of commit c3b6b81 with merge base 4796da7 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
added
the
CLA Signed
mergennachin
reviewed
Jan 8, 2025
malfet
reviewed
Jan 8, 2025
| # FAQs and Common Issues | ||
|
|
||
| This page summarizes frequently asked questions and provides guidance on issues that commonly occur when adopting ExecuTorch. | ||
|
|
There was a problem hiding this comment.
Can you also remind the user to check https://github.com/pytorch/executorch/issues and https://github.com/pytorch/executorch/discussions
There was a problem hiding this comment.
Good idea. I will add that as a follow-up today.
mergennachin
approved these changes
Jan 30, 2025
dbort
reviewed
Jan 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add "FAQs and Common Issues" page to the ExecuTorch docs. This summarizes common issues that we've seen when users adopt ExecuTorch, as well as trends I've found looking through the last 6 months of GitHub and Meta-internal questions and issues.
I've tentatively put this under the Getting Started section, as that seems like the most reasonable place to put it, but I'm open to suggestions.
Test plan
New doc page preview: https://docs-preview.pytorch.org/pytorch/executorch/7547/getting-started-faqs.html.
For some reason, the doc job doesn't seem to re-run when updating the PR. I've re-build locally to check.