diff --git a/agent/customize.mdx b/agent/customize.mdx index 7edb950219..cfe77f5cfc 100644 --- a/agent/customize.mdx +++ b/agent/customize.mdx @@ -4,7 +4,7 @@ description: "Customize agent behavior with an `AGENTS.md` configuration file to keywords: ["AGENTS.md", "agent configuration", "custom instructions", "agent customization"] --- -Create a `.mintlify/AGENTS.md` file at the root of your documentation project to customize the agent's behavior (`Agents.md` is also an accepted filename). +Create a `.mintlify/AGENTS.md` file at the root of your documentation project to customize the agent's behavior (asd`Agents.md` is also an accepted filename). Place your `AGENTS.md` file inside the `.mintlify/` directory, not at the root of your project. If you store the file at the root of your project, visitors can access your custom instructions at the `/agents.md` path. Mintlify does not serve the `.mintlify/` directory publicly, so visitors cannot access your `AGENTS.md` file there. @@ -55,4 +55,4 @@ Consider adding instructions for: - Add prerequisite sections to guides when users need API keys, environment setup, or dependencies. - Include "Next steps" sections linking to related documentation. - Add troubleshooting sections for common issues we see in support tickets. -``` +``` \ No newline at end of file diff --git a/agent/index.mdx b/agent/index.mdx index 139e57bbcf..978035b6cf 100644 --- a/agent/index.mdx +++ b/agent/index.mdx @@ -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" --- 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 - -Add the agent to your Slack workspace. + + Add the agent to your Slack workspace. - -Configure the agent with an `AGENTS.md` file. - - -Get better results with focused prompts. + + + Configure the agent with an `AGENTS.md` file. - -Automate recurring tasks and documentation maintenance with automations. + + + Get better results with focused prompts. + + + Automate recurring tasks and documentation maintenance with automations. + \ No newline at end of file diff --git a/agent/use-cases.mdx b/agent/use-cases.mdx index 9e5c41292a..5953a1d3c6 100644 --- a/agent/use-cases.mdx +++ b/agent/use-cases.mdx @@ -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 @@ Integrate the agent into your existing automation tools to automatically update 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? + +--- \ No newline at end of file diff --git a/ai/mintlify-mcp.mdx b/ai/mintlify-mcp.mdx index fb2ed56c70..794b2c50cd 100644 --- a/ai/mintlify-mcp.mdx +++ b/ai/mintlify-mcp.mdx @@ -128,7 +128,7 @@ Every admin MCP session binds to a single Git branch. The flow is: 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`. @@ -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. + + + + + + \ No newline at end of file diff --git a/assistant/skills.mdx b/assistant/skills.mdx index 5a7e29b613..a9c6a35cda 100644 --- a/assistant/skills.mdx +++ b/assistant/skills.mdx @@ -69,4 +69,4 @@ Skills work alongside [custom assistant instructions](/assistant/customize) in ` ## Disable skills -Skills are on by default when at least one `skill.md` file is present. To remove all skills, delete the `.mintlify/assistant/skills/` directory and redeploy your site. To turn off the skills feature for your deployment, contact [support](mailto:support@mintlify.com). +Skills are on by default when at least one `skill.md` file is present. To remove all skills, delete the `.mintlify/assistant/skills/` directory and redeploy your site. To turn off the skills feature for your deployment, contact [support](mailto:support@mintlify.com). \ No newline at end of file diff --git a/images/CleanShot-2026-08-23-at-15.45.21@2x.png b/images/CleanShot-2026-08-23-at-15.45.21@2x.png new file mode 100644 index 0000000000..a888f304de Binary files /dev/null and b/images/CleanShot-2026-08-23-at-15.45.21@2x.png differ diff --git a/organize/settings.mdx b/organize/settings.mdx index 55274b3644..970e82d374 100644 --- a/organize/settings.mdx +++ b/organize/settings.mdx @@ -4,6 +4,12 @@ description: "Configure your Mintlify documentation site with docs.json, the req keywords: ["docs.json", "configuration", "setup", "mint.json"] --- +> Landrum is great! + + + Landrum + + 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 @@ Store your `docs.json` file at the root of your documentation repository. If you 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 @@ For the best editing experience, include the `$schema` reference at the top of y Customize the visual appearance of your site including theme, colors, logo, favicon, fonts, and background. + Design the information architecture and user experience (UX) of your site, including the navbar, footer, banner, navigation, and redirects. + Control the display and behavior of API documentation including OpenAPI and AsyncAPI specs, API playground, and code examples. + Connect your site to third-party services for analytics, chat, and more. + Control how search engines index your site including meta tags, search, and page timestamps. + Complete reference for all `docs.json` properties. @@ -164,4 +175,4 @@ If your project uses the deprecated `mint.json` file, use the [CLI](/cli) to upg After verifying your `docs.json` is configured correctly, you can safely delete your old `mint.json` file. - + \ No newline at end of file diff --git a/untitled-page.mdx b/untitled-page.mdx new file mode 100644 index 0000000000..58a5d5afa0 --- /dev/null +++ b/untitled-page.mdx @@ -0,0 +1,3 @@ +--- +title: "Untitled Page" +--- \ No newline at end of file