Skip to content

docs: fix broken source links (1.4.x) - #1335

Merged
pjfanning merged 1 commit into
apache:1.4.xfrom
pjfanning:docs-fix-source-links-1.4.x
Oct 9, 2026
Merged

pjfanning merged 1 commit into
apache:1.4.xfrom
pjfanning:docs-fix-source-links-1.4.x

Conversation

@pjfanning

Copy link
Copy Markdown
Member

Motivation

The Route TestKit page linked to directive test sources under akka/... paths that do not exist in this repository, and the Java marshalling docs showed a leftover TODO linking to pekko-http issue 1367, which does not exist (the TODO referred to akka/akka-http#1367). Found while reviewing #1334.

Modification

  • routing-dsl/testkit.md: point the examples links at http-tests/src/test/{scala,java}/org/apache/pekko/http/....
  • common/marshalling.md: remove the stale TODO.

Result

The source links in the docs resolve.

Tests

  • Checked every @github link under docs/src/main/paradox against the 1.4.x tree; these were the only broken ones
  • Not built locally: 1.4.x docs need JDK 8, which is not installed; relying on CI

References

Note: scripts/link-validator.conf ignores all https://github.com/ URLs, so @github source links are not validated in CI.

Motivation:
The testkit page linked to directive test sources under akka/...
paths that do not exist in this repository, and the Java marshalling
docs showed a leftover TODO linking to pekko-http issue 1367, which
does not exist (the TODO referred to akka/akka-http#1367).

Modification:
Point the testkit links at the org/apache/pekko test source paths and
remove the stale TODO.

Result:
The source links in the docs resolve.

Tests:
- Checked every @github link under docs/src/main/paradox against the
  1.4.x tree; these were the only broken ones
- Not built locally: 1.4.x docs need JDK 8, which is not installed

References:
None
@pjfanning pjfanning added this to the 1.4.2 milestone Oct 8, 2026
@pjfanning
pjfanning merged commit f45c043 into apache:1.4.x Oct 9, 2026
10 checks passed
@pjfanning
pjfanning deleted the docs-fix-source-links-1.4.x branch October 9, 2026 08:07
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.

2 participants