kingchenc
9309bf9d60
The documentation now lives in the wickra-lib/wickra-docs VitePress repo and
will deploy to docs.wickra.org. Rewrite every tracked, user-facing wiki link
in the main repo to the new canonical site:
- docs/README.md, CONTRIBUTING.md, PULL_REQUEST_TEMPLATE.md
- bindings/{node,python,wasm}/README.md, examples/wasm/README.md
- repo-metadata.toml: wiki_url/wiki_git -> docs_url/docs_git
Page paths map 1:1 to VitePress clean URLs (e.g. /wiki/Quickstart-Rust.md ->
docs.wickra.org/Quickstart-Rust). The sync-about.yml wiki-sync step is left
untouched on purpose: it stays until the docs site is live (tracked as P8.3).
The GitHub wiki itself is not deleted yet for the same reason.
1.5 KiB
1.5 KiB
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 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.
- 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.