From 7da0e94e470ce48437c964137f741ac486935a9e Mon Sep 17 00:00:00 2001
From: Russell Jones <499552+jonesrussell@users.noreply.github.com>
Date: Sat, 11 Jan 2025 03:54:35 +0000
Subject: [PATCH] Update TODO and writing style documentation for clarity and
 completeness

- Expanded the TODO list with additional tasks for Ruby, PHP, GitHub Actions, and security updates.
- Enhanced writing style guidelines by emphasizing concise language and active voice.
- Improved formatting in both TODO.md and WRITING_STYLE.md for better readability and organization.
---
 TODO.md          | 15 +++++++++++++++
 WRITING_STYLE.md |  4 ++++
 2 files changed, 19 insertions(+)

diff --git a/TODO.md b/TODO.md
index 6488463..b1d5dc7 100644
--- a/TODO.md
+++ b/TODO.md
@@ -1,25 +1,30 @@
 # Maintenance TODO List
 
 ## Ruby Dependencies
+
 - [ ] Update minima theme from "~> 2.5" to latest version
 - [ ] Update jekyll-feed from "~> 0.12" to latest version
 - [ ] Add explicit version constraints for csv and webrick gems
 - [ ] Run `bundle update` to update all dependencies
 
 ## PHP Dependencies
+
 - [ ] Update PHP dependencies in php-fig-guide
 - [ ] Add Composer version constraints
 - [ ] Set up Composer audit for security checks
 - [ ] Consider adding PHP CS Fixer
 
 ## GitHub Actions
+
 - [ ] Update Ruby setup action version
 - [ ] Add caching for faster builds
 - [ ] Add status checks/tests before deployment
 - [ ] Consider adding automated testing workflow
 
 ## Dependabot Configuration
+
 Update `.github/dependabot.yml` to include:
+
 - [ ] Bundler ecosystem monitoring
 - [ ] GitHub Actions monitoring
 - [ ] Composer ecosystem monitoring
@@ -50,11 +55,13 @@ updates:
 ```
 
 ## Analytics
+
 - [ ] Update Google Analytics implementation to GA4
 - [ ] Review and update privacy policy accordingly
 - [ ] Consider adding cookie consent banner
 
 ## Jekyll Configuration
+
 - [ ] Add explicit timezone setting
 - [ ] Update remote theme version
 - [ ] Add SEO optimization settings:
@@ -67,6 +74,7 @@ updates:
   - [ ] jekyll-archives
 
 ## PHP-FIG Guide
+
 - [ ] Complete implementation of remaining PSR standards
 - [ ] Add comprehensive test coverage
 - [ ] Document each PSR implementation
@@ -77,6 +85,7 @@ updates:
 - [ ] Implement CI/CD pipeline for PHP tests
 
 ## Security Updates
+
 - [ ] Add security.txt file
 - [ ] Add CORS headers
 - [ ] Implement Content Security Policy
@@ -84,6 +93,7 @@ updates:
 - [ ] Add security disclosure policy
 
 ## Documentation
+
 - [ ] Update README with new features and configuration
 - [ ] Add CONTRIBUTING.md guidelines
 - [ ] Add SECURITY.md for security policy
@@ -92,18 +102,21 @@ updates:
 - [ ] Document testing procedures for PHP code
 
 ## Performance
+
 - [ ] Optimize image assets
 - [ ] Implement lazy loading for images
 - [ ] Add caching headers
 - [ ] Consider implementing service worker for offline support
 
 ## Accessibility
+
 - [ ] Add ARIA labels where needed
 - [ ] Ensure proper heading hierarchy
 - [ ] Add alt text to all images
 - [ ] Test with screen readers
 
 ## Testing
+
 - [ ] Add automated tests
 - [ ] Set up CI/CD pipeline
 - [ ] Add lighthouse testing
@@ -112,12 +125,14 @@ updates:
 - [ ] Set up PHP test coverage reporting
 
 ## Future Considerations
+
 - [ ] Consider implementing dark mode
 - [ ] Add search functionality
 - [ ] Implement commenting system
 - [ ] Add RSS feed improvements
 
 ## Blog Content
+
 - [ ] Complete PSR standards article series
 - [ ] Add code examples for each PSR
 - [ ] Create index page for PHP-FIG series
diff --git a/WRITING_STYLE.md b/WRITING_STYLE.md
index e73dc56..400a7d0 100644
--- a/WRITING_STYLE.md
+++ b/WRITING_STYLE.md
@@ -76,6 +76,7 @@ description: "Compelling description"
 ## Language and Style
 
 ### Writing Concisely
+
 - Avoid unnecessary adjectives like "comprehensive", "complete", "full", "robust", etc.
 - Remove words that don't add value (very, really, basically, actually)
 - Use active voice instead of passive
@@ -83,12 +84,15 @@ description: "Compelling description"
 - If a word doesn't change the meaning when removed, remove it
 
 ### Examples
+
 ❌ Don't:
+
 - "A comprehensive guide to PHP-FIG standards"
 - "A complete tutorial that fully explains..."
 - "A really useful tool that actually helps..."
 
 ✅ Do:
+
 - "A guide to PHP-FIG standards"
 - "A tutorial explaining..."
 - "A tool that helps..."