Add docs badge to README #22
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update the URL of the docs badge to include it from inch-ci.org instead of inch-pages.github.io (the former being the successor of the Inch Pages project). [ci skip]
|
I updated the badge in this PR to now link to Inch CI, the successor of the Inch Pages project. The status page now is http:https://inch-ci.org/github/mmozuras/pronto It is a web-service based on Inch that lets people lint and show off their inline docs (as opposed to a static website served via GitHub Pages). What do you think? |
|
@rrrene I think it's interesting enough to try and see what happens 😄 Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi Mindaugas,
this patch adds a docs badge to the README to show off inline-documentation to the casual visitor:
The badge links to Inch Pages, a project that tries to raise the visibility of documentation in Ruby projects. The status page for Pronto is http:https://inch-pages.github.io/github/mmozuras/pronto/
Inch Pages is still in it's infancy, but already used by projects like Guard, Haml, Pry, and Libnotify.
What do you think?