Skip to content

docs: remove unused warnOldDocs.js and projectSpecificFooter template - #3547

Merged
pjfanning merged 1 commit into
apache:mainfrom
pjfanning:remove-warn-old-docs-js
Sep 18, 2026
Merged

pjfanning merged 1 commit into
apache:mainfrom
pjfanning:remove-warn-old-docs-js

Conversation

@pjfanning

Copy link
Copy Markdown
Member

Motivation

docs/src/main/paradox/assets/js/warnOldDocs.js is the Akka-era "you are reading an old version of the docs" banner script. It is dead code:

  • Its only reference is docs/src/main/paradox/_template/projectSpecificFooter.st, a footer hook from Akka's own Paradox theme. The pekko-theme-paradox page.st/footer.st templates never include projectSpecificFooter, so no generated page loads the script. The published site confirms this: https://pekko.apache.org/docs/pekko/current/index.html only loads the theme's scripts, though the unused .js file is still copied into the site as a static asset.
  • Even if loaded, it fetches //pekko.io/versions.json, which does not exist (pekko.io does not resolve; pekko.apache.org/versions.json is a 404), so the banner logic is a no-op.
  • Its URL parsing assumes Akka's <project>/<version>/ path layout and does not match /docs/pekko/<version>/.

None of the other Pekko repos (pekko-http, pekko-connectors, pekko-grpc, pekko-persistence-jdbc, pekko-management) carry this file.

Modification

Delete warnOldDocs.js and _template/projectSpecificFooter.st (both directories are now empty and removed).

Result

Unused docs assets are gone. Generated docs are unchanged apart from no longer shipping the unused script.

Tests

  • Not run locally - docs only; relying on the CI docs build.

References

None - cleanup of unused Akka-era docs assets.

Motivation:
warnOldDocs.js is the Akka-era "old docs version" banner script. It is
only referenced from _template/projectSpecificFooter.st, a footer hook
that the pekko-theme-paradox page templates never include, so no
generated page loads the script (confirmed on the published site). Even
if it were loaded, it fetches //pekko.io/versions.json, which does not
exist, and its URL parsing does not match the /docs/pekko/<version>/
layout.

Modification:
Delete docs/src/main/paradox/assets/js/warnOldDocs.js and
docs/src/main/paradox/_template/projectSpecificFooter.st.

Result:
Dead docs assets are gone; generated docs are unchanged apart from no
longer shipping the unused script.

Tests:
- Not run locally - docs only; CI builds the docs

References:
None - cleanup of unused Akka-era docs assets

@raboof raboof left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a bit sad (we're still publishing old versions of the docs, e.g. https://pekko.apache.org/docs/pekko/1.6.0/ , and it's nice to point people to the latest version), but better to clean it up (and potentially resurrect later) than to leave it broken

@pjfanning
pjfanning merged commit 1f573c9 into apache:main Sep 18, 2026
10 checks passed
@pjfanning
pjfanning deleted the remove-warn-old-docs-js branch September 18, 2026 13:47
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