docs: update channels doc to mention manual installation (#5964)

microsoft · Mar 26, 2021 · 12e0062 · 12e0062
1 parent 6c1d3f6
commit 12e0062
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 5 deletions.
diff --git a/docs/src/api/class-browsertype.md b/docs/src/api/class-browsertype.md
@@ -181,7 +181,7 @@ Whether to run browser in headless mode. More details for
 ### option: BrowserType.launch.channel
 - `channel` <[BrowserChannel]<"chrome"|"chrome-beta"|"chrome-dev"|"chrome-canary"|"msedge"|"msedge-beta"|"msedge-dev"|"msedge-canary">>
 
-Browser distribution channel.
+Browser distribution channel. Read more about using [Google Chrome and Microsoft Edge](./browsers#google-chrome--microsoft-edge).
 
 ### option: BrowserType.launch.executablePath
 - `executablePath` <[path]>

diff --git a/docs/src/browsers.md b/docs/src/browsers.md
@@ -17,7 +17,7 @@ when the world is on Google Chrome 89, Playwright already supports Chromium 91 t
 if a few weeks.
 
 There is also a way to opt into using Google Chrome's or Microsoft Edge's branded builds for testing. For details
-on when to opt into stable channels, refer to the [Google Chrome & Microsoft Edge section below.](#google-chrome--microsoft-edge) section below.
+on when to opt into stable channels, refer to the [Google Chrome & Microsoft Edge](#google-chrome--microsoft-edge) section below.
 
 ## Firefox
 
@@ -33,7 +33,7 @@ also working on a dedicated support for builds that would match Apple Safari Tec
 ## Google Chrome & Microsoft Edge
 
 While Playwright will download and use the recent Chromium build by default, it can operate against the stock Google
-Chrome and Microsoft Edge browsers. In particular, current Playwright version will support Stable and Beta channels
+Chrome and Microsoft Edge browsers available on the machine. In particular, current Playwright version will support Stable and Beta channels
 of these browsers. Here is how you can opt into using the stock browser:
 
 ```js
@@ -67,6 +67,10 @@ browser = await playwright.chromium.launch(channel="chrome")
 browser = playwright.chromium.launch(channel="chrome")
 ```
 
+:::note
+Playwright bundles a recent Chromium build, but not Google Chrome or Microsoft Edge browsers - these should be installed manually before use.
+:::
+
 ### When to use Google Chrome & Microsoft Edge and when not to?
 
 **Defaults**

diff --git a/package-lock.json b/package-lock.json
diff --git a/types/types.d.ts b/types/types.d.ts
@@ -10648,7 +10648,8 @@ export interface LaunchOptions {
   args?: Array<string>;
 
   /**
-   * Browser distribution channel.
+   * Browser distribution channel. Read more about using
+   * [Google Chrome and Microsoft Edge](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge).
    */
   channel?: "chrome"|"chrome-beta"|"chrome-dev"|"chrome-canary"|"msedge"|"msedge-beta"|"msedge-dev"|"msedge-canary";