kingchenc
4aec5d544c
The 84 markdown files under docs/wiki/ are now published to the project's GitHub Wiki at https://github.com/kingchenc/wickra/wiki — a separate git repository (https://github.com/kingchenc/wickra.wiki.git) that GitHub hosts natively with its own UI, search and history. The flat layout that the GitHub Wiki requires has been generated, all internal cross-links rewritten, and a _Sidebar.md groups the 71 indicators by their canonical 8 families. Effects: - docs/wiki/ is removed from the main repo (-84 files). docs/README.md now just points readers at the Wiki. - PR template + CONTRIBUTING text updated to point at the Wiki instead of the in-repo path. The Wiki repo is separately cloneable and editable via the GitHub web UI. - examples/wasm/README.md cross-link fixed to use the Wiki URL. - The (still in-repo) CHANGELOG keeps its historical references to docs/wiki/ paths — those describe what the tree looked like at past releases and stay accurate as history. - README.md, license, all source unaffected. The Wiki itself ships with _Sidebar.md / _Footer.md generated from the 8-families taxonomy and 503/503 cross-links resolved.
1.6 KiB
1.6 KiB
Documentation
Wickra's full documentation lives in the GitHub Wiki.
That includes:
- Quickstarts for Rust, Python, Node, and WASM.
- A per-indicator deep dive for every one of the 71 indicators across the eight families (Moving Averages, Momentum Oscillators, Trend & Directional, Price Oscillators, Volatility & Bands, Trailing Stops, Volume, Price Statistics) — 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 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.