docs: Add streaming-related info for RSI, MACD, Bollinger Bands, etc. (#1729)

Signed-off-by: Dave Skender <[email protected]>
Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: DaveSkender <[email protected]>

Author: Copilot

.specify/specs/001-develop-streaming-indicators/tasks.md

@@ -409,11 +409,17 @@ Note on former deferrals: Indicators like Fractal, HtTrendline, Hurst, Ichimoku,
 
 - [x] **D001** Update `docs/_indicators/Sma.md` with streaming usage section and examples ✅
 - [x] **D002** Update `docs/_indicators/Ema.md` with streaming usage section and examples ✅
-- [ ] **D003** Update `docs/_indicators/Rsi.md` with streaming usage section and examples
-- [ ] **D004** Update `docs/_indicators/Macd.md` with streaming usage section and examples
-- [ ] **D005** Update `docs/_indicators/BollingerBands.md` with streaming usage section and examples
-- [ ] **D006** Update `README.md` with streaming overview paragraph and quick-start example
-- [ ] **D007** Update `src/MigrationGuide.V3.md` with streaming capability summary and migration guidance
+- [x] **D003** Update `docs/_indicators/Rsi.md` with streaming usage section and examples ✅
+- [x] **D004** Update `docs/_indicators/Macd.md` with streaming usage section and examples ✅
+- [x] **D005** Update `docs/_indicators/BollingerBands.md` with streaming usage section and examples ✅
+- [x] **D006** Update `README.md` with streaming overview paragraph and quick-start example ✅
+- [x] **D007** Update `src/MigrationGuide.V3.md` with streaming capability summary and migration guidance ✅
+  - Overview of three calculation styles (Series, BufferList, StreamHub)
+  - Migration examples from v2 Series to v3 streaming
+  - Performance considerations
+  - Links to indicator-specific documentation
+  - Completed guide.md TODO sections (BufferList and StreamHub)
+  - Added comprehensive streaming performance documentation to performance.md
 
 **Checkpoint**: Phase 5 completion delivers polished user-facing documentation for all streaming features
 
@@ -588,8 +594,8 @@ Each task should follow these guidelines:
 - **Phase 2**: 85 BufferList implementation tasks (T001-T085) — 82 complete, 3 remaining (T055/T068 not implementing, T085 human-only)
 - **Phase 3**: 85 StreamHub implementation tasks (T086-T170) — 79 complete, 6 remaining (T108, T145 implementable; T140/T153 not implementing, T170 human-only)
 - **Phase 4**: 17 test infrastructure tasks (T175-T185, Q001-Q006) — 12 complete, 5 remaining
-- **Phase 5**: 7 documentation tasks (D001-D007) — 2 complete, 5 remaining
+- **Phase 5**: 7 documentation tasks (D001-D007) — 7 complete, 0 remaining ✅
 - **Phase 6**: 10 enhancement tasks (E001-E010) — 0 complete, 10 remaining (Priority 4 enhancements + private project items)
-- **Total**: 214 tasks — 183 complete, 31 remaining (4 marked as not implementing, 2 human-only)
+- **Total**: 214 tasks — 188 complete, 26 remaining (4 marked as not implementing, 2 human-only)
 
 Removed blanket deferral: The above indicators are complex but unblocked with established reference patterns (see instruction files).

README.md

@@ -14,6 +14,35 @@
 
 Build your technical analysis, trading algorithms, machine learning, charting, or other intelligent market software with this library and your own [OHLCV](https://dotnet.stockindicators.dev/guide/#historical-quotes) price quotes sources for equities, commodities, forex, cryptocurrencies, and others.  [Stock Indicators for Python](https://python.stockindicators.dev/) is also available.
 
+## Streaming Support
+
+v3 introduces comprehensive **streaming capabilities** for real-time and incremental data processing. Most indicators now support three calculation styles:
+
+- **Series** - Traditional batch processing for complete historical datasets
+- **BufferList** - Incremental calculations with efficient buffer management
+- **StreamHub** - Real-time processing with observable patterns and state management
+
+Quick example using streaming:
+
+```csharp
+// Create a quote hub for streaming quotes
+QuoteHub<Quote> quoteHub = new();
+
+// Subscribe indicators to the hub
+EmaHub<Quote> emaHub = quoteHub.ToEma(20);
+RsiHub<Quote> rsiHub = quoteHub.ToRsi(14);
+
+// Stream quotes as they arrive
+foreach (Quote quote in liveQuotes)
+{
+    quoteHub.Add(quote);
+    
+    // Access real-time results
+    EmaResult emaResult = emaHub.Results.LastOrDefault();
+    RsiResult rsiResult = rsiHub.Results.LastOrDefault();
+}
+```
+
 Visit our project site for more information:
 
 - [Overview](https://dotnet.stockindicators.dev/)

docs/_indicators/Aroon.md

@@ -72,3 +72,33 @@ var results = quotes
 ```
 
 This indicator must be generated from `quotes` and **cannot** be generated from results of another chain-enabled indicator or method.
+
+## Streaming
+
+Use the buffer-style `List<T>` when you need incremental calculations without a hub:
+
+```csharp
+AroonList aroonList = new(lookbackPeriods);
+
+foreach (IQuote quote in quotes)  // simulating stream
+{
+  aroonList.Add(quote);
+}
+
+// based on `ICollection<AroonResult>`
+IReadOnlyList<AroonResult> results = aroonList;
+```
+
+Subscribe to a `QuoteHub` for advanced streaming scenarios:
+
+```csharp
+QuoteHub<Quote> quoteHub = new();
+AroonHub<Quote> observer = quoteHub.ToAroon(lookbackPeriods);
+
+foreach (Quote quote in quotes)  // simulating stream
+{
+  quoteHub.Add(quote);
+}
+
+IReadOnlyList<AroonResult> results = observer.Results;
+```

docs/_indicators/Cci.md

@@ -68,3 +68,33 @@ var results = quotes
 ```
 
 This indicator must be generated from `quotes` and **cannot** be generated from results of another chain-enabled indicator or method.
+
+## Streaming
+
+Use the buffer-style `List<T>` when you need incremental calculations without a hub:
+
+```csharp
+CciList cciList = new(lookbackPeriods);
+
+foreach (IQuote quote in quotes)  // simulating stream
+{
+  cciList.Add(quote);
+}
+
+// based on `ICollection<CciResult>`
+IReadOnlyList<CciResult> results = cciList;
+```
+
+Subscribe to a `QuoteHub` for advanced streaming scenarios:
+
+```csharp
+QuoteHub<Quote> quoteHub = new();
+CciHub<Quote> observer = quoteHub.ToCci(lookbackPeriods);
+
+foreach (Quote quote in quotes)  // simulating stream
+{
+  quoteHub.Add(quote);
+}
+
+IReadOnlyList<CciResult> results = observer.Results;
+```

docs/_indicators/ConnorsRsi.md

@@ -87,3 +87,33 @@ var results = quotes
     .ToConnorsRsi(..)
     .ToSma(..);
 ```
+
+## Streaming
+
+Use the buffer-style `List<T>` when you need incremental calculations without a hub:
+
+```csharp
+ConnorsRsiList connorsRsiList = new(rsiPeriods, streakPeriods, rankPeriods);
+
+foreach (IQuote quote in quotes)  // simulating stream
+{
+  connorsRsiList.Add(quote);
+}
+
+// based on `ICollection<ConnorsRsiResult>`
+IReadOnlyList<ConnorsRsiResult> results = connorsRsiList;
+```
+
+Subscribe to a `QuoteHub` for advanced streaming scenarios:
+
+```csharp
+QuoteHub<Quote> quoteHub = new();
+ConnorsRsiHub<Quote> observer = quoteHub.ToConnorsRsi(rsiPeriods, streakPeriods, rankPeriods);
+
+foreach (Quote quote in quotes)  // simulating stream
+{
+  quoteHub.Add(quote);
+}
+
+IReadOnlyList<ConnorsRsiResult> results = observer.Results;
+```

docs/_indicators/Keltner.md

@@ -80,12 +80,32 @@ var results = quotes
     .ToKeltner(..);
 ```
 
-### Stream indicator
+## Streaming
 
-This indicator supports real-time streaming with `ToKeltnerHub()`.  See [StreamHub guide]({{site.baseurl}}/guide/#streaming-hub-style-indicators) for usage.
+Use the buffer-style `List<T>` when you need incremental calculations without a hub:
 
 ```csharp
-// example - to stream real-time data
-var quoteHub = new QuoteHub();
-var keltnerHub = quoteHub.ToKeltnerHub(emaPeriods, multiplier, atrPeriods);
+KeltnerList keltnerList = new(emaPeriods, multiplier, atrPeriods);
+
+foreach (IQuote quote in quotes)  // simulating stream
+{
+  keltnerList.Add(quote);
+}
+
+// based on `ICollection<KeltnerResult>`
+IReadOnlyList<KeltnerResult> results = keltnerList;
+```
+
+Subscribe to a `QuoteHub` for advanced streaming scenarios:
+
+```csharp
+QuoteHub<Quote> quoteHub = new();
+KeltnerHub<Quote> observer = quoteHub.ToKeltner(emaPeriods, multiplier, atrPeriods);
+
+foreach (IQuote quote in quotes)  // simulating stream
+{
+  quoteHub.Add(quote);
+}
+
+IReadOnlyList<KeltnerResult> results = observer.Results;
 ```

docs/_indicators/Macd.md

@@ -89,3 +89,33 @@ var results = quotes
     .ToMacd(..)
     .ToSlope(..);
 ```
+
+## Streaming
+
+Use the buffer-style `List<T>` when you need incremental calculations without a hub:
+
+```csharp
+MacdList macdList = new(fastPeriods, slowPeriods, signalPeriods);
+
+foreach (IQuote quote in quotes)  // simulating stream
+{
+  macdList.Add(quote);
+}
+
+// based on `ICollection<MacdResult>`
+IReadOnlyList<MacdResult> results = macdList;
+```
+
+Subscribe to a `QuoteHub` for advanced streaming scenarios:
+
+```csharp
+QuoteHub<Quote> quoteHub = new();
+MacdHub<Quote> observer = quoteHub.ToMacd(fastPeriods, slowPeriods, signalPeriods);
+
+foreach (Quote quote in quotes)  // simulating stream
+{
+  quoteHub.Add(quote);
+}
+
+IReadOnlyList<MacdResult> results = observer.Results;
+```

docs/_indicators/StochRsi.md

@@ -88,3 +88,33 @@ var results = quotes
     .ToStochRsi(..)
     .ToSlope(..);
 ```
+
+## Streaming
+
+Use the buffer-style `List<T>` when you need incremental calculations without a hub:
+
+```csharp
+StochRsiList stochRsiList = new(rsiPeriods, stochPeriods, signalPeriods, smoothPeriods);
+
+foreach (IQuote quote in quotes)  // simulating stream
+{
+  stochRsiList.Add(quote);
+}
+
+// based on `ICollection<StochRsiResult>`
+IReadOnlyList<StochRsiResult> results = stochRsiList;
+```
+
+Subscribe to a `QuoteHub` for advanced streaming scenarios:
+
+```csharp
+QuoteHub<Quote> quoteHub = new();
+StochRsiHub<Quote> observer = quoteHub.ToStochRsi(rsiPeriods, stochPeriods, signalPeriods, smoothPeriods);
+
+foreach (Quote quote in quotes)  // simulating stream
+{
+  quoteHub.Add(quote);
+}
+
+IReadOnlyList<StochRsiResult> results = observer.Results;
+```

docs/_indicators/SuperTrend.md

@@ -69,3 +69,33 @@ See [Utilities and helpers]({{site.baseurl}}/utilities#utilities-for-indicator-r
 ## Chaining
 
 This indicator is not chain-enabled and must be generated from `quotes`.  It **cannot** be used for further processing by other chain-enabled indicators.
+
+## Streaming
+
+Use the buffer-style `List<T>` when you need incremental calculations without a hub:
+
+```csharp
+SuperTrendList superTrendList = new(lookbackPeriods, multiplier);
+
+foreach (IQuote quote in quotes)  // simulating stream
+{
+  superTrendList.Add(quote);
+}
+
+// based on `ICollection<SuperTrendResult>`
+IReadOnlyList<SuperTrendResult> results = superTrendList;
+```
+
+Subscribe to a `QuoteHub` for advanced streaming scenarios:
+
+```csharp
+QuoteHub<Quote> quoteHub = new();
+SuperTrendHub<Quote> observer = quoteHub.ToSuperTrend(lookbackPeriods, multiplier);
+
+foreach (Quote quote in quotes)  // simulating stream
+{
+  quoteHub.Add(quote);
+}
+
+IReadOnlyList<SuperTrendResult> results = observer.Results;
+```

docs/_indicators/T3.md

@@ -77,3 +77,33 @@ var results = quotes
     .ToT3(..)
     .ToRsi(..);
 ```
+
+## Streaming
+
+Use the buffer-style `List<T>` when you need incremental calculations without a hub:
+
+```csharp
+T3List t3List = new(lookbackPeriods, volumeFactor);
+
+foreach (IQuote quote in quotes)  // simulating stream
+{
+  t3List.Add(quote);
+}
+
+// based on `ICollection<T3Result>`
+IReadOnlyList<T3Result> results = t3List;
+```
+
+Subscribe to a `QuoteHub` for advanced streaming scenarios:
+
+```csharp
+QuoteHub<Quote> quoteHub = new();
+T3Hub<Quote> observer = quoteHub.ToT3(lookbackPeriods, volumeFactor);
+
+foreach (Quote quote in quotes)  // simulating stream
+{
+  quoteHub.Add(quote);
+}
+
+IReadOnlyList<T3Result> results = observer.Results;
+```