Qwik Agent Rules

A web framework that resumes serialized application state in the browser.

Overview

Qwik generates its root guide from Ruler sources and keeps committed guidance separate from local skill copies. Six skills cover focused tasks, while the root file defines the language and checks used for resumability.

Documents

├── 
├── 
├── .ruler
│   ├── skills
│   │   ├── qwik-core-development
│   │   │   └── 
│   │   ├── qwik-docs-development
│   │   │   └── 
│   │   ├── qwik-e2e-verification
│   │   │   └── 
│   │   ├── qwik-guidance-maintenance
│   │   │   └── 
│   │   ├── qwik-optimizer-development
│   │   │   └── 
│   │   └── qwik-router-development
│   │       └── 
│   ├── 
│   └── 
└── 

Techniques in this file

01 / Pointing at the source of truth

Keep shared guidance in a generator input

Root AGENTS.md and CLAUDE.md are generated but committed, while tool-specific skill copies are regenerated locally. The file identifies .ruler as the editable source and describes a CI check for drift.

Source excerpt starting at line 499.
To change guidance, edit `.ruler/`, run `ruler apply`, and commit the regenerated root filesalongside your `.ruler/` change. Never hand-edit the generated files. A CI check

02 / Router files

Route work to six source skills

A table maps core, router, optimizer, end-to-end testing, documentation, and guidance maintenance to named skills. If generated copies are absent, the guide gives the original .ruler path as the fallback.

Source excerpt starting at line 169.
If a skill above is not loadable, its copy has not been generated in this worktree yet — run the`ruler apply` step from Setup, or read the source directly at `.ruler/skills/<name>/SKILL.md`.

03 / House vocabulary

Define the vocabulary from the execution model

The guide explains that client execution resumes from serialized state rather than reconstructing it. It forbids hydration terminology for Qwik mechanisms while allowing the term when explicitly comparing other frameworks.

Source excerpt starting at line 356.
Never describe Qwik or any part of how Qwik works as hydration. Qwik does not hydrate. Qwik isresumable: the server serializes application state and listeners into the HTML, and the clientresumes execution exactly where the server left off, without re-running component code orrebuilding the framework state.

04 / Verification by change type

Check both sides of a protocol change

Test guidance distinguishes unit tests, optimizer fixtures, and browser-dependent behavior. Changes to serialization or loader protocols require writer and reader coverage rather than a test of only the edited side.

Source excerpt starting at line 332.
- For serialization, hydration, streaming, or loader protocol changes, test both the writer and the  reader path.

Ideas for your repo

  1. Identify both the editable instruction source and its generated outputs.
  2. Provide a source-path fallback when skill installation is missing.
  3. Explain the technical distinction behind a vocabulary rule.
  4. Require tests on both ends of a serialization or protocol change.
Sponsored byModem

Give your agents the whole story.

These instructions explain how to work in Qwik. Modem shows your agents what customers said, who is affected, and what changed.

See how Modem works