kingchenc
62ab84c472
Introduce repo-metadata.toml as single source of truth for repo identity (org slug, maintainer email, canonical URLs) and add sync-metadata.yml workflow with a Python audit script that fails CI if any tracked file drifts back to pre-migration values. Bulk-replace across 24 tracked files: - kingchenc/wickra -> wickra-lib/wickra (URL segment) - kingchencp@gmail.com -> wickra.lib@gmail.com (maintainer email) - @kingchenc -> @wickra-lib (CODEOWNERS mention only) Person-name credits are preserved: LICENSE copyright holder, Cargo.toml authors handle, and CHANGELOG historical @kingchenc reference all remain unchanged. Crate / PyPI / npm package names also untouched. Merge this PR only after the kingchenc/wickra -> wickra-lib/wickra org transfer has happened on the GitHub side, otherwise all badges and repository links 404 until the transfer is performed.
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/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.
|