Skip to content

Move link to docs under it's own heading #5720

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

Merged
merged 1 commit into from May 22, 2017
Merged

Move link to docs under it's own heading #5720

merged 1 commit into from May 22, 2017

Conversation

ghost
Copy link

@ghost ghost commented May 22, 2017

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Build-related changes
  • Other, please describe: Update to documentation.

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

Other information:

This PR moves the link to the documentation site under it's own heading in the repo's README.

The reason I submitted this PR is that I often have trouble finding the Vue docs.
When googling I click the Vue github repo link by default.
When landing on the github repo I am confused as to where the docs are.
Currently there is a link to the documentation site, however it is not very noticeable.
In order to make it more noticeable and easier for other developers to find, I have moved the link to the documentation under it's own heading.

This will make it easier for developers to quickly find a link to the Vue documentation from the github repo.

@yyx990803 yyx990803 merged commit 05195b8 into vuejs:dev May 22, 2017
@ghost ghost deleted the feature/add-documentation-heading-to-readme branch May 22, 2017 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant