structurizr / java

Structurizr for Java
https://docs.structurizr.com/java
Apache License 2.0
1.01k stars 288 forks source link

Documentation : Auto generate elements tables #322

Closed arnaudroubinet closed 2 months ago

arnaudroubinet commented 2 months ago

Description

Most of the time in our documentation, we want to list elements we describe with a table format. Unless I've missed something, today I have to describe the elements twice, in the documentation and in the dsl file.

To illustrate my point, here's an example :

        my_software = softwareSystem "My super software with a wonderful and explicit name"{
                super_container = container "A super container"{
                    technology "A wonderful one"
                    tags tag_1 tag_2
                }
                super_container2 = container "Another super container"{
                    technology "A wonderful one"
                    tags tag_2 tag_3
                }
               ...
        }

I would like structurizr to generate the following markdown.

Container technology tags
A super container A wonderful one tag_1 tag_2
Another super container A wonderful one tag_2 tag_3

...

Of course, it would be perfect if we could define the columns to be displayed and potentially the order, filter on tags, etc.

In this way, we only need to describe the element once for the entire documentation.

Priority

I have no budget and there's no rush, please add this feature for free

More information

No response

arnaudroubinet commented 2 months ago

Probably not the good repository ?