From 30e31279312e23070d78968c8e344735f7bca67f Mon Sep 17 00:00:00 2001 From: Marcel Veselka Date: Mon, 1 Sep 2025 20:23:10 +0200 Subject: [PATCH 1/2] feat: more details about tools and assertions, nav improvements --- docs/{bot.md => ai-agent.md} | 4 +- .../pom-login-example.md | 0 docs/concepts/prompting-guidelines.md | 6 + docs/concepts/tools-and-assertions.md | 137 ++++++++++++++++++ docs/index.md | 1 + mkdocs.yml | 6 +- 6 files changed, 150 insertions(+), 4 deletions(-) rename docs/{bot.md => ai-agent.md} (89%) rename docs/{automation => concepts}/pom-login-example.md (100%) create mode 100644 docs/concepts/tools-and-assertions.md diff --git a/docs/bot.md b/docs/ai-agent.md similarity index 89% rename from docs/bot.md rename to docs/ai-agent.md index dd989c4..65ab1df 100644 --- a/docs/bot.md +++ b/docs/ai-agent.md @@ -22,7 +22,8 @@ After creating a project, you have two options to add tests: **A. Generate new tests automatically** -- Start a [NEW ANALYSIS](analysis.md) to let the system create tests for you. +- Start a [NEW ANALYSIS](concepts/analysis-process.md) to let the system create tests for you. +- Learn about [πŸ› οΈ Tools & Assertions](tools-and-assertions.md) to understand how the agent interacts with your app. **B. Integrate your existing tests** @@ -33,7 +34,6 @@ After creating a project, you have two options to add tests: - [Robot Framework](robot-framework/01-getting-started.md) - [WebdriverIO](webdriverio-visual-testing.md) - ## 4. Run tests Once your tests are ready: diff --git a/docs/automation/pom-login-example.md b/docs/concepts/pom-login-example.md similarity index 100% rename from docs/automation/pom-login-example.md rename to docs/concepts/pom-login-example.md diff --git a/docs/concepts/prompting-guidelines.md b/docs/concepts/prompting-guidelines.md index 3bdb63d..66106af 100644 --- a/docs/concepts/prompting-guidelines.md +++ b/docs/concepts/prompting-guidelines.md @@ -291,3 +291,9 @@ When applying POM patterns, also verify: - [ ] **Error handling** requirements are outlined - [ ] **Example usage** demonstrates page object interaction - [ ] **Single responsibility** principle is maintained + +## Related topics + +- [πŸ› οΈ Tools & Assertions](tools-and-assertions.md) - Understand how the agent interacts with your app and validates outcomes +- [✨ Analysis Process](analysis-process.md) - Learn about the complete analysis workflow +- [πŸ”— Analysis Inputs](analysis-inputs.md) - Discover what inputs improve test analysis quality diff --git a/docs/concepts/tools-and-assertions.md b/docs/concepts/tools-and-assertions.md new file mode 100644 index 0000000..4560c2b --- /dev/null +++ b/docs/concepts/tools-and-assertions.md @@ -0,0 +1,137 @@ +--- +title: Tools & Assertions +--- + +# Tools & Assertions (Wopee.io) + +## What this page covers + +How the agent interacts with your app, how it validates outcomes, and how locators are chosen. After a scenario runs, Wopee.io generates **plain test code** (e.g., Playwright) that you can run anywhereβ€”**no LLMs or Wopee.io runtime required**. + +--- + +## Execution flow (at a glance) + +1. **Select interaction tool** (click, type, select, etc.) for the desired action. +2. **Agent automatically chooses locator strategy** (ARIA/HTML/visual) based on the tool and target element. +3. **Perform interactions** using the selected tool and optimal locator. +4. **Validate results** with assertions (text, visibility, visual). +5. **Export deterministic code** that mirrors the exact tools and locators used. + +--- + +## Interaction tools + +Use these to drive the UI. +_(Tip: prefer semantic/accessible targets first; fall back to visual only when needed.)_ + +- **Click** – Click an element once. +- **Double click** – Double-click an element. +- **Visual click** – Click by visual position (e.g., icon/button without stable DOM locator). +- **Fill** – Type text into an input/textarea. +- **Select** – Choose an option in a `