fix: Links#891
Conversation
There was a problem hiding this comment.
Pull request overview
This PR cleans up documentation links across the repo: replacing hard-coded https://docs.lido.fi/... references with site-relative paths, fixing several stale third-party URLs (Discord invites, Prysm/OffchainLabs, eth-docker, ssv.network, OpenZeppelin, Dappnode, beaconcha.in, research.lido.fi forum slug), and updating one CSM cross-reference to its new location.
Changes:
- Convert absolute
https://docs.lido.fi/...links to relative paths throughoutdocs/andrun-on-lido/. - Update outdated external URLs (Prysm → OffchainLabs, eth-educators → ethstaker, discord.gg → discord.com/invite, OpenZeppelin defender, Dappnode product page, beaconcha.in, etc.).
- Fix a few in-doc cross-references (CSM mev-stealing path, integration guide link, forum topic slug).
Reviewed changes
Copilot reviewed 43 out of 43 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| run-on-lido/stvaults/tech-documentation/tech-design.md | Two docs.lido.fi → relative path conversions. |
| run-on-lido/stvaults/tech-documentation/pdg.md | DSM link relativized. |
| run-on-lido/stvaults/tech-documentation/integration-overview.md | Two link relativizations. |
| run-on-lido/stvaults/features-and-mechanics/parameters-and-metrics.md | Rate-limits link relativized. |
| run-on-lido/stvaults/building-guides/basic-stvault.md | Deployed-contracts links converted to Markdown links. |
| run-on-lido/csm/useful-tools/extra-resources.md | Discord/docs link updates. |
| run-on-lido/csm/troubleshooting/setting-the-fee-recipient-for-csm-validators/*.md | Discord & internal path updates. |
| run-on-lido/csm/troubleshooting/index.md | Discord URL update. |
| run-on-lido/csm/node-setup/DVT-setup/ssv.md | Trailing-slash fix on ssv.network URL. |
| run-on-lido/csm/node-setup/beginner/dappnode.md | Dappnode product URL update. |
| run-on-lido/csm/node-setup/advanced/systemd/method-2-...md | Prysm/OffchainLabs and Discord URL updates. |
| run-on-lido/csm/node-setup/advanced/ethereum-on-arm.md | Ethereum-on-ARM docs URL update. |
| run-on-lido/csm/node-setup/advanced/eth-docker.md | Repo redirect ethstaker/eth-docker. |
| run-on-lido/csm/lido-csm-widget/upload-remove-view-validator-keys.md | beacon chain link to mainnet. |
| run-on-lido/csm/lido-csm-widget/operator-roles.md | Trailing-slash removal. |
| run-on-lido/csm/lido-csm-widget/exiting-csm-validators/exit-using-validator-keystores.md | Prysm URL updates. |
| run-on-lido/csm/index.md | Internal docs link relativized. |
| run-on-lido/csm/alerts-and-monitoring/expert-custom-alerts.md | Forum slug + OZ defender URL updates. |
| run-on-lido/cm-v2/glossary.md | Committee link relativized. |
| run-on-lido/cm-v2/bond-and-key-management.md | VEBO links relativized. |
| docs/token-guides/cross-chain-tokens-guide.md | Multiple link conversions. |
| docs/staking-modules/csm/permissions.md | Forum topic slug update. |
| docs/staking-modules/csm/contracts/CSVerifier.md | consensus-specs branch change (dev → master). |
| docs/security/safeharbor.md | Deployed-contracts link relativized. |
| docs/security/audits.md | Several deployed-contracts link relativizations. |
| docs/multisigs/{committees,lido-contributors-group,alliance}.md | Easy-track factories links relativized; CSM forum slug updated. |
| docs/introduction.mdx | Integration guide link updated. |
| docs/integrations/api.md | Withdrawals link relativized. |
| docs/integrations/aave/aip.md | Two doc-portal/superuser link relativizations. |
| docs/guides/verify-steth-on-optimism-upgrade-manual.md | Multiple link conversions including one inside a code block. |
| docs/guides/validator-ejector-guide.md | LidoLocator deployed-contracts link relativized. |
| docs/guides/reward-distributor-bot.md | Tooling link relativized. |
| docs/guides/oracle-operator-manual.md | Tooling link relativized (display text now a path). |
| docs/guides/lido-tokens-integration-guide.md | API link relativized. |
| docs/guides/kapi-guide.md | Tooling link relativized. |
| docs/guides/depositor-bot.md | Multiple deployed-contracts/DSM link relativizations. |
| docs/guides/curated-module/validator-keys.md | Easy-track guide link relativized. |
| docs/contracts/triggerable-withdrawals-gateway.md | GateSeals link relativized. |
| docs/contracts/oracle-report-sanity-checker.md | consensus-specs branch change (dev → master). |
| docs/contracts/node-operators-registry.md | VEBO links relativized. |
Comments suppressed due to low confidence (1)
docs/token-guides/cross-chain-tokens-guide.md:458
- Same issue: the bare path
/deployed-contracts/#lido-multichainwill not be rendered as a clickable link (unlike the previoushttps://...autolink). Use Markdown link syntax to preserve clickability. The other entries on this list are bare URLs that get auto-linked, so they need similar treatment if converted to internal paths.
- Deployed contracts addresses /deployed-contracts/#lido-multichain
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Linter should be good after merging - #892 |
TheDZhon
left a comment
There was a problem hiding this comment.
Tysm for the PR! 💪 💪 💪
LGTM with a few nipticks, pls ping to approve wen ready 🙏
fix: refresh outdated external and internal doc links
TheDZhon
left a comment
There was a problem hiding this comment.
🏁 Tysm!
Will be ready to merge once CI passed 🙏
Fix some broken links, explicit mentions of https://docs.lido.fi, and some redirects