Skip to content

(stack): (header tag breaking jsii-doc) #28897

Open
@automartin5000

Description

@automartin5000

Describe the issue

The header tags in this inline documentation are breaking jsii-docgen generated docs because they're being added as H2 tags on pages where they should probably H4 (if even headers at all). I know this isn't necessarily an AWS CDK issue, but if the header tags aren't really needed, it seems like an easy fix to remove it.

I mean does this really need to be H2? 😅

Links

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugThis issue is a bug.documentationThis is a problem with documentation.effort/mediumMedium work item – several days of effortp3

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions