-
-
Notifications
You must be signed in to change notification settings - Fork 26.8k
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 more prominent link to the guide #524
Conversation
As a contributor, I know where to find the documentation/guide since know the codebase, but I've seen people miss the link to it in the README, because it's not very prominent. Let's try to make it more discoverable by including a link to it right on top of the page.
The guide itself is very comprehensive and useful, so I want people to find it easily. |
@@ -2,6 +2,9 @@ | |||
|
|||
Create React apps with no build configuration. | |||
|
|||
* [Getting Started](#getting-started) | |||
* [Guide](https://github.com/facebookincubator/create-react-app/blob/master/template/README.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
People will click Guide expecting step-by-step installation / project creation instructions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you're right. What about this:
- Getting Started – How to create a new app.
- Usage Guide – How to develop apps bootstrapped with Create React App.
@@ -2,6 +2,9 @@ | |||
|
|||
Create React apps with no build configuration. | |||
|
|||
* [Getting Started](#getting-started) – How to create a new app. | |||
* [User Guide](https://github.com/facebookincubator/create-react-app/blob/master/template/README.md) – How to develop apps bootstrapped with Create React App. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Much better. Let’s also rename How Do I...
below section into User Guide
for consistency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea. Renamed now.
Thx |
* Add a more prominent link to the guide As a contributor, I know where to find the documentation/guide since know the codebase, but I've seen people miss the link to it in the README, because it's not very prominent. Let's try to make it more discoverable by including a link to it right on top of the page. * Make the wording of links more obvious * Rename the "How Do I...?" section to "User Guide" for consistency
* Add a more prominent link to the guide As a contributor, I know where to find the documentation/guide since know the codebase, but I've seen people miss the link to it in the README, because it's not very prominent. Let's try to make it more discoverable by including a link to it right on top of the page. * Make the wording of links more obvious * Rename the "How Do I...?" section to "User Guide" for consistency
As a contributor, I know where to find the documentation/guide since know the codebase, but I've seen people miss the link to it in the README, because it's not very prominent. Let's try to make it more discoverable by including a link to it right on top of the page.