docs: point README's upgrade section at UPGRADE.md instead of duplicating it - #231
Merged
Conversation
…ting it UPGRADE.md and the README's section independently described the same v3.0.0 migration steps, with no reference from one to the other. Because neither is derived from the other, a future breaking change is likely to be documented in only one of them, leaving the other stale or contradictory. Replace the README's duplicated migration content with a short pointer to UPGRADE.md, which becomes the single source of truth and can grow to cover future major versions without bloating the README. Fixes #161
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What was broken
UPGRADE.mdand the README's## Upgrading from v2section (README.md:566-615) independently described the same v2→v3 breaking changes and migration steps, written with different wording and detail. Neither file referenced the other.Because the two guides weren't derived from one source, a future breaking change was likely to get documented in only one of them, leaving the other stale and potentially contradictory — misleading for whichever guide a reader happened to land on.
What changed
UPGRADE.md#upgrading-from-v2x-to-v30, which is now the single source of truth for the v2→v3 migration guide.## Upgrading from v2heading (and its anchor) intact, since it's still referenced by the "Upgrading from v2?" callout earlier in the README.UPGRADE.mditself is unchanged — it already covers this content in full and can grow to cover future major versions without bloating the README.Testing
vendor/bin/pint --dirty --test— no PHP files changed, nothing to format.vendor/bin/pest— 250 passed (631 assertions), including the existing README/documentation link tests.Fixes #161