ContextQMD
Back to Slint

Slint SC Safety Manual

docs/safety/README.md

1.17.11003 B
Original Source

Slint SC Safety Manual

Astro Starlight site for the Slint SC Safety Manual and Qualification Plan.

Hand-written content lives in src/content/docs/. The API reference under src/content/docs/reference/generated/ is produced by slint-doc-generator from items annotated with \sc in internal/compiler/builtins.slint (and later in internal/common/{enums,builtin_structs}.rs); that directory is gitignored.

Prerequisites

  • Node.js (v22+)
  • pnpm
  • A Rust toolchain (for slint-doc-generator)

Run pnpm install from the repository root first.

Commands

sh
pnpm install   # install dependencies

# Regenerate the SC-filtered API reference (run from the repo root).
# Required before `pnpm build` if you've changed builtins or generator code.
cargo run -p slint-doc-generator -- --slint-sc generate-mdx

pnpm dev       # start dev server
pnpm build     # type-check and build for production
pnpm preview   # preview the production build