Skip to content

docs: small tweaks #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 27, 2022
Merged

docs: small tweaks #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
754c3ae
docs: small tweaks
robwalkerco Jul 27, 2022
fc69e0d
doc: use npx commands for the npm examples
robwalkerco Jul 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cli/building-the-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Before the app can be tested, it must be built.
<TabItem value="npm" label="npm">

```bash
npm run owl build -- --platform ios --config ./owl.config.json
npx owl build --platform ios --config ./owl.config.json
```

</TabItem>
Expand Down
6 changes: 3 additions & 3 deletions docs/cli/testing-the-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The baseline images will be automatically generated. To regenerate the baseline
<TabItem value="npm" label="npm">

```bash
npm run owl test -- --platform ios
npx owl test --platform ios
```

</TabItem>
Expand All @@ -62,7 +62,7 @@ Update the baseline images
<TabItem value="npm" label="npm">

```bash
npm run owl test -- --platform ios --update
npx owl test --platform ios --update
```

</TabItem>
Expand All @@ -83,7 +83,7 @@ Update the baseline images
<TabItem value="npm" label="npm">

```bash
npm run owl test -- --platform ios --config ./owl.config.json
npx owl test --platform ios --config ./owl.config.json
```

</TabItem>
Expand Down
10 changes: 4 additions & 6 deletions docs/introduction/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Below you can find an example config (can also be found in the [example app](htt
},
"android": {
"packageName": "com.owldemo"
},
}
}
```

Expand All @@ -47,9 +47,7 @@ describe('App.tsx', () => {

expect(screen).toMatchBaseline();
});
});

describe('App.tsx', () => {
it('presses a button, then takes a screenshot', async () => {
await press('button')

Expand All @@ -68,7 +66,7 @@ Before the app can be tested, it must be built.
<TabItem value="npm" label="npm">

```bash
npm run owl build -- --platform ios
npx owl build --platform ios
```

</TabItem>
Expand Down Expand Up @@ -100,7 +98,7 @@ Test against the baseline images (will create the baseline images if they don't
<TabItem value="npm" label="npm">

```bash
npm run owl test -- --platform ios
npx owl test --platform ios
```

</TabItem>
Expand All @@ -119,7 +117,7 @@ Update the baseline images
<TabItem value="npm" label="npm">

```bash
npm run owl test -- --platform ios --update
npx owl test --platform ios --update
```

</TabItem>
Expand Down