-
Notifications
You must be signed in to change notification settings - Fork 242
Draft from Aug 24 #7059
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Draft from Aug 24 #7059
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,7 @@ | |
| title: "What is the agent?" | ||
| description: "Learn how the Mintlify agent researches, plans, and writes documentation, then opens pull requests with proposed changes for your team to review." | ||
| keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"] | ||
| icon: "alarm-clock-minus" | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Irrelevant page icon chosenLow Severity The agent overview page now sets Reviewed by Cursor Bugbot for commit ce1ad4d. Configure here. |
||
| --- | ||
|
|
||
| import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx"; | ||
|
|
@@ -78,15 +79,18 @@ To let an external agent edit your content directly through MCP tool calls, conn | |
|
|
||
| ## Next steps | ||
|
|
||
| <Card title="Connect Slack" horizontal icon="slack" href="/agent/slack"> | ||
| Add the agent to your Slack workspace. | ||
| <Card title="Connect Slack" icon="slack" horizontal href="/agent/slack"> | ||
| Add the agent to your Slack workspace. | ||
| </Card> | ||
| <Card title="Customize behavior" horizontal icon="wrench" href="/agent/customize"> | ||
| Configure the agent with an `AGENTS.md` file. | ||
| </Card> | ||
| <Card title="Write effective prompts" horizontal icon="pen" href="/agent/effective-prompts"> | ||
| Get better results with focused prompts. | ||
|
|
||
| <Card title="Customize behavior" icon="wrench" horizontal href="/agent/customize"> | ||
| Configure the agent with an `AGENTS.md` file. | ||
| </Card> | ||
| <Card title="Automate with automations" horizontal icon="refresh-cw" href="/automations/index"> | ||
| Automate recurring tasks and documentation maintenance with automations. | ||
|
|
||
| <Card title="Write effective prompts" icon="pen" horizontal href="/agent/effective-prompts"> | ||
| Get better results with focused prompts. | ||
| </Card> | ||
|
|
||
| <Card title="Automate with automations" icon="refresh-cw" horizontal href="/automations/index"> | ||
| Automate recurring tasks and documentation maintenance with automations. | ||
| </Card> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| --- | ||
| title: "Mintlify agent use cases and examples" | ||
| sidebarTitle: "Use cases" | ||
| description: "Explore real-world examples of using the Mintlify agent to automate documentation updates, capture knowledge, and maintain accurate docs." | ||
| keywords: ["agent automations", "documentation automations", "automation examples"] | ||
| sidebarTitle: "Use cases" | ||
| --- | ||
|
|
||
| The agent assists with many different documentation tasks. These examples show some of the ways you can integrate the agent into your documentation process. Try an approach that fits how your team currently works and adapt it to your specific needs. | ||
|
|
@@ -74,3 +74,14 @@ | |
| Use the agent endpoints to [create jobs](/api/agent/v2/create-agent-job), [get job status](/api/agent/v2/get-agent-job), and [send messages](/api/agent/v2/send-message). | ||
|
|
||
| When creating jobs via the API, you can control whether pull requests open in draft mode using the `asDraft` parameter (defaults to `false`). Set `asDraft: true` to create draft pull requests, or keep the default to create non-draft pull requests ready for immediate review and merging in automated workflows. | ||
|
|
||
| ## New H2 spacing | ||
|
|
||
| Content below | ||
|
|
||
| --- | ||
|
|
||
| - Hello there | ||
| - What is this? | ||
|
|
||
| --- | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Placeholder content on use-casesMedium Severity A draft section titled Reviewed by Cursor Bugbot for commit ce1ad4d. Configure here. |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -128,7 +128,7 @@ Every admin MCP session binds to a single Git branch. The flow is: | |
|
|
||
| <Tip> | ||
| If your connection has access to multiple deployments, each checked-out deployment keeps its own session and branch in memory at the same time. | ||
|
|
||
| Calling `checkout` again with a different `subdomain` or branch switches which session is active. It doesn't discard the others. To abandon an in-progress draft instead of switching away from it, call `discard_session`. | ||
| </Tip> | ||
|
|
||
|
|
@@ -208,3 +208,9 @@ Disconnect the admin MCP when you no longer want an AI tool to edit your project | |
| - Codex: delete the `[mcp_servers.mintlify]` block from `~/.codex/config.toml`. | ||
|
|
||
| Revoking the OAuth grant does not affect pull requests the MCP has already opened. Close or revert those PRs in your Git provider if you want to undo pending changes. | ||
|
|
||
| <Info> | ||
| </Info> | ||
|
|
||
| <Card icon="sparkles"> | ||
| </Card> | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Empty components left in docsLow Severity Empty Reviewed by Cursor Bugbot for commit ce1ad4d. Configure here. |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,12 @@ | |
| keywords: ["docs.json", "configuration", "setup", "mint.json"] | ||
| --- | ||
|
|
||
| > Landrum is great! | ||
|
Check warning on line 7 in organize/settings.mdx
|
||
|
|
||
| <Info> | ||
| Landrum | ||
| </Info> | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Personal notes in settings docsMedium Severity A personal blockquote and an Reviewed by Cursor Bugbot for commit ce1ad4d. Configure here. |
||
|
|
||
| The `docs.json` file is the central configuration file for your Mintlify documentation site. It controls your site's global settings, including visual branding, navigation structure, integrations, API settings, and more. Think of it as the blueprint for your site. | ||
|
|
||
| ## File location | ||
|
|
@@ -15,7 +21,7 @@ | |
| You must define four fields to build a working site. | ||
|
|
||
| | Field | Description | | ||
| |---|---| | ||
| | --- | --- | | ||
| | `name` | Your project or organization name | | ||
| | `theme` | The layout [theme](/customize/themes) for your site | | ||
| | `colors.primary` | Primary brand color as a hex code | | ||
|
|
@@ -52,18 +58,23 @@ | |
| <Card title="Appearance and branding" icon="palette" href="/organize/settings-appearance"> | ||
| Customize the visual appearance of your site including theme, colors, logo, favicon, fonts, and background. | ||
| </Card> | ||
|
|
||
| <Card title="Site structure" icon="layout-panel-left" href="/organize/settings-structure"> | ||
| Design the information architecture and user experience (UX) of your site, including the navbar, footer, banner, navigation, and redirects. | ||
| </Card> | ||
|
|
||
| <Card title="API settings" icon="square-terminal" href="/organize/settings-api"> | ||
| Control the display and behavior of API documentation including OpenAPI and AsyncAPI specs, API playground, and code examples. | ||
| </Card> | ||
|
|
||
| <Card title="Integrations" icon="plug" href="/organize/settings-integrations"> | ||
| Connect your site to third-party services for analytics, chat, and more. | ||
| </Card> | ||
|
|
||
| <Card title="SEO & search" icon="search" href="/organize/settings-seo"> | ||
| Control how search engines index your site including meta tags, search, and page timestamps. | ||
| </Card> | ||
|
|
||
| <Card title="Schema reference" icon="code" href="/organize/settings-reference"> | ||
| Complete reference for all `docs.json` properties. | ||
| </Card> | ||
|
|
@@ -164,4 +175,4 @@ | |
| <Step title="Delete your mint.json file"> | ||
| After verifying your `docs.json` is configured correctly, you can safely delete your old `mint.json` file. | ||
| </Step> | ||
| </Steps> | ||
| </Steps> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| --- | ||
| title: "Untitled Page" | ||
| --- | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Empty untitled page addedLow Severity A new root-level Reviewed by Cursor Bugbot for commit ce1ad4d. Configure here. |
||


There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Corrupted accepted filename text
Medium Severity
The note about the alternate filename was corrupted: stray
asdwas inserted before`Agents.md`, so the sentence no longer correctly documents thatAgents.mdis accepted.Reviewed by Cursor Bugbot for commit ce1ad4d. Configure here.