Skip to content
Open
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions deploy/ci.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
To begin, follow the steps on the [GitHub](/deploy/github) page.

<Tip>
Only access to the repository where your documentation content exists is required, so it is highly recommended to only grant access to that repository.

Check warning on line 18 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L18

In general, use active voice instead of passive voice ('is required').
</Tip>

## Configuration
Expand All @@ -24,8 +24,8 @@

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

- A `Warning` level check will never provide a failure status, even if there is an error or suggestions.

Check warning on line 27 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L27

Avoid using 'will'.
- A `Blocking` level check will provide a failure status if there is an error or suggestions.

Check warning on line 28 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L28

Avoid using 'will'.

## Available CI checks

Expand All @@ -36,6 +36,13 @@

To see the results of this check, visit GitHub's check results page for a specific commit.

#### Configuration options

The broken links check supports additional options:

- **Check anchors**: Enable to validate anchor links like `/path/to/page#anchor`. When enabled, the check verifies that the target anchor exists on the destination page.
- **Check snippets**: Enable to validate [snippet](/components/reusable-snippets) references in your documentation. When enabled, the check verifies that all referenced snippet files exist.

### Vale

[Vale](https://vale.sh/) is an open source rule-based prose linter which supports a range of document types, including Markdown and MDX. Use Vale to check for consistency of style and tone in your documentation.
Expand Down Expand Up @@ -355,8 +362,8 @@

To add your own vocabulary for the default configuration, create a `styles/config/vocabularies/Mintlify` directory with `accept.txt` and `reject.txt` files.

- `accept.txt`: Words that should be ignored by the Vale linter. For example, product names or uncommon terms.

Check warning on line 365 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L365

In general, use active voice instead of passive voice ('be ignored').
- `reject.txt`: Words that should be flagged as errors. For example, jargon or words that are not appropriate for the tone of your documentation.

Check warning on line 366 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L366

In general, use active voice instead of passive voice ('be flagged').

```text Example Vale file structure
/your-project
Expand Down Expand Up @@ -394,7 +401,7 @@
</Note>

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

Check warning on line 404 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L404

In general, use active voice instead of passive voice ('be used').

For packages not included in your repository, you may specify any packages from the [Vale package registry](https://vale.sh/explorer), and they're automatically downloaded and used in your Vale configuration.

Expand All @@ -413,9 +420,9 @@
```mdx
{/* vale off */}

This text is ignored by Vale

Check warning on line 423 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L423

In general, use active voice instead of passive voice ('is ignored').

{/* vale on */}
```

Vale automatically recognizes and respects these comments in MDX files without additional configuration. Use comments to skip lines or sections that should be ignored by the linter.

Check warning on line 428 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L428

In general, use active voice instead of passive voice ('be ignored').
Loading