You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/get-started/create-your-first-test.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ A [test](/docs/get-started/tests) in Doc Detective is a series of steps, where e
12
12
13
13
## What does this test do?
14
14
15
-
This test navigates to `https://example.com`, checks for the presence of the `<h1>` heading with the text `Example Domain`, and verifies that the `More information...` link is present. It then clicks the link and captures a screenshot of the resulting page.
15
+
This test navigates to `https://example.com`, checks for the presence of the `<h1>` heading with the text `Example Domain`, and verifies that the `Learn more` link is present. It then clicks the link and captures a screenshot of the resulting page.
16
16
17
17
## Prerequisites
18
18
@@ -53,8 +53,8 @@ To create your first test, follow these steps:
53
53
"find": "Example Domain"
54
54
},
55
55
{
56
-
"description": "Verify that the 'More information...' link is present and working",
57
-
"click": "More information..."
56
+
"description": "Verify that the 'Learn more' link is present and working",
57
+
"click": "Learn more"
58
58
},
59
59
{
60
60
"description": "Capture a screenshot of the resulting page",
@@ -70,7 +70,7 @@ To create your first test, follow these steps:
70
70
71
71
-[`goTo`](/docs/get-started/actions/goTo): Navigates to the specified URL, https://example.com, to start the test flow.
72
72
-[`find`](/docs/get-started/actions/find): Locates elements on the page using CSS selectors such as HTML tags like `h1` or `a`, and validates their presence and text content.
73
-
-[`click`](/docs/get-started/actions/click): Clicks on the specified element, in this case, the `More information...` link.
73
+
-[`click`](/docs/get-started/actions/click): Clicks on the specified element, in this case, the `Learn more` link.
74
74
-[`screenshot`](/docs/get-started/actions/screenshot): Captures a screenshot of the current page and saves it to the specified path.
75
75
76
76
4. Save the file.
@@ -149,8 +149,8 @@ After running the test, you should see the results in your terminal, which Doc D
149
149
{
150
150
"result": "PASS",
151
151
"resultDescription": "Clicked element. Found element by text. Clicked element.",
152
-
"description": "Verify that the 'More information...' link is present and working",
153
-
"click": "More information...",
152
+
"description": "Verify that the 'Learn more' link is present and working",
Copy file name to clipboardExpand all lines: docs/references/schemas/config.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,14 @@ Field | Type | Description | Default
10
10
$schema | string | Optional. JSON Schema for this object.<br/><br/>Accepted values: `https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/config_v3.schema.json` |
11
11
configId | string | Optional. Identifier for the configuration. |
12
12
configPath | string | ReadOnly. Path to the configuration file. |
13
-
input | one of:<br/>- string<br/>- array of string | Optional. Paths to test specifications and documentation source files. May be paths to specific files or to directories to scan for files. | `.`
13
+
input | one of:<br/>- string<br/>- array of string | Optional. Path(s) to test specifications and documentation source files. May be paths to specific files or to directories to scan for files. | `.`
14
14
output | string | Optional. Path of the directory in which to store the output of Doc Detective commands. If a file path is specified, Doc Detective attempts to honor the file name specified, but file path behavior is controlled by the configured reporters. | `.`
15
15
recursive | boolean | Optional. If `true` searches `input`, `setup`, and `cleanup` paths recursively for test specifications and source files. | `true`
16
16
relativePathBase | string | Optional. Whether paths should be interpreted as relative to the current working directory (`cwd`) or to the file in which they're specified (`file`).<br/><br/>Accepted values: `cwd`, `file` | `file`
17
17
loadVariables | string | Optional. Load environment variables from the specified `.env` file. |
18
18
origin | string | Optional. Default protocol and domain to use for relative URLs. |
19
-
beforeAny | one of:<br/>- string<br/>- array of string | Optional. Paths to test specifications to perform before those specified by `input`. Useful for setting up testing environments. |
20
-
afterAll | one of:<br/>- string<br/>- array of string | Optional. Paths to test specifications to perform after those specified by `input`. Useful for cleaning up testing environments. |
19
+
beforeAny | one of:<br/>- string<br/>- array of string | Optional. Path(s) to test specifications to perform before those specified by `input`. Useful for setting up testing environments. |
20
+
afterAll | one of:<br/>- string<br/>- array of string | Optional. Path(s) to test specifications to perform after those specified by `input`. Useful for cleaning up testing environments. |
21
21
detectSteps | boolean | Optional. Whether or not to detect steps in input files based on defined markup. | `true`
22
22
allowUnsafeSteps | boolean | Optional. Whether or not to run potentially unsafe steps, such as those that might modify files or system state. |
23
23
logLevel | string | Optional. Amount of detail to output when performing an operation.<br/><br/>Accepted values: `silent`, `error`, `warning`, `info`, `debug` | `info`
0 commit comments