Merge pull request #50 from theiiienrique/typos

hawkeyexl · web-flow · commit b2cd01a22bce · 2024-09-07T15:08:05.000-07:00
Fix typos, consistent formatting
diff --git a/docs/contribute/repos/doc-detective.md b/docs/contribute/repos/doc-detective.md
@@ -7,5 +7,5 @@ sidebar_position: 1
 The most common entrypoint for most users, [`doc-detective`](https://github.com/doc-detective/doc-detective) is an NPM-based CLI tool that performs tests. It's installable via NPM (`npm i -g doc-detective`) and directly runnable without installation via NPX (`npx doc-detective`).
 
 This repo depends on
-- [`doc-detective-core`](doc-detective-core) for the primarly testing logic.
+- [`doc-detective-core`](doc-detective-core) for the primary testing logic.
 - [`doc-detective-common`](doc-detective-common) for JSON schema definitions, schema validation logic, and path resolution logic.
diff --git a/docs/contribute/repos/docker-image.md b/docs/contribute/repos/docker-image.md
@@ -6,6 +6,6 @@ sidebar_position: 6
 
 > This repo is in alpha. It's not ready for production use.
 
-[`docker-image`](https://github.com/doc-detective/docker-image) runs Doc Detective in a container. While Doc Detective can run on most machines as-is, this Docker image simplifies installation and running Doc Detective on machines without Node.js or with hightened security requirements.
+[`docker-image`](https://github.com/doc-detective/docker-image) runs Doc Detective in a container. While Doc Detective can run on most machines as-is, this Docker image simplifies installation and running Doc Detective on machines without Node.js or with heightened security requirements.
 
 This repo depends on [`doc-detective`](doc-detective) for performing the tests.
diff --git a/docs/get-started/actions/checkLink.md b/docs/get-started/actions/checkLink.md
@@ -15,7 +15,7 @@ You can also specify
 - an `origin` to navigate to a URL relative to a specific path.
 - `statusCodes` to set acceptable HTTP status codes.
 
-> For comprehensive options, see the [checkLink](/docs/references/schemas/checkLink) reference.
+> For comprehensive options, see the [`checkLink`](/docs/references/schemas/checkLink) reference.
 
 ## Examples
 
diff --git a/docs/get-started/actions/find.md b/docs/get-started/actions/find.md
@@ -8,6 +8,6 @@ grand_parent: Tests
 
 # find
 
-The `find` action locations an element in the current interface and interacts with it, such as validating its text content, clicking it, or typing into it.
+The `find` action locates an element in the current interface and interacts with it, such as validating its text content, clicking it, or typing into it.
 
 > For comprehensive options, see the [`find`](/docs/references/schemas/find) reference.
diff --git a/docs/get-started/actions/saveScreenshot.md b/docs/get-started/actions/saveScreenshot.md
@@ -6,7 +6,7 @@ parent: Actions
 grand_parent: Tests
 ---
 
-# find
+# saveScreenshot
 
 The `saveScreenshot` action captures a PNG of the current viewport. If an image with the same name and dimensions exists, it can also perform pixel diffs and capture updated screenshots for debugging or media updating purposes.
 
diff --git a/docs/get-started/actions/setVariables.md b/docs/get-started/actions/setVariables.md
@@ -10,7 +10,7 @@ grand_parent: Tests
 
 The `setVariables` action sets environment variables from a `.env` file. This action is useful for accessing sensitive information, such as API keys or other credentials, without hardcoding them into your tests.
 
-For comprehensive options, see the [setVariables](/docs/references/schemas/setVariables) reference.
+> For comprehensive options, see the [`setVariables`](/docs/references/schemas/setVariables) reference.
 
 ## Example
 
diff --git a/docs/get-started/actions/startRecording.md b/docs/get-started/actions/startRecording.md
@@ -6,7 +6,7 @@ parent: Actions
 grand_parent: Tests
 ---
 
-# find
+# startRecording
 
 The `startRecording` action records tests as they are run for debugging or multimedia purposes.
 
diff --git a/docs/get-started/actions/stopRecording.md b/docs/get-started/actions/stopRecording.md
@@ -6,7 +6,7 @@ parent: Actions
 grand_parent: Tests
 ---
 
-# find
+# stopRecording
 
 The `stopRecording` action stops a recording started by a [`startRecording`](startRecording) action.
 
diff --git a/docs/get-started/actions/typeKeys.md b/docs/get-started/actions/typeKeys.md
@@ -12,7 +12,7 @@ The `typeKeys` action registers key presses, including special keys such as Ente
 
 You can specify `keys` either as a string or as an array of strings. Each character in a string or array is separated is treated as a separate key press, but specifying an array allows you to include both regular and [special](#special-keys) keys.
 
-For comprehensive options, see the [typeKeys](/docs/references/schemas/typeKeys) reference.
+> For comprehensive options, see the [`typeKeys`](/docs/references/schemas/typeKeys) reference.
 
 ## Special keys
 
diff --git a/docs/get-started/actions/wait.md b/docs/get-started/actions/wait.md
@@ -12,7 +12,7 @@ The `wait` action pauses before performing the next step. This action is useful
 
 You can specify the `duration` to pause in milliseconds. The default `duration` is 5 seconds.
 
-For comprehensive options, see the [wait](/docs/references/schemas/wait) reference.
+> For comprehensive options, see the [`wait`](/docs/references/schemas/wait) reference.
 
 ## Examples
 
diff --git a/docs/get-started/get-started.md b/docs/get-started/get-started.md
@@ -4,7 +4,7 @@ sidebar_position: 2
 
 # Get started
 
-Downloading and running Doc Detective is simple, but lets walk through it and run tests on a few sample files.
+Downloading and running Doc Detective is straightforward. Follow these steps to run tests on a few sample files.
 
 1. Install prerequisites:
 
@@ -62,7 +62,7 @@ You can override config options with command-line arguments. For example, to run
 npx doc-detective runTests --config .doc-detective.json --input tests.spec.json
 ```
 
-### Run remotely-hosted tests
+### Run remotely hosted tests
 
 You can run tests hosted remotely by specifying the URL of the test file with the `--input` argument. For example, to run tests from a file hosted at `https://doc-detective.com/sample.spec.json`, run the following command:
 
diff --git a/docs/get-started/intro.md b/docs/get-started/intro.md
@@ -63,7 +63,7 @@ As an open-source and accessible project, Doc Detective is for anyone who is int
 
 - **Small teams:** There’s often limited personnel or budget dedicated to a project, and documentation takes a backseat as a result. With Doc Detective, you can spend less time reviewing published documentation and trust that it is still functional and accurate for the end user.
 - **Large teams:** The more people you have contributing to a project, the faster it can change shape. In cases where development is outpacing documentation, Doc Detective keeps a watchful eye on the changes made and note any inconsistencies.
-- **Anything in between:** You can be a team of one or of one thousand and still find a use for Doc Detective. When it comes time to address the documentation of your project, look to Doc Detective to ease the burden and help bring consistency and accuracyto the end user.
+- **Anything in between:** You can be a team of one or of one thousand and still find a use for Doc Detective. When it comes time to address the documentation of your project, look to Doc Detective to ease the burden and help bring consistency and accuracy to the end user.
 
 ## Next steps
 
diff --git a/docs/get-started/tests/index.md b/docs/get-started/tests/index.md
@@ -388,7 +388,7 @@ This example runs all test specs in a file named `doc-content.md` in the `sample
 npx doc-detective runTests --input ./samples/doc-content.md
 ```
 
-### Remotely-hosted tests
+### Remotely hosted tests
 
 You can run tests hosted remotely by specifying the URL of the test file with the `--input` argument. For example, to run tests from a file hosted at `https://doc-detective.com/sample.spec.json`, run the following command:
 
diff --git a/docs/references/schemas/config.md b/docs/references/schemas/config.md
@@ -10,28 +10,28 @@ Field | Type | Description | Default
 defaultCommand | string |  Optional. Default command to run when no command is specified.<br/><br/>Accepted values: `runTests`, `runCoverage` | 
 input | One of<br/>-&nbsp;string<br/>-&nbsp;array of strings |  Optional. Path(s) to test specifications and documentation source files. May be paths to specific files or to directories to scan for files. | `.`
 output | string |  Optional. Path of the of the file or directory in which to store the output of Doc Detective commands. If a file path is specified, the output is written to that file. If a file of that name already exists, Doc Detective creates appends an integer to the result file name. If a directory path is specified, the output file name is dependent on the command being run. | `.`
-recursive | boolean |  Optional. If `true` searches `input`, `setup`, and `cleanup` paths recursively for test specificaions and source files. | `true`
+recursive | boolean |  Optional. If `true` searches `input`, `setup`, and `cleanup` paths recursively for test specifications and source files. | `true`
 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` | `cwd`
 envVariables | string |  Optional. Path to a `.env` file to load before performing a Doc Detective operation. | 
 runTests | object |  Optional. Options for running tests. When running tests, values set here override general configuration options. | 
 runTests.input | One of<br/>-&nbsp;string<br/>-&nbsp;array of strings |  Optional. Path(s) to test specifications and documentation source files. May be paths to specific files or to directories to scan for files. | 
 runTests.output | string |  Optional. Path of the of the file or directory in which to store the output of Doc Detective commands. If a file path is specified, the output is written to that file. If a file of that name already exists, Doc Detective creates appends an integer to the result file name. If a directory path is specified, the output file name is dependent on the command being run. | `.`
 runTests.setup | One of<br/>-&nbsp;string<br/>-&nbsp;array of strings |  Optional. Path(s) to test specifications to perform before those specified by `input`. Useful for setting up testing environments. | 
 runTests.cleanup | One of<br/>-&nbsp;string<br/>-&nbsp;array of strings |  Optional. Path(s) to test specifications to perform after those specified by `input`. Useful for cleaning up testing environments. | 
-runTests.recursive | boolean |  Optional. If `true` searches `input`, `setup`, and `cleanup` paths recursively for test specificaions and source files. | 
+runTests.recursive | boolean |  Optional. If `true` searches `input`, `setup`, and `cleanup` paths recursively for test specifications and source files. | 
 runTests.detectSteps | boolean |  Optional. Whether or not to detect steps in input files based on markup regex. | `false`
 runTests.mediaDirectory | string |  Optional. DEPRECATED. | `.`
 runTests.downloadDirectory | string |  Optional. Path of the directory in which to store downloaded files. | `.`
 runTests.contexts | array of object([context](/docs/references/schemas/context)) |  Optional. Application/platform sets to run tests in. If no contexts are specified but a context is required by one or more tests, Doc Detective attempts to identify a supported context in the current environment and run tests against it. | ``[{"app":{"name":"firefox","options":{"width":1200,"height":800,"headless":true}},"platforms":["linux","mac","windows"]}]``
-runCoverage | object |  Optional. Options for performing test coverage analysis on documentation source files.  When performing coveration analysis, values set here override general configuration options. | 
+runCoverage | object |  Optional. Options for performing test coverage analysis on documentation source files. When performing coverage analysis, values set here override general configuration options. | 
 runCoverage.input | One of<br/>-&nbsp;string<br/>-&nbsp;array of strings |  Optional. Path(s) to test specifications and documentation source files. May be paths to specific files or to directories to scan for files. | 
 runCoverage.output | string |  Optional. Path of the of the file or directory in which to store the output of Doc Detective commands. If a file path is specified, the output is written to that file. If a file of that name already exists, Doc Detective creates appends an integer to the result file name. If a directory path is specified, the output file name is dependent on the command being run. | `.`
-runCoverage.recursive | boolean |  Optional. If `true` searches `input`, `setup`, and `cleanup` paths recursively for test specificaions and source files. | 
+runCoverage.recursive | boolean |  Optional. If `true` searches `input`, `setup`, and `cleanup` paths recursively for test specifications and source files. | 
 runCoverage.markup | array of strings |  Optional. Markup types to include when performing this operation. If no markup types are specified, the operation includes all markup types as defined in `fileTypes`. | ``["onscreenText","emphasis","image","hyperlink","codeInline","codeBlock","interaction"]``
-suggestTests | object |  Optional. Options for suggesting tests based on documentation source files.  When suggesting tests, values set here override general condiguration options. | 
+suggestTests | object |  Optional. Options for suggesting tests based on documentation source files. When suggesting tests, values set here override general configuration options. | 
 suggestTests.input | One of<br/>-&nbsp;string<br/>-&nbsp;array of strings |  Optional. Path(s) to test specifications and documentation source files. May be paths to specific files or to directories to scan for files. | 
 suggestTests.output | string |  Optional. Path of the of the file or directory in which to store the output of Doc Detective commands. If a file path is specified, the output is written to that file. If a file of that name already exists, Doc Detective creates appends an integer to the result file name. If a directory path is specified, the output file name is dependent on the command being run. | `.`
-suggestTests.recursive | boolean |  Optional. If `true` searches `input`, `setup`, and `cleanup` paths recursively for test specificaions and source files. | 
+suggestTests.recursive | boolean |  Optional. If `true` searches `input`, `setup`, and `cleanup` paths recursively for test specifications and source files. | 
 suggestTests.markup | array of strings |  Optional. Markup types to include when performing this operation. If no markup types are specified, the operation includes all markup types as defined in `fileTypes`. | ``["onscreenText","emphasis","image","hyperlink","codeInline","codeBlock","interaction"]``
 fileTypes | array of objects |  Optional. Information on supported file types and how to parse the markup within them. | []
 fileTypes.name | string |  Optional. Name of the file type. | 
diff --git a/docs/references/schemas/httpRequest.md b/docs/references/schemas/httpRequest.md
@@ -9,7 +9,7 @@ Field | Type | Description | Default
 :-- | :-- | :-- | :--
 id | string |  Optional. ID of the step. | Generated UUID
 description | string |  Optional. Description of the step. | 
-action | string |  Required. Aciton to perform. | 
+action | string |  Required. Action to perform. | 
 url | string |  Required. URL for the HTTP request. | 
 statusCodes | array of integers |  Optional. Accepted status codes. If the specified URL returns a code other than what is specified here, the action fails. | ``[200]``
 method | string |  Optional. Method of the HTTP request<br/><br/>Accepted values: `get`, `put`, `post`, `patch`, `delete` | `get`
diff --git a/docs/references/schemas/saveScreenshot.md b/docs/references/schemas/saveScreenshot.md
@@ -12,7 +12,7 @@ description | string |  Optional. Description of the step. |
 action | string |  Required. The action to perform. | 
 path | string |  Optional. File path of the PNG file, relative to `directory`. If not specified, the file name is the ID of the step. | 
 directory | string |  Optional. Directory of the PNG file. If the directory doesn't exist, creates the directory. | 
-maxVariation | number |  Optional. Allowed variation in percentage of pixels between the new screenshot and the exisitng screenshot at `path`. If the difference between the new screenshot and the existing screenshot is greater than `maxVariation`, the step fails. If a screenshot doesn't exist at `path`, this value is ignored. | `5`
+maxVariation | number | Optional. Allowed variation in percentage of pixels between the new screenshot and the existing screenshot at `path`. If the difference between the new screenshot and the existing screenshot is greater than `maxVariation`, the step fails. If a screenshot doesn't exist at `path`, the system ignores this value. | `5`
 overwrite | string |  Optional. If `true`, overwrites the existing screenshot at `path` if it exists.
 If `byVariation`, overwrites the existing screenshot at `path` if the difference between the new screenshot and the existing screenshot is greater than `maxVariation`.<br/><br/>Accepted values: `true`, `false`, `byVariation` | `false`
 
