Skip to content

Removal of documentation section (title)? #200

@dirkgroot

Description

@dirkgroot

Hi @simonbrowndotje,

Following the latest couple of releases, I have a question about the support for documentation sections.

In version 1.22.1, you removed the title argument from the Section constructor. In the release notes you suggest that the title is unused. In the release notes for version 1.22.3 you seem to suggest that documentation sections will be removed altogether.

The removal of the title from documentation sections is a breaking change for Structurizr Site Generatr, as we use it for links to documentation sections in the menu, and in the "Documentation" overview for a software system (example).

Removal of documentation sections entirely would be a breaking change as well, because we would either have to remove the documentation feature from the site generator, or find another way to include documentation in the generated site.

So my question is: Could you clarify what your plans are, regarding support for documentation in Structurizr?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions