docs: More documentation cleanup#2106
Conversation
Align core type and enum names with industry-standard terminology for v3, where breaking changes are expected. A "quote" is properly a bid/ask snapshot; an OHLCV aggregate is a "bar" (Pine Script, TA-Lib, FIX/ITCH). Renames (full consistency across types, hubs, providers, extension methods, files/folders, tests, docs, and tooling): - Quote/QuoteD/IQuote -> Bar/BarD/IBar - QuoteHub/QuoteProvider/IQuoteProvider/QuoteAggregatorHub -> Bar* equivalents - QuotePart/IQuotePart -> BarPart/IBarPart - IIncrementFromQuote -> IIncrementFromBar; InvalidQuotesException -> InvalidBarsException - PeriodSize -> BarInterval (enum) - Tick/ITick/TickHub -> TradeTick/ITradeTick/TradeTickHub (raw trade print) Additions: - BarInterval <-> string-code map (BarIntervals.ToCode/ToBarInterval/TryToBarInterval), reused by the SSE test server; round-trip tests added. - Error-level [Obsolete] stubs for the v2-public IQuote/Quote/PeriodSize names, consolidated in Obsolete.V3.Other.cs (net-new v3 types hard-break, no stub). Docs: migration guide section, utilities/quotes -> utilities/bars (+ nav/redirects), QuotePart.md -> BarPart.md, AGENTS.md/README.md/skills updated. Intentional non-renames: tools/application + docs/examples (pinned to published Quote package), _testdata/quotes data dirs, external indy-charts /quotes API, frozen benchmark baselines. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…d markdown includes
Signed-off-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
DaveSkender
left a comment
There was a problem hiding this comment.
Some refinements to address
There was a problem hiding this comment.
This page needs editorial revisions
| ### `Direction` options for `type` | ||
|
|
||
| **`Direction.Short`** - Intended as stop loss value for short positions. | ||
| | enum value | description | |
There was a problem hiding this comment.
- this should be a shared markdown file
- ensure table header consistency
There was a problem hiding this comment.
Known issues needs to be reviewed
Co-authored-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Signed-off-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Co-authored-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Signed-off-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Co-authored-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Signed-off-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
| @@ -36,25 +36,25 @@ See links in the supported [MaType options](#matype-options) section below for d | |||
There was a problem hiding this comment.
| ### `MaType` options |
- convert to standard table format
| </script> | ||
|
|
||
| <p style="display:flex; justify-content:left; gap:1rem; margin-top: 2rem; flex-wrap:wrap;"> | ||
| <a href="https://www.nuget.org/packages/Skender.Stock.Indicators" aria-label="Get the NuGet package."><img src="https://img.shields.io/nuget/v/skender.stock.indicators?logo=NuGet&label=NuGet&color=blue&cacheSeconds=259200" alt="NuGet Package" /></a> |
There was a problem hiding this comment.
Move version badge to top site nav, maybe
| Access a comprehensive library of battle-tested technical indicators used by traders worldwide. Extend functionality by creating your own [custom indicators](/guide/customization) that integrate seamlessly with the library. | ||
|
|
||
| <ClientOnly> | ||
| <LandingCharts /> |
There was a problem hiding this comment.
fix right axis consistency
| Visit our [GitHub repository](https://github.com/DaveSkender/Stock.Indicators) to begin contributing. | ||
|
|
||
| » see our [full list of indicators and overlays](/indicators) | ||
| ::: tip |
| - **`QuoteHub` → `BarHub`**, **`QuoteProvider`/`IQuoteProvider` → `BarProvider`/`IBarProvider`** | ||
| - **`QuoteAggregatorHub` → `BarAggregatorHub`**, **`QuotePart`/`IQuotePart` → `BarPart`/`IBarPart`** | ||
| - **`PeriodSize` → `BarInterval`** (aggregation interval enum; member names unchanged) | ||
| - **`Tick`/`ITick` → `TradeTick`/`ITradeTick`** (single trade print; `TickHub` → `TradeTickHub`) |
There was a problem hiding this comment.
This shouldn’t be correct, review section
There was a problem hiding this comment.
This shouldn’t be correct, review section
There was a problem hiding this comment.
| IReadOnlyList<SmaResult> results = bars.ToSma(20); |
Many places
| // adxResults[40].Adxr is now NaN | ||
| ``` | ||
|
|
||
| ## New v3 feature: streaming capabilities |
There was a problem hiding this comment.
This should merge into doc site and just be succinct highlight here, or have a separate “What’s new in v3”
|
|
||
| Feed and correct streaming data through the `BarHub` (or `TradeTickHub`) you created — it cascades to every dependent hub. Calling `Add`, `RemoveAt`, `RemoveRange`, `Remove`, or `Reinitialize` on a subscribed hub such as an `EmaHub` throws `InvalidOperationException`. See the [streaming guide](/guide/styles/stream#thread-safety). | ||
|
|
||
| ### `null` versus `NaN` results |
There was a problem hiding this comment.
This shouldn’t be correct
Revert the temporary removal of HTML-Proofer exemptions that surfaced 224 external-link "failures" in the Website URLs check. All were false positives or intentionally-kept links: - status 0: v2 legacy-docs subdomain (kept by design) and slow/blocking hosts (stockcharts, mesasoftware) - 402/403: bot-blocking sites (investopedia, medium, coinbase, codeburst, jstor, forex-station) - 429: GitHub rate-limiting on auto-generated edit/blob/discussions links Restore the original --ignore-status-codes and regex --ignore-urls in both the workflow and the local test-links.sh (also fixes a nested-quote bug the temp change introduced). Revert kama.md back to the stockcharts source, matching the other indicator pages, instead of a Google-search URL. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
| # Kaufman's Adaptive Moving Average (KAMA) | ||
|
|
||
| Created by Perry Kaufman, [KAMA](https://www.google.com/search?q=Kaufman+Adaptive+Moving+Average+(KAMA)) is an volatility adaptive moving average of price over configurable lookback periods. | ||
| Created by Perry Kaufman, [KAMA](https://school.stockcharts.com/doku.php?id=technical_indicators:kaufman_s_adaptive_moving_average) is an volatility adaptive moving average of price over configurable lookback periods. |
There was a problem hiding this comment.
We’re suppressing legitimately dead link findings, this is likely better as generic < https://www.google.com/search?q=Kaufman+Adaptive+Moving+Average+(KAMA)> or via and internal URL shortener?
| --no-enforce-https | ||
| --no-check-external-hash | ||
| --ignore-urls "fonts.gstatic.com,github.com/DaveSkender/Stock.Indicators" | ||
| --ignore-status-codes "0,302,402,403,406,408,415,429,502,503,999" |
There was a problem hiding this comment.
This is overly suppressing legitimately failing dead links, see example.
The stockcharts KAMA page is dead (does not resolve); revert to the Google-search referral, which returns 200 and does not rely on the status-0 link-checker exemption. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
No description provided.