@foldstryx/docs
v0.6.0
Published
Platform-neutral Foldstryx documentation composition (shell, typed routes, navigation)
Readme
@foldstryx/docs
Platform-neutral Foldstryx documentation composition. A Foldkit
Model / Message / init / update / view application with typed routes,
canonical navigation metadata, and a fixed sidebar shell. No browser globals,
URL history, Tauri, or native APIs at import time — hosts own runtime bootstrap
and command execution (e.g. clipboard writes via WriteClipboard).
import { Message, Model, init, update, view } from '@foldstryx/docs'
import '@foldstryx/styles/document.global.css'@foldkit/ui, effect, and foldkit are peer dependencies supplied by the
host. See the root README for the layer map and packaging
notes.
Runtime message schema (Foldkit DevTools)
Message is both the docs application's typed message union and its runtime
Effect Schema. External hosts (e.g. Taurifold) can pass it to
Runtime.makeApplication({ devTools: { Message } }) to keep the Foldkit
DevTools overlay and message-dispatch bridge without reconstructing the union.
The nested Sink.message payload is intentionally unconstrained (S.Any) so
the docs package does not depend on a kitchen-sink runtime schema or any
host-specific schema. CopySnippet carries snippet text for host-owned clipboard
commands; SucceededCopySnippet / FailedCopySnippet report command outcomes.
The DevTools overlay is host-owned: @foldstryx/docs does not import or depend
on @foldkit/devtools.
