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
- 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]>
Copy file name to clipboardExpand all lines: settings/ci.mdx
+14-20Lines changed: 14 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,19 +8,17 @@ icon: "circle-check"
8
8
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.
9
9
</Info>
10
10
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.
12
12
13
13
## Installation
14
14
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.
16
16
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.
20
18
21
19
## Configuration
22
20
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.
24
22
25
23
When enabling checks, you can choose to run them at a `Warning` or `Blocking` level.
26
24
@@ -41,30 +39,28 @@ CI checks are configured to run on commits to your configured deployment branch,
41
39
42
40
### Broken Links
43
41
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.
46
43
47
44
### Vale
48
45
49
46
[Vale](https://vale.sh/) is an open-source rule-based prose linter which supports a range of document types, including Markdown and MDX.
50
47
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.
52
49
53
50
#### 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`.
56
52
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>
58
54
59
55
<Warning>
60
56
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.
61
57
</Warning>
62
58
63
59
#### Packages
64
60
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.
66
62
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.
68
64
69
65
<Warning>
70
66
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
73
69
#### Vale with MDX
74
70
Vale does not natively support MDX, but Vale's author has provided a [custom extension](https://github.com/errata-ai/MDX) to support it.
75
71
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:
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.
95
89
96
90
```mdx
97
91
{/* vale off */}
@@ -102,7 +96,7 @@ This text will be ignored by Vale
102
96
```
103
97
104
98
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:
106
100
107
101
```mdx
108
102
{/* <!-- vale off --> */}
@@ -111,4 +105,4 @@ This text will be ignored by Vale
111
105
112
106
{/* <!-- vale on --> */}
113
107
```
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