Support rendering with comments and notes - unified documentation concept

[kapinnow]

Documentation can be added in various ways in various places as specific elements like comment and notes object, but also as documentation or comments in properties and as additional objects (adoc). However, the notation and the support for text formats seems different all the time.
While adoc supports a lot of formatting (which however lacks wysiwyg), the notes in state machines allows font and colour effects (but not on single words but on the entire object) whereas comments do not admit any formatting at all. And the documentation does not reveal easily on how to come up with a properly configured whole documentation for a project.
A sound concept is needed that unifies the approaches to generate a clean and nice documentation for whole models (including application objects and sub projects).

[deyabhik]

Hi @kapinnow ,

I really like your proposal.
Having a dedicated chapter in user manual to showcase all the capabilities makes so much sense. 👍
Having a consistent formatting approach is important.
Will take this to the backlog.

For adoc editor support you can try the asciidoctor eclipse plugin from marketplace, vscode with asiidoc extension or closes to best wyswig experience is asciidocfx.

Keep the good ideas coming in.

Best Wishes
ASCET Team

[kapinnow]

the ascidoctor plugin seems to have an issue with images

[deyabhik]

Hi Kai,

Use ./images instead of images and it works. Both are syntactically correct.
We will fix the product example for next iteration.

BR
Abhik

[kapinnow]

thank you, that was it!