From dd083cd91246d8184e7b5bb9b82df0af8bcb4049 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 17:30:00 +0000 Subject: [PATCH 1/4] Documentation edits made through Mintlify web editor --- ai/agent.mdx | 44 ++++++++++++++++++++++++++++++++++---------- 1 file changed, 34 insertions(+), 10 deletions(-) diff --git a/ai/agent.mdx b/ai/agent.mdx index 54558ef27..41d397e64 100644 --- a/ai/agent.mdx +++ b/ai/agent.mdx @@ -30,8 +30,8 @@ To get started, add the agent to your Slack workspace and mention it with `@mint 3. Follow the Slack prompts to add the `mintlify` app to your workspace. 4. Follow the Slack prompts to link your Mintlify account to your Slack workspace. 5. Test that the agent is working and responds when you: - - Send a direct message to it. - - Mention it with `@mintlify` in a channel. + - Send a direct message to it. + - Mention it with `@mintlify` in a channel. ## Connect repositories as context @@ -47,34 +47,58 @@ Think of the agent as a helpful assistant that needs your guidance to complete t Make your prompts specific and outcome-focused. Generic prompts like `@mintlify Improve the onboarding page` apply general best practices, but may not improve content in the specific way that you were picturing. -Try prompts based on outcomes you want your users to achieve or problems that they encounter. For example: `@mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI` or `@mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key`. +Try prompts based on outcomes you want your users to achieve or problems that they encounter. For example: -Use broad prompts for general content maintenance like fixing typos, updating redirects, or renaming a feature throughout your docs. For example: `@mintlify Find and fix all typos in the docs` or `@mintlify change all unordered lists to use * instead of -`. +- `@mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI` +- `@mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key` + +Use broad prompts for general content maintenance like fixing typos, updating redirects, or renaming a feature throughout your docs. For example: + +- `@mintlify Find and fix all typos in the docs` +- `@mintlify change all unordered lists to use * instead of -` ## Agent workflows The agent assists with many different documentation tasks. These workflows 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. ### Iterate on a prompt in a Slack thread + Prompt the agent, then continue to mention it with `@mintlify` in the same thread to refine and iterate on the pull request that it creates. For example: `@mintlify Our quickstart page needs a new section on inviting collaborators`. Then `@mintlify The new section should be called "Inviting collaborators"`. Followed by any other iterations. ### Start with the agent, finish manually + Prompt the agent to begin a project, then check out the branch it creates and finish the task in your local environment or the web editor. The agent can help you get started, then you can take over to complete the task. For example: `@mintlify Update the quickstart page to include information about inviting collaborators` and then checkout the branch to make any additional changes using your preferred method. ### Update docs when merging feature changes -When you merge a feature pull request, share the PR link with the agent to update relevant docs. For example: `@mintlify This PR adds a new authentication method. Update the docs to include the new auth flow: [PR link]`. + +When you merge a feature pull request, share the PR link with the agent to update relevant docs. + +For example: `@mintlify This PR adds a new authentication method. Update the docs to include the new auth flow: [PR link]`. ### Generate release notes from commit history -Prompt the agent with a specific pull request or a time period to generate release notes or changelog updates based on the commit history. For example: `@mintlify Generate release notes for this PR: [PR link]` or `@mintlify Generate release notes for the last month`. + +Prompt the agent with a specific pull request or a time period to generate release notes or changelog updates based on the commit history. + +For example: `@mintlify Generate release notes for this PR: [PR link]` or `@mintlify Generate release notes for the last month`. ### Generate code examples -Prompt the agent to generate code examples for features throughout your docs or on specific pages. For example: `@mintlify Generate a code example to make the authentication method easier to understand`. + +Prompt the agent to generate code examples for features throughout your docs or on specific pages. + +For example: `@mintlify Generate a code example to make the authentication method easier to understand`. ### Review existing content -Prompt the agent to review existing content for technical accuracy, style, grammar, or other issues. For example: `@mintlify Review the API rate limiting section. We changed limits last month`. + +Prompt the agent to review existing content for technical accuracy, style, grammar, or other issues. + +For example: `@mintlify Review the API rate limiting section. We changed limits last month`. ### Respond to user feedback -Prompt the agent with feedback from your users to make focused updates to your docs. For example: `@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?`. + +Prompt the agent with feedback from your users to make focused updates to your docs. + +For example: `@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?`. ### Automate with the API -Integrate the agent into your existing automation tools to automatically update documentation when code changes occur, trigger content reviews, or sync documentation updates across multiple repositories. + +Integrate the agent into your existing automation tools to automatically update documentation when code changes occur, trigger content reviews, or sync documentation updates across multiple repositories. \ No newline at end of file From 345662e478a701548c41a63952cfcbf58233e2f7 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 17:32:12 +0000 Subject: [PATCH 2/4] Documentation edits made through Mintlify web editor --- ai/agent.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ai/agent.mdx b/ai/agent.mdx index 41d397e64..c3de31cb0 100644 --- a/ai/agent.mdx +++ b/ai/agent.mdx @@ -39,7 +39,7 @@ The agent can only access repositories that you connect through the Mintlify Git ## Embed the agent via API -The agent endpoints can be used to [create jobs](/api-reference/agent/create-agent-job), [get a specific job](/api-reference/agent/get-agent-job), and [get all jobs](/api-reference/agent/get-all-jobs). +The agent endpoints can [create jobs](/api-reference/agent/create-agent-job), [get a specific job](/api-reference/agent/get-agent-job), and [get all jobs](/api-reference/agent/get-all-jobs). ## Write effective prompts From aee7bf62cd75d17c48a7da2c9d66284b1952296f Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 17:33:34 +0000 Subject: [PATCH 3/4] Documentation edits made through Mintlify web editor --- ai/agent.mdx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/ai/agent.mdx b/ai/agent.mdx index c3de31cb0..86cd8989a 100644 --- a/ai/agent.mdx +++ b/ai/agent.mdx @@ -63,11 +63,15 @@ The agent assists with many different documentation tasks. These workflows show ### Iterate on a prompt in a Slack thread -Prompt the agent, then continue to mention it with `@mintlify` in the same thread to refine and iterate on the pull request that it creates. For example: `@mintlify Our quickstart page needs a new section on inviting collaborators`. Then `@mintlify The new section should be called "Inviting collaborators"`. Followed by any other iterations. +Prompt the agent, then continue to mention it with `@mintlify` in the same thread to refine and iterate on the pull request that it creates. + +For example: `@mintlify Our quickstart page needs a new section on inviting collaborators`. Then `@mintlify The new section should be called "Inviting collaborators"`. Followed by any other iterations. ### Start with the agent, finish manually -Prompt the agent to begin a project, then check out the branch it creates and finish the task in your local environment or the web editor. The agent can help you get started, then you can take over to complete the task. For example: `@mintlify Update the quickstart page to include information about inviting collaborators` and then checkout the branch to make any additional changes using your preferred method. +Prompt the agent to begin a project, then check out the branch it creates and finish the task in your local environment or the web editor. The agent can help you get started, then you can take over to complete the task. + +For example: `@mintlify Update the quickstart page to include information about inviting collaborators` and then checkout the branch to make any additional changes using your preferred method. ### Update docs when merging feature changes From 7aebe3e5c831c44087db60b45f93a7899818b12f Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 17:35:08 +0000 Subject: [PATCH 4/4] Documentation edits made through Mintlify web editor --- ai/agent.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ai/agent.mdx b/ai/agent.mdx index 86cd8989a..2de92f597 100644 --- a/ai/agent.mdx +++ b/ai/agent.mdx @@ -39,7 +39,7 @@ The agent can only access repositories that you connect through the Mintlify Git ## Embed the agent via API -The agent endpoints can [create jobs](/api-reference/agent/create-agent-job), [get a specific job](/api-reference/agent/get-agent-job), and [get all jobs](/api-reference/agent/get-all-jobs). +Use the agent endpoints to [create jobs](/api-reference/agent/create-agent-job), [get a specific job](/api-reference/agent/get-agent-job), and [get all jobs](/api-reference/agent/get-all-jobs). ## Write effective prompts