Skip to content

Commit 7f77e34

Browse files
committed
Update the docs
1 parent 14604b3 commit 7f77e34

File tree

5 files changed

+39
-21
lines changed

5 files changed

+39
-21
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
<meta property="og:site_name" content="SeleniumBase | Docs">
2-
<meta property="og:title" content="SeleniumBase | Python Web Testing" />
1+
<meta property="og:site_name" content="SeleniumBase">
2+
<meta property="og:title" content="SeleniumBase: Python Web Automation and E2E Testing" />
33
<meta property="og:description" content="Build fast, reliable, end-to-end tests." />
44
<meta property="og:keywords" content="Python, pytest, selenium, webdriver, test automation, testing, seleniumbase, test framework, RPA, reports, website tours, presentations">
55
<meta property="og:image" content="https://seleniumbase.io/cdn/img/sb_logo_dh.png" />
66
<link rel="icon" href="https://seleniumbase.io/img/logo3a.png" />
77

88
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/">
9-
<img src="https://seleniumbase.io/cdn/img/fancy_logo_14.png" alt="SeleniumBase" width="300" />
9+
<img src="https://seleniumbase.io/cdn/img/fancy_logo_14.png" alt="SeleniumBase" title="SeleniumBase" width="300" />
1010
</a></p>
11-
<p align="center"><b>A complete end-to-end testing experience.</b></p>
12-
<p align="center">Extends <a href="https://www.w3.org/TR/webdriver/">Selenium/WebDriver</a> and <a href="https://docs.pytest.org/en/latest/index.html">pytest</a>.</p>
11+
<p align="center"><b>The complete web automation library.</b></p>
12+
<p align="center">Powered by WebDriver APIs and pytest.</p>
1313
<!-- View on GitHub -->
1414
<p align="center">
1515
<a href="https://github.com/seleniumbase/SeleniumBase/releases">
@@ -22,8 +22,8 @@
2222
</p>
2323

2424
<p>
25-
<b>SeleniumBase</b> is an all-in-one framework for reliable browser automation, end-to-end testing, reports, charts, presentations, and website tours.
26-
Tests are run with <b>pytest</b>. Browsers are controlled by <b>WebDriver</b>.
25+
<b>SeleniumBase</b> is an all-in-one framework for reliable browser automation, end-to-end testing, reports, charts, presentations, website tours, and visual testing.
26+
Tests are run with <a href="https://docs.pytest.org/en/latest/index.html">pytest</a>. Browsers are controlled by <a href="https://www.w3.org/TR/webdriver2/#endpoints">WebDriver</a>.
2727
</p>
2828

2929
<p align="center">
@@ -57,7 +57,7 @@ Tests are run with <b>pytest</b>. Browsers are controlled by <b>WebDriver</b>.
5757

5858
--------
5959

60-
<p align="center"><img src="https://cdn2.hubspot.net/hubfs/100006/images/swag_mobile.gif" width="450" alt="SeleniumBase Mobile Mode" title="SeleniumBase Mobile Mode" /></p>
60+
<p align="center"><img src="https://seleniumbase.io/cdn/gif/swag_mobile.gif" width="450" alt="SeleniumBase Mobile Mode" title="SeleniumBase Mobile Mode" /></p>
6161

6262
```bash
6363
pytest test_swag_labs.py --mobile
@@ -414,8 +414,9 @@ SeleniumBase provides additional ``pytest`` command-line options for tests:
414414
--ad-block # (Block some types of display ads after page loads.)
415415
--block-images # (Block images from loading during tests.)
416416
--verify-delay=SECONDS # (The delay before MasterQA verification checks.)
417-
--disable-csp # (This disables the Content Security Policy of websites.)
418-
--enable-ws # (Enable Web Security on Chrome.)
417+
--disable-csp # (Disable the Content Security Policy of websites.)
418+
--disable-ws # (Disable Web Security on Chromium-based browsers.)
419+
--enable-ws # (Enable Web Security on Chromium-based browsers.)
419420
--enable-sync # (Enable "Chrome Sync".)
420421
--use-auto-ext # (Use Chrome's automation extension.)
421422
--swiftshader # (Use Chrome's "--use-gl=swiftshader" feature.)

help_docs/ReadMe.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@
7070

7171
<div><a href="https://seleniumbase.io/demo_page"><b>Demo Page / Demo Site</b></a></div>
7272
<div><a href="https://seleniumbase.io/other/tinymce"><b>TinyMCE Demo Page</b></a></div>
73+
<div><a href="https://seleniumbase.io/devices/"><b>Virtual Device Farm</b></a></div>
7374
<div><a href="https://seleniumbase.io/error_page/"><b>Error Page for Tests</b></a></div>
7475
<div><a href="https://seleniumbase.io/other/presenter.html"><b>Presenter Demo</b></a></div>
7576
<div><a href="https://seleniumbase.io/other/core_presentation.html"><b>Core Presentation</b></a></div>

help_docs/customizing_test_runs.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,9 @@ SeleniumBase provides additional ``pytest`` command-line options for tests:
126126
--ad-block # (Block some types of display ads after page loads.)
127127
--block-images # (Block images from loading during tests.)
128128
--verify-delay=SECONDS # (The delay before MasterQA verification checks.)
129-
--disable-csp # (This disables the Content Security Policy of websites.)
130-
--enable-ws # (Enable Web Security on Chrome.)
129+
--disable-csp # (Disable the Content Security Policy of websites.)
130+
--disable-ws # (Disable Web Security on Chromium-based browsers.)
131+
--enable-ws # (Enable Web Security on Chromium-based browsers.)
131132
--enable-sync # (Enable "Chrome Sync".)
132133
--use-auto-ext # (Use Chrome's automation extension.)
133134
--swiftshader # (Use Chrome's "--use-gl=swiftshader" feature.)

help_docs/mobile_testing.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,42 @@ Use ``--mobile`` to run SeleniumBase tests using Chrome's mobile device emulator
1111
```bash
1212
pytest test_skype_site.py --mobile
1313
```
14-
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/skype_mobile_test_2.gif" title="SeleniumBase Mobile Testing">](https://cdn2.hubspot.net/hubfs/100006/images/skype_mobile_test_2.gif)
14+
15+
[<img src="https://seleniumbase.io/cdn/gif/skype_mobile_test_2.gif" title="SeleniumBase Mobile Testing">](https://seleniumbase.io/cdn/gif/skype_mobile_test_2.gif)
1516

1617
To configure Device Metrics, use:
18+
1719
```bash
1820
--metrics="CSS_Width,CSS_Height,Pixel_Ratio"
1921
```
2022

2123
To configure the User-Agent, use:
24+
2225
```bash
2326
--agent="USER-AGENT-STRING"
2427
```
2528

2629
To find real values for Device Metrics, see:
30+
2731
* [Device Metrics List](https://gist.github.com/sidferreira/3f5fad525e99b395d8bd882ee0fd9d00)
2832

2933
To find real User-Agent strings, see:
34+
3035
* [User Agent Strings List](https://developers.whatismybrowser.com/useragents/explore/)
3136

3237
--------
3338

34-
Here's another example of running a mobile test ([SeleniumBase/examples/test_swag_labs.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py)), which demonstrates using ``--metrics`` and ``--agent`` with ``--mobile``:
39+
<b>Here's another example of a mobile test:</b>
40+
41+
[SeleniumBase/examples/test_swag_labs.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py)
42+
43+
```bash
44+
pytest test_swag_labs.py --mobile
45+
```
46+
47+
[<img src="https://seleniumbase.io/cdn/gif/swag_mobile.gif" title="SeleniumBase Mobile Testing">](https://seleniumbase.io/cdn/gif/swag_mobile.gif)
48+
49+
<b>Here's an example of configuring mobile settings for that test:</b>
3550

3651
```bash
3752
# Run tests using Chrome's mobile device emulator (default settings)
@@ -43,7 +58,6 @@ pytest test_swag_labs.py --mobile --metrics="411,731,3"
4358
# Run mobile tests specifying the user agent
4459
pytest test_swag_labs.py --mobile --agent="Mozilla/5.0 (Linux; Android 9; Pixel 3 XL)"
4560
```
46-
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/swag_mobile.gif" title="SeleniumBase Mobile Testing">](https://cdn2.hubspot.net/hubfs/100006/images/swag_mobile.gif)
4761

4862
--------
4963

mkdocs.yml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Project information
2-
site_name: SeleniumBase | Docs
2+
site_name: Docs - seleniumbase.io
33
site_url: https://seleniumbase.io
44
site_author: Michael Mintz
5-
site_description: Fast, reliable, end-to-end testing
5+
site_description: The world's most powerful all-in-one web automation platform. Build fast, reliable, end-to-end tests with Python.
66
# Repository information
77
repo_name: seleniumbase/SeleniumBase
88
repo_url: https://github.com/seleniumbase/SeleniumBase
@@ -33,7 +33,7 @@ theme:
3333
search_index_only: true
3434
features:
3535
- tabs
36-
# - instant
36+
- instant
3737
palette:
3838
scheme: default
3939
primary: blue
@@ -47,13 +47,13 @@ theme:
4747
plugins:
4848
- search
4949
- minify:
50-
minify_html: false
50+
minify_html: true
5151
- mkdocs-simple-hooks:
5252
hooks:
5353
on_pre_build: docs.prepare:main
5454
# Page tree
5555
nav:
56-
- SeleniumBase | Docs: README.md
56+
- SeleniumBase Docs: README.md
5757
- Features List: help_docs/features_list.md
5858
- Running Example Tests: examples/ReadMe.md
5959
- Command Line Options: help_docs/customizing_test_runs.md
@@ -98,13 +98,14 @@ nav:
9898
- Docker Help: integrations/docker/ReadMe.md
9999
- MySQL Help: help_docs/mysql_installation.md
100100
- Case Studies: help_docs/happy_customers.md
101-
- Thank You: help_docs/thank_you.md
102101
- Demo Pages:
103102
- Demo Page / Demo Site: https://seleniumbase.io/demo_page
104103
- TinyMCE Demo Page: https://seleniumbase.io/other/tinymce
104+
- Virtual Device Farm: https://seleniumbase.io/devices/
105105
- Error Demo Page: https://seleniumbase.io/error_page/
106106
- Presenter Demo: https://seleniumbase.io/other/presenter.html
107107
- Core Presentation: https://seleniumbase.io/other/core_presentation.html
108108
- Chart Maker Demo: https://seleniumbase.io/other/chart_presentation.html
109+
- Thank You: help_docs/thank_you.md
109110
# Google Analytics
110111
google_analytics: ['UA-167313767-1', 'seleniumbase.io']

0 commit comments

Comments
 (0)