docs: Update README for SilverStripe 6 #77
Conversation
- Update PHP requirement to ^8.3 (SS6 requirement) - Update all dependencies to SS6 compatible versions - Add GitHub Sponsors badge (replacing codecov) - Remove unstable version badge - Add comprehensive Features section (6 capabilities) - Add upgrade notes for v3→v4 - Add SilverStripe 6 upgrade guide reference
There was a problem hiding this comment.
Pull Request Overview
This PR updates the module documentation for SilverStripe 6 compatibility as part of the v4.0 release. The changes align the documentation with the framework's PHP 8.3 requirement and update dependency version references to their SilverStripe 6-compatible versions.
Key changes:
- Updated PHP requirement from ^8.1 to ^8.3 in both composer.json and README
- Refreshed dependency versions in documentation to match SilverStripe 6 requirements
- Added comprehensive Features section highlighting the module's 6 core capabilities
- Included upgrade guidance for users migrating from version 3
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| composer.json | Updates PHP requirement to ^8.3 to match SilverStripe 6 requirements |
| README.md | Comprehensive documentation refresh including updated badges, reformatted requirements list, new features section, and upgrade notes for v3→v4 transition |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
README.md
Outdated
| - Updated to SilverStripe CMS 6 | ||
| - Requires PHP 8.3 or higher | ||
| - Updated `dynamic/silverstripe-country-dropdown-field` from ^2 to ^3 (SS6 compatible) | ||
| - Extension namespace changes (ORM → Core\Extension) |
There was a problem hiding this comment.
The mention of "Extension namespace changes (ORM → Core\Extension)" is unclear and potentially confusing. This statement could be interpreted as suggesting that users need to update their extension usage, but:
- The example code in line 45-48 shows
SilverStripe\ORM\DataObject, not an extension namespace - It's unclear if this refers to internal changes in the module or changes users need to make
Consider either removing this line or clarifying whether this refers to internal module changes that don't affect user code, or if it's something users need to update in their implementations.
| - Extension namespace changes (ORM → Core\Extension) | |
| - Internal extension namespace changes (ORM → Core\Extension); no changes required in user code |
| - PHP: ^8.3 | ||
| - SilverStripe: ^6 | ||
| - dynamic/silverstripe-country-dropdown-field: ^3 | ||
| - geocoder-php/google-maps-provider: ^4.7 | ||
| - guzzlehttp/guzzle: ^7.4 | ||
| - php-http/guzzle7-adapter: ^1.0 | ||
| - php-http/message: ^1.13 |
There was a problem hiding this comment.
The Requirements section lists individual dependencies but is missing the main SilverStripe dependency that is in composer.json. Consider adding:
- silverstripe/recipe-core: ^6
This is important as it explicitly documents the SilverStripe version requirement.
- Add silverstripe/recipe-core ^6 to requirements list - Clarify extension namespace change is internal only
Updates README documentation for the SilverStripe 6 release.
Changes
This completes the documentation updates for the v4.0 release.