Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Revamp Getting Started Experience #8048

Open
GregoryComer opened this issue Jan 30, 2025 · 1 comment
Open

Revamp Getting Started Experience #8048

GregoryComer opened this issue Jan 30, 2025 · 1 comment
Assignees
@GregoryComer
Labels
module: doc Issues related to documentation, both in docs/ and inlined in code module: user experience Issues related to reducing friction for users triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module

Comments

@GregoryComer
Copy link
Member

GregoryComer commented Jan 30, 2025 •
edited
Loading

📚 The doc issue

The current Getting Started experience in the documentation leaves a lot to be desired. There are a few major issues I'd like to solve:

  1. Documentation is focused on C++ APIs and building from source. Provide dedicated paths for Android, iOS, and native/C++ runtime.
  2. Android and iOS users don't need to build from source for common use cases. We should ideally cover downloading pre-built binaries in the getting started section. The information is currently somewhat buried in the docs. We should also split out information on building from source.

Suggest a potential alternative/fix

No response

cc @mergennachin @byjlw
@GregoryComer GregoryComer added module: doc Issues related to documentation, both in docs/ and inlined in code module: user experience Issues related to reducing friction for users labels Jan 30, 2025
@GregoryComer GregoryComer self-assigned this Jan 30, 2025
@manuelcandales manuelcandales added the triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module label Jan 30, 2025
@byjlw
Copy link
Contributor

byjlw commented Jan 31, 2025

Yeah, it's the right thing to do. Next step in that direction is building a navigation map. Are you able to draft up one @GregoryComer?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@GregoryComer GregoryComer

Labels
module: doc Issues related to documentation, both in docs/ and inlined in code module: user experience Issues related to reducing friction for users triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
ExecuTorch DevX improvements
Status: To triage
Milestone
No milestone
Development

No branches or pull requests
3 participants
@byjlw @GregoryComer @manuelcandales