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.

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

Add a "how to use" section #45

Closed
lucasbento opened this issue Jul 2, 2019 · 10 comments
Closed

Add a "how to use" section #45

lucasbento opened this issue Jul 2, 2019 · 10 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@lucasbento
Copy link
Member

Feature Request

Working on facebook/react-native-website#1063 I noticed that we lack a "getting started"/"how to use" guide for the user to know what to do once they land on the page.

Why it is needed

So it's more clear to the user what they need to do with that beautiful diff that's showing in their browser.

Possible implementation

A button with a ? icon that opens a modal with some nice content about how to upgrade using Upgrade Helper, content can be based on facebook/react-native-website#1063.

@lucasbento lucasbento added enhancement New feature or request good first issue Good for newcomers labels Jul 2, 2019
@kelset
Copy link
Member

kelset commented Jul 2, 2019

Yeah, this sounds like a good approach - probably just a few lines explaining👍

@KevinHu2014
Copy link
Contributor

Could I have this one :)

By the way, Where should this button belongs?
Will it be nice if placing it besides the Github star badge button?

A button with a ? icon that opens a modal with some nice content about how to upgrade using Upgrade Helper

@lucasbento
Copy link
Member Author

@KevinHu2014: of course!

I was thinking more like putting it on the top right of the container, something like here:

Screenshot 2019-07-03 at 09 52 50

But I suppose it would also look nice close to the star button, any of the two solutions would work well in my opinion.

@lucasbento lucasbento added the help wanted Extra attention is needed label Aug 20, 2019
@KevinHu2014
Copy link
Contributor

Sorry I forgot this one. 😓

@lucasbento Shall we discuss the short version content of "How to use" first?
And since #91 (comment), the how to button still goes to top right of the container right?

@vinnyA3
Copy link
Collaborator

vinnyA3 commented Aug 25, 2019

Hi @KevinHu2014

I think the top right corner is a nice position. It can go right next to the settings button. What do you think @lucasbento?

@lucasbento
Copy link
Member Author

I think the top right corner is a nice position. It can go right next to the settings button. What do you think @lucasbento?

Oh yeah, definitely agree with this!

I would start doing this after #91 is merged, @KevinHu2014.

@KevinHu2014
Copy link
Contributor

#91 has been merged.

@lucasbento Maybe we can start discussing the short version content of "How to use"

@pvinis
Copy link
Member

pvinis commented Oct 11, 2019

The talk is out where I explain how to use this. Should we link to that? 😬

@kelset
Copy link
Member

kelset commented Oct 11, 2019

100% :)

@lucasbento
Copy link
Member Author

The talk is out where I explain how to use this. Should we link to that? 😬

Would be nice!

@KevinHu2014: you can also use https://facebook.github.io/react-native/docs/upgrading#upgrade-helper as reference.

@kulyk kulyk mentioned this issue May 17, 2020
1 task
@pvinis pvinis closed this as completed Nov 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

5 participants