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. Learn more →
Top 23 Ruby Documentation Projects
-
Project mention: Zeal is an offline documentation browser for software developers | news.ycombinator.com | 2023-05-31
-
-
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-15changelog-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-17If Maths is important to you, take a look at Asciidoc - https://asciidoctor.org/
-
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
-
Project mention: Is there a way to easily autogenerate API documentation for a Ruby on Rails API? | reddit.com/r/rails | 2023-01-10
-
-
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
-
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.
-
-
-
-
-
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.
-
-
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.
-
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-02Hello 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.
diaspora/diaspora_federation
-
-
-
-
-
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.
Ruby Documentation related posts
- Devdocs.io Is Looking for Maintainers
- Xeme: I'd value your opinion on my new Ruby gem
- 7 Useful Resources for Web Developers
- I spent the past 3 months working on a fork of the Annotate models gem
- Good software/SaaS for Technical Documentation CMS
- Offline DB Copy for Accessing in PWA?
- Programming types and mindsets
-
A note from our sponsor - InfluxDB
www.influxdata.com | 1 Jun 2023
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 |