Skip to content

Commit

Permalink
Update wording
Browse files Browse the repository at this point in the history
  • Loading branch information
rrrene committed Feb 23, 2014
1 parent a05cc22 commit f7822ad
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 15 deletions.
2 changes: 1 addition & 1 deletion _layouts/default.html
Expand Up @@ -32,7 +32,7 @@ <h1 class="masthead-title"><em>#</em> Inch</h1>


<div class="container pages-footer">
<h1 class="pages-title"><img src="/public/images/logo.png">nch Pages</h1>
<h1 class="pages-title"><a href="/"><img src="/public/images/logo.png">nch Pages</a></h1>
<small>
built with
<a target="_blank" href="https://pages.github.com/">GitHub Pages</a>,
Expand Down
36 changes: 29 additions & 7 deletions index.html
Expand Up @@ -3,12 +3,32 @@
title: Home
---

<h1 class="pages-title"><img src="/public/images/logo.png">nch Pages</h1>

<div class="repo-wrapper">
<div class="repo-card">
<div class="repo-info">
<h2>What is Inch Pages?</h1>

{% markdown %}
## Documentation badges for Ruby projects ![Inline docs](/public/images/badge-example.png)

### Advantages for maintainers

If you are a gem developer or maintain a library you probably already use badges in your README to show that your tests are passing and your code isn't a horrible mess in need of refactoring.

Now you can also show that you documented your project properly.

[Click here to request a badge for your project](/participate)

### Advantages for developers

If you are a Ruby developer, you know the pain of cloning a project you want to improve just to find out that it is completely undocumented.

Then you have to form the mental equivalent of an AST to comprehend how it all fits together. Wouldn't it be great to see the present level of documentation directly in the README?

<a target="_blank" href="http://twitter.com/intent/tweet?url=http://inch-pages.github.io/&text={{ "Documentation badges for Ruby!" | url_escape }}">Click here to spread the word</a>

## FAQ
{% endmarkdown %}
<h3>What is Inch Pages?</h3>
<p>
This project is an attempt to raise the visiblity of code documentation in Ruby.
It provides <strong>badges to include in your project's README</strong>, to show people that documenting code is a cool thing.
Expand All @@ -19,25 +39,27 @@ <h2>What is Inch Pages?</h1>
<a href="/participate">Get yours!</a>
</p>

<h2>What is Inch?</h1>
<h3>What is Inch?</h3>
<p>
<a target="_blank" href="http://trivelop.de/inch">Inch</a> is a <strong>documentation measurement tool for Ruby</strong> that was created to help people document their code.
It is a command-line utility that gives grades based on how complete the docs are (<a target="_blank" href="http://trivelop.de/inch">screenshots</a>).
</p>

<h2>What is the goal?</h1>
<h3>What is the goal?</h3>
<p>
I really think that posting these badges in a project's README will benefit the project (because <strong>people can see that it's well documented</strong>) and the community by improving the visibility of documentation.
</p>
<p>
Let's start a discussion, let's raise the visibility of documentation, let's talk.
<a target="_blank" href="https://twitter.com/rrrene">Hit me up on Twitter</a> or <a target="_blank" href="{{ site.inch_pages.new_issue_url }}">via issue</a>.
</p>

<h2>Wait, who are you?</h1>
<h3>Wait, who are you?</h3>
<p>
I'm <a target="_blank" href="https://twitter.com/rrrene">@rrrene</a>, creator of <a target="_blank" href="http://github.com/rrrene/sparkr">sparkr</a> and <a target="_blank" href="http://github.com/rrrene/inch">Inch</a>.
</p>
<p>
<a target="_blank" href="https://twitter.com/rrrene">Hit me up on Twitter</a> or <a target="_blank" href="{{ site.inch_pages.new_issue_url }}">create an issue</a> in the Inch Pages project.
</p>
</div>
</div>
</div>
26 changes: 19 additions & 7 deletions participate.html
Expand Up @@ -7,7 +7,7 @@
<div class="repo-wrapper">
<div class="repo-card">
<div class="repo-info">
<h2>How do I get my own badge?</h1>
<h2>How do I get my own badge?</h2>
<p>
To get a badge for your own projects, <a href="{{ site.inch_pages.project_yaml_url }}">edit this file on GitHub</a> and <strong>add your project</strong> in the form <code>username/repo</code>:
</p>
Expand All @@ -18,18 +18,30 @@ <h2>How do I get my own badge?</h1>
<p>
I will in turn send you a pull request with your updated README (and a link to your "Inch Page", so you can check it first).
</p>
<h2>Why is this not an automated service?</h1>
<p>
I would really like this to be one, but unfortunately I'm currently pretty busy (preparing my first teaching assignment). <strong>If this project gains traction, I will work on a web-service</strong> with hooks, oauth et al.
But until then, this solution can help us to raise awareness for good documentation in our projects.
</p>

{% markdown %}
### So is this a fully featured CI service?

No, not yet at least. This is a ***community driven project*** based on GitHub Pages, passion, pull requests and a bit of manual labor on my part.

Inch Pages is a social project at heart.
We can always implement a full-blown web-service after we have convinced a broader audience of the importance of inline documentation.

But for now, the important bits for raising the visibility of code documentation are there: ***badges and status pages***.
{% endmarkdown %}

<p>
So: <a href="{{ site.inch_pages.project_yaml_url }}">add your project!</a> Pull requests are fun!
</p>
<h2>Wait, who are you?</h1>


<h3>Wait, who are you?</h3>
<p>
I'm <a target="_blank" href="https://twitter.com/rrrene">@rrrene</a>, creator of <a target="_blank" href="http://github.com/rrrene/sparkr">sparkr</a> and <a target="_blank" href="http://github.com/rrrene/inch">Inch</a>.
</p>
<p>
<a target="_blank" href="https://twitter.com/rrrene">Hit me up on Twitter</a> or <a target="_blank" href="{{ site.inch_pages.new_issue_url }}">create an issue</a> in the Inch Pages project.
</p>
</div>
</div>
</div>
6 changes: 6 additions & 0 deletions public/css/site.css
@@ -1,6 +1,12 @@
.pages-title {
text-align: center;
}
.pages-title a {
color: inherit;
}
.pages-title a:hover {
text-decoration: none;
}
.pages-title img {
vertical-align: bottom;
opacity: 0.8;
Expand Down

0 comments on commit f7822ad

Please sign in to comment.