Connect wiki.openpit.dev

Author: palchukovsky

.github/workflows/wiki.yml

@@ -0,0 +1,95 @@
+# Copyright The Pit Project Owners. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Please see https://openpit.dev and the OWNERS file for details.
+
+name: Wiki
+
+on:
+  gollum:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - .github/workflows/wiki.yml
+
+permissions:
+  contents: read
+  deployments: write
+
+concurrency:
+  group: wiki-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-deploy:
+    name: Build and deploy wiki
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout workflow repository
+        uses: actions/checkout@v4
+
+      - name: Clone wiki repository
+        run: |
+          git clone \
+            --depth 1 \
+            "https://github.com/${{ github.repository }}.wiki.git" \
+            "$RUNNER_TEMP/pit.wiki"
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: ${{ runner.temp }}/pit.wiki/.site/requirements.txt
+
+      - name: Install wiki build dependencies
+        working-directory: ${{ runner.temp }}/pit.wiki
+        run: python -m pip install -r .site/requirements.txt
+
+      - name: Prepare wiki source
+        working-directory: ${{ runner.temp }}/pit.wiki
+        run: python .site/scripts/prepare_wiki_source.py --source .
+
+      - name: Build wiki
+        working-directory: ${{ runner.temp }}/pit.wiki
+        run: mkdocs build --strict --config-file .site/mkdocs.yml
+
+      - name: Check Cloudflare configuration
+        env:
+          CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+        run: |
+          missing=0
+          if [ -z "$CLOUDFLARE_ACCOUNT_ID" ]; then
+            echo "::error::CLOUDFLARE_ACCOUNT_ID secret is not configured"
+            missing=1
+          fi
+          if [ -z "$CLOUDFLARE_API_TOKEN" ]; then
+            echo "::error::CLOUDFLARE_API_TOKEN secret is not configured"
+            missing=1
+          fi
+          exit "$missing"
+
+      - name: Deploy wiki to Cloudflare Pages
+        uses: cloudflare/wrangler-action@v3
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}
+          command: >-
+            pages deploy ${{ runner.temp }}/pit.wiki/.site/site
+            --project-name=openpit-wiki

README.md

@@ -41,35 +41,35 @@ The current implementation focuses on the pre-trade pipeline, a small set
 of built-in controls, and an API for building project-specific strategy and
 risk policies. Built-ins:
 
-- [Spot Funds](https://github.com/openpitkit/pit/wiki/Spot-Funds) - per-account
+- [Spot Funds](https://wiki.openpit.dev/Spot-Funds/) - per-account
   solvency gate over spendable funds.
-- [Order Validation](https://github.com/openpitkit/pit/wiki/Policies#ordervalidationpolicy)
+- [Order Validation](https://wiki.openpit.dev/Policies/#ordervalidationpolicy)
   \- structural integrity checks on every order.
-- [Rate Limit](https://github.com/openpitkit/pit/wiki/Policies#ratelimitpolicy)
+- [Rate Limit](https://wiki.openpit.dev/Policies/#ratelimitpolicy)
   \- throttle order flow per broker, asset, or account.
-- [Order Size Limit](https://github.com/openpitkit/pit/wiki/Policies#ordersizelimitpolicy)
+- [Order Size Limit](https://wiki.openpit.dev/Policies/#ordersizelimitpolicy)
   \- fat-finger caps on quantity and notional.
-- [P&L Kill Switch](https://github.com/openpitkit/pit/wiki/Policies#pnlboundskillswitchpolicy)
+- [P&L Kill Switch](https://wiki.openpit.dev/Policies/#pnlboundskillswitchpolicy)
   \- halt an account when realized P&L breaches bounds.
-- plus your own via the [policy SDK](https://github.com/openpitkit/pit/wiki/Policy-API).
+- plus your own via the [policy SDK](https://wiki.openpit.dev/Policy-API/).
 
 Custom policies that maintain state across calls can use the built-in
-[Storage](https://github.com/openpitkit/pit/wiki/Storage) abstraction.
+[Storage](https://wiki.openpit.dev/Storage/) abstraction.
 Synchronization is selected once at engine construction and applied
 transparently, with no overhead in single-threaded embeddings.
 
 Controls can act both by account and by group of accounts: register accounts
-under a compact identifier with [Account Groups](https://github.com/openpitkit/pit/wiki/Account-Groups)
+under a compact identifier with [Account Groups](https://wiki.openpit.dev/Account-Groups/)
 and let a policy branch on the group instead of an enumerated account list.
 
 The engine is intentionally in-memory and deterministic, designed to be
 embedded into a larger trading system rather than replace one. For custom
 policy APIs:
 
-- [Go custom policies](https://github.com/openpitkit/pit/wiki/Policy-API#go-interface)
-- [Python custom policies](https://github.com/openpitkit/pit/wiki/Policy-API#python-interface)
-- [C++ custom policies](https://github.com/openpitkit/pit/wiki/Policy-API#c-interface)
-- [Rust custom policies](https://github.com/openpitkit/pit/wiki/Policy-API#rust-interface)
+- [Go custom policies](https://wiki.openpit.dev/Policy-API/#go-interface)
+- [Python custom policies](https://wiki.openpit.dev/Policy-API/#python-interface)
+- [C++ custom policies](https://wiki.openpit.dev/Policy-API/#c-interface)
+- [Rust custom policies](https://wiki.openpit.dev/Policy-API/#rust-interface)
 
 ## Versioning Policy (Pre‑1.0)
 
@@ -95,7 +95,7 @@ constraints that tolerate API evolution during the pre-stable phase.
 - [C SDK README](bindings/c/README.md) - C interface for environments that
   integrate through C.
 - [examples/](examples/) - end-to-end runnable scenarios.
-- [Wiki](https://github.com/openpitkit/pit/wiki) - conceptual pages and
+- [Wiki](https://wiki.openpit.dev/) - conceptual pages and
   architecture notes.
 
 ## Local Build And Test

bindings/c/README.md

@@ -10,7 +10,7 @@ that consume a C ABI.
 
 For an overview and links to all resources, see the project website [openpit.dev](https://openpit.dev/).
 For full project documentation, see [the repository README](https://github.com/openpitkit/pit/blob/main/README.md).
-For conceptual and architectural pages, see [the project wiki](https://github.com/openpitkit/pit/wiki).
+For conceptual and architectural pages, see [the project wiki](https://wiki.openpit.dev/).
 For the split C reference manual, see [the C API docs](https://github.com/openpitkit/pit/blob/main/docs/c-api/index.md).
 
 ## Versioning Policy (Pre‑1.0)
@@ -133,17 +133,17 @@ reject is produced.
 
 Built-in policies:
 
-- [Spot Funds](https://github.com/openpitkit/pit/wiki/Spot-Funds) - per-account
+- [Spot Funds](https://wiki.openpit.dev/Spot-Funds/) - per-account
   solvency gate over spendable funds.
-- [Order Validation](https://github.com/openpitkit/pit/wiki/Policies#ordervalidationpolicy)
+- [Order Validation](https://wiki.openpit.dev/Policies/#ordervalidationpolicy)
   \- structural integrity checks on every order.
-- [Rate Limit](https://github.com/openpitkit/pit/wiki/Policies#ratelimitpolicy)
+- [Rate Limit](https://wiki.openpit.dev/Policies/#ratelimitpolicy)
   \- throttle order flow per broker, asset, or account.
-- [Order Size Limit](https://github.com/openpitkit/pit/wiki/Policies#ordersizelimitpolicy)
+- [Order Size Limit](https://wiki.openpit.dev/Policies/#ordersizelimitpolicy)
   \- fat-finger caps on quantity and notional.
-- [P&L Kill Switch](https://github.com/openpitkit/pit/wiki/Policies#pnlboundskillswitchpolicy)
+- [P&L Kill Switch](https://wiki.openpit.dev/Policies/#pnlboundskillswitchpolicy)
   \- halt an account when realized P&L breaches bounds.
-- plus your own via the [policy SDK](https://github.com/openpitkit/pit/wiki/Policy-API).
+- plus your own via the [policy SDK](https://wiki.openpit.dev/Policy-API/).
 
 The primary integration model is to build project-specific policies against the
 public C API: [the C API docs](../../docs/c-api/index.md).
@@ -153,7 +153,7 @@ rejection of only the current request. Kill switches are intended for
 algorithmic trading where automatic order submission must be halted until the
 situation is analyzed.
 
-Built-in policies that maintain state across calls use the SDK's [Storage](https://github.com/openpitkit/pit/wiki/Storage)
+Built-in policies that maintain state across calls use the SDK's [Storage](https://wiki.openpit.dev/Storage/)
 abstraction internally. The runtime library handles the necessary memory
 synchronization for policy state; the C consumer is responsible only for the
 threading contract on the SDK handle.

bindings/cpp/README.md

@@ -13,7 +13,7 @@ is packaged as a CMake config package and exposes the `OpenPit::openpit` target.
 For an overview and links to all resources, see the project website [openpit.dev](https://openpit.dev/).
 For the C++ API reference, see [the C++ API docs](../../docs/cpp-api/index.html).
 For full project documentation, see [the repository README](https://github.com/openpitkit/pit/blob/main/README.md).
-For conceptual and architectural pages, see [the project wiki](https://github.com/openpitkit/pit/wiki).
+For conceptual and architectural pages, see [the project wiki](https://wiki.openpit.dev/).
 
 ## Versioning Policy (Pre-1.0)
 
@@ -142,15 +142,15 @@ in reverse order when any reject is produced.
 Built-in policies:
 
 - `SpotFundsPolicy` -
-  [per-account solvency gate over spendable funds](https://github.com/openpitkit/pit/wiki/Spot-Funds)
-- `OrderValidationPolicy` - [structural integrity checks on every order](https://github.com/openpitkit/pit/wiki/Policies#ordervalidationpolicy)
-- `RateLimitPolicy` - [throttle order flow per broker, asset, or account](https://github.com/openpitkit/pit/wiki/Policies#ratelimitpolicy)
-- `OrderSizeLimitPolicy` - [fat-finger caps on quantity and notional](https://github.com/openpitkit/pit/wiki/Policies#ordersizelimitpolicy)
-- `PnlBoundsKillSwitchPolicy` - [halt an account when realized P&L breaches bounds](https://github.com/openpitkit/pit/wiki/Policies#pnlboundskillswitchpolicy)
+  [per-account solvency gate over spendable funds](https://wiki.openpit.dev/Spot-Funds/)
+- `OrderValidationPolicy` - [structural integrity checks on every order](https://wiki.openpit.dev/Policies/#ordervalidationpolicy)
+- `RateLimitPolicy` - [throttle order flow per broker, asset, or account](https://wiki.openpit.dev/Policies/#ratelimitpolicy)
+- `OrderSizeLimitPolicy` - [fat-finger caps on quantity and notional](https://wiki.openpit.dev/Policies/#ordersizelimitpolicy)
+- `PnlBoundsKillSwitchPolicy` - [halt an account when realized P&L breaches bounds](https://wiki.openpit.dev/Policies/#pnlboundskillswitchpolicy)
 
 The primary integration model is to write project-specific policies against
 the public C++ policy API:
-[Custom C++ policies](https://github.com/openpitkit/pit/wiki/Policy-API#c-interface).
+[Custom C++ policies](https://wiki.openpit.dev/Policy-API/#c-interface).
 
 ## Usage
 
@@ -205,7 +205,7 @@ wrapper owns the default C++ engine adapter and exposes the typed async methods
 
 ## Threading
 
-Canonical contract: [Threading Contract](https://github.com/openpitkit/pit/wiki/Threading-Contract).
+Canonical contract: [Threading Contract](https://wiki.openpit.dev/Threading-Contract/).
 
 Choose the storage synchronization policy when building the engine:
 
@@ -214,7 +214,7 @@ Choose the storage synchronization policy when building the engine:
 - `openpit::SyncPolicy::Account` - account-sharded synchronization.
 
 Custom policies that need internal state across calls use the built-in
-[Storage](https://github.com/openpitkit/pit/wiki/Storage) abstraction:
+[Storage](https://wiki.openpit.dev/Storage/) abstraction:
 synchronization-aware key-value storage that keeps locking details out of
 policy code.
 

bindings/go/README.md

@@ -13,7 +13,7 @@ risk checks into trading systems from Go.
 
 For an overview and links to all resources, see the project website [openpit.dev](https://openpit.dev/).
 For full project documentation, see [the repository README](https://github.com/openpitkit/pit/blob/main/README.md).
-For conceptual and architectural pages, see [the project wiki](https://github.com/openpitkit/pit/wiki).
+For conceptual and architectural pages, see [the project wiki](https://wiki.openpit.dev/).
 For the public Go module source, see [go.openpit.dev/openpit](https://go.openpit.dev/openpit).
 
 ## Versioning Policy (Pre‑1.0)
@@ -31,7 +31,7 @@ phase.
 ## Getting Started
 
 Visit the [Go module page](https://go.openpit.dev/openpit) and the
-[project wiki](https://github.com/openpitkit/pit/wiki) for conceptual pages
+[project wiki](https://wiki.openpit.dev/) for conceptual pages
 and architecture notes.
 
 ## Examples
@@ -134,21 +134,21 @@ in reverse order when any reject is produced.
 
 Built-in policies:
 
-- [Spot Funds](https://github.com/openpitkit/pit/wiki/Spot-Funds) - per-account
+- [Spot Funds](https://wiki.openpit.dev/Spot-Funds/) - per-account
   solvency gate over spendable funds.
-- [Order Validation](https://github.com/openpitkit/pit/wiki/Policies#ordervalidationpolicy)
+- [Order Validation](https://wiki.openpit.dev/Policies/#ordervalidationpolicy)
   \- structural integrity checks on every order.
-- [Rate Limit](https://github.com/openpitkit/pit/wiki/Policies#ratelimitpolicy)
+- [Rate Limit](https://wiki.openpit.dev/Policies/#ratelimitpolicy)
   \- throttle order flow per broker, asset, or account.
-- [Order Size Limit](https://github.com/openpitkit/pit/wiki/Policies#ordersizelimitpolicy)
+- [Order Size Limit](https://wiki.openpit.dev/Policies/#ordersizelimitpolicy)
   \- fat-finger caps on quantity and notional.
-- [P&L Kill Switch](https://github.com/openpitkit/pit/wiki/Policies#pnlboundskillswitchpolicy)
+- [P&L Kill Switch](https://wiki.openpit.dev/Policies/#pnlboundskillswitchpolicy)
   \- halt an account when realized P&L breaches bounds.
-- plus your own via the [policy SDK](https://github.com/openpitkit/pit/wiki/Policy-API#go-interface).
+- plus your own via the [policy SDK](https://wiki.openpit.dev/Policy-API/#go-interface).
 
 The primary integration model is to write project-specific policies against
 the public Go policy API:
-[Custom Go policies](https://github.com/openpitkit/pit/wiki/Policy-API#go-interface).
+[Custom Go policies](https://wiki.openpit.dev/Policy-API/#go-interface).
 
 Two types of rejections are supported: a full kill switch for the account
 and a rejection of only the current request. Kill switches are intended
@@ -157,14 +157,14 @@ until the situation is analyzed.
 
 ## Threading
 
-Canonical contract: [Threading Contract](https://github.com/openpitkit/pit/wiki/Threading-Contract).
+Canonical contract: [Threading Contract](https://wiki.openpit.dev/Threading-Contract/).
 
 Goroutine migration between OS threads during one SDK call is supported,
 and callbacks invoked by the SDK may run on a different OS thread than the
 goroutine that initiated the call.
 
 Custom policies that need internal state across calls use the built-in
-[Storage](https://github.com/openpitkit/pit/wiki/Storage) abstraction:
+[Storage](https://wiki.openpit.dev/Storage/) abstraction:
 synchronization-aware key-value storage that handles goroutine migration
 correctly without exposing locks to policy code.
 

bindings/python/README.md

@@ -10,7 +10,7 @@ risk checks into trading systems from Python.
 For an overview and links to all resources, see the project website [openpit.dev](https://openpit.dev/).
 For the Python API guide and reference, see [openpit.readthedocs.io](https://openpit.readthedocs.io/en/stable/).
 For full project documentation, see [the repository README](https://github.com/openpitkit/pit/blob/main/README.md).
-For conceptual and architectural pages, see [the project wiki](https://github.com/openpitkit/pit/wiki).
+For conceptual and architectural pages, see [the project wiki](https://wiki.openpit.dev/).
 
 ## Versioning Policy (Pre‑1.0)
 
@@ -133,26 +133,26 @@ order when any reject is produced.
 Built-in policies:
 
 - `SpotFundsPolicy` -
-  [per-account solvency gate over spendable funds](https://github.com/openpitkit/pit/wiki/Spot-Funds)
-- `OrderValidationPolicy` - [structural integrity checks on every order](https://github.com/openpitkit/pit/wiki/Policies#ordervalidationpolicy)
-- `RateLimitPolicy` - [throttle order flow per broker, asset, or account](https://github.com/openpitkit/pit/wiki/Policies#ratelimitpolicy)
-- `OrderSizeLimitPolicy` - [fat-finger caps on quantity and notional](https://github.com/openpitkit/pit/wiki/Policies#ordersizelimitpolicy)
-- `PnlBoundsKillSwitchPolicy` - [halt an account when realized P&L breaches bounds](https://github.com/openpitkit/pit/wiki/Policies#pnlboundskillswitchpolicy)
+  [per-account solvency gate over spendable funds](https://wiki.openpit.dev/Spot-Funds/)
+- `OrderValidationPolicy` - [structural integrity checks on every order](https://wiki.openpit.dev/Policies/#ordervalidationpolicy)
+- `RateLimitPolicy` - [throttle order flow per broker, asset, or account](https://wiki.openpit.dev/Policies/#ratelimitpolicy)
+- `OrderSizeLimitPolicy` - [fat-finger caps on quantity and notional](https://wiki.openpit.dev/Policies/#ordersizelimitpolicy)
+- `PnlBoundsKillSwitchPolicy` - [halt an account when realized P&L breaches bounds](https://wiki.openpit.dev/Policies/#pnlboundskillswitchpolicy)
 
 The primary integration model is to write project-specific policies against
 the public Python policy API:
-[Custom Python policies](https://github.com/openpitkit/pit/wiki/Policy-API#python-interface).
+[Custom Python policies](https://wiki.openpit.dev/Policy-API/#python-interface).
 
 ## Threading
 
-Canonical contract: [Threading Contract](https://github.com/openpitkit/pit/wiki/Threading-Contract).
+Canonical contract: [Threading Contract](https://wiki.openpit.dev/Threading-Contract/).
 
 Public methods acquire the GIL when needed; the SDK does not release the
 GIL across callback boundaries, so Python policies execute on the calling
 thread.
 
 Custom policies that need internal state across calls can use the built-in
-[Storage](https://github.com/openpitkit/pit/wiki/Storage) abstraction. In
+[Storage](https://wiki.openpit.dev/Storage/) abstraction. In
 typical Python usage (synchronous code or an asyncio loop pinned to one
 thread) the no-sync policy is sufficient and the storage compiles down to
 direct dictionary access. A synchronizing policy is needed only when the