Add comprehensive documentation to improve developer experience (#180)

This PR addresses multiple user pain points by adding extensive documentation
that covers troubleshooting, best practices, and framework-specific guides.

Key Improvements:

Documentation Structure:
- Added TROUBLESHOOTING.md with solutions to common issues (database errors,
  webpack compilation, factory loading, authentication, parallel testing)
- Added PLAYWRIGHT_GUIDE.md providing complete Playwright support documentation
  with feature parity to Cypress functionality
- Added VCR_GUIDE.md covering both insert/eject and use_cassette modes with
  GraphQL-specific configuration examples
- Added BEST_PRACTICES.md with recommended patterns for test organization,
  performance optimization, and security
- Added DX_IMPROVEMENTS.md summarizing all developer experience enhancements

Enhanced README:
- Restructured with Quick Start section for new users
- Added clear navigation to specialized guides
- Improved visibility of key features and use cases

Rake Tasks and Server Management:
- Documented new rake tasks (cypress:open, cypress:run, playwright:open, playwright:run)
- Added server lifecycle hooks documentation (before_server_start, after_server_start,
  after_transaction_start, after_state_reset, before_server_stop)
- Included migration guide from manual server management to automated approach
- Added cypress-rails compatibility guide

Issues Addressed:
Directly resolves documentation gaps for issues #175 (VCR errors), #169 (Playwright
fixtures), #160 (VCR modes), #157 (environment config), #155 (database errors),
#152 (server management), #146 (webpack errors), #137 (authentication), #119
(parallel testing), #118 (headless mode), #114 (transactional fixtures)

Impact:
For new installations: Provides clear onboarding path with quick start guide and
comprehensive examples

For existing installations: Offers solutions to common problems and migration guides
for new features without requiring code changes

Breaking Changes: None

Security Implications: Adds documentation for secure command handling and
authentication best practices

Author: justin808

CHANGELOG.md

@@ -51,7 +51,7 @@ If migrating from the `cypress-rails` gem:
    ```ruby
    # Remove
    gem 'cypress-rails'
-   
+
    # Add
    gem 'cypress-on-rails', '~> 1.0'
    ```

README.md

@@ -47,6 +47,28 @@ Consider first learning the basics of Playwright before attempting to integrate
 
 * [Good start Here](https://playwright.dev/docs/writing-tests)
 
+## Quick Start
+
+```bash
+# 1. Add to Gemfile
+gem 'cypress-on-rails', '~> 1.0'
+
+# 2. Install and generate
+bundle install
+bin/rails g cypress_on_rails:install
+
+# 3. Run tests (new rake tasks!)
+bin/rails cypress:open    # Open Cypress UI
+bin/rails cypress:run     # Run headless
+```
+
+For Playwright:
+```bash
+bin/rails g cypress_on_rails:install --framework playwright
+bin/rails playwright:open  # Open Playwright UI
+bin/rails playwright:run   # Run headless
+```
+
 ## Overview
 
 Gem for using [cypress.io](http://github.com/cypress-io/) or [playwright.dev](https://playwright.dev/) in Rails and Ruby Rack applications to control state as mentioned in [Cypress Best Practices](https://docs.cypress.io/guides/references/best-practices.html#Organizing-Tests-Logging-In-Controlling-State). 
@@ -64,7 +86,16 @@ Has examples of setting up state with:
 * scenarios
 * custom commands
 
-## Resources
+## Documentation
+
+### 📚 Essential Guides
+* **[Best Practices Guide](docs/BEST_PRACTICES.md)** - Recommended patterns and practices
+* **[Troubleshooting Guide](docs/TROUBLESHOOTING.md)** - Solutions to common issues
+* **[Playwright Guide](docs/PLAYWRIGHT_GUIDE.md)** - Complete Playwright documentation
+* **[VCR Integration Guide](docs/VCR_GUIDE.md)** - HTTP recording and mocking
+* **[DX Improvements](docs/DX_IMPROVEMENTS.md)** - Recent improvements based on user feedback
+
+### 🎥 Resources
 * [Video of getting started with this gem](https://grant-ps.blog/2018/08/10/getting-started-with-cypress-io-and-ruby-on-rails/)
 * [Article: Introduction to Cypress on Rails](https://www.shakacode.com/blog/introduction-to-cypress-on-rails/)