Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Grammar and Spelling Across Documentation #574

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions advanced/dashboard/permissions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Frame>
<img className="rounded-md" src="/images/editor-gate.png" />
</Frame>

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).
29 changes: 14 additions & 15 deletions advanced/mcp/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,34 +5,35 @@

## 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.
<Note>
By enabling the OpenAPI toggle, you are allowing the MCP server to access
**all** endpoints in your OpenAPI spec.
</Note>

## Install the MCP server
<Note>
By enabling the OpenAPI toggle, you are allowing the MCP server to access
**all** endpoints in your OpenAPI spec.
</Note>

## Install the MCP Server

<Tip>
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.
</Tip>

## 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

<Steps>
<Step title="Install the server through the CLI">
Run the following command to install the server:
```bash
npx mcp add mintlify

Check warning on line 36 in advanced/mcp/quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/mcp/quickstart.mdx#L36

Did you really mean 'npx'?

Check warning on line 36 in advanced/mcp/quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/mcp/quickstart.mdx#L36

Did you really mean 'mcp'?
```
</Step>
<Step title="Add the authentication token">
Expand All @@ -41,7 +42,6 @@
> What is the Authorization (basic token)?
```
Using your API chat key, copy the authentication token and paste it into the CLI.

</Step>
<Step title="Start your MCP server">
You can now run:
Expand All @@ -51,7 +51,7 @@
</Step>
</Steps>

## Use your server with Claude
## Use Your Server with Claude

<Note>
Download the [Claude Desktop App](https://claude.ai/download)
Expand All @@ -60,12 +60,12 @@
Once you have the Claude Desktop App installed, follow these steps:

<Steps>
<Step title="Navigate to the Settings > Developer" />
<Step title="Navigate to Settings > Developer" />
<Step title="Click on Edit Config">
Add the following to the `claude_desktop_config.json`:
```json
{
"mcpServers": {

Check warning on line 68 in advanced/mcp/quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/mcp/quickstart.mdx#L68

Did you really mean 'mcpServers'?
"mintlify": {
"command": "npm",
"args": [
Expand All @@ -84,5 +84,4 @@
<img src="/images/mcp-with-claude.png" alt="Claude MCP" />
</Frame>
</Step>
</Steps>

</Steps>
28 changes: 15 additions & 13 deletions advanced/rest-api/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,36 +7,38 @@ title: Overview
You can leverage the REST API to programmatically trigger an update when desired.

<Info>
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)!
</Info>

## 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.

<Frame>
<img src="/images/external-api-key.png" />
</Frame>

## 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.

<Note>
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.
</Note>

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).
53 changes: 27 additions & 26 deletions development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,14 @@
---

<Info>

**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.

</Info>

## Installation

**Step 1**: Install the Mintlify CLI:

<CodeGroup>

```bash npm
npm i -g mintlify
```
Expand All @@ -24,7 +23,6 @@
```bash pnpm
pnpm add -g mintlify
```

</CodeGroup>

**Step 2**: Navigate to the docs directory (where the `docs.json` file is located) and execute the following command:
Expand All @@ -33,11 +31,11 @@
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:

<CodeGroup>
```bash npm
npx mintlify dev

Check warning on line 38 in development.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

development.mdx#L38

Did you really mean 'npx'?
```

```bash yarn
Expand All @@ -47,35 +45,33 @@
```bash pnpm
pnpm dlx mintlify dev
```

</CodeGroup>

<Warning>
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).

Check warning on line 51 in development.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

development.mdx#L51

Did you really mean 'dlx'?
</Warning>

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:

<CodeGroup>

```bash npm
npm i -g mintlify@latest
```
Expand All @@ -87,20 +83,19 @@
```bash pnpm
pnpm up --global mintlify
```

</CodeGroup>

## 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
```

## Deployment

If the deployment is successful, you should see the following:
After a successful deployment, you should see a confirmation screen similar to this:

<Frame>
<img
Expand All @@ -111,21 +106,27 @@

## Code Formatting

We suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting.
For the best development experience, we recommend using IDE extensions that support MDX. For Visual Studio Code users, we suggest:

- [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting

## Troubleshooting

<AccordionGroup>
<Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
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`
</Accordion>

<Accordion title="Issue: Encountering an unknown error">

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
</Accordion>
</AccordionGroup>
</AccordionGroup>
26 changes: 19 additions & 7 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@
{
"group": "Editing",
"icon": "pen-paintbrush",
"pages": ["development", "web-editor"]
"pages": [
"development",
"web-editor",
"web-editor"
]
},
"settings/global",
{
Expand All @@ -37,7 +41,9 @@
]
},
"themes",
"migration"
"migration",
"development",
"settings/seo"
]
},
{
Expand Down Expand Up @@ -85,7 +91,8 @@
"settings/github",
"settings/gitlab",
"settings/ci",
"settings/preview-deployments"
"settings/preview-deployments",
"settings/github"
]
},
{
Expand Down Expand Up @@ -135,6 +142,7 @@
"icon": "house-lock",
"pages": [
"advanced/dashboard/sso",
"advanced/dashboard/permissions",
"advanced/dashboard/permissions"
]
},
Expand All @@ -143,7 +151,8 @@
"icon": "server",
"pages": [
"advanced/mcp/quickstart",
"advanced/mcp/generate"
"advanced/mcp/generate",
"advanced/mcp/quickstart"
]
},
{
Expand All @@ -164,7 +173,8 @@
"advanced/rest-api/chat/create-topic",
"advanced/rest-api/chat/generate-message"
]
}
},
"advanced/rest-api/overview"
]
}
]
Expand Down Expand Up @@ -262,7 +272,9 @@
"groups": [
{
"group": "Changelog",
"pages": ["changelog/overview"]
"pages": [
"changelog/overview"
]
}
]
}
Expand Down Expand Up @@ -374,4 +386,4 @@
"publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"
}
}
}
}
Loading