docs(aws-cdk-lib): remove duplication of main docs #35229
Merged
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
rix0rrr
approved these changes
Aug 13, 2025
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Comments on closed issues and PRs are hard for our team to see. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 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.
Issue # (if applicable)
n/a
Reason for this change
The core docs currently shown in the API Reference (as of before this PR is merged), is the one at packages/aws-cdk-lib/README.md and not 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 we enforced both files to have the have the same content, but this got lost in the big repo remodel of 2023.
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
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license