Broken link in README: ./docs/migrations/migrating-to-v5.md (migration guides moved under docs/reference/)

[irfanfandi]

Summary

In README.md (line 120, current main @ b126c33), the createWithEqualityFn note links to:

./docs/migrations/migrating-to-v5.md#using-custom-equality-functions-such-as-shallow

That path does not exist — the migration guides live under ./docs/reference/migrations/, so the link 404s when reading the README on GitHub.

Suggested fix

-For more control over re-rendering, you may provide any custom equality function (this example requires the use of [`createWithEqualityFn`](./docs/migrations/migrating-to-v5.md#using-custom-equality-functions-such-as-shallow)).
+For more control over re-rendering, you may provide any custom equality function (this example requires the use of [`createWithEqualityFn`](./docs/reference/migrations/migrating-to-v5.md#using-custom-equality-functions-such-as-shallow)).

The anchor is unchanged and still matches the ### Using custom equality functions such as \shallow`heading indocs/reference/migrations/migrating-to-v5.md`.

Scope check

I resolved every relative docs/ link in the README against the repo at b126c33: this is the only one that is still broken, and all of them resolve after this one-line change. Prettier (prettier --list-different README.md) is clean with the change applied.

This is the same class of link rot as #3537 / #3542 and #3518 / #3519.

Note

I have the fix ready on a branch and would have opened a PR, but PR creation is currently limited to repository collaborators, so I am reporting it here instead. Happy to open the PR if the restriction is lifted, or feel free to take the diff as-is.

[MLuc24]

Verified your fix end to end, and it is correct on all three counts.

The target resolves — docs/reference/migrations/migrating-to-v5.md returns 200 on main. The anchor survives the move too; the heading is still there, at line 26:

### Using custom equality functions such as `shallow`

so #using-custom-equality-functions-such-as-shallow continues to match and nothing else in the link needs touching.

I also checked whether the move left other casualties, since a directory rename usually does. It did not, in either direction:

Every other doc link in the README resolves — docs/learn/guides/updating-state.md, docs/reference/integrations/persisting-store-data.md, docs/learn/guides/immutable-state-and-merging.md, slices-pattern, flux-inspired-practice, event-handler-in-pre-react-18, testing, docs/index.md, third-party-libraries and prevent-rerenders-with-use-shallow. All 200.

And searching the whole repo for the stale docs/migrations/ prefix returns exactly one hit: the line you found. Nothing under docs/ still points at the old location either.

So it really is a one-line change with no follow-ups hiding behind it, which is worth saying in the PR — a reviewer looking at a link fix after a directory move will reasonably wonder whether it is the only one, and it is.

[dai-shi]

Thanks. #3567