Add a more prominent link to the guide #524
Merged
Conversation
This file contains 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
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.
ghost
added
the
|
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.
People will click Guide expecting step-by-step installation / project creation instructions.
There was a problem hiding this comment.
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.
Much better. Let’s also rename How Do I... below section into User Guide for consistency.
There was a problem hiding this comment.
Good idea. Renamed now.
|
Thx |
stayradiated
pushed a commit
to stayradiated/create-react-app
that referenced
this pull request
Sep 7, 2016
* 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
feiqitian
pushed a commit
to feiqitian/create-react-app
that referenced
this pull request
Oct 25, 2016
* 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
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.