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 link to documentation in README #495

Merged
merged 1 commit into from
Jan 21, 2022
Merged

Add a link to documentation in README #495

merged 1 commit into from
Jan 21, 2022

Conversation

alkino
Copy link
Member

@alkino alkino commented Jan 21, 2022

Fix #493

@@ -5,6 +5,8 @@
[![Doxygen -> gh-pages](https://github.com/BlueBrain/HighFive/workflows/gh-pages/badge.svg)](https://BlueBrain.github.io/HighFive)
[![codecov](https://codecov.io/gh/BlueBrain/HighFive/branch/master/graph/badge.svg?token=UBKxHEn7RS)](https://codecov.io/gh/BlueBrain/HighFive)

Documentation: https://bluebrain.github.io/HighFive/
Copy link
Member

Choose a reason for hiding this comment

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

I think all this could be phrased nicer, but maybe we should give the README a holistic make-over some time later. Having the link in plain sight is a better than having to decipher which badge to click, though.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, I saw the badge but it seems me complicate to see and understand you should click on it to see the documentation

@alkino alkino merged commit e6b24e2 into master Jan 21, 2022
@alkino alkino deleted the add_link_doc branch January 21, 2022 10:55
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.

Add a link to the documentation in README.md
2 participants