mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
017d7c7377
* fix: reduce Vale false positives via vocab and config updates - Make English-word vocab entries case-insensitive so sentence-start capitalization and normal prose usage stop flagging (agents, rest, cursor, setup, endpoints, etc.) - Add vocab entries for filenames and code identifiers that appear in frontmatter and JSX contexts (docs.json, llms.txt, CLAUDE.md, etc.) - Ignore openapi frontmatter lines, filenames, JSX attributes, email addresses, and internal link targets via TokenIgnores - Skip inline code scope and indented code fences - Add Headings exceptions for proper nouns (Claude Code, GitHub Actions, Route 53, GA4, etc.) - Disable linting for the all-code vercel-json-generator snippet Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: resolve all Vale warnings and errors across docs Content fixes: - Reword sentences using 'will', first person, spaced em dashes, 'e.g.', Latin abbreviations, and hyphenated adverbs - Sentence-case headings that started with dotted filenames - Backtick literal API values instead of bolding them - Move periods inside quotation marks - Fix Oxford comma rule misfires by restructuring sentences False-positive suppression: - Vale toggles around example user questions, keyboard shortcut keys (Cmd+I), UI labels, and code samples in JSX contexts that Vale misparses - Exclude vale toggle comments from the brace Token/BlockIgnores so in-document commands actually reach Vale (the greedy brace pattern was also silently swallowing large regions; now lazy) - Vocab entries for code identifiers (internal_id, handleSubmit, etc.) - Per-file rule disables for component docs with dotted JSX names and files where link-target linting ignores in-document toggles Result: vale --minAlertLevel warning is clean repo-wide; only suggestion-level items (Passive, Semicolons, Acronyms) remain. mint broken-links passes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: correct WordList rule instead of degrading prose - Restore sentence-start "Email" in advanced-support; the rule now only flags hyphenated e-mail/E-mail forms - Restore the idiom "above all else"; the above->preceding swap now exempts "above all" Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: restore deliberate prose flagged by blunt rules - Restore spatial 'above the navbar' / 'above a page title' in custom-scripts; the above->preceding swap now exempts 'above the/a/an' - Restore the '= ...' in the react-components named-export example (the ellipsis is inside inline code) with an Ellipses toggle - Restore SLA phrasing 'will use commercially reasonable efforts' with a Will toggle - Restore the quoted developer question in the GEO guide intro with a FirstPerson toggle, matching the file's other example questions Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: remove WordList swaps that flag legitimate English - Drop tablet->device and firewalls->firewall rules; both words are correct in ordinary prose - Narrow touch->tap to UI-instruction phrasing (touch the/a) so 'keep in touch' and 'touch devices' stop flagging Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: reposition vale toggles to wrap whole blocks Toggle comments placed between list items split the lists (restarting ol numbering in deployments) and comments flush against tables risked breaking GFM table parsing. Wrap entire lists/tables with blank-line separation instead. Verified rendering with mint dev: single ol with two items, tables intact, no comments in visible DOM. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * refactor: prune accept.txt to load-bearing entries Empirically removed 166 vocab entries (575 -> 409) whose removal causes no Vale flags across all 908 English pages: dictionary words that never needed listing (agents, setup, endpoints, webhooks, yaml), lowercase entries the speller already accepts, and filename entries made redundant by inline vale toggles. Kept every case-enforcing entry (API, JSON, GitHub, ...) so casing policy is unchanged, plus entries that double as capitalization exceptions for headings (mcp, md, auth, cursor, txt). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Update ai/mintlify-mcp.mdx * Update api/agent/v2/create-agent-job.mdx * chore: alphabetize Headings exceptions and accept.txt Case-insensitive sort, ignoring the (?i) prefix; also drops a duplicate Scala entry. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: re-apply OxfordComma rewrite lost in branch merge Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: resolve Vale suggestions batch 1 (acronyms, semicolons, passive voice) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: resolve remaining Vale suggestions (passive voice batch 2) Rewrite ~90 passive constructions to active voice across deploy, guides, migration-services, and organize docs. Toggle the deliberate passive examples in the style-and-tone guide ('by zombies' test). Add axios/lodash vocab entries for a repositioned code example. vale . is now fully clean: 0 errors, 0 warnings, 0 suggestions. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
101 lines
5.0 KiB
Plaintext
101 lines
5.0 KiB
Plaintext
---
|
|
title: "Ask agent"
|
|
description: "Use the editor's built-in AI agent to write content, edit pages, search across your site, upload files, and configure settings from a chat interface."
|
|
keywords: ["editor", "AI", "assistant", "agent", "chat", "code mode", "file upload"]
|
|
---
|
|
|
|
The editor includes a built-in agent that can edit pages, reorganize navigation, update `docs.json`, search across your entire repository, and manage dashboard settings.
|
|
|
|
The editor agent makes changes directly in your current branch.
|
|
|
|
## Open the agent
|
|
|
|
{/* vale Mintlify.FirstPerson = NO */}
|
|
Click **Ask agent** in the editor toolbar, or press <kbd>Cmd</kbd> + <kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>I</kbd> (Windows).
|
|
|
|
To close the panel, click the **X** button in the panel header or press <kbd>Cmd</kbd> + <kbd>I</kbd> again.
|
|
{/* vale Mintlify.FirstPerson = YES */}
|
|
|
|
## Send a message
|
|
|
|
Type your request in the chat box at the bottom of the panel and press <kbd>Enter</kbd> or click the <Icon icon="arrow-up" /> send button.
|
|
|
|
Type <kbd>@</kbd> to mention a specific page. The agent focuses on that page when processing your request. If you don't mention a page, the agent uses the page you currently have open.
|
|
|
|
Example prompts:
|
|
|
|
- `simplify the introduction page`
|
|
- `fix all grammar errors across my content`
|
|
- `add a new page that explains authentication`
|
|
- `rename every mention of "Acme Pro" to "Acme Team" across all pages`
|
|
- `update docs.json to add a new group called "Guides"`
|
|
|
|
## Attach files
|
|
|
|
Click the paperclip icon in the chat box, or drag and drop files onto the panel. The agent reads attached files as context for your request.
|
|
|
|
Supported file types:
|
|
- **Images**: JPG, PNG, GIF, WebP, SVG
|
|
- **Documents**: PDF
|
|
- **Code and text**: `.js`, `.ts`, `.jsx`, `.tsx`, `.mdx`, `.md`, `.json`, `.yaml`, `.html`, `.css`, Python, Go, Rust, Ruby, Java, Swift, C, C++, SQL, shell scripts, and more
|
|
|
|
Maximum size: 5 MB per file. Maximum: 10 files per message.
|
|
|
|
## Add a selection to the agent
|
|
|
|
In visual mode, select text on a page. A floating toolbar appears over the selection. Click **Add to agent** to send the selected text to the agent as context.
|
|
|
|
## Review what the agent changed
|
|
|
|
As the agent edits your pages, a **Changed files** panel appears in the chat. Expand it to see a list of every file modified in the session. Click any file to open it in diff view and compare the agent's changes against the original.
|
|
|
|
## What the agent can do
|
|
|
|
### Edit pages
|
|
|
|
The agent can write, rewrite, expand, and reorganize content on any page. It reads your existing content to match your style and structure.
|
|
|
|
### Search and navigate your content
|
|
|
|
The agent can search across your entire repository, not just the page you have open. Use it to find information, check for inconsistencies, or verify that content exists before adding it.
|
|
|
|
### Update navigation and docs.json
|
|
|
|
The agent can add, rename, reorder, and delete navigation elements, the same changes you'd make manually in the navigation panel. It can also update `docs.json` configuration directly, including adding new groups, adjusting settings, and configuring redirects.
|
|
|
|
Example: `add a "Quickstart" group under the Getting Started tab and move the quickstart page into it`
|
|
|
|
### Run bash commands
|
|
|
|
The agent can run `grep`, `rg`, and other bash commands against your repository. Use this for bulk operations that span many files.
|
|
|
|
Example: `find every page that mentions the deprecated /v1/auth endpoint`
|
|
|
|
### Configure your site (code mode)
|
|
|
|
For requests that go beyond editing pages (setting up authentication, managing workflows, or changing deployment settings), the agent switches into code mode. It writes and runs a script against your Mintlify dashboard on your behalf.
|
|
|
|
Code mode respects your dashboard permissions. If you don't have access to a setting in the dashboard, the agent can't change it either.
|
|
|
|
Example prompts that use code mode:
|
|
|
|
- `enable JWT authentication for my site`
|
|
- `create a workflow that updates my site when I merge a PR`
|
|
- `add a custom domain`
|
|
|
|
### Continue an automation run
|
|
|
|
When you open the editor from a completed automation run by clicking **View changes**, the agent panel opens automatically with context on what the automation did. A **Changed pages** card at the top of the chat lists every page the automation modified—click any page to open a diff view.
|
|
|
|
The agent has context on the automation's prompt, a summary of the changes it made, and which pages it modified. You can ask it to refine or extend the automation's work without re-explaining the background.
|
|
|
|
For example: `The new section on rate limits is too long. Trim it to three sentences.`
|
|
|
|
## Session history
|
|
|
|
Click the clock icon in the panel header to see your previous chat sessions. Click any session to reopen it and see what the agent changed.
|
|
|
|
## AI instructions
|
|
|
|
To give the agent persistent guidance like voice rules, terminology, or formatting conventions, configure AI instructions in [Editor settings](/editor/settings#ai-instructions). The agent follows these instructions on every request without you needing to repeat them.
|