Skip to content

Commit b59c063

Browse files
Luc45claude
andcommitted
Restructure AI docs as top-level section with linked prerequisites
Move AI docs from test-packages/ to top-level ai/ directory: - ai/getting-started.md — plugin install (trimmed: removed common mistakes and best practices sections, renamed to "AI-Assisted Development") - ai/test-packages/writing-with-agents.md — methodology with linked prerequisite pages instead of "fetch from llms.txt" instructions - ai/test-packages/browser-observation.md — Playwright MCP guide Sidebar: AI-Assisted Development is now a top-level category with nested Test Packages sub-category. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent c942f5c commit b59c063

File tree

6 files changed

+88
-269
lines changed

6 files changed

+88
-269
lines changed

docs/ai/getting-started.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
description: "Install the QIT plugin for Claude Code to get AI-powered test creation, debugging, and quality automation. For other AI assistants, use the QIT documentation index at llms.txt to provide context."
3+
---
4+
5+
# AI-Assisted Development
6+
7+
QIT integrates with AI assistants to help you develop test packages, debug failures, and automate quality workflows.
8+
9+
## Claude Code Plugin (Recommended)
10+
11+
The QIT CLI ships as a **Claude Code plugin**. Once installed, Claude can handle any QIT task autonomously — it fetches live documentation, runs commands, creates test packages, and debugs failures without you needing to provide manual context.
12+
13+
### Install
14+
15+
In Claude Code, run:
16+
17+
```
18+
/plugin marketplace add woocommerce/qit-cli
19+
/plugin install qit@woocommerce-qit
20+
```
21+
22+
That's it. Claude now has QIT expertise. Try asking:
23+
24+
- "Run a security scan on my plugin"
25+
- "Create E2E tests for this extension"
26+
- "My QIT tests are failing, help me debug"
27+
- "Set up qit.json for this project"
28+
- "What test packages are available for cross-compatibility testing?"
29+
30+
### How It Works
31+
32+
The plugin provides a skill that uses **progressive disclosure** from QIT's live documentation:
33+
34+
1. Claude fetches the [documentation index](https://qit.woo.com/docs/llms.txt) to find relevant pages
35+
2. It reads the specific docs needed for your task
36+
3. It acts on what it learned — running commands, writing code, interpreting results
37+
38+
This means Claude always has current information, even as QIT evolves.
39+
40+
### What Claude Can Do
41+
42+
With the QIT plugin, Claude can:
43+
44+
- **Run any QIT test** — managed tests, test packages, or both
45+
- **Create test packages** — follows a [structured methodology](./test-packages/writing-with-agents.md) that includes user research, UI observation, and persona-based test design
46+
- **Debug failures** — read CTRF reports, analyze artifacts, identify root causes
47+
- **Configure projects** — generate `qit.json` with profiles, environments, and groups
48+
- **Manage environments** — start, stop, and interact with Docker test environments
49+
- **Publish packages** — validate and publish test packages to the QIT registry
50+
51+
---
52+
53+
## Other AI Assistants
54+
55+
If you're using GPT-4, GitHub Copilot, or another AI assistant, QIT provides two machine-readable documentation files you can feed to your AI:
56+
57+
- **[llms.txt](https://qit.woo.com/docs/llms.txt)** — Documentation index with descriptions. Feed this to your AI and ask it to fetch the pages relevant to your task.
58+
- **[llms-full.txt](https://qit.woo.com/docs/llms-full.txt)** — Complete documentation in a single file. Use when your AI can accept large context.
59+
60+
These follow the [llmstxt.org](https://llmstxt.org) standard and contain the same documentation that the Claude Code plugin accesses.
File renamed without changes.

docs/test-packages/how-to/ai-test-methodology.md renamed to docs/ai/test-packages/writing-with-agents.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ This is the methodology to follow when creating QIT E2E test packages for a WooC
88

99
## Prerequisites
1010

11-
Before starting, fetch and read the documentation pages you will need. Use the [documentation index](https://qit.woo.com/docs/llms.txt) to find the current pages for:
11+
Before starting, fetch and read the documentation pages you will need:
1212

13-
- **How to create test packages** — scaffolding, manifest structure, package types
14-
- **Test package manifest reference** — all fields and validation rules for `qit-test.json`
15-
- **Test package lifecycle** — execution phases, database isolation, command context
16-
- **Global setup concepts** — what goes in globalSetup vs setup, cross-compatibility design
17-
- **Development workflow** — how to use `env:up`, `env:source`, `env:reset` for iterative testing
18-
- **How to write tests with AI browser observation** — using Playwright MCP to see the real UI
19-
- **How to handle secrets** — declaring and providing API keys and credentials
20-
- **Test results and artifacts** — CTRF format, blob directory, screenshots, traces
13+
- [How to Create Test Packages](/test-packages/how-to/create-packages/) — scaffolding, manifest structure, package types
14+
- [Test Package Manifest Reference](/test-packages/manifest/) — all fields and validation rules for `qit-test.json`
15+
- [Test Package Lifecycle](/test-packages/lifecycle/) — execution phases, database isolation, command context
16+
- [Global Setup Concepts](/test-packages/concepts/global-setup/) — what goes in globalSetup vs setup, cross-compatibility design
17+
- [Development Workflow](/environment/development-workflow/) — how to use `env:up`, `env:source`, `env:reset` for iterative testing
18+
- [AI Browser Observation](./browser-observation.md) — using Playwright MCP to see the real UI before writing selectors
19+
- [How to Handle Secrets](/test-packages/how-to/use-secrets/) — declaring and providing API keys and credentials
20+
- [Test Results and Artifacts](/test-packages/results/) — CTRF format, blob directory, screenshots, traces
2121

2222
Also run `qit package:scaffold --help`, `qit env:up --help`, and `qit run:e2e --help` to get current command syntax. Never guess at flags — use `--help` output.
2323

@@ -108,7 +108,7 @@ Use `qit env:up` to start a local environment with the extension and test packag
108108

109109
**Do not skip this step.** Navigate the running site using Playwright MCP browser tools.
110110

111-
Refer to the [browser observation guide](./ai-browser-testing.md) for detailed instructions.
111+
Refer to the [browser observation guide](./browser-observation.md) for detailed instructions.
112112

113113
### Explore the merchant experience (admin)
114114

docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ qit run:security --help
108108

109109
**[Configuration](configuration/)** — Save your test settings in `qit.json` so you don't retype them.
110110

111-
**[AI-Assisted Testing](/test-packages/ai-development/)** — Use QIT with Claude Code for AI-powered test development and debugging.
111+
**[AI-Assisted Development](/ai/getting-started/)** — Use QIT with Claude Code for AI-powered test development and debugging.
112112

113113
---
114114

docs/test-packages/ai-development.md

Lines changed: 0 additions & 255 deletions
This file was deleted.

0 commit comments

Comments
 (0)