chore: keep core documentation in sync between @aws-cdk/core and aws-cdk-lib #14280
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…cdk-lib Users of CDKv1 use the @aws-cdk/core documentation as the landing point for documentation on core concepts like stacks, durations, references, etc. For CDKv2 users, the same landing point is aws-cdk-lib, which currently has very limited documentation. This change introduces a pkglint rule to keep a subset of the two READMEs in sync. This was chosen over syncing the entire README as the titles, heading, stability markings, etc. needed to be different between the two packages.
|
|
github-actions
bot
added
@aws-cdk/core
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
john-tipper
pushed a commit
to john-tipper/aws-cdk
that referenced
this pull request
May 10, 2021
…cdk-lib (aws#14280) Users of CDKv1 use the @aws-cdk/core documentation as the landing point for documentation on core concepts like stacks, durations, references, etc. For CDKv2 users, the same landing point is aws-cdk-lib, which currently has very limited documentation. This change introduces a pkglint rule to keep a subset of the two READMEs in sync. This was chosen over syncing the entire README as the titles, heading, stability markings, etc. needed to be different between the two packages. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
hollanddd
pushed a commit
to hollanddd/aws-cdk
that referenced
this pull request
Aug 26, 2021
…cdk-lib (aws#14280) Users of CDKv1 use the @aws-cdk/core documentation as the landing point for documentation on core concepts like stacks, durations, references, etc. For CDKv2 users, the same landing point is aws-cdk-lib, which currently has very limited documentation. This change introduces a pkglint rule to keep a subset of the two READMEs in sync. This was chosen over syncing the entire README as the titles, heading, stability markings, etc. needed to be different between the two packages. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 task
mergify bot
pushed a commit
that referenced
this pull request
Aug 13, 2025
### Issue # (if applicable) n/a ### Reason for this change The core docs currently shown in [the API Reference](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib-readme.html) (as of before this PR is merged), is the one at [packages/aws-cdk-lib/README.md](https://github.com/aws/aws-cdk/blob/aaaa9cc330ea1e2854e764e164fe432aeb8606ca/packages/aws-cdk-lib/README.md) and not [packages/aws-cdk-lib/core/README.md](https://github.com/aws/aws-cdk/blob/aaaa9cc330ea1e2854e764e164fe432aeb8606ca/packages/aws-cdk-lib/core/README.md). Both have a lot of duplication, but there is content that has been added to the core README that is missing from the main doc. [A long time ago](#14280) we enforced both files to have the have the same content, but this got lost in the [big repo remodel of 2023](#24376). ### Description of changes I'm removing the core README.md in favor of the top-level one. All missing content has been backported and some additional fixes where made. ### Describe any new or updated permissions being added n/a ### Description of how you validated changes I checked and none of the places we publish to uses the current core README.md. This is because the contents get dropped as part of the jsii compilation and doesn't end up in the jsii assembly. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
djglaser
pushed a commit
to djglaser/aws-cdk
that referenced
this pull request
Aug 13, 2025
### Issue # (if applicable) n/a ### Reason for this change The core docs currently shown in [the API Reference](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib-readme.html) (as of before this PR is merged), is the one at [packages/aws-cdk-lib/README.md](https://github.com/aws/aws-cdk/blob/aaaa9cc330ea1e2854e764e164fe432aeb8606ca/packages/aws-cdk-lib/README.md) and not [packages/aws-cdk-lib/core/README.md](https://github.com/aws/aws-cdk/blob/aaaa9cc330ea1e2854e764e164fe432aeb8606ca/packages/aws-cdk-lib/core/README.md). Both have a lot of duplication, but there is content that has been added to the core README that is missing from the main doc. [A long time ago](aws#14280) we enforced both files to have the have the same content, but this got lost in the [big repo remodel of 2023](aws#24376). ### Description of changes I'm removing the core README.md in favor of the top-level one. All missing content has been backported and some additional fixes where made. ### Describe any new or updated permissions being added n/a ### Description of how you validated changes I checked and none of the places we publish to uses the current core README.md. This is because the contents get dropped as part of the jsii compilation and doesn't end up in the jsii assembly. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Users of CDKv1 use the @aws-cdk/core documentation as the landing point for
documentation on core concepts like stacks, durations, references, etc. For
CDKv2 users, the same landing point is aws-cdk-lib, which currently has very
limited documentation.
This change introduces a pkglint rule to keep a subset of the two READMEs in
sync. This was chosen over syncing the entire README as the titles, heading,
stability markings, etc. needed to be different between the two packages.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license