Skip to content
Open
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

StylesPath = .vale/styles
MinAlertLevel = suggestion
IgnoredScopes = code, tt, img, url, a
IgnoredScopes = code, tt, img, url, a, kbd
SkippedScopes = script, style, pre, figure, code

Vocab = Mintlify
Expand Down
37 changes: 37 additions & 0 deletions .vale/styles/Mintlify/Acronyms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,36 +8,54 @@ second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
# ... with the exception of these:
exceptions:
- AAA
- ACS
- AEO
- ANSI
- API
- ASCII
- ASP
- AWS
- BETA
- CAA
- CDN
- CIDR
- CLI
- CNAME
- CPU
- CRM
- CSP
- CSS
- CSV
- CTA
- CTR
- DEBUG
- DNS
- DOCX
- DOM
- DPI
- FAQ
- GCC
- GDB
- GEO
- GET
- GIF
- GPU
- GTK
- GUI
- HEAD
- HTML
- HTTP
- HTTPS
- IAM
- ICO
- IDE
- ISO
- JAR
- JIT
- JPEG
- JPG
- JSON
- JSONC
- JSX
- JWT
- LESS
Expand All @@ -46,27 +64,39 @@ exceptions:
- llms
- LLMs
- LTS
- MCP
- MDX
- NAT
- NET
- NEW
- NOT
- NOTE
- NVDA
- OAI
- OIDC
- OSS
- PATCH
- PATH
- PDF
- PHP
- PNG
- POST
- PST
- PUT
- RAG
- RAM
- RBAC
- REPL
- REST
- ROI
- RPC
- RSA
- SAML
- SCIM
- SCM
- SCSS
- SDK
- SEO
- SKILL
- SLA
- SQL
Expand All @@ -76,16 +106,23 @@ exceptions:
- SVG
- TBD
- TCP
- TLS
- TODO
- TOML
- TSV
- TTF
- TXT
- URI
- URL
- USB
- UTC
- UTF
- UUID
- VPN
- WAVE
- WOFF
- XML
- XSS
- YAML
- YYYY
- ZIP
2 changes: 1 addition & 1 deletion api-playground/sdk-reference-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Generate SDK reference pages from doc-tool output"
sidebarTitle: "SDK reference setup"
description: "Publish SDK reference documentation in Mintlify from TypeDoc, DocFX, Javadoc, Sphinx, or phpDocumentor artifacts using the sdk navigation property."

Check warning on line 4 in api-playground/sdk-reference-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/sdk-reference-setup.mdx#L4

Use 'SDK' instead of 'sdk'.
keywords: ["sdk", "typedoc", "docfx", "javadoc", "sphinx", "phpdocumentor", "reference"]
---

Expand Down Expand Up @@ -57,15 +57,15 @@
"tab": "SDK Reference",
"sdk": {
"format": "typedoc",
"source": "sdk-artifacts/typedoc.json",

Check warning on line 60 in api-playground/sdk-reference-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/sdk-reference-setup.mdx#L60

Use 'SDK' instead of 'sdk'.
"directory": "sdk/typescript"

Check warning on line 61 in api-playground/sdk-reference-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/sdk-reference-setup.mdx#L61

Use 'TypeScript' instead of 'typescript'.
}
}
]
}
```

Add `sdk` to a [group](/organize/navigation#groups) to generate pages inside one section of a tab instead of an entire tab. Groups and pages inherit the `sdk` settings of the tab or group above them. If a nested group sets its own `sdk`, Mintlify uses those settings instead of the inherited ones.
Add `sdk` to a [group](/organize/navigation#groups) to generate pages inside one section of a tab instead of an entire tab. Groups and pages inherit the `sdk` settings of the parent tab or group. If a nested group sets its own `sdk`, Mintlify uses those settings instead of the inherited ones.

```json
{
Expand Down
10 changes: 5 additions & 5 deletions assistant/use.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -129,11 +129,11 @@ Limits:

**For readers:** Ask your IT team to allow outbound HTTPS requests to the following hostnames from your network. If you can, try the assistant from a personal network to confirm the issue is network-specific.

- `leaves.mintlify.com`assistant API
- `*.mintlify.dev`assistant streaming and supporting services
- `*.mintlify.com`dashboard, API, and analytics
- `hcaptcha.com` and `*.hcaptcha.com`CAPTCHA verification for the assistant
- `leaves.mintlify.com`assistant API
- `*.mintlify.dev`assistant streaming and supporting services
- `*.mintlify.com`dashboard, API, and analytics
- `hcaptcha.com` and `*.hcaptcha.com`CAPTCHA verification for the assistant

**For site owners:** If a reader reports that the assistant does not load on their corporate network or VPN, treat it as an outbound network block. It is not a problem with your documentation. Point them to the hostnames above and suggest that they share the list with their IT team. This allowlist applies to the visitor's device or network. You cannot configure it from your site. If you self-host behind a reverse proxy that overwrites the default CSP, see [CSP configuration](/deploy/csp-configuration) for the domains to allow.
**For site owners:** If a reader reports that the assistant does not load on their corporate network or VPN, treat it as an outbound network block. It is not a problem with your documentation. Point them to the preceding hostnames and suggest that they share the list with their IT team. This allowlist applies to the visitor's device or network. You cannot configure it from your site. If you self-host behind a reverse proxy that overwrites the default CSP, see [CSP configuration](/deploy/csp-configuration) for the domains to allow.

</Accordion>
2 changes: 1 addition & 1 deletion assistant/widget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

export const WidgetCodeBlock = ({ children, ...props }) => (
<CodeBlock {...props}>{children}</CodeBlock>
);

Check warning on line 13 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L13

Use semicolons judiciously.

The [assistant](/assistant) answers questions on your Mintlify site. To embed the same capability on another site or web app, use the widget. The widget gives your users access to AI chat trained on your content, wherever they use your product. Embed it in your dashboard, marketing site, support portal, or elsewhere.

Expand Down Expand Up @@ -279,7 +279,7 @@

Conversation snapshots remain private to the widget. Each method resolves to `void`.

## Content Security Policy

Check warning on line 282 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L282

'Content Security Policy' should use sentence-style capitalization.

If your site uses a Content Security Policy, allow the origins required by your enabled widget features:

Expand All @@ -290,10 +290,10 @@
| `connect-src` | `https://api.mintlify.com` | Configuration, messages, and feedback |
| `connect-src` | `https://ph.mintlify.com` | Internal widget analytics |
| `font-src` | `https://widget.mintlify.com` | Optional bundled Inter font |
| `script-src`, `connect-src`, and `frame-src` | `https://challenges.cloudflare.com` | Turnstile bot protection |

Check warning on line 293 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L293

Use 'Cloudflare' instead of 'cloudflare'.
| `script-src` | `https://js.hcaptcha.com` | hCaptcha bot protection |

Check warning on line 294 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L294

Use 'hCaptcha' instead of 'hcaptcha'.
| `connect-src` and `frame-src` | `https://*.hcaptcha.com` | hCaptcha bot protection |

Check warning on line 295 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L295

Use 'hCaptcha' instead of 'hcaptcha'.

A strict `script-src` policy must still authorize both the loader and initialization script. A strict `style-src` policy must authorize the nonce you pass to `init()`, which the widget copies to its injected stylesheet. Passing `nonce` to `init()` propagates it only to resources the widget creates after initialization.
A strict `script-src` policy must still authorize both the loader and initialization script. A strict `style-src` policy must authorize the nonce you pass to `init()`, which the widget copies to its injected style sheet. Passing `nonce` to `init()` propagates it only to resources the widget creates after initialization.

</AssistantWidgetPlayground>
Loading