Skip to content

Commit dbae1a2

Browse files
committed
Update the Case Plans documentation
1 parent 6996324 commit dbae1a2

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

help_docs/case_plans.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) SeleniumBase Case Plans 📒🗂️
22

3-
📒 <b>SeleniumBase Case Plans</b> is Test Case Management Software that utilizes Markdown Table Technology for hosting test plans directly in GitHub (or any source code management system that supports Markdown format).
3+
<img src="https://seleniumbase.io/cdn/img/cp/sb_case_plans.png" title="SeleniumBase Case Plans Summary" width="625">
44

5-
📒 The ``case_summary.md`` file is generated from individual Case Plans that exist in the ``case_plans/`` folders of your repository. Here's how the Case Summary file may look after you've created some initial Case Plans:
5+
📒 <b>SeleniumBase Case Plans</b> is Test Case Management Software that uses Markdown tables for displaying test plans directly in GitHub (and other source code management systems that support Markdown format).
6+
7+
📒 The ``case_summary.md`` file is generated from individual Case Plans that exist in the ``case_plans/`` folders of your repository. (See the example below to learn how the Case Summary file may look.)
68

79
--------
810

11+
> **Example of a ``case_summary.md`` file:**
12+
913
<h2>Summary of existing Case Plans</h2>
1014

1115
| | | |
@@ -154,7 +158,7 @@
154158
sbase caseplans
155159
```
156160

157-
<img src="https://seleniumbase.io/cdn/img/cp/case_plan_boilerplate_gen.png" title="SeleniumBase Case Plans GUI" width="550">
161+
<img src="https://seleniumbase.io/cdn/img/cp/case_plan_boilerplate_gen.png" title="SeleniumBase Case Plans GUI" width="525">
158162

159163
📒 Once you are running the Case Plans GUI, select the existing tests that need Case Plans, and then click: ``Generate boilerplate Case Plans for selected tests missing them``. For each selected test that didn't already have a Case Plan file, one will be generated. Each new Case Plan file starts with default boilerplate code with a Markdown table. Eg:
160164

0 commit comments

Comments
 (0)