Fix dead REST API and libp2p documentation links - #11268
Merged
lucassaldanha merged 2 commits intoSep 14, 2026
Merged
lucassaldanha merged 2 commits into
lucassaldanha merged 2 commits into
Conversation
The REST API reference link pointed at the retired consensys.github.io/teku GitHub Pages site instead of docs.teku.consensys.io. The multiaddr glossary link in the beacon REST API field descriptions also 404s now that libp2p's docs moved from docs.libp2p.io to libp2p.io/docs. Point both at their current locations.
lucassaldanha
force-pushed
the
worktree/rapid-forest-ed1e
branch
from
September 14, 2026 02:55
fe62db7 to
491db6c
Compare
lucassaldanha
enabled auto-merge (squash)
September 14, 2026 02:56
lucassaldanha
merged commit Sep 14, 2026
2f84943
into
Consensys-Incorporated:master
93 checks passed
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 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.
PR Description
A user reported the Teku REST API reference link in our README was pointing at the old GitHub Pages site. While fixing it we audited other doc links in the repo for the same class of problem.
Changes
README.mdand.openapidoc/README.mdathttps://docs.teku.consensys.io/reference/restinstead of the retiredhttps://consensys.github.io/teku/.[Read more]link in the beacon REST API field descriptions (GetIdentity,GetPeers,Peerserializer, and their test fixtures), which 404s now that libp2p's docs moved fromdocs.libp2p.iotolibp2p.io/docs. Points it atlibp2p.io/docs/addressing/, which documents multiaddrs on the new site.We checked every other
consensys.github.io/pegasys.github.ioanddocs.teku.consensys.ioreference in the repo plus the other external doc/community links (Hyperledger wiki, Discord, Docker Hub, libp2p, Kurtosis, Groovy, Renovate); nothing else was dead.Fixed Issue(s)
Documentation
doc-change-requiredlabel to this PR if updates are required.Changelog
Note
Low Risk
Documentation and OpenAPI description text only; no runtime API or networking behavior changes.
Overview
Updates broken documentation URLs so README and OpenAPI-related text point at live sites.
Teku REST API:
README.mdand.openapidoc/README.mdnow link tohttps://docs.teku.consensys.io/reference/restinstead of the retired GitHub Pages URLhttps://consensys.github.io/teku/.libp2p multiaddr help links: Beacon REST schema descriptions for
p2p_addresses,discovery_addresses, andlast_seen_p2p_addressnow usehttps://libp2p.io/docs/addressing/instead of the olddocs.libp2p.ioglossary anchor. The same string updates appear inGetIdentity,GetPeers, thePeerserializer, and matching integration-test JSON fixtures so generated OpenAPI stays aligned.Reviewed by Cursor Bugbot for commit 8d1061e. Bugbot is set up for automated code reviews on this repo. Configure here.