kingchenc
ad51dbc1a3
* fix: keep docs/README indicator count in sync-about
The docs/README.md pointer prose names the indicator count
("**N indicators**") but was never part of the sync-about counter
pipeline, so it drifted to 214 while the real count (lib.rs) is 249.
Add docs/README.md to the PR-flow gate check, the patch sed, and the
fix-up commit so future count changes keep it in sync, and correct the
current stale value to 249.
* docs: fix stale Wiki reference in CONTRIBUTING layout table
The project-layout table still described docs/ as a "Pointer to the
project Wiki" even though the wiki was retired and the docs moved to
docs.wickra.org (wickra-lib/wickra-docs). Align the row with the
already-correct doc-site section further down the same file.
Documentation
Wickra's full documentation lives at docs.wickra.org.
That includes:
- Quickstarts for Rust, Python, Node, and WASM.
- A per-indicator deep dive for every one of the 249 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.
- 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.