kingchenc
0f2ff9c3c7
* chore(sync-about): count public indicator types, not module files
The sync-about workflow counted `mod xxx;` lines in
crates/wickra-core/src/indicators/mod.rs to derive the indicator count
that gets propagated to README, the GitHub About description, and the
wiki. That under-reported by one because `vwap.rs` exports two public
types — `Vwap` (cumulative) and `RollingVwap` (finite window) — from
the same module. The bindings reach both, so users see 214 indicators
even though there are only 213 source files.
Fix the count by parsing the canonical `pub use indicators::{ ... }`
block in lib.rs, dropping the `FAMILIES` constant and any `*Output`
companion structs, and counting the remaining public types. Pure-shell
implementation so the workflow doesn't grow a python dependency.
Sync README to the corrected count (213 -> 214) in the same commit so
the PR validates cleanly through the workflow's PR-flow.
* docs(bindings): sync per-binding READMEs and docs/ pointer to 214 / 16
The bindings/{node,python,wasm}/README.md files (which ship to
npm / PyPI / npm again) and docs/README.md (the pointer to the
wiki) all carried the stale '71 streaming-first indicators across
eight families' header from before the family expansion. Pull the
canonical 16-family table out of the main README into all three
binding READMEs and update docs/README.md to list every family by
name, so a user landing on PyPI / npm sees the current catalogue
shape.
31 lines
1.7 KiB
Markdown
31 lines
1.7 KiB
Markdown
# Documentation
|
|
|
|
Wickra's full documentation lives in the **[GitHub Wiki](https://github.com/kingchenc/wickra/wiki)**.
|
|
|
|
That includes:
|
|
|
|
- **Quickstarts** for [Rust](https://github.com/kingchenc/wickra/wiki/Quickstart-Rust.md),
|
|
[Python](https://github.com/kingchenc/wickra/wiki/Quickstart-Python.md),
|
|
[Node](https://github.com/kingchenc/wickra/wiki/Quickstart-Node.md), and
|
|
[WASM](https://github.com/kingchenc/wickra/wiki/Quickstart-WASM.md).
|
|
- A per-indicator deep dive for every one of the **214 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://github.com/kingchenc/wickra/wiki/Indicators-Overview.md).
|
|
- **Reference pages**: [warmup periods](https://github.com/kingchenc/wickra/wiki/Warmup-Periods.md),
|
|
[streaming vs batch](https://github.com/kingchenc/wickra/wiki/Streaming-vs-Batch.md),
|
|
[indicator chaining](https://github.com/kingchenc/wickra/wiki/Indicator-Chaining.md), and the
|
|
[data layer](https://github.com/kingchenc/wickra/wiki/Data-Layer.md).
|
|
- **Guides**: [Cookbook](https://github.com/kingchenc/wickra/wiki/Cookbook.md),
|
|
[TA-Lib migration](https://github.com/kingchenc/wickra/wiki/TA-Lib-Migration.md),
|
|
[FAQ](https://github.com/kingchenc/wickra/wiki/FAQ.md).
|
|
|
|
## Editing the wiki
|
|
|
|
The wiki is a separate git repository at `https://github.com/kingchenc/wickra.wiki.git`.
|
|
Clone it locally if you want to bulk-edit; otherwise the GitHub web UI's "Edit" button on any
|
|
wiki page is fine for one-off changes.
|