# Askr

> Askr is an opinionated, batteries-included TypeScript framework for building applications that stay understandable — to the human who owns them and the agent that edits them — as both keep changing the code. Routes, rendering mode, server boundaries, and data ownership are explicit registries and typed contracts you read end to end, not conventions you infer from file placement.

That legibility is the actual value prop, not raw performance or ecosystem size: a state update re-runs the owning component and reconciles its output (a traceable "this function ran, this output changed" story you can follow without holding a dependency graph in your head), runtime misuse is caught with an error that names what broke and how to fix it, and a documented surface that ships narrower than it reads is marked `experimental` or `limited` rather than left ambiguous. Askr is not chasing Solid's fine-grained-reactivity performance or React's ecosystem flexibility — don't describe it in either vocabulary. If you are an agent building with Askr: prefer the explicit primitive over a clever shortcut, read a page's status marker before depending on what it describes, and when a familiar-framework assumption (from React, Next.js, or anywhere else) would fill a gap in what you just read, treat that as a sign to go verify the actual behavior rather than carry the assumption over.

Use the documentation links below as the primary source for Askr APIs and usage. Each documentation link is clean Markdown; its human-facing HTML page is the enclosing directory URL. Askr packages use the `@askrjs/*` npm scope, and the command-line tool is invoked as `askr`.

## Start here

- [Agent building guide](https://askrjs.com/AGENTS.md): Concise architectural rules and the entry point for agents building with Askr.
- [Build an Askr app skill](https://askrjs.com/skills/build-askr-app/SKILL.md): Thin end-to-end workflow that composes the project structures, routes, themes, and static-delivery guidance.
- [Askr themes skill](https://askrjs.com/skills/themes/SKILL.md): Theme boundaries, styled building blocks, tokens, customization, and server-rendered style integration.
- [Askr routes skill](https://askrjs.com/skills/routes/SKILL.md): Route registries, layouts, URL state, navigation, loaders, access, metadata, and fallbacks.
- [Askr project structures skill](https://askrjs.com/skills/project-structures/SKILL.md): Ownership and dependency direction across pages, features, components, data boundaries, and server code.
- [Askr control flows skill](https://askrjs.com/skills/control-flows/SKILL.md): Conditional rendering, keyed collections, reactive rows, and render-scoped ordering invariants.
- [Askr icons skill](https://askrjs.com/skills/icons/SKILL.md): Lucide icons, brand logos, accessible composition, semantic sizing, and custom SVG integration.
- [Askr queries and mutations skill](https://askrjs.com/skills/queries-and-mutations/SKILL.md): Query identity, consistency, reconciliation, mutations, invalidation, server prefetch, dehydration, and hydration.
- [Askr i18n skill](https://askrjs.com/skills/i18n/SKILL.md): Typed locale catalogs, application-owned locale resolution, direction, formatting, and SSR hydration.
- [Askr charts skill](https://askrjs.com/skills/charts/SKILL.md): Typed plotting, marks and transforms, interaction, accessibility, live data, styling, and export.
- [Documentation](https://askrjs.com/docs/index.md): Documentation overview and navigation for the Askr platform.
- [Getting started](https://askrjs.com/docs/getting-started/index.md): Install Askr, choose a starter, and build a first route.
- [Core concepts](https://askrjs.com/docs/core-concepts/index.md): Components, state, scopes, lifecycle work, and deterministic rendering.
- [Guides](https://askrjs.com/docs/guides/index.md): Task-oriented guides for building and shipping Askr applications.

## Framework

- [Routing and data](https://askrjs.com/docs/routing/index.md): Explicit route registries, loaders, navigation, parameters, and data flow.
- [Rendering](https://askrjs.com/docs/rendering/index.md): Client rendering, SSR, streaming, hydration, islands, and static generation.
- [Server and APIs](https://askrjs.com/docs/server/index.md): Server applications, actions, typed APIs, authentication, middleware, and MCP.
- [UI and components](https://askrjs.com/docs/components/index.md): Headless accessible primitives, themed components, icons, charts, and editor integrations.
- [Tooling](https://askrjs.com/docs/tooling/index.md): CLI workflows for creating, analyzing, generating, checking, and upgrading projects.
- [API reference](https://askrjs.com/docs/reference/index.md): Package entry points, exported APIs, CLI reference, and release notes.

## Deliver excellent developer experience

The docs treat "it works" and "it's ready to ship" as different bars — these pages are where the second bar is spelled out explicitly, not left implicit in example code.

- [Guides: production finish bar](https://askrjs.com/docs/guides/index.md): The checklist every task-oriented guide ends on — error boundaries around what can fail, mutations invalidating the right query keys, auth-gated routes marked runtime-only, `askr openapi --check` passing in CI.
- [Production readiness](https://askrjs.com/docs/guides/production-readiness/index.md): Wiring `onError`, health probes, and OpenTelemetry so a broken deploy fails loudly instead of serving errors quietly.
- [Accessibility](https://askrjs.com/docs/guides/accessibility/index.md): Using `@askrjs/ui`'s typed `*_A11Y_CONTRACT` exports to verify keyboard behavior, focus handling, and ARIA roles instead of trusting a component's look.
- [Determinism and runtime rules](https://askrjs.com/docs/core-concepts/determinism/index.md): The render-purity, hook-order, and no-mutation-during-render rules the runtime enforces with a specific thrown error, not silent misbehavior.

## Platform overview

- [Platform](https://askrjs.com/platform): How the runtime, router, UI, server, rendering, and tooling fit together.
- [Application model](https://askrjs.com/application-model): Ownership and cleanup of state, routes, and asynchronous work.
- [Full-stack applications](https://askrjs.com/full-stack): Forms, validated APIs, OpenAPI, and authorization policies in one route tree.
- [Production](https://askrjs.com/production): Static and Node deployment paths, probes, middleware, localization, and telemetry.

## Optional

- [Complete documentation corpus](https://askrjs.com/llms-full.txt): All documentation pages and generated API signatures combined into one Markdown document.
- [Askr source](https://github.com/askrjs/askr): Framework runtime and public package source.
- [Example applications](https://github.com/askrjs/askr-examples): Complete applications demonstrating Askr patterns.
- [Website source](https://github.com/askrjs/website): Source for this documentation website.