Recursive import of documentation

[toorog]

Issue

When using the DefaultDocumentationImporter it is not possible to import a folder structure like this:

• docs
  • 01-introduction-and-goals
    • 01-introduction-and-goals.md
    • someAsset.png
    • anotherAsset.png

DefaultDocumentationImporter requires the files to be in the same (flat) directory.

Motivation

I'd like to be able to group assets referenced in a documentation chapter in a folder next to the actual document. This would also enable advanced workflows on Git level (e.g. define a chapter (=folder) owner as default reviewer if a given folder path was changed).

Solution Proposal

Support recursive documentation import in the default importer.

[simonbrowndotje]

Did you try the RecursiveDefaultDocumentationImporter?

[toorog]

I've indeed overlooked that one (since there was no reference here, that there are other ready to use importers available). Thanks for the hint.

How can I change the importer being used when parsing a DSL file via StructurizrDslParser?

I don't want the authors of the DSL file to deal with class names.

[simonbrowndotje]

I don't want the authors of the DSL file to deal with class names.

You have a couple of options:

1. You could copy the code for the importer into a new class that doesn't have a package name, which would allow you to use the following:

!docs docs RecursiveDefaultDocumentationImporter

2. You could build your own fork of the DSL parser that uses a specific documentation importer instead of the default implementation.