README.md

---

Documentation site for Wickra — streaming-first technical indicators. Built with VitePress, deployed via Cloudflare Pages.

Local development

npm install
npm run dev      # http://localhost:5173
npm run build    # static output -> .vitepress/dist
npm run preview  # serve the built site

Requires Node 22 (see .nvmrc).

Content

Pages are plain Markdown at the repo root. The indicator deep-dives (Indicator-*.md), quickstarts, and reference pages were migrated from the former GitHub Wiki. The sidebar (.vitepress/sidebar.ts) is generated — do not hand-edit it.

Re-running the wiki migration

The migration script expects the wiki clone at ../wickra.wiki:

npm run migrate   # copies pages + regenerates .vitepress/sidebar.ts

It rewrites kingchenc/wickra → wickra-lib/wickra, bumps the version table, and turns Home.md into overview.md (index.md is the hand-written hero).

Deployment (Cloudflare Pages)

Connect this repo in Cloudflare → Workers & Pages → Pages → Connect to Git.

Setting	Value
Production branch	main
Build command	npm run build
Build output directory	.vitepress/dist
Node version	20 (env NODE_VERSION or .nvmrc)

Every push to main redeploys production; every PR gets a preview deployment.

Notes

• base: '/' — served at a domain root (e.g. docs.wickra.org), not the /wickra/ sub-path the marketing site/ uses.
• ignoreDeadLinks: true is set for now; tighten once the link transform is finalised and the link-check CI lands.