fix docs

Author: ndbroadbent

examples/configuration.rb

@@ -98,26 +98,29 @@ def self.configuration_examples
       # END CODE EXAMPLE: filter_configuration
       # ----------------------------------------------------------
 
+      # rubocop:disable Layout/ExtraSpacing
       # ----------------------------------------------------------
       # BEGIN CODE EXAMPLE: error_handling_modes
       # ----------------------------------------------------------
       # Configure error handling modes
       modes = config.error_handling_modes
-      modes.logstruct_errors = LogStruct::ErrorHandlingMode::Log
-      modes.security_errors = LogStruct::ErrorHandlingMode::Report
-      modes.standard_errors = LogStruct::ErrorHandlingMode::LogProduction
-      modes.type_checking_errors = LogStruct::ErrorHandlingMode::Raise
+      modes.type_checking_errors = LogStruct::ErrorHandlingMode::ReportProduction
+      modes.logstruct_errors     = LogStruct::ErrorHandlingMode::ReportProduction
+      modes.security_errors      = LogStruct::ErrorHandlingMode::Report
+      modes.standard_errors      = LogStruct::ErrorHandlingMode::Raise
 
-      # Available error handling modes:
+      # Error handling modes:
+      # ------------------------------------------------------------
+      # Ignore:             Ignore the error
+      # Log:                Log the error
+      # Report:             Log and report to tracking service without crashing
+      # LogProduction:      Log error in production, raise during dev/test
+      # ReportProduction:   Report in production without crashing, raise during dev/test
+      # Raise:              Always raise the error (reported by tracking service)
       # ------------------------------------------------------------
-      # ::Ignore          # Completely ignore errors
-      # ::Log             # Log errors but don't report them
-      # ::LogProduction   # Log in production, raise in development
-      # ::Report          # Log and report errors to error service
-      # ::Raise           # Always raise errors
-      # ----------------------------------------------------------
       # END CODE EXAMPLE: error_handling_modes
       # ----------------------------------------------------------
+      # rubocop:enable Layout/ExtraSpacing
     end
   end
 end

examples/type_safety.rb

@@ -22,7 +22,7 @@ def self.type_safety_examples
     )
 
     # Log the typed struct
-    Rails.logger.info(request_log)
+    LogStruct.log(request_log)
 
     # Create a typed error log entry
     error_log = LogStruct::Log::Error.new(
@@ -32,7 +32,7 @@ def self.type_safety_examples
     )
 
     # Log the error
-    Rails.logger.error(error_log)
+    LogStruct.log(error_log)
     # ----------------------------------------------------------
     # END CODE EXAMPLE: basic_typed_logging
     # ----------------------------------------------------------

lib/log_struct/config_struct/error_handling_modes.rb

@@ -8,12 +8,12 @@ class ErrorHandlingModes < T::Struct
 
       # How to handle different types of errors
       # Modes:
-      # - :ignore - always ignore the error
-      # - :log - always log the error
-      # - :report - always report to tracking service and continue
-      # - :log_production - log in production, raise locally
-      # - :report_production - report in production, raise locally
-      # - :raise - always raise regardless of environment
+      # - Ignore - Ignore the error
+      # - Log - Log the error
+      # - Report - Log and report to error tracking service (but don't crash)
+      # - LogProduction - Log error in production, raise locally (dev/test)
+      # - ReportProduction - Report error in production, raise locally (dev/test)
+      # - Raise - Always raise the error
 
       # Configurable error handling categories
       prop :type_checking_errors, ErrorHandlingMode, default: ErrorHandlingMode::LogProduction

site/app/docs/configuration/page.tsx

@@ -2,6 +2,7 @@ import { RubyCodeExample } from '@/components/ruby-code-example';
 import { EditPageLink } from '@/components/edit-page-link';
 import { CodeBlock } from '@/components/code-block';
 import { HeadingWithAnchor } from '@/components/heading-with-anchor';
+import Link from 'next/dist/client/link';
 
 export default function ConfigurationPage() {
   return (
@@ -59,8 +60,20 @@ export default function ConfigurationPage() {
         Error Handling Configuration
       </HeadingWithAnchor>
       <p className="text-neutral-600 dark:text-neutral-400 mb-4">
-        LogStruct provides different error handling modes to control how errors
-        are processed:
+        LogStruct provides customizable error handling modes to control how
+        errors are processed. You probably don&apos;t want type-checking errors
+        or internal logging-related errors to crash your application, so our
+        default behavior is to log and report those errors without crashing. We
+        automatically detect which error reporting service you use (Sentry,
+        Bugsnag, Rollbar, etc.). If you use a service that we don&apos;t support
+        yet, you can configure a{' '}
+        <Link
+          className="text-gray-200 hover:underline"
+          href="#custom-error-reporting"
+        >
+          custom error handler
+        </Link>
+        . (Or you can send a PR!)
       </p>
 
       <RubyCodeExample name="error_handling_modes" />