Skip to content

docs: fix dead Foundry Book and Uniswap V3 Book links - #1176

Open
ninglinLiu wants to merge 1 commit into
Uniswap:mainfrom
ninglinLiu:docs/fix-dead-foundry-book-links
Open

ninglinLiu wants to merge 1 commit into
Uniswap:mainfrom
ninglinLiu:docs/fix-dead-foundry-book-links

Conversation

@ninglinLiu

Copy link
Copy Markdown

Summary

Fixes 7 dead external documentation links (all currently return 404), found by checking every non-GitHub external link under content/. The Foundry Book moved from book.getfoundry.sh to getfoundry.sh, and the old /reference/forge/* paths no longer resolve or redirect:

Page Old link (404) New link (200)
v2 → Guides → Getting started book.getfoundry.sh/reference/forge/forge-test, forge-build, forge-script getfoundry.sh/forge/reference/forge-test, forge-build, forge-script
Unichain → Guides → Deploy a smart contract book.getfoundry.sh/reference/forge/forge-verify-contract, forge-create getfoundry.sh/forge/reference/forge-verify-contract, forge-create
v4 → Security (tooling list) getfoundry.sh/introduction/overview getfoundry.sh/introduction/getting-started
SDK v3 → Managing liquidity → Getting started uniswapv3book.com/docs/introduction/uniswap-v3/ uniswapv3book.com/milestone_0/uniswap-v3.html (the book's "Introduction to Uniswap V3" chapter)

Type of change

  • Fix (typo, broken link, incorrect or outdated content)
  • New content (guide, page, code example)
  • Update to existing content
  • Other

How has this been verified?

  • curl -L returns 404 for every old URL and 200 for every new one; each new Foundry page is the matching forge <command> reference page.
  • Other book.getfoundry.sh links in the repo (e.g. /forge/deploying, /anvil/, /getting-started/installation) still redirect correctly, so they are left untouched.

Anything else reviewers should know?

Docs-only, 7 lines across 4 files. Separate from #1173, #1174 and #1175. Prepared with AI assistance; I reviewed the change and checked every link listed above.

@github-actions

Copy link
Copy Markdown

Thanks for contributing to Uniswap Docs! 🦄

Quick heads up on how this repo works: the docs you see on developers.uniswap.org are built from a separate source repo. When we accept a change here, we port it over there, so your fix might show up on the live site before it lands in this repo.

Updates to this repo come in batches on a regular cadence. When yours is included, you'll be credited as a co-author on the commit, so the contribution counts on your GitHub profile and in Uniswap/docs.

We review every PR but can't merge everything. Either way, someone from the docs team will follow up here once we've taken a look.

One legal bit: by submitting a PR you agree your contribution is licensed under the repo's MIT license.

@github-actions

Copy link
Copy Markdown

Review summary

Reviewed the 4-file, 7-line diff that swaps 7 dead external links for working ones.

Findings: no issues. The changes look correct and well-scoped:

  • book.getfoundry.sh/reference/forge/* → getfoundry.sh/forge/reference/* (forge-test, forge-build, forge-script, forge-verify-contract, forge-create) is consistent with the Foundry Book's known migration off the book.getfoundry.sh domain. The repo already uses the new getfoundry.sh domain elsewhere (e.g. getfoundry.sh/introduction/installation, getfoundry.sh/anvil/overview in content/liquidity/liquidity-launchpad/guides/*.mdx), so the new links are consistent with existing, presumably-verified usage.
  • getfoundry.sh/introduction/overview → getfoundry.sh/introduction/getting-started in content/protocols/v4/security.mdx is a plausible IA fix on the same domain.
  • uniswapv3book.com/docs/introduction/uniswap-v3/ → uniswapv3book.com/milestone_0/uniswap-v3.html matches the milestone_N/*.html URL pattern already used elsewhere in the repo (content/sdks/v3/guides/pool-data.mdx and content/sdks/v4/guides/pool-data.mdx both link to uniswapv3book.com/milestone_2/tick-bitmap-index.html), which supports this being the correct current structure for that site.
  • No contract addresses, chain IDs, or code samples are touched — this is a pure external-link swap.
  • No MDX/frontmatter syntax issues; diffs are minimal and self-contained.
  • Scope is intentionally narrow (the PR notes it leaves other book.getfoundry.sh links like /forge/deploying, /anvil/, and /getting-started/installation untouched since those still redirect, and defers other broken links to separate PRs docs(v4): fix dead HookMiner.sol link in hook deployment guide #1173–docs: fix dead ERC-7739 and ERC-7914 reference links #1175).

Note: my sandbox doesn't have outbound network access, so I could not independently re-curl each URL; the above is based on cross-referencing URL patterns already in use elsewhere in this repo, which corroborates the author's stated manual verification. Nothing here warrants blocking.

This branch has not been deployed

No deployments
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