Skip to content
Closed
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
6 changes: 3 additions & 3 deletions agent/workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@
- `git` and the GitHub CLI (`gh`)
- The Mintlify CLI (`mint`)
- Node.js and Bun
- **Web search** to find up-to-date information outside your documentation

Check warning on line 164 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L164

Did you really mean 'informat'?
- **Web fetch** to retrieve and read the contents of a web page

The agent cannot install additional packages or tools at runtime. Package registries are not reachable from the sandbox.
Expand Down Expand Up @@ -235,7 +235,7 @@

### Track translation lag

**Trigger:** Cron schedule `0 9 * * 3` (Wednesdays at 9:00 AM UTC)
**Trigger:** cron schedule `0 9 * * 3` (Wednesdays at 9:00 AM UTC)

Update the example language subdirectories (`es/`, `fr/`, `zh/`) to your actual language subdirectories.

Expand All @@ -254,7 +254,7 @@

### SEO and metadata audit

**Trigger:** Cron schedule `0 9 * * 1` (Mondays at 9:00 AM UTC)
**Trigger:** cron schedule `0 9 * * 1` (Mondays at 9:00 AM UTC)

```text
Audit all MDX files in the docs for SEO and metadata quality. Check for:
Expand Down Expand Up @@ -298,7 +298,7 @@

### Changelog with notifications

**Trigger:** Cron schedule `0 9 * * 1` (Mondays at 9:00 AM UTC)
**Trigger:** cron schedule `0 9 * * 1` (Mondays at 9:00 AM UTC)
**Context repos:** `your-org/your-product`
**Slack notifications:** `documentation` channel, `tech-writer` user

Expand Down
2 changes: 1 addition & 1 deletion cli/commands.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Commands"
description: "Complete reference for every Mintlify CLI command and flag, including mint dev, mint build, mint validate, mint analytics, and more."

Check warning on line 3 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L3

Use 'Dev' instead of 'dev'.
keywords: ["CLI", "mint", "commands", "flags", "reference"]
---

Expand Down Expand Up @@ -141,7 +141,7 @@
| --- | --- |
| `--page` | Filter conversations that reference a specific page in sources. |

#### `mint analytics conversation view <conversation-id>`

Check warning on line 144 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L144

'````' should use sentence-style capitalization.

View a single conversation by ID. Use `mint analytics conversation list` to get IDs.

Expand All @@ -157,7 +157,7 @@
mint analytics conversation buckets list
```

#### `mint analytics conversation buckets view <bucket-id>`

Check warning on line 160 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L160

'````' should use sentence-style capitalization.

View conversations in a category bucket. Use `mint analytics conversation buckets list` to get IDs.

Expand All @@ -175,7 +175,7 @@
mint config <subcommand> <key> [value]
```

| Subcommand | Description |

Check warning on line 178 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L178

Use 'subcommands?' instead of 'Subcommand'.
| --- | --- |
| `set <key> <value>` | Set a configuration value. |
| `get <key>` | Display a configuration value. |
Expand Down Expand Up @@ -242,7 +242,7 @@
| `--local-schema` | Allow validation of locally hosted OpenAPI files served over HTTP. Only supports HTTPS in production. |

<Note>
The standalone `mint openapi-check` command is deprecated. Use `mint validate` instead.
Mintlify deprecated the standalone `mint openapi-check` command. Use `mint validate` instead.
</Note>

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

## Telemetry

The CLI collects anonymous usage telemetry to help improve Mintlify. Telemetry data includes the command name, CLI version, operating system, and architecture. Mintlify does **not** collect personally identifiable information, project content, or file paths.

Check warning on line 367 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L367

Did you really mean 'informat'?

By default, the CLI collects telemetry data. You can opt out at any time using the `--telemetry` flag:

Expand Down
2 changes: 1 addition & 1 deletion guides/assistant-embed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
keywords: ["assistant embed", "in-app chat", "widget", "chatbot"]
---

## What you will build
## What you build

A reusable widget that embeds the [assistant](/assistant/index) directly in your application. The widget provides:

Expand Down Expand Up @@ -73,7 +73,7 @@
export const ASSISTANT_CONFIG = {
domain: 'your-domain',
docsURL: 'https://yourdocs.mintlify.app',
};

Check warning on line 76 in guides/assistant-embed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant-embed.mdx#L76

Use semicolons judiciously.
```

Replace:
Expand Down Expand Up @@ -117,12 +117,12 @@
.map(source => ({
url: source.url || source.path,
title: source.metadata?.title || source.path,
})) || [];

Check warning on line 120 in guides/assistant-embed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant-embed.mdx#L120

Use semicolons judiciously.
};

Check warning on line 121 in guides/assistant-embed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant-embed.mdx#L121

Use semicolons judiciously.

// In your message rendering:
{messages.map((message) => {
const sources = message.role === 'assistant' ? extractSources(message.parts) : [];

Check warning on line 125 in guides/assistant-embed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant-embed.mdx#L125

Use semicolons judiciously.
return (
<div key={message.id}>
{/* message content */}
Expand Down Expand Up @@ -173,7 +173,7 @@
}
}, []);

const { messages, input, handleInputChange, handleSubmit, isLoading } = useChat({

Check warning on line 176 in guides/assistant-embed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant-embed.mdx#L176

Did you really mean 'handleSubmit'?
api: `https://api.mintlify.com/discovery/v1/assistant/${domain}/message`,
headers: {
'Authorization': `Bearer ${import.meta.env.VITE_MINTLIFY_TOKEN}`,
Expand Down
2 changes: 1 addition & 1 deletion guides/branches.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Branches are a feature of version control that point to specific commits in your

Branches let you create separate instances of your documentation to make changes, get reviews, and try new approaches before publishing. Your team can work on branches to update different parts of your documentation simultaneously without affecting what users see on your live site.

The following diagram shows an example of a branch workflow where a feature branch is created, changes are made, and then the feature branch is merged into the main branch.
The following diagram shows an example of a branch workflow where someone creates a feature branch, makes changes, and then merges the feature branch into the main branch.

```mermaid
gitGraph
Expand Down
Loading