chore: add comments for syncing with docs

Author: asambstack

duckduckgo_search.js

@@ -4,22 +4,23 @@ const puppeteer = require('puppeteer');
 const expect = require('chai').expect;
 (async () => {
     const caps = {
-        'browser': 'chrome',
-        'browser_version': 'latest',
+        'browser': 'chrome',  // You can choose `chrome`, `edge` or `firefox` in this capability
+        'browser_version': 'latest',  // We support v83 and above. You can choose `latest`, `latest-beta`, `latest-1`, `latest-2` and so on, in this capability
         'os': 'os x',
         'os_version': 'big sur',
         'build': 'puppeteer-build-1',
-        'name': 'My first Puppeteer test',
+        'name': 'My first Puppeteer test',  // The name of your test and build. See browserstack.com/docs/automate/puppeteer/organize tests for more details
         'browserstack.username': process.env.BROWSERSTACK_USERNAME || 'YOUR_USERNAME',
         'browserstack.accessKey': process.env.BROWSERSTACK_ACCESS_KEY || 'YOUR_ACCESS_KEY'
     };
     const browser = await puppeteer.connect({
     browserWSEndpoint:
-    `wss://cdp.browserstack.com/puppeteer?caps=${encodeURIComponent(JSON.stringify(caps))}`,
+    `wss://cdp.browserstack.com/puppeteer?caps=${encodeURIComponent(JSON.stringify(caps))}`,  // The BrowserStack CDP endpoint gives you a `browser` instance based on the `caps` that you specified
     });
 
     /* 
-    *  BrowserStack specific code ends here
+    *  The BrowserStack specific code ends here. Following this line is your test script.
+    *  Here, we have a simple script that opens google.com, searches for the word BrowserStack and asserts the result.
     */
     const page = await browser.newPage();
     await page.goto('https://www.duckduckgo.com');
@@ -36,5 +37,5 @@ const expect = require('chai').expect;
     } catch {
         await page.evaluate(_ => {}, `browserstack_executor: ${JSON.stringify({action: 'setSessionStatus',arguments: {status: 'failed',reason: 'Title did not match'}})}`);
     }
-    await browser.close();
+    await browser.close();  // At the end of each of your tests, you must close the browser so that BrowserStack knows when to end the session.
 })();

parallel_test.js

@@ -7,9 +7,12 @@ const main = async (cap) => {
     cap['browserstack.accessKey'] = process.env.BROWSERSTACK_ACCESS_KEY || 'YOUR_ACCESS_KEY';
 
     const browser = await puppeteer.connect({
-      browserWSEndpoint:`wss://cdp.browserstack.com/puppeteer?caps=${encodeURIComponent(JSON.stringify(cap))}`,
+      browserWSEndpoint:`wss://cdp.browserstack.com/puppeteer?caps=${encodeURIComponent(JSON.stringify(cap))}`,  // The BrowserStack CDP endpoint gives you a `browser` instance based on the `caps` that you specified
     });
-
+    /* 
+    *  The BrowserStack specific code ends here. Following this line is your test script.
+    *  Here, we have a simple script that opens google.com, searches for the word BrowserStack and asserts the result.
+    */
     const page = await browser.newPage();
     await page.goto('https://www.duckduckgo.com');
     const element = await page.$('[name="q"]');
@@ -32,23 +35,23 @@ const main = async (cap) => {
 const capabilities = [
 {
   'browser': 'chrome',
-  'browser_version': 'latest',
+  'browser_version': 'latest',  // We support chrome v72 and above. You can choose `latest`, `latest-beta`, `latest-1`, `latest-2` and so on, in this capability
   'os': 'osx',
   'os_version': 'catalina',
-  'name': 'Chrome latest on Catalina',
+  'name': 'Chrome latest on Catalina',  // The name of your test and build. See browserstack.com/docs/automate/puppeteer/organize-tests for more details
   'build': 'puppeteer-build-2'
 },
 {
   'browser': 'firefox',
-  'browser_version': 'latest',
+  'browser_version': 'latest',  // We support firefox v86 and above. You can choose `latest`, `latest-beta`, `latest-1`, `latest-2` and so on, in this capability
   'os': 'osx',
   'os_version': 'catalina',
   'name': 'Firefox latest on Catalina',
   'build': 'puppeteer-build-2'
 },
 {
   'browser': 'edge',
-  'browser_version': 'latest',
+  'browser_version': 'latest',  // We support edge v80 and above. You can choose `latest`, `latest-beta`, `latest-1`, `latest-2` and so on, in this capability
   'os': 'osx',
   'os_version': 'catalina',
   'name': 'Edge latest on Catalina',
@@ -79,7 +82,7 @@ const capabilities = [
   'build': 'puppeteer-build-2'
 }]
 
-//  The following code loops through the capabilities array defined above and runs your code against each environment that you have specified
+//  The following code loops through the capabilities array defined above and runs your code against each environment that you have specified in parallel
 capabilities.forEach(async (cap) => {
   await main(cap);
 });