Skip to content

Commit 58d32a4

Browse files
committed
Update the documentation
1 parent 2f32d0c commit 58d32a4

File tree

6 files changed

+210
-51
lines changed

6 files changed

+210
-51
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md">🔮 Scripts</a> |
1919
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mobile_testing.md">📱 Phone</a>
2020
<br />
21-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">📙 APIs</a> |
21+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">📚 APIs</a> |
2222
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md">📝 Formats</a> |
23-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md">🔵 Dashboard</a> |
23+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md"> Dashboard</a> |
2424
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/recorder_mode.md">🔴 Recorder</a> |
2525
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/locale_codes.md">🗾 Locales</a> |
2626
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md">🌐 Grid</a>
@@ -32,11 +32,18 @@
3232
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/chart_maker/ReadMe.md">📊 Charts</a> |
3333
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md">🚎 Tours</a>
3434
<br />
35-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/github/workflows/ReadMe.md">🤖 CI</a> |
36-
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Boilerplates</a> |
35+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/how_it_works.md">👁️ How</a> |
36+
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/migration/raw_selenium">🚝 Migrate</a> |
37+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/case_plans.md">📒 CasePlans</a> |
38+
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js">🚉 NodeGUI</a> |
39+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">🧬 Hybrid</a> |
40+
<a href="https://seleniumbase.io/devices/?url=seleniumbase.com">💻 Farm</a>
41+
<br />
42+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/github/workflows/ReadMe.md">🤖 CI/CD</a> |
43+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/js_package_manager.md">🕹️ JSMgr</a> |
44+
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Templates</a> |
3745
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/html_inspector.md">🔎 Inspector</a> |
38-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/js_package_manager.md">🕹️ JSCode</a> |
39-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/dialog_boxes/ReadMe.md">🛂 Dialogs</a> |
46+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/dialog_boxes/ReadMe.md">🛂 Boxes</a> |
4047
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md">🖼️ Visual</a>
4148
<br />
4249
</p>
@@ -200,6 +207,7 @@ COMMANDS:
200207
behave-options (List common behave options)
201208
gui / commander [OPTIONAL PATH or TEST FILE]
202209
behave-gui (SBase Commander for Behave)
210+
caseplans [OPTIONAL PATH or TEST FILE]
203211
mkdir [DIRECTORY] [OPTIONS]
204212
mkfile [FILE.py] [OPTIONS]
205213
mkrec / codegen [FILE.py] [OPTIONS]

help_docs/features_list.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
* A powerful Python framework for browser automation and E2E UI testing.
99
* Includes [Recorder Mode](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/recorder_mode.md) for instantly generating browser tests in Python.
1010
* Supports multiple browsers, tabs, iframes, and proxies in the same test.
11+
* Includes [Test Case Management Software](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/case_plans.md) with Markdown technology.
1112
* Automatic smart-waiting improves reliability and prevents flaky tests.
1213
* Supports [pytest](https://docs.pytest.org/en/latest/), [unittest](https://docs.python.org/3/library/unittest.html), [nose](http://nose.readthedocs.io/en/latest/), and [behave](https://behave.readthedocs.io/en/stable/index.html) for finding/running tests.
1314
* All the code is open source. Look inside to learn about any feature.

help_docs/how_it_works.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,17 @@ class TestMFALogin(BaseCase):
3838
self.assert_exact_text("You have been signed out!", "#top_message")
3939
```
4040

41-
(See the example test, [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py), for reference.)
41+
(See the example, [test_mfa_login.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_mfa_login.py), for reference.)
42+
43+
The most common way of running SeleniumBase tests is with ``pytest``:
44+
45+
```bash
46+
pytest --headless --rs --dashboard --html=report.html -v -n=4
47+
pytest test_mfa_login.py
48+
pytest -m marker2
49+
pytest offline_examples/
50+
pytest -k agent
51+
```
4252

4353
--------
4454

help_docs/html_inspector.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ pytest test_inspect_html.py
2222
============== test session starts ==============
2323

2424
* HTML Inspection Results: https://xkcd.com/1144/
25-
X - 'property' is not a valid attribute of the <meta> element.
26-
X - Do not use <div> or <span> elements without any attributes.
27-
X - The 'alt' attribute is required for <img> elements.
28-
X - The 'border' attribute is no longer valid on the <img> element and should not be used.
29-
X - 'srcset' is not a valid attribute of the <img> element.
30-
X - The <center> element is obsolete and should not be used.
31-
X - <script> elements should appear right before the closing </body> tag for optimal performance.
32-
X - The id 'comicLinks' appears more than once in the document.
25+
⚠️ 'property' is not a valid attribute of the <meta> element.
26+
⚠️ Do not use <div> or <span> elements without any attributes.
27+
⚠️ The 'alt' attribute is required for <img> elements.
28+
⚠️ The 'border' attribute is no longer valid on the <img> element and should not be used.
29+
⚠️ 'srcset' is not a valid attribute of the <img> element.
30+
⚠️ The <center> element is obsolete and should not be used.
31+
⚠️ <script> elements should appear right before the closing </body> tag for optimal performance.
32+
⚠️ The id 'comicLinks' appears more than once in the document.
3333
* (See the Console output for details!)
3434
```

0 commit comments

Comments
 (0)