Document modules with YARD or as README.MD
AFAIK, forge.puppetlabs.com only renders the
readme.md along the module description. However, I've noticed there's something in the works: There was a
puppetlabs/strings module, which now is a Ruby gem. And in the long run puppet module documentation is done via YARD documentation strings.
That's great. However, I haven't found any clue, that PuppetForge goes along with this development and respects YARD documentation strings. Do I write my module documentation still as
readme.md for now, or should I switch to YARD? How long does it take, until YARD documentation is propagated as new standard?
Because, I don't like to document, publish my great module, and some months later Forge considers YARD documentation, too. On the other, a YARD only documented module doesn't “sell”, since it's got a pretty empty
readme.md. I'd place a hint “I did a great job with YARD”, but it doesn't show up on the module description page on Forge. ☹