Inch
rspec_api_documentation
Our great sponsors
| Inch | rspec_api_documentation | |
|---|---|---|
| 1 | - | |
| 519 | 1,439 | |
| - | 0.0% | |
| 5.7 | 0.0 | |
| 4 months ago | 9 months ago | |
| Ruby | Ruby | |
| MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Inch
-
Ask HN: How do you upskill your teams technical writing?
As a 20+-year full-stack veteran (and once-upon-a-time English major), I second this. Even the best writers in literature had editors.
To gamify documentation and review, add a static analyzer that measures documentation coverage to CI. Not sure what your stack is, but for Ruby one I've had success with was Inch: https://github.com/rrrene/inch.
rspec_api_documentation
We haven't tracked posts mentioning rspec_api_documentation yet.
Tracking mentions began in Dec 2020.
What are some alternatives?
YARD - YARD is a Ruby Documentation tool. The Y stands for "Yay!"
Apipie - Ruby on Rails API documentation tool
Apidoco - Ruby on Rails API documentation tool
grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API
Asciidoctor - :gem: A fast, open source text processor and publishing toolchain, written in Ruby, for converting AsciiDoc content to HTML 5, DocBook 5, and other formats.
RDoc - RDoc produces HTML and online documentation for Ruby projects.
Doctor
Hanna - RDoc generator designed with simplicity, beauty and ease of browsing in mind
Annotate - Annotate Rails classes with schema and routes info