From 514c6a87d9833931e204564142dd09e693b86f8b Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 17 Mar 2025 16:10:55 +0000 Subject: [PATCH] Documentation edits made through Mintlify web editor --- advanced/dashboard/permissions.mdx | 10 ++- advanced/mcp/quickstart.mdx | 29 +++--- advanced/rest-api/overview.mdx | 28 +++--- development.mdx | 53 +++++------ docs.json | 26 ++++-- settings/github.mdx | 34 +++---- settings/seo.mdx | 56 ++++++------ web-editor.mdx | 139 ++++++++++++++--------------- 8 files changed, 194 insertions(+), 181 deletions(-) diff --git a/advanced/dashboard/permissions.mdx b/advanced/dashboard/permissions.mdx index d39d099a..7ccdacf6 100644 --- a/advanced/dashboard/permissions.mdx +++ b/advanced/dashboard/permissions.mdx @@ -3,14 +3,16 @@ title: 'Editor Permissions' description: 'Allow more members of your team to update your docs' --- -The team member who created your initial docs will have update access to your docs, as long as they push to your documentation repo with the same GitHub account that was used while signing up for Mintlify. +The team member who created your initial docs will have update access to your documentation, as long as they push to your documentation repository with the same GitHub account that was used while signing up for Mintlify. -If another editor attempts to update the docs while on the free plan, you will see a warning in your git commit check. +If another editor attempts to update the docs while on the free plan, you will see a warning in your Git commit check. -In the details of the git check warning, you'll find the link to upgrade your plan. You can also upgrade your plan on the [dashboard](https://dashboard.mintlify.com) to enable unlimited editors to update your docs. Once you upgrade your plan, trigger a manual update or push another change to deploy your updates. +In the details of the Git check warning, you'll find the link to upgrade your plan. You can also upgrade your plan on the [dashboard](https://dashboard.mintlify.com) to enable unlimited editors to update your docs. -Learn more about our pricing [here](https://mintlify.com/pricing). +Once you upgrade your plan, trigger a manual update or push another change to deploy your updates. + +Learn more about our pricing [here](https://mintlify.com/pricing). \ No newline at end of file diff --git a/advanced/mcp/quickstart.mdx b/advanced/mcp/quickstart.mdx index 45516030..52e6aad6 100644 --- a/advanced/mcp/quickstart.mdx +++ b/advanced/mcp/quickstart.mdx @@ -5,28 +5,29 @@ description: "[MCP](https://modelcontextprotocol.io/introduction) simplifies how ## Introduction -The MCP Generator is a CLI tool that generates an MCP server based on your company's documentation & OpenAPI specification if available. It takes in your documentation and a OpenAPI spec and outputs an MCP server that can be used with any MCP client. The MCP Generator is delivered via [npm package](https://www.npmjs.com/package/mcp) and generates an MCP server that can be used with any MCP client. +The MCP Generator is a CLI tool that generates an MCP server based on your company's documentation and OpenAPI specification (if available). It takes in your documentation and OpenAPI spec and outputs an MCP server that can be used with any MCP client. The MCP Generator is delivered via [npm package](https://www.npmjs.com/package/mcp). Mintlify enables you to create an MCP server that allows AI tools to interact with your docs in these key scenarios: 1. **Docs Q&A**, similar to our AI Chat. This is automatically enabled for your docs, no setup required. 2. **Real-time API querying**, if you have an OpenAPI spec, head to the `Mintlify Dashboard > Products > MCP Server` and hit the toggle to enable your OpenAPI spec. - - By enabling the OpenAPI toggle, you are allowing the MCP server to access - **all** endpoints in your OpenAPI spec. - -## Install the MCP server + + By enabling the OpenAPI toggle, you are allowing the MCP server to access + **all** endpoints in your OpenAPI spec. + + +## Install the MCP Server - This page is dedicated to the Mintlify MCP Server. If you are looking for information on generating your MCP, please refer to the [MCP Generator](/advanced/mcp/generate) page. + This page is dedicated to the Mintlify MCP Server. If you are looking for information on generating your MCP, please refer to the [MCP Generator](/advanced/mcp/generate) page. -## Example installation with the Mintlify MCP server +## Example Installation with the Mintlify MCP Server -To use the Mintlify MCP server you will need an [API key](https://mintlify.com/docs/advanced/rest-api/overview#authentication) from your Mintlify account. If you don't have one, navigate to `Settings > API Keys > Chat API Key` and create a new key. +To use the Mintlify MCP server, you will need an [API key](https://mintlify.com/docs/advanced/rest-api/overview#authentication) from your Mintlify account. If you don't have one, navigate to `Settings > API Keys > Chat API Key` and create a new key. -## Start the MCP server locally +## Start the MCP Server Locally @@ -41,7 +42,6 @@ To use the Mintlify MCP server you will need an [API key](https://mintlify.com/d > What is the Authorization (basic token)? ``` Using your API chat key, copy the authentication token and paste it into the CLI. - You can now run: @@ -51,7 +51,7 @@ To use the Mintlify MCP server you will need an [API key](https://mintlify.com/d -## Use your server with Claude +## Use Your Server with Claude Download the [Claude Desktop App](https://claude.ai/download) @@ -60,7 +60,7 @@ To use the Mintlify MCP server you will need an [API key](https://mintlify.com/d Once you have the Claude Desktop App installed, follow these steps: - + Add the following to the `claude_desktop_config.json`: ```json @@ -84,5 +84,4 @@ Once you have the Claude Desktop App installed, follow these steps: Claude MCP - - + \ No newline at end of file diff --git a/advanced/rest-api/overview.mdx b/advanced/rest-api/overview.mdx index c1f39943..5da6525d 100644 --- a/advanced/rest-api/overview.mdx +++ b/advanced/rest-api/overview.mdx @@ -7,36 +7,38 @@ title: Overview You can leverage the REST API to programmatically trigger an update when desired. - While the primary use-case will be to trigger updates, we will be adding more and more - functionality to the API overtime. Let us know what else you want to see in + While the primary use case will be to trigger updates, we will be adding more functionality + to the API over time. Let us know what else you want to see in [our community](https://mintlify.com/community)! ## Authentication -You can generate an API key through -[the dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). The API key is -associated with the entire org and can be used across multiple deployments. +You can generate an API key through +[the dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). The API key is +associated with the entire organization and can be used across multiple deployments. -## Admin API key +## Admin API Key -The Admin API key is used for the majority of the API. It is used to trigger updates via the [Update endpoint](/advanced/rest-api/update/trigger). +The Admin API key is used for the majority of the API endpoints. It is primarily used to trigger +updates via the [Update endpoint](/advanced/rest-api/update/trigger). -## Chat API key +## Chat API Key -The Chat API allows you to embed the AI chat experience grounded in your docs and continually kept up to date into any application of your choosing. +The Chat API allows you to embed an AI chat experience into any application of your choosing. +This chat is grounded in your documentation and is continually kept up to date. Responses include citations so you can point your users to the right places they need to get help. - The Chat API token is a public token that can be referenced in your - frontend code whereas the API key is a server-side token that should be kept + The Chat API token is a public token that can be referenced in your + frontend code, whereas the Admin API key is a server-side token that should be kept secret. -Now that you have an API key, check out our [example](https://github.com/mintlify/discovery-api-example) for how to use -the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com). +Now that you have an API key, check out our [example repository](https://github.com/mintlify/discovery-api-example) for how to use +the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com). \ No newline at end of file diff --git a/development.mdx b/development.mdx index 9358c1ff..4a68c2e1 100644 --- a/development.mdx +++ b/development.mdx @@ -4,15 +4,14 @@ description: 'Preview changes locally to update your docs' --- - **Prerequisite**: Please install Node.js (version 19 or higher) before proceeding. - +## Installation + **Step 1**: Install the Mintlify CLI: - ```bash npm npm i -g mintlify ``` @@ -24,7 +23,6 @@ description: 'Preview changes locally to update your docs' ```bash pnpm pnpm add -g mintlify ``` - **Step 2**: Navigate to the docs directory (where the `docs.json` file is located) and execute the following command: @@ -33,7 +31,7 @@ description: 'Preview changes locally to update your docs' mintlify dev ``` -Alternatively, if you do not want to install the CLI globally you can use a run script available: +If you prefer not to install the CLI globally, you can use one of these run scripts instead: ```bash npm @@ -47,35 +45,33 @@ Alternatively, if you do not want to install the CLI globally you can use a run ```bash pnpm pnpm dlx mintlify dev ``` - - Yarn's "dlx" run script requires yarn version >2. See [here](https://yarnpkg.com/cli/dlx) for more information. + Yarn's "dlx" run script requires Yarn version 2 or higher. For more information, see the [Yarn documentation](https://yarnpkg.com/cli/dlx). -A local preview of your documentation will be available at `http://localhost:3000`. +Once started, a local preview of your documentation will be available at `http://localhost:3000`. -### Custom Ports +## Custom Ports -By default, Mintlify uses port 3000. You can customize the port using the `--port` flag. To run Mintlify on port 3333, for instance, use this command: +By default, Mintlify uses port 3000. You can customize the port using the `--port` flag. For example, to run Mintlify on port 3333, use this command: ```bash mintlify dev --port 3333 ``` -If you attempt to run on a port that's already in use, it will use the next available port: +If you attempt to run Mintlify on a port that's already in use, it will automatically select the next available port: ```md Port 3000 is already in use. Trying 3001 instead. ``` -## Versions +## Version Management -Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, please update the CLI: +Each CLI release corresponds to a specific version of Mintlify. If your local preview doesn't match the production version, update the CLI using one of these commands: - ```bash npm npm i -g mintlify@latest ``` @@ -87,12 +83,11 @@ Please note that each CLI release is associated with a specific version of Mintl ```bash pnpm pnpm up --global mintlify ``` - -## Validating Links +## Link Validation -The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command: +The CLI includes a tool to help validate reference links in your documentation. To check for broken links, use: ```bash mintlify broken-links @@ -100,7 +95,7 @@ mintlify broken-links ## Deployment -If the deployment is successful, you should see the following: +After a successful deployment, you should see a confirmation screen similar to this: + This error typically occurs with outdated Node.js versions. To resolve: - This may be due to an outdated version of node. Try the following: - 1. Remove the currently-installed version of mintlify: `npm remove -g mintlify` - 2. Upgrade to Node v19 or higher. - 3. Reinstall mintlify: `npm install -g mintlify` + 1. Remove the current Mintlify installation: `npm remove -g mintlify` + 2. Upgrade to Node.js v19 or higher + 3. Reinstall Mintlify: `npm install -g mintlify` - - Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again. + If you encounter an unknown error, try these steps: + + 1. Navigate to the root of your device + 2. Delete the ~/.mintlify folder + 3. Run `mintlify dev` again - + \ No newline at end of file diff --git a/docs.json b/docs.json index edd11836..b4bdbca4 100644 --- a/docs.json +++ b/docs.json @@ -22,7 +22,11 @@ { "group": "Editing", "icon": "pen-paintbrush", - "pages": ["development", "web-editor"] + "pages": [ + "development", + "web-editor", + "web-editor" + ] }, "settings/global", { @@ -37,7 +41,9 @@ ] }, "themes", - "migration" + "migration", + "development", + "settings/seo" ] }, { @@ -85,7 +91,8 @@ "settings/github", "settings/gitlab", "settings/ci", - "settings/preview-deployments" + "settings/preview-deployments", + "settings/github" ] }, { @@ -135,6 +142,7 @@ "icon": "house-lock", "pages": [ "advanced/dashboard/sso", + "advanced/dashboard/permissions", "advanced/dashboard/permissions" ] }, @@ -143,7 +151,8 @@ "icon": "server", "pages": [ "advanced/mcp/quickstart", - "advanced/mcp/generate" + "advanced/mcp/generate", + "advanced/mcp/quickstart" ] }, { @@ -164,7 +173,8 @@ "advanced/rest-api/chat/create-topic", "advanced/rest-api/chat/generate-message" ] - } + }, + "advanced/rest-api/overview" ] } ] @@ -262,7 +272,9 @@ "groups": [ { "group": "Changelog", - "pages": ["changelog/overview"] + "pages": [ + "changelog/overview" + ] } ] } @@ -374,4 +386,4 @@ "publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8" } } -} +} \ No newline at end of file diff --git a/settings/github.mdx b/settings/github.mdx index 310499c0..d3111d38 100644 --- a/settings/github.mdx +++ b/settings/github.mdx @@ -15,11 +15,12 @@ To begin, you need to install the Mintlify GitHub App into the GitHub account where your docs repo resides. Installing a GitHub App requires either organization ownership or admin permissions in a repository. If you lack the necessary permissions, the repository owner will need to approve the request. + You can access the installation page by logging into the [Mintlify dashboard](https://dashboard.mintlify.com). -For GitHub Apps, you can choose to only give permissions to a single repository. -We highly recommend you do so as we only need access to the repository where +For GitHub Apps, you can choose to give permissions to a single repository. +We highly recommend this approach as we only need access to the repository where your docs are hosted. @@ -28,7 +29,7 @@ your docs are hosted. ## Permissions -During the installation of our GitHub app, you will be prompted to grant certain +During the installation of our GitHub App, you will be prompted to grant certain permissions: - Read and write access to `checks`, `contents`, `deployments`, `pull requests`, @@ -37,26 +38,25 @@ permissions: These permissions are leveraged to provide a seamless experience when managing your docs. -When you make a commit to the branch you configured as your docs deployment -branch, we fetch the contents of the files changed to update your docs. To -accomplish this we need read access to your `contents`. +When you make a commit to your configured docs deployment branch, we fetch the +contents of the changed files to update your docs. This requires read access +to your repository's `contents`. -When pull requests are created we create a check and preview deployment which is -why we need write access to `checks` and `deployments`. +When Pull Requests are created, we create a check and preview deployment. This +requires write access to `checks` and `deployments`. Inside the Mintlify web editor, Mintlify works on your behalf to create branches -and pull requests which is why we need write access to `pull requests` and -`workflows`. +and Pull Requests, which requires write access to `pull requests` and `workflows`. If you are concerned about the write permissions, the GitHub App will only - have access to the repos you give it access to _and_ if you have branch - protections on it _cannot_ push directly to your branches - it abides by your - branch protection rules. + have access to the repositories you explicitly grant access to. Additionally, + if you have branch protections enabled, the App cannot push directly to your + branches—it must abide by your branch protection rules. -## Repositories Installations +## Repository Installations -When installing our GitHub app, you will be prompted to select all repositories -or a subset of them. This selection can be changed at any time by going to the -[GitHub app settings](https://github.com/apps/mintlify/installations/new). +When installing our GitHub App, you will be prompted to select either all repositories +or a specific subset. You can modify this selection at any time by visiting the +[GitHub App settings](https://github.com/apps/mintlify/installations/new). \ No newline at end of file diff --git a/settings/seo.mdx b/settings/seo.mdx index bd115d08..a489c207 100644 --- a/settings/seo.mdx +++ b/settings/seo.mdx @@ -6,26 +6,26 @@ icon: 'magnifying-glass' -- og:site_name -- og:title -- og:description -- og:url -- og:image -- og:locale -- og:logo -- article:publisher -- twitter:title -- twitter:description -- twitter:url -- twitter:image -- twitter:site -- og:image:width -- og:image:height -- robots +- `og:site_name` +- `og:title` +- `og:description` +- `og:url` +- `og:image` +- `og:locale` +- `og:logo` +- `article:publisher` +- `twitter:title` +- `twitter:description` +- `twitter:url` +- `twitter:image` +- `twitter:site` +- `og:image:width` +- `og:image:height` +- `robots` -## Default meta tags +## Default Meta Tags You can set default meta tags by adding the `metadata` field to your `docs.json`. @@ -37,9 +37,9 @@ You can set default meta tags by adding the `metadata` field to your `docs.json` } ``` -## Changing meta tags on one page +## Changing Meta Tags on One Page -Add your meta tags to the page's metadata like so: +Add your meta tags to the page's metadata as follows: ```md --- @@ -49,32 +49,32 @@ title: 'Your Example Page Title' ``` - Meta tags with colons need to be typed with quotes around them when you put them in the page metadata. - ## Sitemaps -Mintlify automatically generates a `sitemap.xml` file and a `robots.txt` file. Simply add `/sitemap.xml` to the end of your website URL to see your sitemap. We recommend submitting the sitemap to search engines for improved SEO. +Mintlify automatically generates a `sitemap.xml` file and a `robots.txt` file. To view your sitemap, simply add `/sitemap.xml` to the end of your website URL. We recommend submitting the sitemap to search engines for improved SEO performance. -Only pages included in your `docs.json` are included by default. To include hidden links, add `seo.indexing` to your `docs.json`: +By default, only pages included in your `docs.json` are included in the sitemap. To include hidden links, add `seo.indexing` to your `docs.json`: ```json "seo": { - "indexing": all + "indexing": "all" } ``` -## Disabling indexing -If you want to stop a page from being indexed by search engines, you can include the following in the [frontmatter](/page) of your page: -``` +## Disabling Indexing + +If you want to prevent a page from being indexed by search engines, you can include the following in the [frontmatter](/page) of your page: + +```md --- noindex: true --- ``` -You can also specify `noindex` for all pages in your docs by setting the `metadata.robots` field to `"noindex"` in your `docs.json`: +You can also specify `noindex` for all pages in your documentation by setting the `metadata.robots` field to `"noindex"` in your `docs.json`: ```json "metadata": { diff --git a/web-editor.mdx b/web-editor.mdx index b8875767..86378950 100644 --- a/web-editor.mdx +++ b/web-editor.mdx @@ -5,20 +5,20 @@ description: 'Edit your docs directly from the dashboard with live previews.' Web Editor is the preferred way to edit docs directly without having to open your IDE or run `mintlify dev`. -The editor includes a few key features to integrate directly into your existing git workflow, -like creating branches, pull requests, commits, and diffs for your current changes. +The editor includes key features to integrate directly into your existing Git workflow, +like creating branches, Pull Requests, commits, and diffs for your current changes. It also includes a fully editable experience for changing and adding content directly, even with custom components. -If you understand git workflows and our integrations already, you can skip to [here](#editing-content). +If you understand Git workflows and our integrations already, you can skip to [here](#editing-content). -## Git and update workflows +## Git and Update Workflows -### Git basics +### Git Basics While Web Editor means you don't need to go to GitHub or your command line to make -changes, it's still helpful to know the basics of git. +changes, it's still helpful to know the basics of Git. Git terminology: @@ -28,23 +28,23 @@ Git terminology: * **Branch**: A separate line of development. It's a working copy of the code that allows you to work on changes without affecting the main version. -* **Pull request:** A request to merge changes from a working branch into the main branch. This is used for reviewing content before making changes live. +* **Pull Request**: A request to merge changes from a working branch into the main branch. This is used for reviewing content before making changes live. -### Making updates +### Making Updates -In order to make updates to your docs, we include a few buttons specifically to -integrate with your git workflow. +In order to make updates to your docs, we include several buttons specifically to +integrate with your Git workflow. If you haven't done so already, please install the Mintlify GitHub app to your GitHub account. You can find [documentation here](#1-deploying-your-docs-repository), or you can install the app in the [GitHub App page](https://dashboard.mintlify.com/settings/organization/github-app) - page of the dashboard. + of the dashboard. - - In order to make changes to your docs, you might want to change from the main branch + + To make changes to your docs, you might want to change from the main branch to avoid publishing directly to your main docs site. To do this, you can open the branches modal on the top left of the editor. @@ -55,7 +55,7 @@ integrate with your git workflow. - From here, you can either switch to a different git branch than `main`, or you can + From here, you can either switch to a different Git branch than `main`, or you can create a new branch by clicking the **"New Branch"** button. @@ -70,19 +70,19 @@ integrate with your git workflow. By default, when you load the page again, you'll default to the main branch. - As a best practice, you should always create a new branch to make changes so you can submit a pull request for review by other teammates. You also may not have permissions to make changes to the main branch, in which case we'll try to open a pull request for you. + As a best practice, you should always create a new branch to make changes so you can submit a Pull Request for review by other teammates. You also may not have permissions to make changes to the main branch, in which case we'll try to open a Pull Request for you. - - In order to make a commit, you have two options, both of which appear on the top + + To make a commit, you have two options, both of which appear on the top right of the editor: - + If you're on the main branch of your docs repository, you can push a commit directly to the repo by clicking the **"Publish"** button. You'll see your changes - reflect in your git branch the next time you run `git pull`. + reflect in your Git branch the next time you run `git pull`. @@ -91,9 +91,9 @@ integrate with your git workflow. - + If you're not on the main branch, you can push a commit to your branch by clicking - on the **"Save Changes"** button. If you're ready to publish a pull request to put your branch + on the **"Save Changes"** button. If you're ready to publish a Pull Request to put your branch up for review, you can click the **"Publish Pull Request"** button. @@ -104,14 +104,13 @@ integrate with your git workflow. - This will create the pull request for you on GitHub using the branch you selected onto + This will create the Pull Request for you on GitHub using the branch you selected onto your main branch. - - If you do put your pull request up for review, you can edit the title and description - of the PR, but a default Mintlify title will be provided for you if you leave it - empty. + + When you submit your changes for review, you can edit the title and description + of the Pull Request. If you leave these fields empty, a default Mintlify title will be provided. @@ -121,11 +120,11 @@ integrate with your git workflow. -## Editing content +## Editing Content -### Slash commands +### Slash Commands -The easiest way to add content in the editor is by using **"Slash commands"**, which are +The easiest way to add content in the editor is by using **"Slash Commands"**, which are commands you have access to after typing `/` in the **"Visual Editor"** mode: @@ -134,20 +133,20 @@ commands you have access to after typing `/` in the **"Visual Editor"** mode: -As you type, you'll see more options pop up: +As you type, you'll see more options appear: - + -#### Content blocks +#### Content Blocks Here are the types of content blocks available to add in the **"Visual Editor"**: - + Paragraph Headings @@ -159,7 +158,7 @@ Here are the types of content blocks available to add in the **"Visual Editor"** - + Callouts Accordions @@ -176,13 +175,13 @@ Here are the types of content blocks available to add in the **"Visual Editor"** -### Adding images +### Adding Images You can add images to your page by typing `/image` and either clicking on the **"Image"** option or hitting ↓ + Enter on the **"Image"** option. This will open up the image modal where you have the option to either upload a new -image or use an existing image from the repo. +image or use an existing image from the repository. @@ -190,7 +189,7 @@ image or use an existing image from the repo. -Uploading an image can be done through the modal: +You can upload an image through the modal: @@ -198,7 +197,7 @@ Uploading an image can be done through the modal: -And you can preview an existing image before you add it. +You can also preview an existing image before adding it. @@ -206,11 +205,10 @@ And you can preview an existing image before you add it. -### Editing images - -In order to edit images, you just have to hover over the image to see the **"Delete"** -and **"Edit"** buttons on the top right of the image. +### Editing Images +To edit images, hover over the image to see the **"Delete"** and **"Edit"** buttons +on the top right of the image. @@ -218,7 +216,7 @@ and **"Edit"** buttons on the top right of the image. -Clicking the **"Edit"** button lets you edit the attributes of the image. +Clicking the **"Edit"** button lets you modify the attributes of the image. @@ -226,15 +224,14 @@ Clicking the **"Edit"** button lets you edit the attributes of the image. -If you want to update the source of an image to be a new image that you haven't yet -uploaded, you have to first delete the image you're changing, and then add a new one -using the [instructions above](#adding-images). +To update the source of an image to a new image that you haven't yet uploaded, +first delete the existing image, then add a new one using the [instructions above](#adding-images). -## Editor modes +## Editor Modes -In order to offer the most flexibility, the editor has three modes: +To offer maximum flexibility, the editor has three modes: - + @@ -243,53 +240,53 @@ In order to offer the most flexibility, the editor has three modes: ### Visual Editor The **"Visual Editor"** is the typical WYSIWYG mode you'd see in something like Notion. -It offers you a view into your docs in a fully editable way that reflects what the final -page would look like on your main docs site. +It provides a fully editable view of your docs that reflects what the final +page will look like on your main docs site. ### Source Editor -The **"Source Editor"** offers you a way to edit your MDX files in code, the same way -you'd do in your IDE. This offers less flexibility, in that our components aren't available -for auto-complete, but it does have two unique advantages. +The **"Source Editor"** allows you to edit your MDX files in code, similar to how +you would in your IDE. While it offers less flexibility, as our components aren't available +for auto-complete, it has two unique advantages: -1. It allows you to edit props of components (see our [limitations below](#current-limitations)) - which is currently not available in **"Visual Editor"** mode yet. +1. It allows you to edit component props (see our [limitations below](#current-limitations)), + which is currently not available in **"Visual Editor"** mode. -2. It allows you to correct syntax errors which might've appeared in your repo that - might not be compatible with **"Visual Editor"** mode until you've fixed them. +2. It allows you to correct syntax errors that might have appeared in your repository + that might not be compatible with **"Visual Editor"** mode until fixed. ### Diff View -The **"Diff View"** is a way to view the changes made to a specific document before +The **"Diff View"** allows you to review changes made to a specific document before committing it to your repository. -This will help you see changes you've made along with formatting changes made by +This helps you see both your changes and any formatting changes made by the editor. -## Current limitations +## Current Limitations -We do have a few current limitations in the editor that we're working to resolve. +We currently have a few limitations in the editor that we're working to resolve. - - You currently cannot live-update your navigation based on added/edited files. You - still have to manually edit renamed, added, and deleted files in your `docs.json` + + You cannot currently live-update your navigation based on added/edited files. You + still need to manually edit renamed, added, and deleted files in your `docs.json` - - We currently don't show any previews for custom snippets. This is on our roadmap to support + + We currently don't show previews for custom snippets. This is on our roadmap to support as fully editable components. - - We currently don't show any previews for OpenAPI specs. This is on our roadmap to support + + We currently don't show previews for OpenAPI specs. This is on our roadmap to support as a read-only preview. ## Feedback -If you have any bug reports, feature requests, or other general feedback, we'd love to hear -where we can improve. +We welcome any bug reports, feature requests, or other general feedback. We'd love to hear +how we can improve. Email us at [support@mintlify.com](mailto:support@mintlify.com) \ No newline at end of file