Skip to content

Commit e5a0e6f

Browse files
ethanpalmclaude
andcommitted
Update CI checks page
- Improve language clarity and conciseness throughout - Remove unnecessary words and phrases - Use present tense for more direct communication - Fix grammar issues and improve flow - Replace 'in-built' with 'built-in' for standard terminology - Streamline explanations for better readability 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 4268267 commit e5a0e6f

File tree

1 file changed

+14
-20
lines changed

1 file changed

+14
-20
lines changed

settings/ci.mdx

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,17 @@ icon: "circle-check"
88
CI checks are available on [Growth and Enterprise plans](https://mintlify.com/pricing?ref=docs-ci), an add-on for other plans, and for GitHub.
99
</Info>
1010

11-
Use CI checks to lint your docs for errors, and give you warnings before you deploy.
11+
Use CI checks to lint your docs for errors and provide warnings before you deploy.
1212

1313
## Installation
1414

15-
To begin, you will need to have followed the steps on the [GitHub](/settings/github) page.
15+
To begin, follow the steps on the [GitHub](/settings/github) page.
1616

17-
For GitHub Apps, you can choose to only give permissions to a single repository.
18-
We highly recommend you do so as we only need access to the repository where
19-
your docs are hosted.
17+
For GitHub Apps, you can choose to give permissions to only a single repository. We highly recommend you do so as we only need access to the repository where your docs are hosted.
2018

2119
## Configuration
2220

23-
You can configure the CI checks enabled for a deployment on the Mintlify dashboard by navigating to the 'Add-Ons' tab. There you can enable or disable the checks you'd like to run.
21+
Configure the CI checks enabled for a deployment on the Mintlify dashboard by navigating to the 'Add-Ons' tab. There you can enable or disable the checks you'd like to run.
2422

2523
When enabling checks, you can choose to run them at a `Warning` or `Blocking` level.
2624

@@ -41,30 +39,28 @@ CI checks are configured to run on commits to your configured deployment branch,
4139

4240
### Broken Links
4341

44-
Similarly to how the [CLI link checker](/settings/broken-links#broken-links) works on your local machine, we will automatically check your docs for broken links.
45-
To see the results of this check, you can visit GitHub's check results page for a specific commit.
42+
Similar to how the [CLI link checker](/settings/broken-links#broken-links) works on your local machine, we automatically check your docs for broken links. To see the results of this check, visit GitHub's check results page for a specific commit.
4643

4744
### Vale
4845

4946
[Vale](https://vale.sh/) is an open-source rule-based prose linter which supports a range of document types, including Markdown and MDX.
5047

51-
Mintlify supports automatically running Vale in a CI check, and displaying the results as a check status.
48+
Mintlify supports automatically running Vale in a CI check and displaying the results as a check status.
5249

5350
#### Configuration
54-
If you have a `.vale.ini` file in the root the content directory for your deployment, we will automatically use that configuration file.
55-
We will also automatically use any configuration files in your specified `stylesPath`.
51+
If you have a `.vale.ini` file in the root content directory for your deployment, we automatically use that configuration file. We also automatically use any configuration files in your specified `stylesPath`.
5652

57-
<Tip>Don't have a Vale config or not sure where to get started? Don't worry, Mintlify has a default configuration that will automatically be used if one is not provided.</Tip>
53+
<Tip>Don't have a Vale config or not sure where to get started? Don't worry, Mintlify has a default configuration that automatically loads if one is not provided.</Tip>
5854

5955
<Warning>
6056
Please note that for security reasons, we are unable to support any absolute `stylesPath`, or `stylesPath` which include `..` values. Please use relative paths and include the `stylesPath` in your repository.
6157
</Warning>
6258

6359
#### Packages
6460
Vale supports a range of [packages](https://vale.sh/docs/keys/packages), which can be used to check for spelling and style errors.
65-
Any packages you include in your repository under the correct `stylesPath` will be automatically installed and used in your Vale configuration.
61+
Any packages you include in your repository under the correct `stylesPath` are automatically installed and used in your Vale configuration.
6662

67-
For packages not included in your repository, you may specify any packages from the [Vale package registry](https://vale.sh/explorer), and they will automatically be downloaded and used in your Vale configuration.
63+
For packages not included in your repository, you may specify any packages from the [Vale package registry](https://vale.sh/explorer), and they are automatically downloaded and used in your Vale configuration.
6864

6965
<Warning>
7066
Please note that for security reasons, we are unable to support automatically downloading packages that are not from the [Vale package registry](https://vale.sh/explorer).
@@ -73,7 +69,7 @@ Please note that for security reasons, we are unable to support automatically do
7369
#### Vale with MDX
7470
Vale does not natively support MDX, but Vale's author has provided a [custom extension](https://github.com/errata-ai/MDX) to support it.
7571

76-
If you'd prefer not to use this extension, we recommend the following lines in your `.vale.ini` file:
72+
If you prefer not to use this extension, we recommend the following lines in your `.vale.ini` file:
7773
```ini
7874
[formats]
7975
mdx = md
@@ -89,9 +85,7 @@ BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
8985
(?sm)^({.+.*})
9086
```
9187

92-
To use Vale's in-document comments, use MDX-style comments `{/* ... */}`.
93-
If you use the `CommentDelimiters = {/*, */}` [setting](https://vale.sh/docs/keys/commentdelimiters) in your configuration, Vale will automatically interpret these comments while linting.
94-
This means you can easily use Vale's in-built features, like skipping lines or sections.
88+
To use Vale's in-document comments, use MDX-style comments `{/* ... */}`. If you use the `CommentDelimiters = {/*, */}` [setting](https://vale.sh/docs/keys/commentdelimiters) in your configuration, Vale automatically interprets these comments while linting. This means you can easily use Vale's built-in features, like skipping lines or sections.
9589

9690
```mdx
9791
{/* vale off */}
@@ -102,7 +96,7 @@ This text will be ignored by Vale
10296
```
10397

10498

105-
If you choose not to use `CommentDelimiters`, but still choose to use Vale's comments, you must wrap any Vale comments in MDX comments `{/* ... */}`. For example:
99+
If you choose not to use `CommentDelimiters` but still choose to use Vale's comments, you must wrap any Vale comments in MDX comments `{/* ... */}`. For example:
106100

107101
```mdx
108102
{/* <!-- vale off --> */}
@@ -111,4 +105,4 @@ This text will be ignored by Vale
111105

112106
{/* <!-- vale on --> */}
113107
```
114-
Please note that these comment tags are not supported within Mintlify components, but can be used anywhere at the base level of a document.
108+
These comment tags are not supported within Mintlify components but can be used anywhere at the base level of a document.

0 commit comments

Comments
 (0)