# Whisq

> The AI-native JavaScript framework. Signals for state. Functions for UI. Under 5 KB gzipped. No build step. Designed so LLMs produce working code on the first try.

Whisq is intentionally small and structured — the entire core fits in a prompt. The authoritative list of every named export for the current release lives at https://unpkg.com/@whisq/core@latest/dist/public-api.json. If you're an AI helping someone write Whisq, start with the LLM reference card, then drop into the specific API pages as needed.

## Docs

- [LLM reference card (start here)](https://whisq.dev/ai/llm-reference/): the whole framework in one compact page, two copy-paste tiers (~600 tokens minimum, ~1.7 K complete).
- [Signals](https://whisq.dev/core-concepts/signals/): the reactive primitive — everything else builds on it.
- [Components](https://whisq.dev/core-concepts/components/): `component()`, props-and-reactivity, context, error boundaries.
- [API — signal()](https://whisq.dev/api/signal/): entry to the per-export pages (sidebar lists ~25 entries).
- [Data fetching guide](https://whisq.dev/guides/data-fetching/): `resource()`, the match() tri-state, retry.
- [Forms guide](https://whisq.dev/guides/forms/): `bind()` spread, text/number/checkbox/radio.
- [Styling (core concept)](https://whisq.dev/core-concepts/styling/): `sheet()`, `theme()`, `sx()`, `cx`/`rcx`.
- [Advanced — Error Boundaries](https://whisq.dev/advanced/error-boundaries/): `errorBoundary()` primitive + patterns.
- [Advanced — Custom Elements](https://whisq.dev/advanced/custom-elements/): `h()`, web components, SVG.
- [Public API manifest (JSON)](https://unpkg.com/@whisq/core@latest/dist/public-api.json): machine-readable list of every named export for the current release.
- [Full docs as plain text](https://whisq.dev/llms-full.txt): every page concatenated, regenerated on each build.

## Example code

- [Quick Start](https://whisq.dev/getting-started/quick-start/): first component in under a minute.
- [Your First Component](https://whisq.dev/getting-started/your-first-component/): end-to-end walkthrough.
- [Playground](https://whisq.dev/playground/): in-browser editor with the framework pre-bundled.
- [Counter example](https://whisq.dev/examples/counter/): minimal signals demo.
- [Todo app example](https://whisq.dev/examples/todo-app/): lists, inputs, filters.
- [Dashboard example](https://whisq.dev/examples/dashboard/): composed components + async data.

## AI tooling

- [Claude Code](https://whisq.dev/ai/claude-code/): CLAUDE.md setup and agent workflow.
- [Cursor](https://whisq.dev/ai/cursor/): `.cursorrules` configuration.
- [GitHub Copilot](https://whisq.dev/ai/copilot/): hints for accurate completions.
- [MCP Server](https://whisq.dev/ai/mcp-server/): component scaffolding and code validation.

## Optional

- [GitHub](https://github.com/whisqjs/whisq): source.
- [Changelog](https://github.com/whisqjs/whisq/releases): per-package release notes.
- [Discussions](https://github.com/whisqjs/whisq/discussions): questions, proposals, RFCs.