# qt-qml-docs

Reads .qml sources and related project files, then writes a Markdown reference per component: properties, signals, methods, dependencies.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 717 installs · ★ 507
- Author: qt-ai-skills
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/TheQtCompanyRnD/agent-skills/tree/HEAD/skills/qt-qml-docs/SKILL.md
- Updated: 2026-10-20
- HTML: https://affpapa.org/en/nevibecode/skills/qt-qml-docs

## What it does

This skill produces reference documentation for QML components and Qt Quick applications. The agent goes through the sources — the .qml files themselves plus C++ backends, modules, qmldir, CMakeLists.txt — and writes one `<ComponentName>.md` per component. The structure is fixed: component overview, its place in the project and its dependencies, type hierarchy, a properties table with Property, Type, Default, Required and Description columns, then signals and methods as separate subsections, then how the component talks to the rest of the app.

Properties always come as a table, never a bullet list. Code fences are avoided everywhere except the Usage Example section, and that section appears only for reusable components whose root type is not `Window` or `ApplicationWindow`. Each signal gets a note on what triggers it and what the connected handler should do; each method gets its parameters, return type and side effects such as restarting a timer.

Before reading any source, the skill checks whether docs already exist in a `doc/` directory next to the code. If they do, the agent stops and asks whether to update the existing files, skip them, regenerate everything or cancel. That matters when you touch one component in a larger project — you avoid silently overwriting docs for its neighbours. QDoc output is out of scope; you need a different tool for that.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/qt-qml-docs/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/qt-qml-docs/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/qt-qml-docs/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/qt-qml-docs/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install TheQtCompanyRnD/agent-skills qt-qml-docs
```

2. **Manually: put the files in place**
- File: `.github/skills/qt-qml-docs/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/TheQtCompanyRnD/agent-skills --path skills/qt-qml-docs
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/qt-qml-docs/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/TheQtCompanyRnD/agent-skills/tree/HEAD/skills/qt-qml-docs/SKILL.md

## When to use it
- get a reference page for a QML component without walking every property by hand
- describe signals and methods so callers know when they fire
- tie a component to its C++ backend, qmldir and CMake targets
- update existing .md files instead of regenerating the whole project
- show a new developer the minimal way to instantiate a reusable component

## Example prompts
- document this QML component
- write reference docs for my Qt Quick app
- go through the project folder and document every .qml file

## Similar
- [docs-write](https://affpapa.org/en/nevibecode/skills/docs-write.md) — skill · 2100 installs
- [write-docs](https://affpapa.org/en/nevibecode/skills/write-docs.md) — skill · 693 installs
- [backend-to-frontend-handoff-docs](https://affpapa.org/en/nevibecode/skills/backend-to-frontend-handoff-docs.md) — skill · 164 installs
- [update-docs](https://affpapa.org/en/nevibecode/commands/update-docs.md) — command · 3861 installs
- [project-docs](https://affpapa.org/en/nevibecode/skills/project-docs.md) — skill · 1200 installs
- [explain_docs](https://affpapa.org/en/nevibecode/prompts/explain-docs.md) — prompt · ★ 44429

From the same set: [theqtcompanyrnd/agent-skills](https://affpapa.org/en/nevibecode/by/theqtcompanyrnd/agent-skills.md) — 12 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md