Documentation Generator

[mvastola]

I really like the documentation on puma.io. Could you share the engine/template/script you use to generate it?

[nateberkopec]

@MSP-Greg has it

[MSP-Greg]

@mvastola

Glad you like it. Much of the code is over ten years old, as I originally wrote back when I had an iPad 2 maybe 2011). Everyone is new at Ruby sometime, and in 2011 and earlier, I was pretty new. Back then, I was mostly coding in C#.

It's essentially an over-the-top plugin for YARD. There is probably a fair bit of code that fixed issues with old versions of RDoc's parser, and YARD's parser/templates. Also, a bit of code for changes to C parsing by YARD.

So, some of the code is so bad I'm embarrassed by it. Rewriting it has been on my list for a while. At that point, I'll probably release it.

More repos are doc'd at https://msp-greg.github.io/

[mvastola]

Ok. I'd love to see it when you're comfortable. (Assuming you wouldn't, in lieu, accept a promise that I won't laugh/judge.)

But yeah, I think your style is more utilitarian than the default without really losing anything else in the exchange.

It's honestly shocking to me how few non-abandonware open-source gems/plugins/templates/etc there are that work to provide or improve ruby documentation.

[mvastola]

Also, over-engineering is an unintentional hobby of mine, so no worries.

[MSP-Greg]

over-engineering

Funny, one issue with Puma is that whatever happens, it should keep running, even restart parts of itself when needed. So...

Re the doc system, actually started it because everything was a PITA on a tablet. And, it really needs a server, it doesn't run very well as static pages.

[mvastola]

And, it really needs a server, it doesn't run very well as static pages.

I mean, I might know a guy who knows a guy who has a server :-p