From bcbed731e60392e9e37e7d4bac19ea0072f093d9 Mon Sep 17 00:00:00 2001 From: Mintlify Agent Date: Wed, 11 Feb 2026 00:07:08 +0000 Subject: [PATCH] Add rainbow text styling to all instances of 'repository' in English docs --- agent/customize.mdx | 4 +- agent/quickstart.mdx | 6 +-- agent/slack.mdx | 2 +- agent/suggestions.mdx | 14 +++---- ai/llmstxt.mdx | 2 +- ai/model-context-protocol.mdx | 2 +- api-playground/mdx-setup.mdx | 2 +- api-playground/openapi-setup.mdx | 2 +- changelog.mdx | 22 +++++------ create/files.mdx | 6 +-- customize/custom-scripts.mdx | 2 +- dashboard/audit-logs.mdx | 2 +- dashboard/permissions.mdx | 4 +- deploy/ci.mdx | 8 ++-- deploy/deployments.mdx | 6 +-- deploy/ghes.mdx | 14 +++---- deploy/github.mdx | 50 ++++++++++++------------- deploy/gitlab.mdx | 2 +- deploy/monorepo.mdx | 2 +- deploy/preview-deployments.mdx | 2 +- deploy/vercel.mdx | 2 +- docs.json | 2 +- editor/index.mdx | 2 +- editor/navigation.mdx | 4 +- editor/pages.mdx | 2 +- editor/publish.mdx | 6 +-- guides/assistant-embed.mdx | 4 +- guides/automate-agent.mdx | 60 +++++++++++++++--------------- guides/branches.mdx | 2 +- guides/cursor.mdx | 2 +- guides/developer-documentation.mdx | 6 +-- guides/git-concepts.mdx | 22 +++++------ guides/knowledge-base.mdx | 8 ++-- guides/windsurf.mdx | 2 +- installation.mdx | 14 +++---- integrations/privacy/osano.mdx | 4 +- integrations/sdks/speakeasy.mdx | 2 +- migration-services/enterprise.mdx | 6 +-- migration-services/pro.mdx | 6 +-- migration.mdx | 4 +- organize/mintignore.mdx | 4 +- organize/navigation.mdx | 2 +- organize/settings.mdx | 12 +++--- quickstart.mdx | 12 +++--- 44 files changed, 172 insertions(+), 172 deletions(-) diff --git a/agent/customize.mdx b/agent/customize.mdx index 4c9461921..ee750adb5 100644 --- a/agent/customize.mdx +++ b/agent/customize.mdx @@ -4,9 +4,9 @@ description: "Configure how the agent handles documentation tasks with AGENTS.md keywords: ["AGENTS.md", "agent configuration", "custom instructions", "agent customization"] --- -Create an `AGENTS.md` file in your repository to customize the agent's behavior (`Agents.md` is also accepted). The agent reads this file and follows any instructions you provide. +Create an `AGENTS.md` file in your repository to customize the agent's behavior (`Agents.md` is also accepted). The agent reads this file and follows any instructions you provide. -The agent searches for `AGENTS.md` files in two locations. It first checks the documentation directory, then the repository root. If you have `AGENTS.md` files in both locations, the agent uses the file in your documentation directory. +The agent searches for `AGENTS.md` files in two locations. It first checks the documentation directory, then the repository root. If you have `AGENTS.md` files in both locations, the agent uses the file in your documentation directory. Add any instructions that you want the agent to follow. The agent appends these instructions to its system prompt, so the instructions apply to all tasks, whether you use the agent in your dashboard, on Slack, or via the API. diff --git a/agent/quickstart.mdx b/agent/quickstart.mdx index 75e6d2c85..7b8af8fb6 100644 --- a/agent/quickstart.mdx +++ b/agent/quickstart.mdx @@ -23,7 +23,7 @@ To open the agent panel: - **Chat**: Click the plus icon, , to start a new chat. In the chat view, send prompts to the agent to update or ask questions about your documentation. The agent creates pull requests based on your instructions and displays links to view the pull requests or open the changes in the web editor. - **Suggestions**: If enabled, the suggestions panel shows suggested updates to your documentation based on pull request changes and users' conversations with the assistant. - **History**: Click the history icon, , to browse past conversations and continue working on previous requests. Click any conversation to load it in the chat view. -- **Settings**: Click the settings icon, , to configure the agent's integrations and repository access. +- **Settings**: Click the settings icon, , to configure the agent's integrations and repository access. Start a new conversation with the agent for each task. This keeps the agent's context focused and helps you associate conversations with specific projects. @@ -33,6 +33,6 @@ To open the agent panel: By default, the agent opens pull requests attributed to the Mintlify bot. To attribute pull requests to you, connect your GitHub account on the [My profile](https://dashboard.mintlify.com/settings/account) page of the dashboard. -## Connect repositories as context +## Connect repositories as context -The agent can only access repositories that you connect through the Mintlify GitHub App. Configure which repositories the agent can access in the agent panel **Settings** or in the [GitHub App settings](https://github.com/apps/mintlify/installations/new). +The agent can only access repositories that you connect through the Mintlify GitHub App. Configure which repositories the agent can access in the agent panel **Settings** or in the [GitHub App settings](https://github.com/apps/mintlify/installations/new). diff --git a/agent/slack.mdx b/agent/slack.mdx index 901d66d97..7c5b05ae8 100644 --- a/agent/slack.mdx +++ b/agent/slack.mdx @@ -39,7 +39,7 @@ Use the agent to update your documentation with a new request or in an existing - **New request**: Send a direct message to the agent or mention `@mintlify` in a channel with instructions on what to update. - **Existing thread**: Reply in the thread and mention `@mintlify` with instructions on what to update. -The agent reads the context of the request or thread and creates a pull request in your connected repository with the updates. +The agent reads the context of the request or thread and creates a pull request in your connected repository with the updates. ## Best practices diff --git a/agent/suggestions.mdx b/agent/suggestions.mdx index 344695175..d04f433e6 100644 --- a/agent/suggestions.mdx +++ b/agent/suggestions.mdx @@ -10,7 +10,7 @@ keywords: ["automation", "documentation gaps", "self updating", "self-updating", You can allow the agent to suggest documentation updates from two sources. -- **Pull request changes**: Monitor selected Git repositories for code changes that require documentation updates. +- **Pull request changes**: Monitor selected Git repositories for code changes that require documentation updates. - **Assistant conversations**: Analyze questions that users ask the assistant on your documentation site to identify content gaps. When the agent identifies potential documentation updates, it creates a suggestion in your dashboard with context to create a pull request. @@ -19,11 +19,11 @@ Use suggestions to proactively keep your documentation up to date when new featu ## Prerequisites -Before using suggestions, you must install the [Mintlify GitHub App](/deploy/github) in your organization. The app must have access to your documentation repository and at least one other repository where code changes require documentation updates. +Before using suggestions, you must install the [Mintlify GitHub App](/deploy/github) in your organization. The app must have access to your documentation repository and at least one other repository where code changes require documentation updates. ## Configure suggestions -Configure which repositories the agent monitors and how you receive notifications in the agent settings. The settings page displays all the GitHub organizations and repositories the agent is monitoring. +Configure which repositories the agent monitors and how you receive notifications in the agent settings. The settings page displays all the GitHub organizations and repositories the agent is monitoring. To access the agent settings: @@ -34,15 +34,15 @@ To access the agent settings: The settings button in dark mode. -### Monitor repositories +### Monitor repositories -The agent monitors all merged pull requests for each repository that you enable, regardless of which branch they're merged into. A GitHub check named **Mintlify Autopilot** runs on pull requests in monitored repositories to analyze them for potential documentation updates. When you merge a pull request that requires documentation updates, the agent creates a suggestion in your dashboard. +The agent monitors all merged pull requests for each repository that you enable, regardless of which branch they're merged into. A GitHub check named **Mintlify Autopilot** runs on pull requests in monitored repositories to analyze them for potential documentation updates. When you merge a pull request that requires documentation updates, the agent creates a suggestion in your dashboard. - When you first enable monitoring for a repository, the agent creates suggestions for pull requests merged in the last seven days. This backfill only occurs if no suggestions already exist for that repository. You may see multiple suggestions appear immediately after enabling monitoring. + When you first enable monitoring for a repository, the agent creates suggestions for pull requests merged in the last seven days. This backfill only occurs if no suggestions already exist for that repository. You may see multiple suggestions appear immediately after enabling monitoring. -If you disable monitoring, the agent immediately stops monitoring the repository. Any existing suggestions for that repository remain in your dashboard until you dismiss them. +If you disable monitoring, the agent immediately stops monitoring the repository. Any existing suggestions for that repository remain in your dashboard until you dismiss them. ### Conversation insights diff --git a/ai/llmstxt.mdx b/ai/llmstxt.mdx index d1dbdccdd..a9cd66735 100644 --- a/ai/llmstxt.mdx +++ b/ai/llmstxt.mdx @@ -25,7 +25,7 @@ An `llms.txt` file is a plain Markdown file that contains: - **Site title** as an H1 heading. - **Structured content sections** with links and a description of each page in your documentation. -Pages are listed alphabetically in the order they appear in your repository, starting from the root directory. +Pages are listed alphabetically in the order they appear in your repository, starting from the root directory. Each page's description comes from the `description` field in its frontmatter. Pages without a `description` field appear in the `llms.txt` file without a description. diff --git a/ai/model-context-protocol.mdx b/ai/model-context-protocol.mdx index 71da1a161..310324c01 100644 --- a/ai/model-context-protocol.mdx +++ b/ai/model-context-protocol.mdx @@ -62,7 +62,7 @@ View and copy your MCP server URL on the [MCP server page](https://dashboard.min ## Content filtering and indexing -Your MCP server searches content that Mintlify indexes from your documentation repository. File processing and search indexing control what content is available through your MCP server. +Your MCP server searches content that Mintlify indexes from your documentation repository. File processing and search indexing control what content is available through your MCP server. ### File processing with `.mintignore` diff --git a/api-playground/mdx-setup.mdx b/api-playground/mdx-setup.mdx index e50260ce0..470c41b51 100644 --- a/api-playground/mdx-setup.mdx +++ b/api-playground/mdx-setup.mdx @@ -126,7 +126,7 @@ You can manually define API endpoints in individual MDX pages. This approach is } ``` - Each page path corresponds to an MDX file in your docs repository. For example, `api-reference/users/create-user.mdx`. Learn more about structuring your docs in [Navigation](/organize/navigation). + Each page path corresponds to an MDX file in your docs repository. For example, `api-reference/users/create-user.mdx`. Learn more about structuring your docs in [Navigation](/organize/navigation). ### Using OpenAPI endpoints in navigation diff --git a/api-playground/openapi-setup.mdx b/api-playground/openapi-setup.mdx index ed7c2274d..cf5bc71b3 100644 --- a/api-playground/openapi-setup.mdx +++ b/api-playground/openapi-setup.mdx @@ -10,7 +10,7 @@ OpenAPI is a specification for describing APIs. Mintlify supports OpenAPI 3.0 an To document your endpoints with OpenAPI, you need one or more valid OpenAPI specifications in either JSON or YAML format that follow the [OpenAPI specification 3.0 or 3.1](https://swagger.io/specification/). -Add OpenAPI specifications to your documentation repository or host them online where you can access the specifications by URL. +Add OpenAPI specifications to your documentation repository or host them online where you can access the specifications by URL. Reference any number of OpenAPI specifications in the navigation element of your `docs.json` to create pages for your API endpoints. Each specification file generates its own set of endpoints. diff --git a/changelog.mdx b/changelog.mdx index 46a113906..573ace16f 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -89,7 +89,7 @@ noindex: true ## `skill.md` auto-generation - Documentation sites now auto-generate a `skill.md` file based on your API references, guides, and features to give AI agents a comprehensive skills file with context on how to help people use your product. `skill.md` replaces the `install.md` approach with more structured capabilities and wider adoption. If you have a custom `skills.md` file at the root of your documentation repository, it replaces the auto-generated version. See [skill.md](/ai/skillmd) for more information. + Documentation sites now auto-generate a `skill.md` file based on your API references, guides, and features to give AI agents a comprehensive skills file with context on how to help people use your product. `skill.md` replaces the `install.md` approach with more structured capabilities and wider adoption. If you have a custom `skills.md` file at the root of your documentation repository, it replaces the auto-generated version. See [skill.md](/ai/skillmd) for more information. ## Audit logs for authentication events @@ -110,7 +110,7 @@ noindex: true ## `install.md` auto-generation - Documentation sites now auto-generate an `install.md` file that aggregates installation-related pages like quickstarts, getting started, installation, and setup guides for AI agents. If you have a custom `install.md` file in your documentation repository, it takes priority over the auto-generated version. + Documentation sites now auto-generate an `install.md` file that aggregates installation-related pages like quickstarts, getting started, installation, and setup guides for AI agents. If you have a custom `install.md` file in your documentation repository, it takes priority over the auto-generated version. ## Web editor improvements @@ -175,7 +175,7 @@ noindex: true The [agent](/agent) can now suggest documentation updates based on [assistant conversations](/agent/suggestions#conversation-insights). When enabled, the agent analyzes questions users ask the assistant to identify patterns that indicate missing or unclear documentation. - This adds a second source for agent suggestions alongside repository monitoring, helping you proactively address common user questions. + This adds a second source for agent suggestions alongside repository monitoring, helping you proactively address common user questions. ## Slack bot customization @@ -219,7 +219,7 @@ noindex: true ## Onboarding improvements - - Choose between a Mintlify-hosted documentation repository or using your own repository while signing up. + - Choose between a Mintlify-hosted documentation repository or using your own repository while signing up. - Create a documentation site without connecting a GitHub account. ## Snippet improvements @@ -236,7 +236,7 @@ noindex: true ## Agent suggestions - The agent can now monitor Git repositories and [suggest](/agent/suggestions) documentation updates. When user-facing code changes are detected, suggestions appear in the agent panel. Suggestions include the relevant pull request and a list of proposed documentation updates. Add suggestions as context for the agent to create pull requests or dismiss them. + The agent can now monitor Git repositories and [suggest](/agent/suggestions) documentation updates. When user-facing code changes are detected, suggestions appear in the agent panel. Suggestions include the relevant pull request and a list of proposed documentation updates. Add suggestions as context for the agent to create pull requests or dismiss them. ## Q&A bots in Slack and Discord @@ -493,7 +493,7 @@ noindex: true ## Performance and infrastructure - - Implemented full Git sync in the web editor for better repository synchronization + - Implemented full Git sync in the web editor for better repository synchronization - Cached MCP responses for improved performance - Improved sitemap to normalize `/index` paths @@ -636,7 +636,7 @@ noindex: true - Fixed code block rendering issues with language tags and custom themes - Fixed accordion link formatting and styling - Fixed footer spacing when assistant configuration is empty - - Fixed card icon rendering for local repository images + - Fixed card icon rendering for local repository images - Fixed audio file handling in API playground (prevented UTF-8 decoding) - Improved PR publish state management in web editor @@ -679,7 +679,7 @@ noindex: true ## Bug fixes and reliability - - Fixed GitLab integration issues with larger repositories + - Fixed GitLab integration issues with larger repositories - Improved dashboard loading performance with optimized deployment queries - Fixed SVG path rendering issues in documentation - Fixed keyboard navigation in search and chat functionality @@ -702,7 +702,7 @@ noindex: true ## Web editor and deployments - - Security enhancement added to editor such that only users with `write permissions` for the connected git hosting repository can make changes + - Security enhancement added to editor such that only users with `write permissions` for the connected git hosting repository can make changes - Fixed a bug where preview deployments wouldn't work for branches with `=` in the name - Fixed a bug where long branch names would overflow modals on preview deployment creations - Quality of life improvement where email query parameter will prefill the input on signup invitations @@ -763,7 +763,7 @@ noindex: true ## Image handling improvements - **Major improvement**: Images no longer cause layout shift by default, even when width and height attributes aren't specified—automatic sizing prevents content jumping during page loads - - All static files in your repository (PDF, TXT, XML, etc.) are now automatically uploaded and served when you deploy, providing complete asset coverage + - All static files in your repository (PDF, TXT, XML, etc.) are now automatically uploaded and served when you deploy, providing complete asset coverage ## Web editor and deployment enhancements @@ -785,7 +785,7 @@ noindex: true ## Technical improvements and reliability - Enhanced logging system for update workflows enabling faster debugging and issue resolution - - Fixed GitHub rate limiting for customers with 10+ OpenAPI/AsyncAPI specs by switching from individual file fetching to repository cloning + - Fixed GitHub rate limiting for customers with 10+ OpenAPI/AsyncAPI specs by switching from individual file fetching to repository cloning - Improved assistant reliability with backup LLM support, enhanced rate limit error handling, and more robust search tool functionality diff --git a/create/files.mdx b/create/files.mdx index 203b174eb..08cf0896d 100644 --- a/create/files.mdx +++ b/create/files.mdx @@ -4,7 +4,7 @@ description: "Serve static assets from your documentation." keywords: ["static assets","supported file types"] --- -Mintlify automatically serves static assets from your documentation repository at the appropriate path on your domain. For example, if you have `/images/my-logo.png` in your repo, the image file is available at `https://docs.your-project.com/images/my-logo.png`. +Mintlify automatically serves static assets from your documentation repository at the appropriate path on your domain. For example, if you have `/images/my-logo.png` in your repo, the image file is available at `https://docs.your-project.com/images/my-logo.png`. You can make any supported file type available to your users, including OpenAPI specifications, images, videos, and more. @@ -34,7 +34,7 @@ Supported file types for Enterprise plans: ## File organization -Organize your files using folders to keep your repository easy to navigate: +Organize your files using folders to keep your repository easy to navigate: ```text /your-project @@ -48,4 +48,4 @@ Organize your files using folders to keep your repository easy to navigate: |- demo-video.mp4 ``` -Files are served from the root of your domain, so the structure in your repository directly maps to the URL structure. From the previous example, `assets/whitepaper.pdf` would be available at `https://docs.your-project.com/assets/whitepaper.pdf`. \ No newline at end of file +Files are served from the root of your domain, so the structure in your repository directly maps to the URL structure. From the previous example, `assets/whitepaper.pdf` would be available at `https://docs.your-project.com/assets/whitepaper.pdf`. \ No newline at end of file diff --git a/customize/custom-scripts.mdx b/customize/custom-scripts.mdx index c12ce2472..12a83ff26 100644 --- a/customize/custom-scripts.mdx +++ b/customize/custom-scripts.mdx @@ -28,7 +28,7 @@ Tailwind CSS arbitrary values are not supported. For custom values, use the `sty ## Custom CSS -Add CSS files to your repository and their defined class names will be applied and available in all of your MDX files. +Add CSS files to your repository and their defined class names will be applied and available in all of your MDX files. ### Adding `style.css` diff --git a/dashboard/audit-logs.mdx b/dashboard/audit-logs.mdx index c13cab134..c787bed51 100644 --- a/dashboard/audit-logs.mdx +++ b/dashboard/audit-logs.mdx @@ -51,7 +51,7 @@ Filter audit logs to find specific activities. | Billing | Subscription updates, add-on purchases, and invoice views. | | Quota | Overage policy and alert configuration changes. | | User | Individual user notification settings. | -| Suggestions | Suggestion configurations and repository management. | +| Suggestions | Suggestion configurations and repository management. | | Audit log | Audit log views and exports. | | Auth | Login attempts, logouts, and session creations. | diff --git a/dashboard/permissions.mdx b/dashboard/permissions.mdx index d3ce45429..e14c1cdc1 100644 --- a/dashboard/permissions.mdx +++ b/dashboard/permissions.mdx @@ -4,6 +4,6 @@ description: "Understand deployment differences between people in your organizat keywords: ["editor access", "permissions", "team", "seats", "deployment"] --- -People with the editor or admin [role](/dashboard/roles) can use the web editor, trigger deployments, and manage integrations from your dashboard. When an editor or admin publishes through the web editor or merges a pull request into your documentation repository, the changes deploy to your live site automatically. +People with the editor or admin [role](/dashboard/roles) can use the web editor, trigger deployments, and manage integrations from your dashboard. When an editor or admin publishes through the web editor or merges a pull request into your documentation repository, the changes deploy to your live site automatically. -Anyone with access to your documentation repository can contribute to your documentation by pushing changes to the repository, but their changes do not deploy until an editor or admin manually triggers a deployment from your dashboard. +Anyone with access to your documentation repository can contribute to your documentation by pushing changes to the repository, but their changes do not deploy until an editor or admin manually triggers a deployment from your dashboard. diff --git a/deploy/ci.mdx b/deploy/ci.mdx index d5483fb3d..00ed76603 100644 --- a/deploy/ci.mdx +++ b/deploy/ci.mdx @@ -5,7 +5,7 @@ keywords: ["continuous integration", "CI/CD", "checks", "Vale", "linter"] --- - [Pro and Enterprise plans](https://mintlify.com/pricing?ref=docs-ci) include CI checks for GitHub repositories. + [Pro and Enterprise plans](https://mintlify.com/pricing?ref=docs-ci) include CI checks for GitHub repositories. Use CI checks to lint your docs for errors and provide warnings before you deploy. Mintlify CI checks run on pull requests against a configured deployment branch. @@ -15,7 +15,7 @@ Use CI checks to lint your docs for errors and provide warnings before you deplo To begin, follow the steps on the [GitHub](/deploy/github) page. - Only access to the repository where your documentation content exists is required, so it is highly recommended to only grant access to that repository. + Only access to the repository where your documentation content exists is required, so it is highly recommended to only grant access to that repository. ## Configuration @@ -390,11 +390,11 @@ To add your own vocabulary for the default configuration, create a `styles/confi For security reasons, absolute `stylesPath`, or `stylesPath` which include `..` values aren't supported. -Use relative paths and include the `stylesPath` in your repository. +Use relative paths and include the `stylesPath` in your repository. #### Packages -Vale supports a range of [packages](https://vale.sh/docs/keys/packages), which can be used to check for spelling and style errors. Any packages you include in your repository under the correct `stylesPath` are automatically installed and used in your Vale configuration. +Vale supports a range of [packages](https://vale.sh/docs/keys/packages), which can be used to check for spelling and style errors. Any packages you include in your repository under the correct `stylesPath` are automatically installed and used in your Vale configuration. For packages not included in your repository, you may specify any packages from the [Vale package registry](https://vale.sh/explorer), and they're automatically downloaded and used in your Vale configuration. diff --git a/deploy/deployments.mdx b/deploy/deployments.mdx index eb1285266..ffbe6badb 100644 --- a/deploy/deployments.mdx +++ b/deploy/deployments.mdx @@ -4,9 +4,9 @@ description: "Manage deployments, view history, and monitor status." keywords: ["manual deployment", "deployment history", "deployment triggers", "delete deployment"] --- -Your documentation site automatically deploys when you push changes to your connected repository. This requires the Mintlify GitHub app to be properly installed and connected. +Your documentation site automatically deploys when you push changes to your connected repository. This requires the Mintlify GitHub app to be properly installed and connected. -If your latest changes are not appearing on your live site, first check that the GitHub account or organization that owns your docs repository has the GitHub App installed. See [GitHub troubleshooting](/deploy/github#troubleshooting) for more information. +If your latest changes are not appearing on your live site, first check that the GitHub account or organization that owns your docs repository has the GitHub App installed. See [GitHub troubleshooting](/deploy/github#troubleshooting) for more information. If you have the GitHub App installed, but changes are still not deploying, manually trigger a deployment from your dashboard. @@ -14,7 +14,7 @@ If you have the GitHub App installed, but changes are still not deploying, manua - Check that your latest commit appears in your docs repository and did not encounter any errors. + Check that your latest commit appears in your docs repository and did not encounter any errors. Go to your [dashboard](https://dashboard.mintlify.com) and select the deploy button. diff --git a/deploy/ghes.mdx b/deploy/ghes.mdx index a5e13c7fb..a54391dcb 100644 --- a/deploy/ghes.mdx +++ b/deploy/ghes.mdx @@ -11,7 +11,7 @@ If you use a cloud-hosted GitHub instance, see the [GitHub](/deploy/github) page ## Prerequisites - Admin privileges on your GitHub Enterprise Server organization where you want to install the app -- Access to your organization's repositories where you want to install the app +- Access to your organization's repositories where you want to install the app - Network connectivity to communicate with our external services (see [Network requirements](#network-requirements) section below) ### Network requirements @@ -120,10 +120,10 @@ Record the following: Select either: - **All repositories** (for organization-wide access) -- **Only select repositories** (choose specific repositories) +- **Only select repositories** (choose specific repositories) -We recommend selecting "Only select repositories" and limiting the app to only the repositories where your documentation is located. +We recommend selecting "Only select repositories" and limiting the app to only the repositories where your documentation is located. @@ -163,7 +163,7 @@ Please share the following information with our team using your secure informati ### Optional credentials for troubleshooting - Organization name: Your GitHub organization name -- Repository names: Specific repositories where the app is installed +- Repository names: Specific repositories where the app is installed - GitHub Enterprise Server version: Found in your site admin dashboard ## Mintlify connection @@ -189,7 +189,7 @@ The webhook URL may change based on our configuration. We test the integration a -1. Create a test issue or pull request in an installed repository. +1. Create a test issue or pull request in an installed repository. 2. Verify that Mintlify responds appropriately. @@ -202,7 +202,7 @@ Ensure you have: - Site admin privileges for app creation - Organization owner or admin rights for app installation. -- Proper repository permissions if installing on specific repositories. +- Proper repository permissions if installing on specific repositories. @@ -224,7 +224,7 @@ Your GHES might use self-signed certificates. Our services cannot verify your se -Yes, during installation you can select "Only select repositories" and choose specific ones. You can modify this later in your organization's installed apps settings. This is the recommended form of installation. +Yes, during installation you can select "Only select repositories" and choose specific ones. You can modify this later in your organization's installed apps settings. This is the recommended form of installation. diff --git a/deploy/github.mdx b/deploy/github.mdx index 83bd8d027..4c39d87e4 100644 --- a/deploy/github.mdx +++ b/deploy/github.mdx @@ -4,7 +4,7 @@ description: "Connect to a GitHub repository for automated deployments, pull req keywords: ["GitHub App","repository connection","automated deployments"] --- -Mintlify uses a GitHub App to automatically sync your documentation with your GitHub repository. +Mintlify uses a GitHub App to automatically sync your documentation with your GitHub repository. **Do you need the GitHub App?** @@ -12,40 +12,40 @@ Mintlify uses a GitHub App to automatically sync your documentation with your Gi - **Mintlify-hosted repository** in the `mintlify-community` organization: No. The GitHub App is already configured. - **Your own repository**: Yes. Install the GitHub App to enable automatic deployments when you push changes. - See your repository in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard. + See your repository in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard. -If your repository is in a private repository owned by the Mintlify organization, the GitHub App is automatically configured and managed by Mintlify. You can use the web editor to make changes to your documentation. If you want to work on your documentation locally, clone the repository to your own organization and update your Git settings to use your own repository. +If your repository is in a private repository owned by the Mintlify organization, the GitHub App is automatically configured and managed by Mintlify. You can use the web editor to make changes to your documentation. If you want to work on your documentation locally, clone the repository to your own organization and update your Git settings to use your own repository. -## Clone to your own repository +## Clone to your own repository -If you skipped connecting your own Git repository during onboarding, your documentation lives in a private repository owned by the Mintlify organization. To move it to your own account or organization: +If you skipped connecting your own Git repository during onboarding, your documentation lives in a private repository owned by the Mintlify organization. To move it to your own account or organization: 1. Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard. 2. Click **Clone as Private** or **Clone as Public**. Public repos allow anyone to view your documentation source and submit issues or suggestions. Private repos restrict access to your team. 3. Install the GitHub App by following the steps in [Install the GitHub App](#install-the-github-app) below. -### Alternative: Download and create your own repository +### Alternative: Download and create your own repository -If you want a private repository without granting elevated OAuth permissions, you can manually transfer your documentation: +If you want a private repository without granting elevated OAuth permissions, you can manually transfer your documentation: 1. Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard. 2. Download your documentation as a zip file. -3. Create a new repository on GitHub or GitLab. -4. Extract the zip contents and push them to your new repository. -5. Return to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) and connect your new repository to Mintlify. +3. Create a new repository on GitHub or GitLab. +4. Extract the zip contents and push them to your new repository. +5. Return to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) and connect your new repository to Mintlify. 6. Install the GitHub App by following the steps in [Install the GitHub App](#install-the-github-app) below. ## Install the GitHub App - You must have organization ownership or administrator permissions in a repository to install the app. If you lack the necessary permissions, the repository owner must approve the installation request. + You must have organization ownership or administrator permissions in a repository to install the app. If you lack the necessary permissions, the repository owner must approve the installation request. Install the Mintlify GitHub App through your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app). - We recommend only granting access to your documentation repository. + We recommend only granting access to your documentation repository. @@ -62,7 +62,7 @@ When you install the GitHub App, grant the following permissions. Read permissions: -- `metadata`: Basic repository information +- `metadata`: Basic repository information Read and write permissions: @@ -72,16 +72,16 @@ Read and write permissions: - `pull requests`: Create branches and pull requests from the web editor - The app only accesses repositories that you explicitly grant it access to. If you have branch protection rules enabled, the app can't push directly to protected branches. + The app only accesses repositories that you explicitly grant it access to. If you have branch protection rules enabled, the app can't push directly to protected branches. -## Manage repository access +## Manage repository access -When installing the GitHub App, you can grant access to all of your repositories or specific ones. We recommend only granting access to your documentation repository and any repositories that you want to provide as context for the agent. You can modify this selection anytime in your [GitHub App settings](https://github.com/apps/mintlify/installations/new). +When installing the GitHub App, you can grant access to all of your repositories or specific ones. We recommend only granting access to your documentation repository and any repositories that you want to provide as context for the agent. You can modify this selection anytime in your [GitHub App settings](https://github.com/apps/mintlify/installations/new). ## Configure docs source -Change the organization, repository, or branch that your documentation builds from in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) section of your dashboard. +Change the organization, repository, or branch that your documentation builds from in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) section of your dashboard. ## GitHub Enterprise with IP allowlists @@ -93,14 +93,14 @@ Follow [GitHub's documentation](https://docs.github.com/en/enterprise-cloud@late ### Deployment not triggering automatically -If pushes to your repository don't trigger deployments, check the following possible problems. +If pushes to your repository don't trigger deployments, check the following possible problems. - Check that the correct repository has the app installed. + Check that the correct repository has the app installed. 1. Go to [GitHub App settings](https://dashboard.mintlify.com/settings/organization/github-app) in your dashboard. - 1. Check that your repository is on the active app installations list. + 1. Check that your repository is on the active app installations list. Ensure that you're pushing to the correct branch. @@ -127,27 +127,27 @@ If you encounter problems with the GitHub app, resetting the connection can solv ### Feedback add-ons are unavailable -The edit suggestions and raise issues feedback features are only available for public GitHub repositories. If these options are disabled in your dashboard, check your repository visibility. +The edit suggestions and raise issues feedback features are only available for public GitHub repositories. If these options are disabled in your dashboard, check your repository visibility. -If your repository is public and you cannot enable the edit suggestions or raise issues options in your dashboard, revalidate your Git settings. +If your repository is public and you cannot enable the edit suggestions or raise issues options in your dashboard, revalidate your Git settings. Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard. - Click the green check mark in the corner of the Git settings box to revalidate your repository settings. This forces an update to your repository settings to reflect whether your repository is public or private. + Click the green check mark in the corner of the Git settings box to revalidate your repository settings. This forces an update to your repository settings to reflect whether your repository is public or private. The Git Settings page in the Mintlify dashboard. An orange arrow points to the green check mark that revalidates the repository settings. The Git Settings page in the Mintlify dashboard. An orange arrow points to the green check mark that revalidates the repository settings. diff --git a/deploy/gitlab.mdx b/deploy/gitlab.mdx index eccbd3c45..74bd3a292 100644 --- a/deploy/gitlab.mdx +++ b/deploy/gitlab.mdx @@ -12,7 +12,7 @@ We use access tokens and webhooks to authenticate and sync changes between GitLa ## Set up the connection - **HTTPS cloning required**: Your GitLab project must have HTTPS cloning enabled for Mintlify to access your repository. You can verify this in GitLab by going to your project's **Settings** > **General** > **Visibility and access controls** section. + **HTTPS cloning required**: Your GitLab project must have HTTPS cloning enabled for Mintlify to access your repository. You can verify this in GitLab by going to your project's **Settings** > **General** > **Visibility and access controls** section. diff --git a/deploy/monorepo.mdx b/deploy/monorepo.mdx index 512499963..a24a2fff2 100644 --- a/deploy/monorepo.mdx +++ b/deploy/monorepo.mdx @@ -4,7 +4,7 @@ description: "Configure documentation path and content directory for monorepo pr keywords: ["monorepo", "content directory", "multi-project repository"] --- -Configure Mintlify to deploy documentation from a specific directory within a monorepo. This setup allows you to maintain documentation alongside your code in repositories that contain multiple projects or services. +Configure Mintlify to deploy documentation from a specific directory within a monorepo. This setup allows you to maintain documentation alongside your code in repositories that contain multiple projects or services. ## Prerequisites diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index cc2938b3c..bf4a8e500 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -87,5 +87,5 @@ If your preview deployment fails, try these troubleshooting steps. - Missing or incorrect file paths referenced in your navigation - Invalid frontmatter in MDX files - Broken image links or missing image files -- **Validate locally**: Run `mint dev` locally to catch build errors before pushing to the repository. +- **Validate locally**: Run `mint dev` locally to catch build errors before pushing to the repository. - **Check recent changes**: Review the most recent commits in your branch to identify what changes caused the build to fail. diff --git a/deploy/vercel.mdx b/deploy/vercel.mdx index 18e049d4b..a2f0eb4e5 100644 --- a/deploy/vercel.mdx +++ b/deploy/vercel.mdx @@ -55,7 +55,7 @@ For more information, see [Configuring projects with vercel.json: Rewrites](http ### Host at custom subpath -To use a custom subpath (any path other than `/docs`), you must organize your documentation files within your repository to match your subpath structure. For example, if your documentation is hosted at `yoursite.com/help`, your documentation files must be in a `help/` directory. +To use a custom subpath (any path other than `/docs`), you must organize your documentation files within your repository to match your subpath structure. For example, if your documentation is hosted at `yoursite.com/help`, your documentation files must be in a `help/` directory. Use the generator below to create your rewrites configuration. Add the rewrites to your `vercel.json` file. diff --git a/docs.json b/docs.json index 7e92ab2b7..86721bb67 100644 --- a/docs.json +++ b/docs.json @@ -1552,7 +1552,7 @@ "copy", "chatgpt", "claude", - "add-mcp", + "mcp", "cursor", "vscode" ] diff --git a/editor/index.mdx b/editor/index.mdx index 251c69058..f551de1a1 100644 --- a/editor/index.mdx +++ b/editor/index.mdx @@ -26,7 +26,7 @@ Create, edit, and publish documentation directly in your browser with the web ed - **Shareable preview links**: Create preview links for your team from the editor. - **Drag-and-drop navigation**: Organize your site structure visually without editing configuration files. - **Built-in media manager**: Upload and organize images, videos, and other assets. -- **Git synchronization**: All changes sync automatically with your documentation repository. +- **Git synchronization**: All changes sync automatically with your documentation repository. - **Branch workflows**: Work on feature branches and create pull requests for review. - **Team collaboration**: Multiple team members can work simultaneously with preview deployments. diff --git a/editor/navigation.mdx b/editor/navigation.mdx index c9b54e766..52586ce94 100644 --- a/editor/navigation.mdx +++ b/editor/navigation.mdx @@ -25,7 +25,7 @@ After creating an element, drag-and-drop it to reorder or nest it within other e ### Add existing files -Add files from your repository that aren't yet in navigation. +Add files from your repository that aren't yet in navigation. 1. Click the plus button, , where you want to add the file. 1. Click **Add existing file**. @@ -116,7 +116,7 @@ Each language maintains the same navigation structure with translated content. **Control visibility:** -Hide the content within a navigation element without deleting it from your repository. +Hide the content within a navigation element without deleting it from your repository. 1. Right-click any item. 1. Click the toggle by the **Hide** label. diff --git a/editor/pages.mdx b/editor/pages.mdx index d7b91eb2d..1699c35eb 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -120,4 +120,4 @@ Right-click a page and select **Delete**. Deleting a page removes it from your n ### Hide pages -To remove a page from navigation without deleting the file, enable the **Hidden** toggle in the page settings. A hidden page remains in your repository and users can still access the page by navigating directly to the page's URL. You can unhide a page in the page settings or add it to your `docs.json` navigation. \ No newline at end of file +To remove a page from navigation without deleting the file, enable the **Hidden** toggle in the page settings. A hidden page remains in your repository and users can still access the page by navigating directly to the page's URL. You can unhide a page in the page settings or add it to your `docs.json` navigation. \ No newline at end of file diff --git a/editor/publish.mdx b/editor/publish.mdx index 5e8c17d11..628899ae2 100644 --- a/editor/publish.mdx +++ b/editor/publish.mdx @@ -7,10 +7,10 @@ keywords: ["editor", "publish", "changes", "branches", "pull requests"] ## Publishing workflows -The editor supports two workflows for publishing documentation updates. The workflow you use depends on your repository's branch protection rules and the branch you work on. +The editor supports two workflows for publishing documentation updates. The workflow you use depends on your repository's branch protection rules and the branch you work on. -* **Create pull requests**: If your repository has a branch protection rule that requires pull requests before changes can merge into your deployment branch, the editor creates a pull request when you publish changes. -* **Publish directly**: If your repository has no branch protection rules, your changes merge to the deployment branch and deploy immediately when you publish. +* **Create pull requests**: If your repository has a branch protection rule that requires pull requests before changes can merge into your deployment branch, the editor creates a pull request when you publish changes. +* **Publish directly**: If your repository has no branch protection rules, your changes merge to the deployment branch and deploy immediately when you publish. | Branch type | Branch protection | Publishing workflow | |-------------|-------------------|------------------------------| diff --git a/guides/assistant-embed.mdx b/guides/assistant-embed.mdx index 39978d057..4fcff3dc9 100644 --- a/guides/assistant-embed.mdx +++ b/guides/assistant-embed.mdx @@ -39,7 +39,7 @@ Users can use the widget to get help with your product without leaving your appl ## Set up the example -Clone the [example repository](https://github.com/mintlify/assistant-embed-example) and customize it for your needs. +Clone the [example repository](https://github.com/mintlify/assistant-embed-example) and customize it for your needs. @@ -51,7 +51,7 @@ cd assistant-embed-example -The repository includes Next.js and Vite examples. Choose the tool you prefer to use. +The repository includes Next.js and Vite examples. Choose the tool you prefer to use. ```bash title="Next.js" diff --git a/guides/automate-agent.mdx b/guides/automate-agent.mdx index 779981e78..8c5bdd69a 100644 --- a/guides/automate-agent.mdx +++ b/guides/automate-agent.mdx @@ -7,21 +7,21 @@ keywords: ["agent automation", "n8n", "GitHub Actions", "automatic doc updates"] ## What you will build -An automation that updates your documentation when code is pushed to your main branch. The workflow can be built on multiple platforms, including GitHub Actions and n8n. It watches your code repository and then calls the agent API to update your documentation in a separate documentation repository. +An automation that updates your documentation when code is pushed to your main branch. The workflow can be built on multiple platforms, including GitHub Actions and n8n. It watches your code repository and then calls the agent API to update your documentation in a separate documentation repository. -This workflow connects two separate repositories: +This workflow connects two separate repositories: -- **Code repository**: Where you store application code. You'll set up the automation trigger on this repository. Examples include a backend API, frontend app, SDK, or CLI tool. -- **Documentation repository**: Where you store your documentation and connect to your Mintlify project. The agent creates pull requests with documentation updates in this repository. +- **Code repository**: Where you store application code. You'll set up the automation trigger on this repository. Examples include a backend API, frontend app, SDK, or CLI tool. +- **Documentation repository**: Where you store your documentation and connect to your Mintlify project. The agent creates pull requests with documentation updates in this repository. -This tutorial assumes your documentation is in a separate repository from your application code. If you have a monorepo, modify the workflow to target the directory where you store your documentation. +This tutorial assumes your documentation is in a separate repository from your application code. If you have a monorepo, modify the workflow to target the directory where you store your documentation. ### Workflow overview 1. Someone pushes code to your main branch. 2. The workflow triggers. 3. The workflow calls the agent API to update your documentation. -4. The agent creates a pull request with documentation updates in your documentation repository. +4. The agent creates a pull request with documentation updates in your documentation repository. ## Choose your platform @@ -32,16 +32,16 @@ GitHub Actions is the simplest option if your code is already on GitHub. No addi ## Prerequisites -- GitHub Actions enabled on your code and documentation repositories -- [Mintlify GitHub App](/deploy/github) installed in both your code and documentation repositories +- GitHub Actions enabled on your code and documentation repositories +- [Mintlify GitHub App](/deploy/github) installed in both your code and documentation repositories - [Mintlify admin API key](https://dashboard.mintlify.com/settings/organization/api-keys) - [Mintlify project ID](https://dashboard.mintlify.com/settings/organization/api-keys) - [Mintlify Enterprise plan](https://mintlify.com/pricing) -- Admin access to the GitHub repositories for your code and documentation +- Admin access to the GitHub repositories for your code and documentation ### Install the Mintlify app on your code repository -The Mintlify app must be installed on your code repository so the agent can fetch context from your codebase. To add the app to new repositories: +The Mintlify app must be installed on your code repository so the agent can fetch context from your codebase. To add the app to new repositories: 1. Open the agent panel in your Mintlify dashboard. @@ -54,7 +54,7 @@ The Mintlify app must be installed on your code repository so the agent can fetc The settings button in dark mode. 1. Click **Add to New Organization**. This will take you to the app installation page on GitHub. -1. Select the repositories you want to grant access to from the list. +1. Select the repositories you want to grant access to from the list. 1. Save your changes. ### Get your admin API key @@ -67,7 +67,7 @@ The Mintlify app must be installed on your code repository so the agent can fetc ### Create the workflow file -1. In your code repository, create a new file: `.github/workflows/update-docs.yml` +1. In your code repository, create a new file: `.github/workflows/update-docs.yml` 2. Add this workflow: ```yaml @@ -155,7 +155,7 @@ The Mintlify app must be installed on your code repository so the agent can fetc ### Add secrets -1. In your code repository, go to **Settings** → **Secrets and variables** → **Actions**. +1. In your code repository, go to **Settings** → **Secrets and variables** → **Actions**. 2. Click **New repository secret**. 3. Add the following secrets: - Name: `MINTLIFY_API_KEY`, Secret: Your Mintlify admin API key @@ -165,21 +165,21 @@ For more information, see [Using secrets in GitHub Actions](https://docs.github. ## Test the automation -1. Make a small change in your code repository and push to main: +1. Make a small change in your code repository and push to main: ```bash git add . git commit -m "Test: trigger docs automation" git push origin main ``` -2. Check the **Actions** tab in your code repository to see the workflow running. +2. Check the **Actions** tab in your code repository to see the workflow running. -3. After the workflow runs, check your documentation repository for a new branch and pull request with documentation updates. +3. After the workflow runs, check your documentation repository for a new branch and pull request with documentation updates. ## Troubleshooting ### Workflow not running -- Verify GitHub Actions is enabled in your code repository. +- Verify GitHub Actions is enabled in your code repository. - Check the **Actions** tab for error messages. - Ensure the workflow file is in `.github/workflows/` with a `.yml` extension. @@ -189,8 +189,8 @@ For more information, see [Using secrets in GitHub Actions](https://docs.github. - Confirm the API key is for the correct Mintlify organization. ### No documentation updates appearing -- Check that the documentation repository is connected to your Mintlify project. -- Verify the agent has write access to the documentation repository. +- Check that the documentation repository is connected to your Mintlify project. +- Verify the agent has write access to the documentation repository. - Check the workflow logs for error messages from the agent. @@ -203,14 +203,14 @@ n8n provides a visual workflow editor and can integrate with multiple services. - n8n workspace - [Mintlify Enterprise plan](https://mintlify.com/pricing) -- Mintlify app installed on your code repository +- Mintlify app installed on your code repository - Mintlify admin API key -- Admin access to the GitHub repositories for your code and documentation +- Admin access to the GitHub repositories for your code and documentation - GitHub personal access token ### Install the Mintlify app on your code repository -The Mintlify app must be installed on your code repository so the agent can fetch context from your codebase. To add the app to new repositories: +The Mintlify app must be installed on your code repository so the agent can fetch context from your codebase. To add the app to new repositories: 1. Open the agent panel in your Mintlify dashboard. @@ -223,7 +223,7 @@ The Mintlify app must be installed on your code repository so the agent can fetc The settings button in dark mode. 1. Click **Add to New Organization**. This will take you to the app installation page on GitHub. -1. Select the repositories you want to grant access to from the list. +1. Select the repositories you want to grant access to from the list. 1. Save your changes. ### Get your admin API key @@ -240,7 +240,7 @@ The Mintlify app must be installed on your code repository so the agent can fetc 4. Click **Tokens (classic)**. 5. Click **Generate new token (classic)**. 6. Select these scopes: - - `repo` (full control of private repositories) + - `repo` (full control of private repositories) - `admin:repo_hook` (if you want n8n to create webhooks) 7. Generate and save the token securely. @@ -269,7 +269,7 @@ For more information, see [Creating a personal access token (classic)](https://d ### Set up the GitHub webhook -1. Navigate to your code repository on GitHub. +1. Navigate to your code repository on GitHub. 2. Click **Settings**. 3. Click **Webhooks**. 4. Click **Add webhook**. @@ -359,14 +359,14 @@ Add an HTTP request node to create a documentation job. }} /> -The agent creates a pull request in your documentation repository using a descriptive branch name that includes the source repository name and timestamp. +The agent creates a pull request in your documentation repository using a descriptive branch name that includes the source repository name and timestamp. ### Activate the workflow 1. Save your workflow. 2. Set it to active. -Your workflow is now monitoring your code repository for pushes to main. +Your workflow is now monitoring your code repository for pushes to main. Screenshot of the automation workflow in the n8n editor. @@ -374,7 +374,7 @@ Your workflow is now monitoring your code repository for pushes to main. ## Test the automation -1. Create a test branch in your code repository: +1. Create a test branch in your code repository: ```bash git checkout -b test-docs-automation ``` @@ -391,14 +391,14 @@ Your workflow is now monitoring your code repository for pushes to main. ### Verify the automation -You should see a new n8n execution with all nodes completed successfully, and a new branch and pull request in your documentation repository. +You should see a new n8n execution with all nodes completed successfully, and a new branch and pull request in your documentation repository. ## Troubleshooting ### Webhook not triggering - Verify the workflow is active in n8n. -- Check GitHub repository Settings → Webhooks → Recent Deliveries for the response code. +- Check GitHub repository Settings → Webhooks → Recent Deliveries for the response code. - Confirm the webhook URL matches your n8n webhook URL exactly. ### 401 error from agent API diff --git a/guides/branches.mdx b/guides/branches.mdx index 7b1b23aa7..1bccf9df9 100644 --- a/guides/branches.mdx +++ b/guides/branches.mdx @@ -4,7 +4,7 @@ description: "Create branches to preview changes and collaborate before publishi keywords: ["Git","branches","branch workflow","creating branches","deployment branch"] --- -Branches are a feature of version control that point to specific commits in your repository. Your deployment branch, usually called `main`, represents the content used to build your live documentation site. All other branches are independent of your live docs unless you choose to merge them into your deployment branch. +Branches are a feature of version control that point to specific commits in your repository. Your deployment branch, usually called `main`, represents the content used to build your live documentation site. All other branches are independent of your live docs unless you choose to merge them into your deployment branch. 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. diff --git a/guides/cursor.mdx b/guides/cursor.mdx index 68183932a..2cc33f64f 100644 --- a/guides/cursor.mdx +++ b/guides/cursor.mdx @@ -10,7 +10,7 @@ Transform Cursor into a documentation expert that knows your components, style g Cursor rules provide persistent context about your documentation, ensuring more consistent suggestions that fit your standards and style. -* **Project rules** are stored in your documentation repository and shared with your team. +* **Project rules** are stored in your documentation repository and shared with your team. * **User rules** apply to your personal Cursor environment. We recommend creating project rules for your docs so that all contributors have access to the same rules. diff --git a/guides/developer-documentation.mdx b/guides/developer-documentation.mdx index ffb7a5222..5619e8d81 100644 --- a/guides/developer-documentation.mdx +++ b/guides/developer-documentation.mdx @@ -19,7 +19,7 @@ Mintlify provides infrastructure built for developer documentation. If you haven't created a Mintlify project yet, see the [Quickstart](/quickstart) to deploy your site. - Your API specification in OpenAPI format (if documenting an API) -- A Git repository for your documentation +- A Git repository for your documentation - Admin access to your Mintlify organization ## Migrate existing documentation @@ -171,13 +171,13 @@ If you maintain multiple API versions, configure versioning so developers find d See [Versions](/organize/navigation#versions) for more information. -## Connect to your repository +## Connect to your repository Install the Mintlify [GitHub App](/deploy/github) to keep documentation in sync with your codebase and enable contributions. - Link your GitHub repository in the [dashboard](https://dashboard.mintlify.com). This enables automatic deployments when you push changes. + Link your GitHub repository in the [dashboard](https://dashboard.mintlify.com). This enables automatic deployments when you push changes. diff --git a/guides/git-concepts.mdx b/guides/git-concepts.mdx index 8f1794cce..647dfb7ee 100644 --- a/guides/git-concepts.mdx +++ b/guides/git-concepts.mdx @@ -53,12 +53,12 @@ If you're completely new to Git and version control, here's a path to get starte - A branch points to a specific commit in your repository. Your live documentation builds from a deployment branch. You can have any number of other branches with changes that are not yet published to your live documentation. If you want to incorporate the changes from a branch into your live documentation, you can merge the branch into your deployment branch through a pull request. + A branch points to a specific commit in your repository. Your live documentation builds from a deployment branch. You can have any number of other branches with changes that are not yet published to your live documentation. If you want to incorporate the changes from a branch into your live documentation, you can merge the branch into your deployment branch through a pull request. Use branches to work on changes without affecting your live documentation, safely experiment with new features, and get reviews before publishing. - Download a complete copy of a repository to your computer, including all files and full history. When you clone, you get everything needed to work locally. + Download a complete copy of a repository to your computer, including all files and full history. When you clone, you get everything needed to work locally. ```bash git clone https://github.com/your-org/your-repo @@ -80,7 +80,7 @@ If you're completely new to Git and version control, here's a path to get starte Combine changes from one branch into another. Usually done via pull request after review to incorporate feature work into your deployment branch. - Get the latest changes from the remote repository to your local copy. Keeps you up to date with other people's work. + Get the latest changes from the remote repository to your local copy. Keeps you up to date with other people's work. ```bash git pull @@ -90,17 +90,17 @@ If you're completely new to Git and version control, here's a path to get starte A way to propose merging your changes on a branch into your live documentation. Allows for review and discussion before changes go live. Commonly called a PR, and also called a merge request in GitLab. - Send your local commits to the remote repository. This makes your changes available to others and can trigger automatic deployments. + Send your local commits to the remote repository. This makes your changes available to others and can trigger automatic deployments. ```bash git push ``` - A version of your repository hosted on a server. Your local repository connects to a remote repository to push and pull changes. + A version of your repository hosted on a server. Your local repository connects to a remote repository to push and pull changes. - Your documentation's source code with all the files, and their history, that make up the pages of your documentation site. The web editor connects to your documentation repository to access and modify content. + Your documentation's source code with all the files, and their history, that make up the pages of your documentation site. The web editor connects to your documentation repository to access and modify content. Prepare specific changes to include in your next commit. Staging lets you organize changes into logical commits. @@ -113,14 +113,14 @@ If you're completely new to Git and version control, here's a path to get starte ## How the web editor uses Git -The web editor connects to your Git repository through the [GitHub App](/deploy/github) or [GitLab integration](/deploy/gitlab) and automates common Git operations. +The web editor connects to your Git repository through the [GitHub App](/deploy/github) or [GitLab integration](/deploy/gitlab) and automates common Git operations. When you: -- **Open a file**: The editor fetches the latest version from your repository, ensuring you're always working with up to date content. +- **Open a file**: The editor fetches the latest version from your repository, ensuring you're always working with up to date content. - **Make changes**: The editor tracks your changes as a draft that can become a commit when you're ready to save your work. - **Save changes**: The editor makes a commit with your changes, preserving your work in the project history. -- **Create a branch**: The editor creates a new branch in your repository that anyone with access to the repository can use to collaborate and review changes. +- **Create a branch**: The editor creates a new branch in your repository that anyone with access to the repository can use to collaborate and review changes. - **Publish on your deployment branch**: The editor commits and pushes directly to your deployment branch, which publishes your changes immediately. - **Publish on other branches**: The editor creates a pull request, which allows you to get feedback from others before merging your changes into your deployment branch. @@ -133,7 +133,7 @@ When you: 1. Open file in the [web editor](https://dashboard.mintlify.com/editor). 2. Make changes. 3. Click **Publish**. - 4. Changes appear in the repository and deploy automatically. + 4. Changes appear in the repository and deploy automatically. 1. Pull the latest changes: `git pull` @@ -196,6 +196,6 @@ Every team develops their own workflows and preferences, but these are some gene - **Write descriptive commit messages**: Be specific about what changed using active language. `Fix broken link in API docs` is more informative than `update page`. - **Use descriptive branch names**: Branch names should explain the purpose the branch. Use informative names like `update-api-reference` instead of generic names like `temp` or `my-branch`. - **Keep branches focused**: Keep the changes on a branch focused on a specific task or project. This makes reviews easier and reduces conflicts. -- **Delete branches after merging**: Delete branches when you no longer need them to keep your repository tidy. +- **Delete branches after merging**: Delete branches when you no longer need them to keep your repository tidy. - **Pull before you push**: Always pull the latest changes before pushing to avoid conflicts. The web editor does this automatically. - **Review your own changes first**: Check the diff before creating a pull request. \ No newline at end of file diff --git a/guides/knowledge-base.mdx b/guides/knowledge-base.mdx index e3ff3df5c..36ab32a31 100644 --- a/guides/knowledge-base.mdx +++ b/guides/knowledge-base.mdx @@ -53,7 +53,7 @@ Your navigation structure determines how people find content in your knowledge b Migrating is a good time to improve your structure. Consider whether your current organization actually works for your team, or if you can reorganize to make information easier to find. -Your `docs.json` file defines the navigation structure of your knowledge base. Create this file at the root of your project repository. +Your `docs.json` file defines the navigation structure of your knowledge base. Create this file at the root of your project repository. ```json { @@ -129,7 +129,7 @@ Move your exported content into a folder structure that matches the navigation s └── code-standards.mdx ``` - Place each article in its corresponding folder. The file path must match the path in your `docs.json`. For example, if `docs.json` references `"finance/expense-reports"`, the file should be `finance/expense-reports.mdx` in your project repository. + Place each article in its corresponding folder. The file path must match the path in your `docs.json`. For example, if `docs.json` references `"finance/expense-reports"`, the file should be `finance/expense-reports.mdx` in your project repository. @@ -166,7 +166,7 @@ Move your exported content into a folder structure that matches the navigation s If you have PDFs, videos, or other media, decide how to include them in your knowledge base. - **Embed videos**: Embed videos or link to hosted videos. - - **Link to PDFs**: Add PDFs to your project repository and link to them from relevant pages. + - **Link to PDFs**: Add PDFs to your project repository and link to them from relevant pages. - **Convert PDFs to Markdown**: If you want the content of a PDF to be a page, convert PDFs to Markdown. @@ -220,7 +220,7 @@ The agent uses the thread context to create documentation that captures the key ### Locally -Anyone with access to your knowledge base repository can work locally in their preferred editor and push changes to your repository. +Anyone with access to your knowledge base repository can work locally in their preferred editor and push changes to your repository. ## Establish maintenance workflows diff --git a/guides/windsurf.mdx b/guides/windsurf.mdx index 41b669a27..ebb7ff568 100644 --- a/guides/windsurf.mdx +++ b/guides/windsurf.mdx @@ -10,7 +10,7 @@ Transform Windsurf into a documentation expert that understands your style guide Windsurf's Cascade AI assistant can be tuned to write documentation according to your standards using Mintlify components. Workspace rules and memories provide persistent context about your project, ensuring more consistent suggestions from Cascade. -* **Workspace rules** are stored in your documentation repository and shared with your team. +* **Workspace rules** are stored in your documentation repository and shared with your team. * **Memories** provide individual context that builds up over time. We recommend setting up workspace rules for shared documentation standards. You can develop memories as you work, but since they are not shared, they will not be consistent across team members. diff --git a/installation.mdx b/installation.mdx index 32fa39b46..003df81ac 100644 --- a/installation.mdx +++ b/installation.mdx @@ -23,22 +23,22 @@ The CLI also has utilities for maintaining your documentation, including command - [Node.js](https://nodejs.org/en) v20.17.0+ (LTS versions recommended) installed - [Git](https://git-scm.com/downloads) installed -- Your documentation repository cloned locally +- Your documentation repository cloned locally -### Clone your repository +### Clone your repository 1. Go to the [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard. - 2. Note your repository location. It is one of these formats: - - `mintlify-community/docs-{org-name}-{id}` (Mintlify-hosted repository) - - `your-org/your-repo` (your own GitHub repository) + 2. Note your repository location. It is one of these formats: + - `mintlify-community/docs-{org-name}-{id}` (Mintlify-hosted repository) + - `your-org/your-repo` (your own GitHub repository) - Replace `your-org/your-repo` with your actual repository details from [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings). + Replace `your-org/your-repo` with your actual repository details from [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings). ```bash git clone https://github.com/your-org/your-repo @@ -51,7 +51,7 @@ The CLI also has utilities for maintaining your documentation, including command - You can clone your repository as a private or public repository. Public repositories are visible to anyone who navigates to the repository URL. Private repositories are only visible to people in your organization. + You can clone your repository as a private or public repository. Public repositories are visible to anyone who navigates to the repository URL. Private repositories are only visible to people in your organization. On the [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard, select **Clone as private** or **Clone as public**. diff --git a/integrations/privacy/osano.mdx b/integrations/privacy/osano.mdx index a04bb7a7f..c0287ff5f 100644 --- a/integrations/privacy/osano.mdx +++ b/integrations/privacy/osano.mdx @@ -4,11 +4,11 @@ description: "Manage cookie consent with Osano privacy platform." keywords: ["Osano integration", "cookie consent manager", "GDPR compliance"] --- -Add [Osano](https://www.osano.com/) cookie consent to your docs with a [custom JavaScript file](/customize/custom-scripts#custom-javascript) in your repository. +Add [Osano](https://www.osano.com/) cookie consent to your docs with a [custom JavaScript file](/customize/custom-scripts#custom-javascript) in your repository. ## Setup -Create an `osano.js` file in your docs repository with the following content: +Create an `osano.js` file in your docs repository with the following content: diff --git a/integrations/sdks/speakeasy.mdx b/integrations/sdks/speakeasy.mdx index a1c5e7f44..77e06c554 100644 --- a/integrations/sdks/speakeasy.mdx +++ b/integrations/sdks/speakeasy.mdx @@ -14,7 +14,7 @@ Autogenerated code snippets from Speakeasy SDKs can be integrated directly into To integrate Mintlify with Speakeasy, you'll need the following: - - A [Mintlify documentation repository](/quickstart#creating-the-repository). + - A [Mintlify documentation repository](/quickstart#creating-the-repository). - A Speakeasy-generated SDK with a configured [automated code sample URL](https://www.speakeasy.com/docs/code-samples/automated-code-sample-urls). ## Setting up the integration diff --git a/migration-services/enterprise.mdx b/migration-services/enterprise.mdx index 6b10b13d6..89c51dace 100644 --- a/migration-services/enterprise.mdx +++ b/migration-services/enterprise.mdx @@ -43,7 +43,7 @@ Submit any feedback on content, assets, or branding. We address all in-scope iss -We provide documentation and guidance for connecting your repository, setting up redirects, and configuring your custom domain. +We provide documentation and guidance for connecting your repository, setting up redirects, and configuring your custom domain. @@ -75,7 +75,7 @@ We work with vetted third-party vendors and conduct an internal quality audit be Once we deliver your migration, you'll need to complete the following steps to launch your documentation: -1. [Connect your GitHub repository and get setup](/quickstart#install-the-github-app). +1. [Connect your GitHub repository and get setup](/quickstart#install-the-github-app). 2. [Set up redirects, if required](/create/redirects). 3. [Configure your custom domain](/customize/custom-domain). 4. **Test before going live** - Before switching over from your old documentation: @@ -103,7 +103,7 @@ Yes. You have a 7-day feedback window after delivery to request changes to conte The migration transfers your content, but you'll need to: -- Connect your documentation repository to your Mintlify dashboard. +- Connect your documentation repository to your Mintlify dashboard. - Set up redirects from your old documentation URLs. - Configure your custom domain. diff --git a/migration-services/pro.mdx b/migration-services/pro.mdx index 74d4f9cee..3f60827e7 100644 --- a/migration-services/pro.mdx +++ b/migration-services/pro.mdx @@ -46,7 +46,7 @@ Migration services **do not** include: - We provide documentation and guidance for connecting your repository, setting up redirects, and configuring your custom domain. + We provide documentation and guidance for connecting your repository, setting up redirects, and configuring your custom domain. @@ -78,7 +78,7 @@ We work with vetted third-party vendors and conduct an internal quality audit be Once we deliver your migration, you'll need to complete the following steps to launch your documentation: -1. [Connect your GitHub repository and get setup](https://www.mintlify.com/docs/quickstart#install-the-github-app). +1. [Connect your GitHub repository and get setup](https://www.mintlify.com/docs/quickstart#install-the-github-app). 2. [Set up redirects if required](https://www.mintlify.com/docs/create/redirects). 3. [Configure your custom domain](https://www.mintlify.com/docs/customize/custom-domain). 4. **Test before going live** - Before switching over from your old documentation: @@ -106,7 +106,7 @@ Once we deliver your migration, you'll need to complete the following steps to l The migration transfers your content, but you'll need to: - - Connect your documentation repository to your Mintlify dashboard. + - Connect your documentation repository to your Mintlify dashboard. - Set up redirects from your old documentation URLs. - Configure your custom domain. diff --git a/migration.mdx b/migration.mdx index 558943b73..174e7e7f5 100644 --- a/migration.mdx +++ b/migration.mdx @@ -137,7 +137,7 @@ mintlify-scrape openapi-file [openApiFilename] After scraping your existing documentation platform, you are ready to build your docs on Mintlify. -Confirm that all of your pages have been migrated then add these files to the documentation repository that you created during the onboarding process. This is usually a GitHub repository. +Confirm that all of your pages have been migrated then add these files to the documentation repository that you created during the onboarding process. This is usually a GitHub repository. @@ -161,7 +161,7 @@ To migrate your content to Mintlify, you will need: ### Asset migration -1. Copy assets to your repository's `images/` directory. +1. Copy assets to your repository's `images/` directory. 2. Update references in your Markdown files: ```mdx ![Alt text](/images/screenshot.png) diff --git a/organize/mintignore.mdx b/organize/mintignore.mdx index 83792f4f7..8be2fcc01 100644 --- a/organize/mintignore.mdx +++ b/organize/mintignore.mdx @@ -5,9 +5,9 @@ description: "Exclude specific files and directories from your published documen keywords: ["exclude", "ignore", "gitignore", "drafts", "private"] --- -The `.mintignore` file allows you to exclude specific files and directories in your documentation repository from being processed and published to your documentation site. +The `.mintignore` file allows you to exclude specific files and directories in your documentation repository from being processed and published to your documentation site. -Use `.mintignore` to keep drafts, internal notes, and source files out of your public documentation while maintaining them in your repository. +Use `.mintignore` to keep drafts, internal notes, and source files out of your public documentation while maintaining them in your repository. ## Create a .mintignore file diff --git a/organize/navigation.mdx b/organize/navigation.mdx index 76f6e5c3a..43c3fd7fc 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -12,7 +12,7 @@ Choose one primary organizational pattern at the root level of your navigation. ## Pages -Pages are the most fundamental navigation component. Each page is an MDX file in your documentation repository. +Pages are the most fundamental navigation component. Each page is an MDX file in your documentation repository. - Optional link type. Omit for a standard text link. Set to `github` to link to a GitHub repository and display the repository's star count. Set to `discord` to link to a Discord server and display the number of online users in the server. + Optional link type. Omit for a standard text link. Set to `github` to link to a GitHub repository and display the repository's star count. Set to `discord` to link to a Discord server and display the number of online users in the server. - Text for the link. Required when `type` is not set. Optional for `github` and `discord` types. When omitted, the label is automatically populated from API data (repository name for GitHub and server name for Discord). + Text for the link. Required when `type` is not set. Optional for `github` and `discord` types. When omitted, the label is automatically populated from API data (repository name for GitHub and server name for Discord). - Link destination. Must be a valid external URL. For `github` type, must be a GitHub repository URL. For `discord` type, must be a Discord invite URL. + Link destination. Must be a valid external URL. For `github` type, must be a GitHub repository URL. For `discord` type, must be a Discord invite URL. @@ -374,13 +374,13 @@ This section contains the full reference for the `docs.json` file. - Button style. Choose `button` for a standard button with a label, `github` for a link to a GitHub repository with live star count, or `discord` for a Discord server invite with live online user count. + Button style. Choose `button` for a standard button with a label, `github` for a link to a GitHub repository with live star count, or `discord` for a Discord server invite with live online user count. - Button text. Required when `type` is `button`. Optional for `github` and `discord` types—when omitted, the label is automatically populated from API data (repository name for GitHub, server name for Discord). + Button text. Required when `type` is `button`. Optional for `github` and `discord` types—when omitted, the label is automatically populated from API data (repository name for GitHub, server name for Discord). - Button destination. Must be an external URL. If `type` is `github`, must be a GitHub repository URL. If `type` is `discord`, must be a Discord invite URL. + Button destination. Must be an external URL. If `type` is `github`, must be a GitHub repository URL. If `type` is `discord`, must be a Discord invite URL. diff --git a/quickstart.mdx b/quickstart.mdx index 87b02debf..98b28351b 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -8,9 +8,9 @@ After you complete this guide, you'll have a live documentation site ready to cu ## Before you begin -Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation repository. +Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation repository. -When you connect your documentation repository to your project, you can work on your documentation locally or in the web editor and sync any changes to your remote repository. +When you connect your documentation repository to your project, you can work on your documentation locally or in the web editor and sync any changes to your remote repository. Using an AI tool to help maintain your documentation? @@ -22,15 +22,15 @@ When you connect your documentation repository to your project, you can work on ## Deploy your documentation site -Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments. +Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments. After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL. - If you want to get started quickly without connecting your own repository, you can skip the GitHub connection during onboarding. Mintlify creates a private repository in a private organization and automatically configures the GitHub App for you. + If you want to get started quickly without connecting your own repository, you can skip the GitHub connection during onboarding. Mintlify creates a private repository in a private organization and automatically configures the GitHub App for you. - This lets you use the web editor immediately and migrate to your own repository later. + This lets you use the web editor immediately and migrate to your own repository later. @@ -82,7 +82,7 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa See [Install the CLI](/installation) for full details and troubleshooting. - If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/installation#clone-your-repository). + If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/installation#clone-your-repository). Open `index.mdx` in your preferred editor and update the description in the frontmatter: