Inch
Annotate
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.
Annotate
-
Must-have gems for mature Rails
gem "annotate" - https://github.com/ctran/annotate_models | Adds DB-schema comments to models. May be unnecessary on RubyMine, YMMW.
-
I spent the past 3 months working on a fork of the Annotate models gem
I believe Ctran is aware of this based on his response in this issue https://github.com/ctran/annotate_models/issues/913
-
What was the name of the gem that finds all unindexed foreign keys?
A gem that's pretty useful alongside this one is the annotation gem -- it prefixes models with their specific schema dump (as comments) and then updates those descriptive comments on migration. It's one of my go-to gems to install when I rotate onto a new-to-me Rails project (or start a new one) and I'm working to understand the data model.
- Cansado de conferir o schema.rb
-
Could really use some help with a plugin rake task issue
Have you looked at annotate for inspiration?
-
The database and migrations work is annoying me the most about Rails as a newcomer, am I missing something?
I get it, though. Sounds like you're used to seeing every column definition in there. And that would be handy. There is a gem that you might like: https://github.com/ctran/annotate_models
-
Rails application boilerplate for fast MVP development
annotate for annotations
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
RDoc - RDoc produces HTML and online documentation for Ruby projects.
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.
grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
Hanna - RDoc generator designed with simplicity, beauty and ease of browsing in mind
rspec_api_documentation - Automatically generate API documentation from RSpec
Doctor