Skip to content

docs: fix 15 broken relative links across four READMEs - #79

Open
bcfmtolgahan wants to merge 1 commit into
aws-samples:mainfrom
bcfmtolgahan:docs/fix-broken-relative-links
Open

bcfmtolgahan wants to merge 1 commit into
aws-samples:mainfrom
bcfmtolgahan:docs/fix-broken-relative-links

Conversation

@bcfmtolgahan

Copy link
Copy Markdown

Issue #, if available: n/a

Description

Three unrelated path errors leave 15 markdown links pointing at files that do not exist. On GitHub and on any case-sensitive filesystem these render as 404s, which cuts readers off from the reference documents the skills load at runtime.

File Problem
aws-managed-definitions/README.md The two portfolio readiness links omit the -analysis suffix the actual files carry (portfolio-modernization-readiness.md vs portfolio-modernization-readiness-analysis.md).
community-sourced-transformations/jboss-to-springboot/README.md 12 links use References/ while the tracked directory is references/. These resolve on case-insensitive filesystems (macOS, Windows) but 404 on GitHub and on Linux.
community-sourced-transformations/kubernetes-readiness-migration/README.md Links java-maven-patterns.md, which was renamed to java-jvm-patterns.md. SKILL.md already uses the new name, so only the README lagged behind.

The directory trees in the same files are updated to match. No other content was touched.

Testing

Walked every tracked .md file, extracted each relative markdown link (after stripping fenced and inline code), and resolved it against git ls-files — case-sensitively, so the macOS filesystem cannot mask the References/ mismatch.

  • Before: 16 broken links
  • After: 1

The one remaining is scaled-execution-containers/README.md -> docs/PUBLIC_ECR.md. I left it alone deliberately: that file was never committed, so it needs content rather than a path correction. Happy to open a separate issue for it if useful.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Three unrelated path errors leave 15 markdown links pointing at files
that do not exist. On GitHub and on any case-sensitive filesystem these
render as 404s, cutting readers off from the reference documents the
skills load at runtime.

- aws-managed-definitions/README.md: the two portfolio readiness links
  omit the "-analysis" suffix the actual files carry.
- community-sourced-transformations/jboss-to-springboot/README.md: 12
  links use "References/" while the tracked directory is "references/".
  These resolve on case-insensitive filesystems (macOS, Windows) but
  404 on GitHub and Linux.
- community-sourced-transformations/kubernetes-readiness-migration/README.md:
  links java-maven-patterns.md, which was renamed to java-jvm-patterns.md.
  SKILL.md already uses the new name, so only the README lagged.

The directory trees in the same files are updated to match.

Verified by walking every tracked .md file and resolving each relative
link against "git ls-files" (case-sensitive, so the macOS filesystem
cannot mask the References/ mismatch). Before: 16 broken links.
After: 1, scaled-execution-containers/README.md -> docs/PUBLIC_ECR.md,
left untouched because that file was never committed and needs content
rather than a path correction.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant