docs: fix broken and malformed links in contributing and package docs#38373
Open
ZayanKhan-12 wants to merge 1 commit into
Open
docs: fix broken and malformed links in contributing and package docs#38373ZayanKhan-12 wants to merge 1 commit into
ZayanKhan-12 wants to merge 1 commit into
Conversation
- ROADMAP.md: double-parenthesized issue link rendered broken - CONTRIBUTING.md: nested-bracket [url](...) link rendered as literal text; cloud-assembly-schema CONTRIBUTING link pointed at the old in-repo path (the package moved to the aws-cdk-cli repository) - docs/NEW_CONSTRUCTS_GUIDE.md: bare-domain constructs.dev link resolved as a relative path - assertions/MIGRATING.md: Migration Script link missing the # anchor - cloud-assembly-schema/README.md: schema JSON links pointed at ./schema/, which only exists in the aws-cdk-cli repository Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
🤖 Agent Docs Sync ReminderThis PR modifies human-facing documentation that has corresponding agent-facing docs.
If you consider no agent-facing changes are needed, leave a comment explaining why |
github-actions
Bot
added
agent-docs-review-needed
beginning-contributor
Author
|
Re the Agent Docs Sync Reminder: no agent-facing changes needed — this PR only corrects link targets (typos, moved files) in human-facing docs; no process or content described in |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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)
Closes #38374.
Reason for this change
A mechanical link audit (resolving every relative markdown link against the filesystem, plus malformed-syntax detection) found 7 broken or malformed links in repo and package documentation. Details in the linked issue.
Description of changes
ROADMAP.md—[change]((https://...32010))double parentheses render the link broken → single parenthesesCONTRIBUTING.md—[default in new CDK TS-based apps]([url](https://...7475))nested-bracket link renders as literal text → plain link; the cloud-assembly-schema CONTRIBUTING link points at./packages/@aws-cdk/cloud-assembly-schema/, which no longer exists in this repo (package moved to aws/aws-cdk-cli) → GitHub URLdocs/NEW_CONSTRUCTS_GUIDE.md—[Construct Hub](constructs.dev)bare-domain link resolves as a relative path and 404s →https://constructs.devpackages/aws-cdk-lib/assertions/MIGRATING.md—[Migration Script](migration-script)missing the#anchor for the in-page headingpackages/aws-cdk-lib/cloud-assembly-schema/README.md— two links to./schema/cloud-assembly.schema.json; the schema directory only exists in aws-cdk-cli → GitHub URL (file verified to exist there)Not touched: a CONTRIBUTING.md reference to
tools/@aws-cdk/cdk-build-tools/config/eslintrc.js, which no longer exists — I couldn't determine the successor location with confidence.Describe any new or updated permissions being added
None — documentation only.
Description of how you validated changes
Docs-only; each new target verified to exist (filesystem for relative links, GitHub API for cross-repo links). Re-ran the link audit: no remaining broken links in the touched files.
Checklist
🤖 Generated with Claude Code