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 more prominent link to the guide #524

Merged
merged 3 commits into from
Aug 31, 2016
Merged

Conversation

fson
Copy link
Contributor

@fson fson commented Aug 31, 2016

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.

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 ghost added the CLA Signed label Aug 31, 2016
@fson
Copy link
Contributor Author

fson commented Aug 31, 2016

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)
Copy link
Contributor

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.

Copy link
Contributor Author

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.
Copy link
Contributor

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. Renamed now.

@gaearon gaearon merged commit 364392b into facebook:master Aug 31, 2016
@gaearon
Copy link
Contributor

gaearon commented Aug 31, 2016

Thx

@fson fson deleted the patch-1 branch August 31, 2016 13:58
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
@lock lock bot locked and limited conversation to collaborators Jan 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants