Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves discoverability and upgrade guidance for users landing on the legacy v1 branch by adding an EOL notice, a version/requirements overview, and a dedicated upgrade guide to newer major versions.
Changes:
- Added
UPGRADE.mddocumenting the 1.x → 2.0 upgrade path and linking to the 2.x → 3.0 guide. - Added an EOL warning banner to the
v1README with a pointer to the upgrade guide and security-fix context. - Added a requirements/version table to the
v1README linking to thev2andmainbranches.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| UPGRADE.md | Adds upgrade instructions for moving from 1.x to 2.0 and links onward to 3.0 guidance. |
| README.md | Adds EOL warning and a version/requirements table to make supported versions discoverable on v1. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Description
Makes the version landscape visible to users landing on the
v1branch:v2andmainbranchesUPGRADE.md: 1.x → 2.0 guide (user_idFK → polymorphiccausermigration steps,HasApiLogstrait) plus a pointer to the 2.x → 3.0 guideDocs only — no code changes, no release needed.
Fixes
Part of #15 (v1 docs) — see #17 for the main part. Note: this PR targets the
v1branch, so the closing keyword would not act; #15 is closed by #17.