docs(P6.4): repoint all doc links from the GitHub wiki to docs.wickra.org (#86)

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.
This commit is contained in:
kingchenc
2026-05-31 21:48:24 +02:00
committed by GitHub
parent 3f05342f72
commit 9309bf9d60
8 changed files with 33 additions and 32 deletions
+3 -3
View File
@@ -24,9 +24,9 @@
- [ ] New behaviour has tests; bug fixes have a regression test. - [ ] New behaviour has tests; bug fixes have a regression test.
- [ ] Public API changes are mirrored in the Python / Node / WASM bindings - [ ] Public API changes are mirrored in the Python / Node / WASM bindings
and their type stubs (If applicable). and their type stubs (If applicable).
- [ ] The relevant page on the [project Wiki](https://github.com/wickra-lib/wickra/wiki) - [ ] The relevant page on the [documentation site](https://docs.wickra.org)
and the `README.md` are updated (If applicable). Wiki edits go to a and the `README.md` are updated (If applicable). Docs edits go to a
separate repository: `https://github.com/wickra-lib/wickra.wiki.git`. separate repository: `https://github.com/wickra-lib/wickra-docs`.
- [ ] An entry was added under `## [Unreleased]` in `CHANGELOG.md`. - [ ] An entry was added under `## [Unreleased]` in `CHANGELOG.md`.
## Notes for reviewers ## Notes for reviewers
+3 -3
View File
@@ -96,9 +96,9 @@ the repository root is not an npm package.
- **Bindings.** A change to a public indicator API must be mirrored across the - **Bindings.** A change to a public indicator API must be mirrored across the
Python, Node, and WASM bindings, including their type stubs / `.d.ts`. Python, Node, and WASM bindings, including their type stubs / `.d.ts`.
- **Docs.** Update the relevant page on the - **Docs.** Update the relevant page on the
[project Wiki](https://github.com/wickra-lib/wickra/wiki) and the [documentation site](https://docs.wickra.org) and the
`README.md` when behaviour or the public API changes. The Wiki lives in `README.md` when behaviour or the public API changes. The docs live in
a separate git repository: `https://github.com/wickra-lib/wickra.wiki.git`. a separate git repository: `https://github.com/wickra-lib/wickra-docs`.
- **Changelog.** Add an entry under `## [Unreleased]` in `CHANGELOG.md`. - **Changelog.** Add an entry under `## [Unreleased]` in `CHANGELOG.md`.
## Commit and pull-request workflow ## Commit and pull-request workflow
+2 -2
View File
@@ -49,10 +49,10 @@ identical values — the equivalence is enforced by the test suite.
## Documentation ## Documentation
The full indicator catalogue, guides, quickstarts, and API reference live in The full indicator catalogue, guides, quickstarts, and API reference live in
the main repository and wiki: the main repository and documentation site:
- **Repository & full indicator list:** <https://github.com/wickra-lib/wickra> - **Repository & full indicator list:** <https://github.com/wickra-lib/wickra>
- **Wiki** (quickstarts, cookbook, TA-Lib migration): <https://github.com/wickra-lib/wickra/wiki> - **Docs** (quickstarts, cookbook, TA-Lib migration): <https://docs.wickra.org>
- **Runnable examples:** [`examples/node/`](https://github.com/wickra-lib/wickra/tree/main/examples/node) - **Runnable examples:** [`examples/node/`](https://github.com/wickra-lib/wickra/tree/main/examples/node)
Wickra ships four bindings — Python, Node.js, WebAssembly, and Rust — that all Wickra ships four bindings — Python, Node.js, WebAssembly, and Rust — that all
+2 -2
View File
@@ -48,10 +48,10 @@ identical values — the equivalence is enforced by the test suite.
## Documentation ## Documentation
The full indicator catalogue, guides, quickstarts, and API reference live in The full indicator catalogue, guides, quickstarts, and API reference live in
the main repository and wiki: the main repository and documentation site:
- **Repository & full indicator list:** <https://github.com/wickra-lib/wickra> - **Repository & full indicator list:** <https://github.com/wickra-lib/wickra>
- **Wiki** (quickstarts, cookbook, TA-Lib migration): <https://github.com/wickra-lib/wickra/wiki> - **Docs** (quickstarts, cookbook, TA-Lib migration): <https://docs.wickra.org>
- **Runnable examples:** [`examples/python/`](https://github.com/wickra-lib/wickra/tree/main/examples/python) - **Runnable examples:** [`examples/python/`](https://github.com/wickra-lib/wickra/tree/main/examples/python)
Wickra ships four bindings — Python, Node.js, WebAssembly, and Rust — that all Wickra ships four bindings — Python, Node.js, WebAssembly, and Rust — that all
+2 -2
View File
@@ -48,10 +48,10 @@ Constructors mirror the other bindings (`new SMA(20)`, `new MACD(12, 26, 9)`,
## Documentation ## Documentation
The full indicator catalogue, guides, quickstarts, and API reference live in The full indicator catalogue, guides, quickstarts, and API reference live in
the main repository and wiki: the main repository and documentation site:
- **Repository & full indicator list:** <https://github.com/wickra-lib/wickra> - **Repository & full indicator list:** <https://github.com/wickra-lib/wickra>
- **Wiki** (quickstarts, cookbook, TA-Lib migration): <https://github.com/wickra-lib/wickra/wiki> - **Docs** (quickstarts, cookbook, TA-Lib migration): <https://docs.wickra.org>
- **Runnable browser examples:** [`examples/wasm/`](https://github.com/wickra-lib/wickra/tree/main/examples/wasm) - **Runnable browser examples:** [`examples/wasm/`](https://github.com/wickra-lib/wickra/tree/main/examples/wasm)
Wickra ships four bindings — Python, Node.js, WebAssembly, and Rust — that all Wickra ships four bindings — Python, Node.js, WebAssembly, and Rust — that all
+18 -17
View File
@@ -1,30 +1,31 @@
# Documentation # Documentation
Wickra's full documentation lives in the **[GitHub Wiki](https://github.com/wickra-lib/wickra/wiki)**. Wickra's full documentation lives at **[docs.wickra.org](https://docs.wickra.org)**.
That includes: That includes:
- **Quickstarts** for [Rust](https://github.com/wickra-lib/wickra/wiki/Quickstart-Rust.md), - **Quickstarts** for [Rust](https://docs.wickra.org/Quickstart-Rust),
[Python](https://github.com/wickra-lib/wickra/wiki/Quickstart-Python.md), [Python](https://docs.wickra.org/Quickstart-Python),
[Node](https://github.com/wickra-lib/wickra/wiki/Quickstart-Node.md), and [Node](https://docs.wickra.org/Quickstart-Node), and
[WASM](https://github.com/wickra-lib/wickra/wiki/Quickstart-WASM.md). [WASM](https://docs.wickra.org/Quickstart-WASM).
- A per-indicator deep dive for every one of the **214 indicators** across - A per-indicator deep dive for every one of the **214 indicators** across
the sixteen families (Moving Averages, Momentum Oscillators, Trend & the sixteen families (Moving Averages, Momentum Oscillators, Trend &
Directional, Price Oscillators, Volatility & Bands, Bands & Channels, Directional, Price Oscillators, Volatility & Bands, Bands & Channels,
Trailing Stops, Volume, Price Statistics, Ehlers / Cycle DSP, Pivots & Trailing Stops, Volume, Price Statistics, Ehlers / Cycle DSP, Pivots &
S/R, DeMark, Ichimoku & Charts, Candlestick Patterns, Market Profile, S/R, DeMark, Ichimoku & Charts, Candlestick Patterns, Market Profile,
Risk / Performance) — see the Risk / Performance) — see the
[indicators overview](https://github.com/wickra-lib/wickra/wiki/Indicators-Overview.md). [indicators overview](https://docs.wickra.org/Indicators-Overview).
- **Reference pages**: [warmup periods](https://github.com/wickra-lib/wickra/wiki/Warmup-Periods.md), - **Reference pages**: [warmup periods](https://docs.wickra.org/Warmup-Periods),
[streaming vs batch](https://github.com/wickra-lib/wickra/wiki/Streaming-vs-Batch.md), [streaming vs batch](https://docs.wickra.org/Streaming-vs-Batch),
[indicator chaining](https://github.com/wickra-lib/wickra/wiki/Indicator-Chaining.md), and the [indicator chaining](https://docs.wickra.org/Indicator-Chaining), and the
[data layer](https://github.com/wickra-lib/wickra/wiki/Data-Layer.md). [data layer](https://docs.wickra.org/Data-Layer).
- **Guides**: [Cookbook](https://github.com/wickra-lib/wickra/wiki/Cookbook.md), - **Guides**: [Cookbook](https://docs.wickra.org/Cookbook),
[TA-Lib migration](https://github.com/wickra-lib/wickra/wiki/TA-Lib-Migration.md), [TA-Lib migration](https://docs.wickra.org/TA-Lib-Migration),
[FAQ](https://github.com/wickra-lib/wickra/wiki/FAQ.md). [FAQ](https://docs.wickra.org/FAQ).
## Editing the wiki ## Editing the docs
The wiki is a separate git repository at `https://github.com/wickra-lib/wickra.wiki.git`. The documentation site is a separate git repository at
Clone it locally if you want to bulk-edit; otherwise the GitHub web UI's "Edit" button on any `https://github.com/wickra-lib/wickra-docs`. Open a pull request there to
wiki page is fine for one-off changes. propose changes; the site is built with VitePress and deploys to
`docs.wickra.org`.
+1 -1
View File
@@ -58,7 +58,7 @@ indicators tracks those.
## See also ## See also
- [Quickstart: WASM](https://github.com/wickra-lib/wickra/wiki/Quickstart-WASM.md) — module-load - [Quickstart: WASM](https://docs.wickra.org/Quickstart-WASM) — module-load
flow, `wasm-pack` targets, and the streaming API. flow, `wasm-pack` targets, and the streaming API.
- [examples/README.md](../README.md) — cross-language index, including - [examples/README.md](../README.md) — cross-language index, including
the Rust, Python and Node siblings of every demo above. the Rust, Python and Node siblings of every demo above.
+2 -2
View File
@@ -10,8 +10,8 @@
org = "wickra-lib" org = "wickra-lib"
name = "wickra" name = "wickra"
url = "https://github.com/wickra-lib/wickra" url = "https://github.com/wickra-lib/wickra"
wiki_url = "https://github.com/wickra-lib/wickra/wiki" docs_url = "https://docs.wickra.org"
wiki_git = "https://github.com/wickra-lib/wickra.wiki.git" docs_git = "https://github.com/wickra-lib/wickra-docs"
issues_url = "https://github.com/wickra-lib/wickra/issues" issues_url = "https://github.com/wickra-lib/wickra/issues"
discussions = "https://github.com/wickra-lib/wickra/discussions" discussions = "https://github.com/wickra-lib/wickra/discussions"
security_url = "https://github.com/wickra-lib/wickra/security/advisories/new" security_url = "https://github.com/wickra-lib/wickra/security/advisories/new"