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

Shorten README.md #154

Merged
merged 5 commits into from
May 10, 2019
Merged

Shorten README.md #154

merged 5 commits into from
May 10, 2019

Conversation

icelynjennings
Copy link
Contributor

Description

Shorten the ReadMe file to accomodate for #114

Motivation and Context

Docs are currently duplicated between our GitHub pages docs and the repo root readme.

  • My change requires a change to the documentation or CHANGELOG.
  • I have updated the documentation/CHANGELOG accordingly.
  • I have created a feature (non-master) branch for my PR.

@icelynjennings icelynjennings requested a review from a team May 9, 2019 14:55
Copy link
Member

@JoelSpeed JoelSpeed left a comment

Choose a reason for hiding this comment

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

One potential improvement as a suggestion below.

Probably also worth adding a changelog entry saying that we have a new live docs site 🎉

README.md Outdated Show resolved Hide resolved
Co-Authored-By: Joel Speed <Joel.speed@hotmail.co.uk>
@icelynjennings icelynjennings requested a review from JoelSpeed May 10, 2019 10:53
CHANGELOG.md Outdated Show resolved Hide resolved
@icelynjennings icelynjennings force-pushed the shorten-readme-gh-pages branch from 6f0f624 to 1f1cc9f Compare May 10, 2019 11:00
@icelynjennings icelynjennings requested a review from JoelSpeed May 10, 2019 11:01
CHANGELOG.md Outdated Show resolved Hide resolved
Co-Authored-By: Joel Speed <Joel.speed@hotmail.co.uk>
@icelynjennings icelynjennings requested a review from JoelSpeed May 10, 2019 11:09
Copy link
Member

@JoelSpeed JoelSpeed left a comment

Choose a reason for hiding this comment

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

LGTM

@icelynjennings icelynjennings merged commit 5d7d0c4 into master May 10, 2019
@icelynjennings icelynjennings deleted the shorten-readme-gh-pages branch May 10, 2019 11:25
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.

2 participants