PkgTemplates.jl icon indicating copy to clipboard operation
PkgTemplates.jl copied to clipboard

suggestion: add doc template with DIVIO organization

Open lmiq opened this issue 1 year ago • 2 comments

Many people has praised the way this site suggests organizing software documentation: https://documentation.divio.com/

Maybe it would be nice if the template generated by PkgTemplates created a structured docs following those guidelines, with some simple examples on what each section could contain.

That would be helpful in guiding the process of building structured documentation for new developers.

lmiq avatar Jun 08 '23 14:06 lmiq

I like this idea. I would happily review a PR to change our documentor plug-in to support it as a flag.

oxinabox avatar Jun 08 '23 15:06 oxinabox

Cool. I'll try to draft something asap

lmiq avatar Jun 08 '23 16:06 lmiq