sord VS rubydoc.info

I tend to follow along using the YardDoc comment style. It has many small things I love about it; an example is when yardoc is followed it can be used to generate RBS/Sorbet type files with the sord gem, you can also generate application documents similar to rdoc/sdoc.

You may be interesting in checking out the Sord gem. If you do YARDOC based comments and documentation in your code not only does it make your code pretty easy to understand. But you can also generate Sorbet RBI and Ruby RBS files based off of your documentation. It's pretty much a require in any new project I start working with.

I love using yard as well and if you use it you can use sord and based on you yard annotates it'll build sorbet types for your code. I've used it on my last few projects and it's helped building your types setup amazingly easy.

Sord was originally developed to generate Sorbet type signature files from YARD comments. Sorbet is a type checking system developed by Stripe, and it does not use anything specific to Ruby 3 but is instead a custom DSL for defining types. However, Sord has recently been upgraded to support generation of RBS files (Ru*by **Signature*). This means that instead of having to write all your Ruby 3 type signature files by hand (which are standalone—Ruby 3 doesn't support inline typing in Ruby code itself), you can write YARD comments—just like with Solargraph—and autogenerate the signature files.

Why isn't anyone talking about Sord?? I see that as being a great solution. https://github.com/AaronC81/sord#example

Go for both until things evolve : https://github.com/AaronC81/sord

Yes, I use rubydoc.info to refer to the docs for gems, didn't realize until now that it also includes documentation for Ruby itself. Thanks!

GitHub will render markdown (and other formats), but I don't believe it supports parsing and rendering YARD or RDoc. Both tools ship with tools that generate documentation websites that you can use for your project. YARD also has https://rubydoc.info

Right now, gemdocs.org is very similar to rubydoc.info as it both uses YARD, with rubydoc.info supporting custom YARD plugins for gems (which might make some gem output look better if they specify said plugins). I have some ideas for improving Ruby documentation in general, so I've been trying to not add too much functionality to YARD as I might be trying to pivot back to RDoc.

The experiment is: can I pre-generate and store the docs forever? Everyone is probably going to say sure, stick them on S3 and forget about it. But how does that get funded? Who is going to pay for that? rubydoc.info is hosted via sponsorship.

rubydoc.info is supported by one person and is open-source. Care to report the problems here: https://github.com/docmeta/rubydoc.info ?