Skip to content

Commit

Permalink
docs: small misc. updates (#9978)
Browse files Browse the repository at this point in the history
Co-authored-by: Alex Rudenko <OrKoN@users.noreply.github.com>
  • Loading branch information
Lightning00Blade and OrKoN authored Apr 5, 2023
1 parent fa93e4e commit c03f592
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 23 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Here are a few examples to get you started:
- Capture a
[timeline trace](https://developers.google.com/web/tools/chrome-devtools/evaluate-performance/reference)
of your site to help diagnose performance issues.
- Test Chrome Extensions.
- [Test Chrome Extensions](https://pptr.dev/guides/chrome-extensions).

## Getting Started

Expand All @@ -39,8 +39,10 @@ To use Puppeteer in your project, run:

```bash
npm i puppeteer
# or `yarn add puppeteer`
# or `pnpm i puppeteer`
# or using yarn
yarn add puppeteer
# or using pnpm
pnpm i puppeteer
```

When you install Puppeteer, it automatically downloads a recent version of
Expand Down
6 changes: 4 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,15 @@ rely on complex conditions (such as names of distinct files) that cannot be
captured by the build system. To clean artifacts, you can run

```sh
npm run clean # or npm run clean --workspace <package>
npm run clean
# or specify the package
npm run clean --workspace <package>
```

## Comprehensive testing

Outside of `npm test`, there are several other
[`npm` scripts](https://docs.npmjs.com/cli/v8/using-npm/scripts) that are
[`npm` scripts](https://docs.npmjs.com/cli/using-npm/scripts) that are
usually check through CI:

- `test-install` - Tests whether `puppeteer` and `puppeteer-core` install
Expand Down
12 changes: 0 additions & 12 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,17 +97,6 @@ taking place in the Chromium repository. Here’s a typical story:
- Once the upstream fix is landed, we roll updated Chromium into Puppeteer:
https://github.com/puppeteer/puppeteer/pull/2769

However, oftentimes it is desirable to use Puppeteer with the official Google
Chrome rather than Chromium. For this to work, you should install a
`puppeteer-core` version that corresponds to the Chrome version.

For example, in order to drive Chrome 71 with puppeteer-core, use `chrome-71`
npm tag:

```bash
npm install puppeteer-core@chrome-71
```

## Q: Which Chromium version does Puppeteer use?

Find the version using one of the following ways:
Expand Down Expand Up @@ -135,7 +124,6 @@ To fetch Firefox Nightly as part of Puppeteer installation:

```bash
PUPPETEER_PRODUCT=firefox npm i puppeteer
# or "yarn add puppeteer"
```

#### Q: What’s considered a “Navigation”?
Expand Down
8 changes: 5 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Here are a few examples to get you started:
- Capture a
[timeline trace](https://developers.google.com/web/tools/chrome-devtools/evaluate-performance/reference)
of your site to help diagnose performance issues.
- Test Chrome Extensions.
- [Test Chrome Extensions](https://pptr.dev/guides/chrome-extensions).

## Getting Started

Expand All @@ -39,8 +39,10 @@ To use Puppeteer in your project, run:

```bash
npm i puppeteer
# or `yarn add puppeteer`
# or `pnpm i puppeteer`
# or using yarn
yarn add puppeteer
# or using pnpm
pnpm i puppeteer
```

When you install Puppeteer, it automatically downloads a recent version of
Expand Down
2 changes: 1 addition & 1 deletion test/installation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
]
},
"build:packages": {
"command": "npm pack --workspace puppeteer --workspace puppeteer-core --workspace @puppeteer/browsers",
"command": "npm pack --quiet --workspace puppeteer --workspace puppeteer-core --workspace @puppeteer/browsers",
"dependencies": [
"../../packages/puppeteer:build",
"../../packages/puppeteer-core:build",
Expand Down
6 changes: 4 additions & 2 deletions website/versioned_docs/version-19.8.3/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,15 @@ rely on complex conditions (such as names of distinct files) that cannot be
captured by the build system. To clean artifacts, you can run

```sh
npm run clean # or npm run clean --workspace <package>
npm run clean
# or specify the package
npm run clean --workspace <package>
```

## Comprehensive testing

Outside of `npm test`, there are several other
[`npm` scripts](https://docs.npmjs.com/cli/v8/using-npm/scripts) that are
[`npm` scripts](https://docs.npmjs.com/cli/using-npm/scripts) that are
usually check through CI:

- `test-install` - Tests whether `puppeteer` and `puppeteer-core` install
Expand Down

0 comments on commit c03f592

Please sign in to comment.