Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide template as strictdoc .sdoc file #147

Open
fkromer opened this issue Jan 3, 2022 · 5 comments
Open

Provide template as strictdoc .sdoc file #147

fkromer opened this issue Jan 3, 2022 · 5 comments

Comments

@fkromer
Copy link

fkromer commented Jan 3, 2022

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
Copy link
Member

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

@fkromer
Copy link
Author

fkromer commented Jan 3, 2022

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
Copy link
Member

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
Copy link
Author

fkromer commented Jan 3, 2022

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
Copy link
Member

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants