docs: Update README for SilverStripe 6 #11
Conversation
- Update badges (remove codecov, add GitHub Sponsors) - Update requirements to SS6 versions (PHP ^8.3, SS ^6, Elemental ^6, Carousel ^3) - Add Features section highlighting key capabilities - Add upgrade notes for version 2 to 3 migration - Reorganize badges for better readability
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README documentation to reflect compatibility with SilverStripe 6 and the v3.0.0 release of the module.
- Reorganized badges, removing codecov and adding GitHub Sponsors support
- Updated minimum version requirements to PHP 8.3+, SilverStripe 6, Elemental 6, and Carousel 3
- Added a Features section documenting 5 key capabilities of the module
- Added upgrade guidance for users migrating from version 2
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * dnadesign/silverstripe-elemental ^6 | ||
| * dynamic/silverstripe-carousel ^3 |
There was a problem hiding this comment.
Inconsistent package name formatting. The requirements section uses inconsistent naming conventions:
- Line 13:
dnadesign/silverstripe-elemental ^6(missing colon after package name) - Line 14:
dynamic/silverstripe-carousel ^3(missing colon after package name)
These should follow the same format as the Installation section (line 18) or use bullet list format consistently. Suggest:
* dnadesign/silverstripe-elemental: ^6
* dynamic/silverstripe-carousel: ^3or
* dnadesign/silverstripe-elemental ^6
* dynamic/silverstripe-carousel ^3but be consistent with lines 11-12.
| * dnadesign/silverstripe-elemental ^6 | |
| * dynamic/silverstripe-carousel ^3 | |
| * dnadesign/silverstripe-elemental: ^6 | |
| * dynamic/silverstripe-carousel: ^3 |
| * dnadesign/silverstripe-elemental: ^5.0 | ||
| * dynamic/silverstripe-carousel: ^2.0 | ||
| * PHP ^8.3 | ||
| * SilverStripe ^6 |
There was a problem hiding this comment.
Inconsistent product name formatting. Line 11 uses "SilverStripe" while line 12 uses "dnadesign/silverstripe-elemental" (lowercase). For consistency with the product name conventions, consider using either:
- "SilverStripe CMS ^6" (matching the upgrade notes on line 52)
- Or maintain the bullet list format consistently across all requirements
This would align with how other requirements list versions (e.g., lines 13-14).
| * SilverStripe ^6 | |
| * silverstripe/cms ^6 |
|
|
||
| ## Features | ||
|
|
||
| - **Carousel Block**: Elemental block for image carousels |
There was a problem hiding this comment.
Missing article. The phrase "Elemental block for image carousels" should be "An Elemental block for image carousels" for proper grammar.
| - **Carousel Block**: Elemental block for image carousels | |
| - **Carousel Block**: An Elemental block for image carousels |
- Add colons after package names in requirements for consistency - Add article 'An' to Carousel Block feature for proper grammar Addresses Copilot review feedback on PR #11
* docs: Fix README formatting consistency - Add colons after package names in requirements for consistency - Add article 'An' to Carousel Block feature for proper grammar Addresses Copilot review feedback on PR #11 * ci: Remove phpcoverage configuration Simplifies CI workflow by removing phpcoverage option.
1 participant
Updates the README to reflect SilverStripe 6 compatibility and improvements.
Changes
Complements the v3.0.0 code release.