search

structurizr / dsl

Structurizr DSL
https://docs.structurizr.com/dsl
Apache License 2.0
1.41k stars 266 forks source link

Add dsl render github action link to the "Tooling support" section of Readme #141

Closed DenisPalnitsky closed 2 years ago

DenisPalnitsky commented 2 years ago

The title says it all

DenisPalnitsky commented 2 years ago

@simonbrowndotje is there a chance that this PR will be merged?

simonbrowndotje commented 2 years ago

The two links don't provide much information on what the GitHub Action does I'm afraid ... it's not clear how the diagrams are being rendered, and why I'd want to use the action. Better documentation, and perhaps some rendered examples, would help.

deinspanjer commented 2 years ago

This is actually a pretty neat idea. I'd recommend changing the example link in the readme to point at the example repo instead of the README.md of the repo directly as it is easier to understand the scope when presented with a list of the files.

It might be worth also be a bit more clear what it provides with the following change to the description: Instead of Automatically create markdown files from DSL in Github repo. Something like When a C4 DSL file with the configured name is present in a GitHub repo, this action will automatically generate markdown files containing embedded mermaid diagrams for each view specified in the DSL file. This allows you to provide up-to-date diagrams in the documentation of your GitHub repo automatically.