search

arc42 / arc42-template

arc42 - the template for software architecture documentation and communication
https://arc42.org
Other
1.02k stars 178 forks source link

Provide template as strictdoc .sdoc file #147

Open fkromer opened 2 years ago

fkromer commented 2 years ago

To help people getting started with strictdoc and arc42 it could be helpful to provide the arc42 template as .sdoc file (english version only) or several files (all languages). There are rst templates in different languages on the download site already which could easily be convert into .sdoc files (SDoc syntax). For an examplary SDoc file refer to the docs/specification of strictdoc.

rdmueller commented 2 years ago

Hm. This would be a manual conversion, wouldn't it?

fkromer commented 2 years ago

StrictDoc has a custom grammar defined here and documented here. A lot of content is reST however. Nevertheless writing a conversion script would be quite some effort I guess.

rdmueller commented 2 years ago

currently the different versions of the arc42 template are autogenerated through https://github.com/arc42/arc42-generator/blob/master/subBuild.gradle .

In case of strictdoc, I understand that we need a manual conversion. In this case, the right way to provide it would be to copy one of the templates, convert it to strictdoc and provide a demo. Can you provide this?

fkromer commented 2 years ago

currently the different versions of the arc42 template are autogenerated through https://github.com/arc42/arc42-generator/blob/master/subBuild.gradle .

I'm not experienced in Groovy. For me it's not possible to contribute something for auto-generating a template.

In case of strictdoc, I understand that we need a manual conversion. In this case, the right way to provide it would be to copy one of the templates, convert it to strictdoc and provide a demo. Can you provide this?

It's quite likely that I need an arc42 template for StrictDoc in the future. I'll contribute something in case I do.

rdmueller commented 2 years ago

If you can describe how a tempalte can be autogenerated throug a conversion, I can implement this step.

I'll contribute something in case I do.

that's great!