Add docs badge to README #404
I would like to propose a docs badge for Elixir projects. Since Elixir declared documentation to be a "first class citizen" and I already had created Inch for Ruby, I decided to try to implement "inline-docs linting" for Elixir as well.
The idea is to show to potential contributors that a lib/package is documented and to inspire people starting with Elixir to follow suit. The badge links to Inch CI, a project that tries to raise the visibility of inline-docs to encourage aspiring programmers to document their code. Inch CI is still relatively new (4 months old), but it is already relatively succesful (badges used by 300+ Ruby projects including Guard, Haml, Pry, ROM, and Sass).
Please understand this not as "I built something, now use it!" but rather a call for discussion. I made a functioning prototype implementation of this (as the badge shows), but I want to emphazise the "prototype" part. There is no well-thought-out UI or workflow for you to add your own projects (yet) and the evaluation criteria are up for discussion as well as any other design choices I made.
@ALL: What do you think? Let's talk!
@josevalim It does and I was actually thinking about changing that. But this is a good example of why I wanted to start a discussion with you guys:
In the above made-up example: Should it be transitive and hide the complete
Btw, you should also skip the modules which are an implementation of a protocol. Similar to how we do here: https://github.com/elixir-lang/ex_doc/blob/master/lib/ex_doc/retriever.ex#L205
Here are other functions you should skip too: https://github.com/elixir-lang/ex_doc/blob/master/lib/ex_doc/retriever.ex#L119-L137