Everyday Rails

Articles tagged documentation

Generating application documentation in Rails 5

Support for generating an HTML version of application documentation in Rails 5 was removed. Here's how to add it back. (March 01, 2017)

Improving Rails application documentation

I've been thinking about how to improve the quality of Rails code bases through better documentation practices. Here are some steps I'm taking in my own projects. (April 18, 2016)

3 Rails documentation tools

Even in Rails, documenting your code is important. It's also pretty easy with these tools. (October 16, 2010)

Black lives matter.

I stand with the Black community against systemic racism, police violence and brutality, intolerance, and hate in the United States and worldwide. We must all demand better from our leaders, and ourselves. Stop tolerating intolerance.

While you're here, please consider making a donation to Black Girls CODE, who do great, important work to provide opportunity to underprivileged girls interested in tech, or any organization working toward equity and safety for all, not just the privileged. Thank you.

Test with confidence!

If you liked my series on practical advice for adding reliable tests to your Rails apps, check out the expanded ebook version. Lots of additional, exclusive content and a complete sample Rails application.

Newsletter

Ruby on Rails news and tips, and other ideas and surprises from Aaron at Everyday Rails. Delivered to your inbox on no particular set schedule.