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

Readme imrovements #2

Merged
merged 2 commits into from
Dec 4, 2019
Merged

Readme imrovements #2

merged 2 commits into from
Dec 4, 2019

Conversation

DavidBarry
Copy link
Contributor

These are a couple minor changes that should help improve the README a bit.

  • I used the appropriate language identifier for code blocks so that you get syntax highlighting on those.
  • I also updated all references to the documentation in the readme to link to a rendered version of it.

For the documentation links I used htmlpreview.github.com to link to the rendered docs instead of the raw html. It seems like setting up GitHub pages to host a set of the docs is probably the better way to go but this will give you a viewable version of the docs in the browser in the meantime.

Let me know if you'd like me to break up this PR. I'd be happy to split these commits out if you don't want everything in this PR.

@claassistantio
Copy link

claassistantio commented Dec 3, 2019

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@michaelbabiy michaelbabiy left a comment

Choose a reason for hiding this comment

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

David, this looks awesome. Thanks!

@michaelbabiy michaelbabiy merged commit 7301d1e into AlaskaAirlines:master Dec 4, 2019
@DavidBarry DavidBarry deleted the readme-imrovements branch December 4, 2019 22:42
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.

4 participants