wickra/docs/README.md

# Documentation

Wickra's full documentation lives in the **[GitHub Wiki](https://github.com/wickra-lib/wickra/wiki)**.

That includes:

- **Quickstarts** for [Rust](https://github.com/wickra-lib/wickra/wiki/Quickstart-Rust.md),
  [Python](https://github.com/wickra-lib/wickra/wiki/Quickstart-Python.md),
  [Node](https://github.com/wickra-lib/wickra/wiki/Quickstart-Node.md), and
  [WASM](https://github.com/wickra-lib/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/wickra-lib/wickra/wiki/Indicators-Overview.md).
- **Reference pages**: [warmup periods](https://github.com/wickra-lib/wickra/wiki/Warmup-Periods.md),
  [streaming vs batch](https://github.com/wickra-lib/wickra/wiki/Streaming-vs-Batch.md),
  [indicator chaining](https://github.com/wickra-lib/wickra/wiki/Indicator-Chaining.md), and the
  [data layer](https://github.com/wickra-lib/wickra/wiki/Data-Layer.md).
- **Guides**: [Cookbook](https://github.com/wickra-lib/wickra/wiki/Cookbook.md),
  [TA-Lib migration](https://github.com/wickra-lib/wickra/wiki/TA-Lib-Migration.md),
  [FAQ](https://github.com/wickra-lib/wickra/wiki/FAQ.md).

## Editing the wiki

The wiki is a separate git repository at `https://github.com/wickra-lib/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.