kingchenc
e5305ffa94
Adds seven information-driven bar builders to the **Alt-Chart Bars** family, the final batch of the family-deepening run. Indicator count **507 → 514**. ## Builders All implement the `BarBuilder` trait (`update(Candle) -> Vec<Bar>`), emitting a data-dependent number of completed bars per candle. | Builder | Driver | Bar fields | |---------|--------|-----------| | `RangeBars` | close | open, close, direction | | `TickBars` | OHLCV | open, high, low, close, volume | | `VolumeBars` | OHLCV | open, high, low, close, volume | | `DollarBars` (Lopez de Prado) | OHLCV | + dollar | | `ImbalanceBars` | OHLC | + imbalance, direction | | `RunBars` | OHLC | + length, direction | | `ThreeLineBreakBars` | close | open, close, direction | ## Touchpoints Seven core modules (each with full unit tests), `mod.rs`/`lib.rs` (builders counted, bar element types on their own re-export lines), README family rows, Python/Node/WASM hand-written bindings for the variable-length output (Python tuples + `(k, N)` ndarray; Node `Vec<object>`; WASM array of objects), the `bar_builder_update_candle` fuzz target, dedicated Python + Node tests, the `BAR_BUILDERS` completeness exclusion, and CHANGELOG. ## Verification - `cargo test -p wickra-core --lib` — 4207 passed - `cargo test -p wickra-core --doc` — 464 passed - `cargo clippy --workspace --all-targets --all-features -- -D warnings` — clean - `npm test` (node) — 584 passed - `pytest` (python) — 957 passed
32 lines
1.5 KiB
Markdown
32 lines
1.5 KiB
Markdown
# Documentation
|
|
|
|
Wickra's full documentation lives at **[docs.wickra.org](https://docs.wickra.org)**.
|
|
|
|
That includes:
|
|
|
|
- **Quickstarts** for [Rust](https://docs.wickra.org/Quickstart-Rust),
|
|
[Python](https://docs.wickra.org/Quickstart-Python),
|
|
[Node](https://docs.wickra.org/Quickstart-Node), and
|
|
[WASM](https://docs.wickra.org/Quickstart-WASM).
|
|
- A per-indicator deep dive for every one of the **514 indicators** across
|
|
the sixteen families (Moving Averages, Momentum Oscillators, Trend &
|
|
Directional, Price Oscillators, Volatility & Bands, Bands & Channels,
|
|
Trailing Stops, Volume, Price Statistics, Ehlers / Cycle DSP, Pivots &
|
|
S/R, DeMark, Ichimoku & Charts, Candlestick Patterns, Market Profile,
|
|
Risk / Performance) — see the
|
|
[indicators overview](https://docs.wickra.org/Indicators-Overview).
|
|
- **Reference pages**: [warmup periods](https://docs.wickra.org/Warmup-Periods),
|
|
[streaming vs batch](https://docs.wickra.org/Streaming-vs-Batch),
|
|
[indicator chaining](https://docs.wickra.org/Indicator-Chaining), and the
|
|
[data layer](https://docs.wickra.org/Data-Layer).
|
|
- **Guides**: [Cookbook](https://docs.wickra.org/Cookbook),
|
|
[TA-Lib migration](https://docs.wickra.org/TA-Lib-Migration),
|
|
[FAQ](https://docs.wickra.org/FAQ).
|
|
|
|
## Editing the docs
|
|
|
|
The documentation site is a separate git repository at
|
|
`https://github.com/wickra-lib/wickra-docs`. Open a pull request there to
|
|
propose changes; the site is built with VitePress and deploys to
|
|
`docs.wickra.org`.
|