Skip to content

docs: Add concurrentRunners configuration property documentation #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add concurrentRunners configuration property documentation #73

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/references/schemas/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ runOn | array of object([context](/docs/references/schemas/context)) | Optional.
fileTypes | array of one of: string, object([File type (custom)](/docs/references/schemas/File%20type%20(custom))), object([File type (executable)](/docs/references/schemas/File%20type%20(executable))) | Optional. Configuration for file types and their markup detection. | ``["markdown","asciidoc","html"]``
integrations | object([Integrations options](/docs/references/schemas/Integrations%20options)) | Optional. Options for connecting to external services. |
telemetry | object([Telemetry options](/docs/references/schemas/Telemetry%20options)) | Optional. Options around sending telemetry for Doc Detective usage. | ``{"send":true}``
concurrentRunners | one of:<br/>- integer<br/>- boolean | Optional. Number of concurrent test runners for parallel execution. Set to an integer ≥ 1 to specify exact number of runners, or `true` to use CPU core count (capped at 4). | `1`
environment | object([Environment details](/docs/references/schemas/Environment%20details)) | ReadOnly. Environment information for the system running Doc Detective. |

## Examples
Expand Down Expand Up @@ -116,3 +117,21 @@ environment | object([Environment details](/docs/references/schemas/Environment%
}
}
```

```json
{
"concurrentRunners": 1
}
```

```json
{
"concurrentRunners": true
}
```

```json
{
"concurrentRunners": 4
}
```
Loading