yard-activerecord icon indicating copy to clipboard operation
yard-activerecord copied to clipboard

Published 20 hours ago • verified publisher icon theodorton

Examples

Open anthonator opened this issue 10 years ago • 3 comments

It would be great if you could provide some examples of documentation generated with yard-activerecord. I'd like to see what I'm getting into before I commit ; )

anthonator avatar Jan 07 '15 22:01 anthonator

Hi @anthonator

Sorry for not getting back to you earlier.

I think https://github.com/discourse/discourse would be a good candidate as an example project.

We could either:

  1. Generate documentation in markdown format and put it in an examples/discourse-folder in the project
  2. Generate HTML documentation, put it online and add a link to it in the README

What option would you prefer? Any other open source projects that may be good candidates?

theodorton avatar Mar 11 '15 12:03 theodorton

:+1: Anything, really.

dogweather avatar May 15 '15 07:05 dogweather

Piping in and suggesting some more documentation, too. This is a great project and a great augmentation of existing YARD work.

AlexSafatli avatar Jun 24 '15 18:06 AlexSafatli