Ruby Documentation

Open-source Ruby projects categorized as Documentation

Top 23 Ruby Documentation Projects

  • devdocs

    API Documentation Browser

    Project mention: Zeal is an offline documentation browser for software developers | news.ycombinator.com | 2023-05-31
  • jazzy

    Soulful docs for Swift & Objective-C

  • SonarQube

    Static code analysis for 29 languages.. Your projects are multi-language. So is SonarQube analysis. Find Bugs, Vulnerabilities, Security Hotspots, and Code Smells so you can release quality code every time. Get started analyzing your projects today for free.

  • GitHub Changelog Generator

    Automatically generate change log from your tags, issues, labels and pull requests on GitHub.

    Project mention: Closing a Knowledge Gap: Best Practices for Writing Git Commit Messages | dev.to | 2023-02-15

    changelog-generator

  • 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.

    Project mention: Good software/SaaS for Technical Documentation CMS | reddit.com/r/technicalwriting | 2023-05-17

    If Maths is important to you, take a look at Asciidoc - https://asciidoctor.org/

  • Annotate

    Annotate Rails classes with schema and routes info

    Project mention: I spent the past 3 months working on a fork of the Annotate models gem | reddit.com/r/rails | 2023-05-17

    I believe Ctran is aware of this based on his response in this issue https://github.com/ctran/annotate_models/issues/913

  • Apipie

    Ruby on Rails API documentation tool

    Project mention: Is there a way to easily autogenerate API documentation for a Ruby on Rails API? | reddit.com/r/rails | 2023-01-10
  • Hologram

    A markdown based documentation system for style guides.

  • ONLYOFFICE

    ONLYOFFICE Docs — document collaboration in your environment. Powerful document editing and collaboration in your app or environment. Ultimate security, API and 30+ ready connectors, SaaS or on-premises

  • YARD

    YARD is a Ruby Documentation tool. The Y stands for "Yay!"

    Project mention: Xeme: I'd value your opinion on my new Ruby gem | reddit.com/r/ruby | 2023-05-29

    In addition to project documentation, you've included a lot of code comments. You could adopt a standardized format and use it to generate API documentation. RDoc and YARD are two options. If I were reviewing this code at work, I would probably ask you to remove comments that explain what, not why.

  • jsduck

    Simple JavaScript Duckumentation generator.

  • rspec_api_documentation

    Automatically generate API documentation from RSpec

  • Ronn

    the opposite of roff

  • grape-swagger

    Add OAPI/swagger v2.0 compliant documentation to your grape API

  • RDoc

    RDoc produces HTML and online documentation for Ruby projects.

    Project mention: Xeme: I'd value your opinion on my new Ruby gem | reddit.com/r/ruby | 2023-05-29

    In addition to project documentation, you've included a lot of code comments. You could adopt a standardized format and use it to generate API documentation. RDoc and YARD are two options. If I were reviewing this code at work, I would probably ask you to remove comments that explain what, not why.

  • bluedoc

    An open-source document management tool for enterprise self host.

    Project mention: Any decent Rails + GraphQL repos to look at? | reddit.com/r/rails | 2022-08-03
  • Inch

    A documentation analysis tool for the Ruby language

    Project mention: Ask HN: How do you upskill your teams technical writing? | news.ycombinator.com | 2022-11-30

    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.

  • fab-manager

    Fab-Manager is the FabLab management solution. It provides a comprehensive, web-based, open-source tool to simplify your administrative tasks and your marker's projects.

  • rubychanges

    Comprehensive changelog of Ruby Programming Language

    Project mention: Question about the language (beginner) | reddit.com/r/ruby | 2023-05-08

    If you want to know what Ruby changes, a good reference is Ruby changes

  • allourideas.org

    allourideas allows groups to collect and priorize information in an open, democratic, and efficient process.

    Project mention: 60 Horror Movies in 60 Days - Day 2: Zombeavers (2014) | reddit.com/r/horror | 2022-09-02

    Hello again r/horror! As I said yesterday, I used a Wiki Survey to rank my 100 favorite horror movies. Leading up to Halloween I'm watching my 60 favorite horror movies in order, and providing a brief review/discussion of each one. Obviously there are spoilers ahead. Today's movie is:

  • diaspora_federation

    A library that provides functionalities needed for the diaspora* federation protocol.

    Project mention: My Altweb Journey: Part 0 | dev.to | 2022-07-24

    diaspora/diaspora_federation

  • Apidoco

    Ruby on Rails API documentation tool

  • ansible-doc-generator

    CLI for documenting Ansible roles into Markdown files.

  • Hanna

    RDoc generator designed with simplicity, beauty and ease of browsing in mind

  • docrb

    📖 An opinionated documentation generator for Ruby

  • InfluxDB

    Access the most powerful time series database as a service. Ingest, store, & analyze all types of time series data in a fully-managed, purpose-built database. Keep data forever with low-cost storage and superior data compression.

NOTE: The open source projects on this list are ordered by number of github stars. The number of mentions indicates repo mentiontions in the last 12 Months or since we started tracking (Dec 2020). The latest post mention was on 2023-05-31.

Ruby Documentation related posts

Index

What are some of the best open-source Documentation projects in Ruby? This list will help you:

Project Stars
1 devdocs 31,522
2 jazzy 7,261
3 GitHub Changelog Generator 7,097
4 Asciidoctor 4,373
5 Annotate 4,168
6 Apipie 2,394
7 Hologram 2,159
8 YARD 1,852
9 jsduck 1,501
10 rspec_api_documentation 1,432
11 Ronn 1,326
12 grape-swagger 1,060
13 RDoc 778
14 bluedoc 620
15 Inch 517
16 fab-manager 200
17 rubychanges 172
18 allourideas.org 154
19 diaspora_federation 98
20 Apidoco 73
21 ansible-doc-generator 31
22 Hanna 29
23 docrb 13
Access the most powerful time series database as a service
Ingest, store, & analyze all types of time series data in a fully-managed, purpose-built database. Keep data forever with low-cost storage and superior data compression.
www.influxdata.com