Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gregberge committed Jan 5, 2024
1 parent fe6ced2 commit 75e61dc
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 25 deletions.
3 changes: 2 additions & 1 deletion packages/puppeteer/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ For tailored visual testing, the `data-visual-test` attributes provide control o
<div id="clock" data-visual-test="transparent">...</div>
```

##Additional Resources
## Additional Resources

- [Quickstart with Argos + Puppeteer](/quickstart/puppeteer)
- [@argos-ci/puppeteer on GitHub](https://github.com/argos-ci/argos-javascript/tree/main/packages/puppeteer)
- [@argos-ci/puppeteer on npm](https://www.npmjs.com/package/@argos-ci/puppeteer)
27 changes: 3 additions & 24 deletions packages/webdriverio/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,9 @@ slug: /webdriverio

Integrating Argos with your [WebdriverIO](https://webdriver.io) tests to enable visual testing on your application.

## Installation
## Get started

### 1. Install package

```
npm install --save-dev @argos-ci/cli @argos-ci/webdriverio
```

### 2. Use in your tests

`argosScreenshot` command takes a screenshot of the page.

```js
import { browser } from "@wdio/globals";
import { argosScreenshot } from "@argos-ci/puppeteer";

describe("Integration test with visual testing", () => {
it("covers homepage", async () => {
await browser.url("http://localhost:3000");
await argosScreenshot(browser, "homepage");
});
});
```

Screenshots are stored in `screenshots/argos` folder, relative to current directory.
Please refer to our [Quickstart guide](/quickstart/webdriverio) to get started with Argos and WebdriverIO.

## API Overview

Expand All @@ -45,5 +23,6 @@ Screenshots are stored in `screenshots/argos` folder, relative to current direct

## Additional Resources

- [Quickstart with Argos + WebdriverIO](/quickstart/webdriverio)
- [@argos-ci/webdriverio on GitHub](https://github.com/argos-ci/argos-javascript/tree/main/packages/webdriverio)
- [@argos-ci/webdriverio on npm](https://www.npmjs.com/package/@argos-ci/webdriverio)

0 comments on commit 75e61dc

Please sign in to comment.