bolshakov / stoplight / 14512922508
100%

DEFAULT BRANCH: master
Ran
Jobs 0
Files 0
Run time –
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
14512922508

push

github

web-flow 
Improved Documentation and Code Examples (#303)

This PR completely revises the Stoplight documentation and introduces the new `Light#with` method for easier configuration.

## New Feature: Light#with Method

The PR introduces a new `Light#with` method that allows for bulk configuration of stoplights:

```ruby
# Base configuration
base_api = Stoplight('api-service')

# Create specialized versions with different configurations
users_api = base_api.with(
  threshold: 5,
  cool_off_time: 30,
  tracked_errors: [TimeoutError]
)

orders_api = base_api.with(
  threshold: 10,
  window_size: 300
)
```

This method offers several advantages:
- **Immutability**: Creates new instances without modifying the original stoplight
- **Composability**: Perfect for creating specialized stoplights from a common base configuration
- **Cleaner Syntax**: More concise than chaining multiple `.with_*` methods
- **Bulk Updates**: Update multiple settings at once with clear, readable code

The method accepts all standard stoplight configuration options and significantly improves developer experience when working with multiple related stoplights.

## README Improvements

The README has been completely restructured to provide a more intuitive learning path, starting with core concepts before diving into implementation details. The new documentation emphasizes Stoplight's zero-configuration philosophy while providing comprehensive examples that show the full lifecycle of circuit breakers in realistic scenarios. Advanced features are now explained with clear use cases and practical code examples, making the library more approachable for newcomers while still serving as a valuable reference for experienced users.

#302 

Co-authored-by: lokideos <archmage@hey.com>
Source Files on build 14512922508