Skip to content

[CDKv2GA]: READMEs for alpha modules #16567

@njlynch

Description

@njlynch

For alpha modules, we are generating and including the L1s for the alpha modules in aws-cdk-lib. However, we are not currently generating READMEs for these modules, so when visiting the module overview page, an ugly "This module does not have a README" message is displayed. Instead, we should generate a "default" README, like the current cfn-only modules.

Screen Shot 2021-09-21 at 10 07 58

Metadata

Metadata

Assignees

Labels

aws-cdk-libRelated to the aws-cdk-lib packagedocumentationThis is a problem with documentation.effort/smallSmall work item – less than a day of effortin-progressThis issue is being actively worked on.p1

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions