Skip to content

Update README for SS6 compatibility#23

Merged
jsirish merged 1 commit intomainfrom
docs/update-readme-ss6
Nov 19, 2025
Merged

Update README for SS6 compatibility#23
jsirish merged 1 commit intomainfrom
docs/update-readme-ss6

Conversation

@jsirish
Copy link
Member

@jsirish jsirish commented Nov 19, 2025

Updates the README to reflect SilverStripe 6 compatibility and reorganizes the documentation structure to match standards used across Dynamic's module family.

Changes

Structure Improvements

  • Reorganized README to match Dynamic elemental module standards
  • Created separate Features section with clear bullet points
  • Created dedicated Usage section with screenshots
  • Consolidated all configuration options into a Configuration section
  • Moved Upgrading section to the end (standard placement)

Content Updates

  • Updated requirements: PHP ^8.3, SilverStripe ^6.0, cms-actions ^2.0
  • Removed version compatibility table (not needed)
  • Updated badges (removed codecov, kept GitHub Sponsors)
  • Improved formatting and consistency throughout

Configuration Organization

All configuration options now grouped under one section:

  • Email Configuration
  • Force Required User Group Assignment
  • Template Override
  • Redirect After Successful User Creation

This brings the README in line with the structure used in other Dynamic modules like elemental-blog, elemental-card, and elemental-customer-service.

- Update requirements to PHP ^8.3 and SilverStripe ^6.0
- Remove version compatibility table
- Reorganize structure to match Dynamic module standards
- Create separate Features and Usage sections
- Consolidate Configuration section
- Move Upgrading section to end
- Update badges (remove codecov, add GitHub Sponsors)
- Improve formatting and consistency
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the README to reflect SilverStripe 6 compatibility and reorganizes the documentation to match the structure standards used across Dynamic's module family. The changes improve documentation clarity and consistency without altering any code functionality.

Key Changes

  • Updated requirements to PHP ^8.3, SilverStripe ^6.0, and cms-actions ^2.0
  • Restructured documentation into standard sections: Features, Usage, Configuration, Upgrading
  • Replaced codecov badge with GitHub Sponsors badge

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jsirish jsirish merged commit 7607ff2 into main Nov 19, 2025
16 of 24 checks passed
@jsirish jsirish deleted the docs/update-readme-ss6 branch November 19, 2025 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant