From 9309bf9d60033d0eaf85f04c3dd16cc4f163b148 Mon Sep 17 00:00:00 2001 From: kingchenc Date: Sun, 31 May 2026 21:48:24 +0200 Subject: [PATCH] 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. --- .github/PULL_REQUEST_TEMPLATE.md | 6 +++--- CONTRIBUTING.md | 6 +++--- bindings/node/README.md | 4 ++-- bindings/python/README.md | 4 ++-- bindings/wasm/README.md | 4 ++-- docs/README.md | 35 ++++++++++++++++---------------- examples/wasm/README.md | 2 +- repo-metadata.toml | 4 ++-- 8 files changed, 33 insertions(+), 32 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ad950ec7..078a43ea 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -24,9 +24,9 @@ - [ ] New behaviour has tests; bug fixes have a regression test. - [ ] Public API changes are mirrored in the Python / Node / WASM bindings and their type stubs (If applicable). -- [ ] The relevant page on the [project Wiki](https://github.com/wickra-lib/wickra/wiki) - and the `README.md` are updated (If applicable). Wiki edits go to a - separate repository: `https://github.com/wickra-lib/wickra.wiki.git`. +- [ ] The relevant page on the [documentation site](https://docs.wickra.org) + and the `README.md` are updated (If applicable). Docs edits go to a + separate repository: `https://github.com/wickra-lib/wickra-docs`. - [ ] An entry was added under `## [Unreleased]` in `CHANGELOG.md`. ## Notes for reviewers diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fec21b3c..7969dc57 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 Python, Node, and WASM bindings, including their type stubs / `.d.ts`. - **Docs.** Update the relevant page on the - [project Wiki](https://github.com/wickra-lib/wickra/wiki) and the - `README.md` when behaviour or the public API changes. The Wiki lives in - a separate git repository: `https://github.com/wickra-lib/wickra.wiki.git`. + [documentation site](https://docs.wickra.org) and the + `README.md` when behaviour or the public API changes. The docs live in + a separate git repository: `https://github.com/wickra-lib/wickra-docs`. - **Changelog.** Add an entry under `## [Unreleased]` in `CHANGELOG.md`. ## Commit and pull-request workflow diff --git a/bindings/node/README.md b/bindings/node/README.md index 709f60e6..500c5d60 100644 --- a/bindings/node/README.md +++ b/bindings/node/README.md @@ -49,10 +49,10 @@ identical values — the equivalence is enforced by the test suite. ## Documentation 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:** -- **Wiki** (quickstarts, cookbook, TA-Lib migration): +- **Docs** (quickstarts, cookbook, TA-Lib migration): - **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 diff --git a/bindings/python/README.md b/bindings/python/README.md index fc19671d..c076c82c 100644 --- a/bindings/python/README.md +++ b/bindings/python/README.md @@ -48,10 +48,10 @@ identical values — the equivalence is enforced by the test suite. ## Documentation 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:** -- **Wiki** (quickstarts, cookbook, TA-Lib migration): +- **Docs** (quickstarts, cookbook, TA-Lib migration): - **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 diff --git a/bindings/wasm/README.md b/bindings/wasm/README.md index 6fdc0dff..819b1da9 100644 --- a/bindings/wasm/README.md +++ b/bindings/wasm/README.md @@ -48,10 +48,10 @@ Constructors mirror the other bindings (`new SMA(20)`, `new MACD(12, 26, 9)`, ## Documentation 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:** -- **Wiki** (quickstarts, cookbook, TA-Lib migration): +- **Docs** (quickstarts, cookbook, TA-Lib migration): - **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 diff --git a/docs/README.md b/docs/README.md index 94d12d5b..8f5546a6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,30 +1,31 @@ # 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: -- **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). +- **Quickstarts** for [Rust](https://docs.wickra.org/Quickstart-Rust), + [Python](https://docs.wickra.org/Quickstart-Python), + [Node](https://docs.wickra.org/Quickstart-Node), and + [WASM](https://docs.wickra.org/Quickstart-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](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). + [indicators overview](https://docs.wickra.org/Indicators-Overview). +- **Reference pages**: [warmup periods](https://docs.wickra.org/Warmup-Periods), + [streaming vs batch](https://docs.wickra.org/Streaming-vs-Batch), + [indicator chaining](https://docs.wickra.org/Indicator-Chaining), and the + [data layer](https://docs.wickra.org/Data-Layer). +- **Guides**: [Cookbook](https://docs.wickra.org/Cookbook), + [TA-Lib migration](https://docs.wickra.org/TA-Lib-Migration), + [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`. -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. +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`. diff --git a/examples/wasm/README.md b/examples/wasm/README.md index 0294699c..eaa32eff 100644 --- a/examples/wasm/README.md +++ b/examples/wasm/README.md @@ -58,7 +58,7 @@ indicators tracks those. ## 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. - [examples/README.md](../README.md) — cross-language index, including the Rust, Python and Node siblings of every demo above. diff --git a/repo-metadata.toml b/repo-metadata.toml index b5cd2dbe..f478724c 100644 --- a/repo-metadata.toml +++ b/repo-metadata.toml @@ -10,8 +10,8 @@ org = "wickra-lib" name = "wickra" url = "https://github.com/wickra-lib/wickra" -wiki_url = "https://github.com/wickra-lib/wickra/wiki" -wiki_git = "https://github.com/wickra-lib/wickra.wiki.git" +docs_url = "https://docs.wickra.org" +docs_git = "https://github.com/wickra-lib/wickra-docs" issues_url = "https://github.com/wickra-lib/wickra/issues" discussions = "https://github.com/wickra-lib/wickra/discussions" security_url = "https://github.com/wickra-lib/wickra/security/advisories/new"