Docs map

Start with Introduction if you are new to Datastar Kit. After that, the docs are organized by how people usually adopt the SDK: understand the model, build one interaction, then add validation, realtime behavior, and production concerns.

Learn the model

1. Programming model explains the server-driven loop: pages, actions, commands, queries, patches, signals, and live views.
2. Runtime boundaries defines what Datastar Kit owns and what stays in your app or framework.

Build UI

3. HTML and JSX covers server-rendered views, layouts, data loading, escaping, and the low-level HTML helpers.
4. Signals covers browser-side signal state, typed refs, request decoding, and signal patches.
5. Actions and responses shows how browser events become HTTP handlers and how to choose the right reply.* helper.
6. Element patches explains stable IDs, selectors, patch modes, removal, and view transitions.

Add app behavior

7. Validation shows the app-owned decode-then-validate pattern and user-facing error patches.
8. Realtime explains current-state live views with reply.stream(...) and app-owned invalidation sources.
9. Debugger adds a development-only panel for inspecting signals, signal patches, and Datastar SSE/fetch traffic.

Operate it

10. Security covers trust boundaries, auth, CSRF, ownership checks, and safe navigation.
11. Deployment covers runtime adapters, Datastar assets, SSE proxy settings, and production checks.
12. Testing covers request/response tests and protocol-level verification.

Reference

• API reference lists the public modules and the main helpers in each namespace.
• Examples maps runnable workspace examples to the concepts they demonstrate.
• Architecture describes source layout and contributor-facing design constraints.
• Agent setup shows how to vendor the repository as read-only reference material for coding agents.