kingchenc
120b6ac265
* docs+ci: surface 10-language golden verification; add WASM golden CI - README: add C++ to the Quickstart list and state prominently that all 514 indicators are replayed through all 10 languages and checked bit-for-bit against the Rust reference. - CHANGELOG: document the cross-language golden suite, the Java and R C-ABI bool-marshalling fixes, the C# nullable directive and the live_binance rename. - ci.yml: run the WASM golden suite (nodejs-target build + node --test); the C/C++ golden tests already run via the C-ABI job's ctest and the other bindings pick up their golden runners in their existing test suites. * readme: add verified badge + prominent per-language throughput table - Add the 'verified across 10 languages' badge to the badge row, linking to the FAQ that explains the cross-language golden parity. - Surface a per-binding throughput table (the cost of each language's FFI boundary) so readers can pick a binding that keeps up with streaming hot loops — the cross-library benchmarks stay in BENCHMARKS.md. * changelog: note the verified badge and per-binding throughput table * docs: fix cross-language consistency (audit) - docs/README.md: add the missing C++ quickstart link. - README testing section: the golden parity now covers all 10 languages and all 514 indicators (was 'four C-ABI bindings, 7 archetype indicators'). - CHANGELOG: the live_binance rename also covers the C examples.
1.9 KiB
1.9 KiB
Documentation
Wickra's full documentation lives at docs.wickra.org.
That includes:
- Quickstarts for Rust, Python, Node, WASM, C, C++, C#, Go, Java, and R.
- A per-indicator deep dive for every one of the 514 indicators across the twenty-four 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, Microstructure, Derivatives, Alt-Chart Bars, Market Breadth, Seasonality & Session, Chart Patterns, Harmonic Patterns, Fibonacci) — see the indicators overview.
- Reference pages: warmup periods, streaming vs batch, indicator chaining, and the data layer.
- Guides: Cookbook, TA-Lib migration, 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.