qwik-docs-development

Solid

Use when writing, modifying, or reviewing Qwik docs content or docs-site code under packages/docs, including docs routes, MDX content, generated LLM outputs, docs build behavior, or docs-specific e2e tests.

Testing & QA 55 stars 2 forks Updated 5 days ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
58
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Qwik Docs Development Use this skill for `packages/docs/**` work. Keep the repo-wide rules from `.ruler/AGENTS.md` in force. ## Fast Path 1. Identify whether the change is docs content, route/layout code, API docs surfacing, generated LLM output, search/indexing, or deployment behavior. 2. For docs content, follow the writing style below before changing site mechanics. 3. For existing docs pages already in the LLM manifest, edit source content and regenerate only when verification requires generated output. 4. For new pages that should appear in LLM outputs, update the curated manifest in `packages/docs/scripts/generate-llms.ts`. 5. When editing docs scripts, keep generation deterministic and add focused unit coverage for parser, path, URL, or output-shape behavior. 6. Prefer docs-specific commands from `packages/docs/package.json`. ## Writing Style Write Qwik docs for readers who are learning the concept while solving a concrete task. - Start with the user need and the Qwik concept in one or two plain paragraphs. - Split the page into short sections named after the concept or API, such as `useSignal()`, `Passing signals to child components`, or `Nested objects and arrays`. - Explain the default case first, then reveal deeper, less common, or higher-cost cases later, this is done in a note block. There is short and long form notes in MDX. - Use complete, minimal examples with current v2 imports from `@qwik.dev/core`. - After each example, state what the ...

Details

Author
modem-dev
Repository
modem-dev/ossrules
Created
1 weeks ago
Last Updated
5 days ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

Testing & QA Solid

qwik-core-development

Use when modifying or reviewing Qwik core package code under packages/qwik, especially reactive primitives, signals, VNodes, cursor behavior, QRLs, optimizer-facing runtime behavior, or Qwik core tests.

55 Updated 5 days ago
modem-dev
Data & Documents Solid

qwik-optimizer-development

Use when modifying or reviewing the Qwik optimizer under packages/optimizer, Rust transform code, WASM/NAPI bindings, optimizer snapshots, or optimizer-facing runtime behavior.

55 Updated 5 days ago
modem-dev
AI & Automation Listed

writing-docs

Use when writing, restructuring, or reviewing any prose documentation — a tutorial, how-to guide, reference page, or explanation/conceptual doc — for a public docs site (e.g. Mintlify MDX, docs/, README material), a getting-started guide, an API/CLI reference page, or a "why we built it this way" conceptual page. Applies the Diátaxis framework (see https://diataxis.fr/) — every document belongs to exactly one of the four quadrants (tutorial / how-to guide / reference / explanation), and mixing quadrants inside one document is the single most common documentation failure. Covers the four-quadrant compass for picking the right form, per-quadrant structure templates, an anti-pattern list for quadrant drift, and generic voice/craft rules — repo-specific voice and target output format (e.g. Mintlify MDX) are resolved from the repo's docs-manifest (falling back to project-context), never hardcoded here.

3 Updated 1 weeks ago
whimzyLive