How do you document your code?

• rswag

  14 1,884 7.8 Ruby

  Seamlessly adds a Swagger to Rails-based API's

  

Using something like rswag will give you some ability, in the specs, to also describe the endpoints and auto-generate some documentation.

• sord

  8 281 4.6 Ruby

  Convert YARD docs to Sorbet RBI and Ruby 3/Steep RBS files

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.

• WorkOS

  workos.com sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• YARD

  18 1,905 6.5 Ruby

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

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.

Suggest a related project