Documentation validation

Documentation validation

The documentation is authored as Markdown under src/content/docs/. Starlight turns those files into pages, generates navigation from the folder structure, and builds a local full-text search index.

Preview and build

From the program-docs repository:

pnpm install
pnpm dev

Build the static site before publishing:

pnpm build

The output is written to dist/. Each build also generates llms.txt as a compact index and llms-full.txt as a Markdown bundle from the source pages. The GitHub Pages workflow builds and deploys them with the site when changes reach main.

The platform MCP server exposes the full bundle as resource://quantflow-syntax. It fetches and caches the public file server-side, so an in-product agent reads the docs through MCP without browser or direct network access.

Validate against the runtime

The docs repository builds the site whenever documentation changes. The Rust repository runs the QuantFlow compiler checks because its source is private: it checks every fenced quantflow example and compares the documented built-in names with the Rust function registry. It runs when QuantFlow changes and once a day, so docs-only changes are picked up by the next scheduled run.

To check a documentation change immediately, dispatch the Validate QuantFlow documentation workflow in LivTorgEx/trading-platform-rust.

When changing syntax or a built-in, update the relevant page in the same change. The validator expects the built-in list to be enclosed by the QUANTFLOW_BUILTINS_START and QUANTFLOW_BUILTINS_END markers in language/built-ins.md.