Update the docs

Author: mdmintz

examples/ReadMe.md

@@ -1,6 +1,6 @@
-<a align="center" href="https://github.com/seleniumbase/SeleniumBase/blob/master/README.md"><img align="center" src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb8.png" alt="SeleniumBase" height="46" /></a>
+<a align="center" href="https://github.com/seleniumbase/SeleniumBase/blob/master/README.md"><img align="center" src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb8.png" alt="SeleniumBase" height="48" /></a>
 
-## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3.png" title="SeleniumBase" height="32"> Running Example Tests:
+## <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Running Example Tests:
 
 SeleniumBase tests are run with **``pytest``**. Chrome is the default browser if not specifed. During test failures, logs and screenshots from the latest run are saved to the ``latest_logs/`` folder.
 

examples/example_logs/ReadMe.md

@@ -1,4 +1,6 @@
-### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3.png" title="SeleniumBase" height="32"> Logging, Screenshots, and Reports:
+<a align="center" href="https://github.com/seleniumbase/SeleniumBase/"><img align="center" src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb.png" title="SeleniumBase" height="48" /></a>
+
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Logging, Screenshots, and Reports:
 
 Log files in [SeleniumBase/examples/example_logs](https://github.com/seleniumbase/SeleniumBase/tree/master/examples/example_logs) were generated when [test_fail.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_fail.py) ran and failed. During test failures, logs and screenshots get saved to the ``latest_logs/`` folder. If ``--archive-logs`` is set, test logs will get archived to the ``archived_logs/`` folder.
 
@@ -9,32 +11,34 @@ nosetests test_fail.py --browser=firefox
 ```
 
 <b>Examples of expected log files generated during failures:</b>
-* [basic_test_info.txt](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/basic_test_info.txt)
-* [page_source.html](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/page_source.html)
-* [screenshot.png](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/screenshot.png)
+<ul>
+<li><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/basic_test_info.txt">basic_test_info.txt</a></li>
+<li><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/page_source.html">page_source.html</a></li>
+<li><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/screenshot.png">screenshot.png</a></li>
+</ul>
 
 --------
 
 <b>In addition to logging, you can also generate test reports:</b>
 
 Reports are most useful when running large test suites. Pytest and Nosetest reports are handled differently.
 
-### Pytest Reports:
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Pytest Reports:
 
 Using ``--html=report.html`` gives you a fancy report of the name specified after your test suite completes.
 
 ```bash
 pytest test_suite.py --html=report.html
 ```
-![](https://cdn2.hubspot.net/hubfs/100006/images/PytestReport.png "Example Pytest Report")
+<img src="https://cdn2.hubspot.net/hubfs/100006/images/pytest_report_2.png" alt="Example Pytest Report" title="Example Pytest Report">
 
-### Nosetest Reports:
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Nosetest Reports:
 
 The ``--report`` option gives you a fancy report after your test suite completes. (Requires ``--with-testing_base`` to also be set when ``--report`` is used because it's part of that plugin.)
 
 ```bash
 nosetests test_suite.py --report --browser=chrome
 ```
-<img src="https://cdn2.hubspot.net/hubfs/100006/images/Test_Report_2.png" title="Example Nosetest Report" height="420">
+<img src="https://cdn2.hubspot.net/hubfs/100006/images/Test_Report_2.png" alt="Example Nosetest Report" title="Example Nosetest Report" height="420">
 
-(NOTE: You can add ``--show_report`` to immediately display Nosetest reports after the test suite completes. Only use ``--show_report`` when running tests locally because it pauses the test run.)
+(NOTE: You can add ``--show_report`` to immediately display Nosetest reports after the test suite completes. Only use ``--show_report`` when running tests locally because it pauses the test run.)

examples/translations/ReadMe.md

@@ -1,6 +1,6 @@
 <h3 align="left"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_m.png" title="SeleniumBase" height="48" /></a></h3>
 
-### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3.png" title="SeleniumBase" height="32"> Multi-Language Tests (Python 3 Only!)
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Multi-Language Tests (Python 3 Only!)
 
 <b>SeleniumBase</b> supports the following 10 languages:
 <ul>

help_docs/ReadMe.md

@@ -1,6 +1,6 @@
 <div><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_media_logo.png" alt="SeleniumBase" height="114" /></a></div>
 
-## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3.png" title="SeleniumBase" height="32"> Help Documents
+## <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Help Documents
 
 <div><b>Table of Contents / Navigation:</b></div>
 <div><a href="https://seleniumbase.io/help_docs/features_list/"><b>SeleniumBase Features List</b></a></div>
@@ -13,7 +13,7 @@
 <div><a href="https://seleniumbase.io/help_docs/customizing_test_runs/"><b>The Command Line Tutorial</b></a></div>
 <div><a href="https://seleniumbase.io/seleniumbase/console_scripts/ReadMe/"><b>The Console Scripts Tutorial</b></a></div>
 <div><a href="https://seleniumbase.io/help_docs/mobile_testing/"><b>Mobile Device Testing</b></a></div>
-<div><a href="https://seleniumbase.io/help_docs/method_summary/"><b>Method Summary Overview</b></a></div>
+<div><a href="https://seleniumbase.io/help_docs/method_summary/"><b>Method Summary (API Ref)</b></a></div>
 <div><a href="https://seleniumbase.io/help_docs/translations/"><b>Language Translations</b></a></div>
 <div><a href="https://seleniumbase.io/examples/tour_examples/ReadMe/"><b>Tour Examples</b></a></div>
 <div><a href="https://seleniumbase.io/help_docs/mysql_installation/"><b>MySQL Installation Overview</b></a></div>

help_docs/customizing_test_runs.md

@@ -1,6 +1,6 @@
 [<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
 
-## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3.png" title="SeleniumBase" height="32"> Customizing test runs
+## <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Customizing test runs
 
 You can customize test runs from the command-line thanks to [SeleniumBase's pytest plugin](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py), which adds command-line options for setting/enabling the browser type, headless mode, mobile mode, multithreading mode, demo mode, proxy config, user agent config, browser extensions, and more.
 
@@ -134,14 +134,16 @@ SeleniumBase provides additional Pytest command-line options for tests:
 ```
 (For more details, see the full list of command-line options **[here](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py)**.)
 
-#### **Customizing default settings:**
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Customizing default settings:
 
 An easy way to override [seleniumbase/config/settings.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py) is by using a custom settings file.
 Here's the command-line option to add to tests: (See [examples/custom_settings.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/custom_settings.py))
 ``--settings-file=custom_settings.py``
 (Settings include default timeout values, a two-factor auth key, DB credentials, S3 credentials, and other important settings used by tests.)
 
-#### **Running tests on [BrowserStack](https://www.browserstack.com/automate#)'s Selenium Grid, the [Sauce Labs](https://saucelabs.com/products/open-source-frameworks/selenium) Selenium Grid, the [TestingBot](https://testingbot.com/features) Selenium Grid, another grid, or your own:**
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Running tests on a remote Selenium Grid:
+
+SeleniumBase lets you run tests on remote Selenium Grids such as [BrowserStack](https://www.browserstack.com/automate#)'s Selenium Grid, [Sauce Labs](https://saucelabs.com/products/open-source-frameworks/selenium)'s Selenium Grid, [TestingBot](https://testingbot.com/features)'s Selenium Grid, other Grids, and even your own Grid:
 
 (For setting browser desired capabilities while running Selenium remotely, see the ReadMe located here: https://github.com/seleniumbase/SeleniumBase/tree/master/examples/capabilities)
 
@@ -172,14 +174,14 @@ pytest my_first_test.py --server=USERNAME:[email protected] --port=80
 
 Or you can create your own Selenium Grid for test distribution. ([See this ReadMe for details](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md))
 
-#### **Example tests using Logging:**
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Example tests using Logging:
 
 ```bash
 pytest test_suite.py --browser=chrome
 ```
 (During test failures, logs and screenshots from the most recent test run will get saved to the ``latest_logs/`` folder. Those logs will get moved to ``archived_logs/`` if you have ARCHIVE_EXISTING_LOGS set to True in [settings.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py), otherwise log files with be cleaned up at the start of the next test run.)
 
-#### **Demo Mode:**
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Demo Mode:
 
 If any test is moving too fast for your eyes to see what's going on, you can run it in **Demo Mode** by adding ``--demo`` on the command line, which pauses the browser briefly between actions, highlights page elements being acted on, and lets you know what test assertions are happening in real time:
 
@@ -193,22 +195,22 @@ You can override the default wait time by either updating [settings.py](https://
 pytest my_first_test.py --demo --demo-sleep=1.2
 ```
 
-#### **Passing additional data to tests:**
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Passing additional data to tests:
 
 If you want to pass additional data from the command line to your tests, you can use ``--data=STRING``. Now inside your tests, you can use ``self.data`` to access that.
 
-#### **Running tests multithreaded:**
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Running tests multithreaded:
 
 To run Pytest multithreaded on multiple CPUs at the same time, add ``-n=NUM`` or ``-n NUM`` on the command line, where NUM is the number of CPUs you want to use.
 
-#### **Retrying failing tests automatically:**
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Retrying failing tests automatically:
 
 You can use ``--reruns=NUM`` to retry failing tests that many times. Use ``--reruns-delay=SECONDS`` to wait that many seconds between retries. Example:
 ```
 pytest --reruns=2 --reruns-delay=1
 ```
 
-#### **Debugging tests:**
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Debugging tests:
 
 **You can use the following code snippets in your scripts to help you debug issues:**
 ```python
@@ -225,27 +227,27 @@ pytest my_first_test.py --pdb -s
 
 The code above will leave your browser window open in case there's a failure. (ipdb commands: 'c', 's', 'n' => continue, step, next).
 
-#### **Pytest Reports:**
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Pytest Reports:
 
 Using ``--html=report.html`` gives you a fancy report of the name specified after your test suite completes.
 
 ```bash
 pytest test_suite.py --html=report.html
 ```
-![](https://cdn2.hubspot.net/hubfs/100006/images/PytestReport.png "Example Pytest Report")
+<img src="https://cdn2.hubspot.net/hubfs/100006/images/pytest_report_2.png" alt="Example Pytest Report" title="Example Pytest Report">
 
-#### **Nosetest Reports:**
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Nosetest Reports:
 
 The ``--report`` option gives you a fancy report after your test suite completes.
 
 ```bash
 nosetests test_suite.py --report
 ```
-<img src="https://cdn2.hubspot.net/hubfs/100006/images/Test_Report_2.png" title="Example Nosetest Report" height="420">
+<img src="https://cdn2.hubspot.net/hubfs/100006/images/Test_Report_2.png" alt="Example Nosetest Report" title="Example Nosetest Report" height="420">
 
 (NOTE: You can add ``--show_report`` to immediately display Nosetest reports after the test suite completes. Only use ``--show_report`` when running tests locally because it pauses the test run.)
 
-#### **Using a Proxy Server:**
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Using a Proxy Server:
 
 If you wish to use a proxy server for your browser tests (Chrome and Firefox only), you can add ``--proxy=IP_ADDRESS:PORT`` as an argument on the command line.
 
@@ -265,15 +267,15 @@ To make things easier, you can add your frequently-used proxies to PROXY_LIST in
 pytest proxy_test.py --proxy=proxy1
 ```
 
-#### **Changing the User-Agent:**
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Changing the User-Agent:
 
 If you wish to change the User-Agent for your browser tests (Chrome and Firefox only), you can add ``--agent="USER-AGENT-STRING"`` as an argument on the command line.
 
 ```bash
 pytest user_agent_test.py --agent="Mozilla/5.0 (Nintendo 3DS; U; ; en) Version/1.7412.EU"
 ```
 
-#### **Mobile Device Testing:**
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Mobile Device Testing:
 
 Use ``--mobile`` to quickly run your tests using Chrome's mobile device emulator with default values for device metrics (CSS Width, CSS Height, Pixel-Ratio) and a default value set for the user agent. To configure the mobile device metrics, use ``--metrics="CSS_Width,CSS_Height,Pixel_Ratio"`` to set those values. You'll also be able to set the user agent with ``--agent="USER-AGENT-STRING"`` (a default user agent will be used if not specified). To find real values for device metrics, [see this GitHub Gist](https://gist.github.com/sidferreira/3f5fad525e99b395d8bd882ee0fd9d00). For a list of available user agent strings, [check out this page](https://developers.whatismybrowser.com/useragents/explore/).
 

help_docs/method_summary.md

@@ -1,5 +1,6 @@
 [<img src="https://cdn2.hubspot.net/hubfs/100006/images/SeleniumBaseText_F.png" title="SeleniumBase" align="center" height="46">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
-## Method Summary Overview
+
+## <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Method Summary (API Reference)
 
 Here's a summary of SeleniumBase method definitions, which are defined in [base_case.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py)
 

mkdocs.yml

@@ -2,9 +2,7 @@
 site_name: SeleniumBase
 site_url: https://seleniumbase.io
 site_author: Michael Mintz
-site_description: >-
-  Create browser tests for web and mobile user interfaces.
-  Uses Python and pytest to execute commands and run tests.
+site_description: Test Automation Framework
 # Repository information
 repo_name: seleniumbase/SeleniumBase
 repo_url: https://github.com/seleniumbase/SeleniumBase
@@ -20,7 +18,6 @@ markdown_extensions:
   - markdown.extensions.codehilite
   - markdown.extensions.def_list
   - markdown.extensions.footnotes
-  - markdown.extensions.meta
   - markdown.extensions.toc:
       permalink: true
 # Configuration
@@ -32,11 +29,14 @@ theme:
   sticky_navigation: true
   features:
     - tabs
+  palette:
+    primary: indigo
+    accent: indigo
 # Plugins
 plugins:
   - search
   - minify:
-      minify_html: true
+      minify_html: false
   - mkdocs-simple-hooks:
       hooks:
         on_pre_build: docs.prepare:main
@@ -73,10 +73,9 @@ nav:
     - Recorder and Exporting: seleniumbase/utilities/selenium_ide/ReadMe.md
   - Help Docs ToC:
     - Table of Contents: help_docs/ReadMe.md
-    - API Reference: help_docs/method_summary.md
     - Master QA: seleniumbase/masterqa/ReadMe.md
     - Decorators & Security: seleniumbase/common/ReadMe.md
     - Using Safari Driver: help_docs/using_safari_driver.md
     - macOS Hidden Files: help_docs/hidden_files_info.md
-    - Happy Customers: help_docs/happy_customers.md
+    - Case Studies: help_docs/happy_customers.md
   - Thank You: help_docs/thank_you.md

seleniumbase/console_scripts/ReadMe.md

@@ -1,6 +1,6 @@
 <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_q.png" title="SeleniumBase" height="48">
 
-## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Console Scripts
+## <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> Console Scripts
 
 SeleniumBase console scripts help you get things done more easily, such as installing web drivers, creating a test directory with necessary configuration files, converting old WebDriver unittest scripts into SeleniumBase code, translating tests into multiple languages, and using the Selenium Grid.
 

seleniumbase/drivers/ReadMe.md

@@ -1,4 +1,4 @@
-### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> SeleniumBase webdriver storage
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> SeleniumBase webdriver storage
 
 * You need a different webdriver for each web browser you want to run automation on: ``chromedriver`` for Chrome, ``edgedriver`` for Edge, ``geckodriver`` for Firefox, ``operadriver`` for Opera, and ``iedriver`` for Internet Explorer.
 

seleniumbase/extensions/ReadMe.md

@@ -1,4 +1,4 @@
-### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> SeleniumBase browser extension storage
+### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" height="30" /> SeleniumBase browser extension storage
 
 **The List:**
 * disable_csp.zip => Disable Chrome's Content-Security-Policy