Skip to content

Fix Grammar and Spelling Across Documentation #575

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Fix Grammar and Spelling Across Documentation #575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions advanced/dashboard/permissions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ 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 a 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.

Learn more about our pricing [here](https://mintlify.com/pricing).
Learn more about our pricing [here](https://mintlify.com/pricing).
27 changes: 13 additions & 14 deletions advanced/dashboard/sso.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
description: "Customize how your team can login to your admin dashboard"
---

Use single sign-on to your dashboard via SAML and OIDC. If you use Okta or Google Workspace, we have provider-specific documentation for setting up SSO, but if you use another provider, please contact us!
Use Single Sign-On (SSO) to access your dashboard via SAML and OIDC. If you use Okta or Google Workspace, we have provider-specific documentation for setting up SSO. If you use another provider, please contact us!

Check warning on line 6 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L6 

Did you really mean 'Okta'?

<Note>
SSO functionality is available on our Enterprise plan. [Contact
us](https://mintlify.com/enterprise) to learn more!
</Note>

## Okta

Check warning on line 13 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L13 

Did you really mean 'Okta'?

<Tabs>
<Tab title="SAML">
Expand All @@ -20,33 +20,33 @@
</Step>
<Step title="Configure integration">
Enter the following:
* Single sign-on URL (provided by Mintlify)
* Single Sign-On URL (provided by Mintlify)
* Audience URI (provided by Mintlify)
* Name ID Format: `EmailAddress`
* Attribute Statements:
| Name | Name format | Value
| Name | Name Format | Value
| ---- | ----------- | -----
| `firstName` | Basic | `user.firstName` |
| `lastName` | Basic | `user.lastName` |
</Step>
<Step title="Send us your IdP information">
Once the application is set up, navigate to the sign-on tab and send us the metadata URL.
Once the application is set up, navigate to the Sign-On tab and send us the metadata URL.
We'll enable the connection from our side using this information.
</Step>
</Steps>
</Tab>
<Tab title="OIDC">
<Steps>
<Step title="Create an application">
Under `Applications`, click to create a new app integration using OIDC.
Under `Applications`, click to create a new app integration using OpenID Connect (OIDC).
You should choose the `Web Application` application type.
</Step>
<Step title="Configure integration">
Select the authorization code grant type and enter the Redirect URI provided by Mintlify.
Select the Authorization Code grant type and enter the Redirect URI provided by Mintlify.
</Step>
<Step title="Send us your IdP information">
Once the application is set up, navigate to the General tab and locate the client ID & client secret.
Please securely provide us with these, along with your Okta instance URL (e.g. `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.
Once the application is set up, navigate to the General tab and locate the Client ID & Client Secret.
Please securely provide us with these, along with your Okta instance URL (e.g., `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.

Check warning on line 49 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L49 

Did you really mean 'Okta'?
</Step>
</Steps>
</Tab>
Expand All @@ -64,23 +64,23 @@
</Frame>
</Step>
<Step title="Send us your IdP information">
Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team.
Copy the provided SSO URL, Entity ID, and X.509 certificate and send it to the Mintlify team.
<Frame>
![](/images/gsuite-saml-metadata.png)
</Frame>
</Step>
<Step title="Configure integration">
On the Service provider details page, enter the following:
On the Service Provider details page, enter the following:
* ACS URL (provided by Mintlify)
* Entity ID (provided by Mintlify)
* Name ID format: `EMAIL`
* Name ID Format: `EMAIL`
* Name ID: `Basic Information > Primary email`

<Frame>
![](/images/gsuite-sp-details.png)
</Frame>

On the next page, enter the following attribute statements:
On the next page, enter the following Attribute Statements:
| Google Directory Attribute | App Attribute |
| -------------------------- | ------------- |
| `First name` | `firstName` |
Expand All @@ -90,5 +90,4 @@
</Step>
</Steps>
</Tab>

</Tabs>
</Tabs>
39 changes: 23 additions & 16 deletions advanced/mcp/generate.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,37 @@
[Installing and using the Mintlify MCP Server](/advanced/mcp/quickstart) page.
</Tip>

## Get started
## Get Started

Run `npm i mcp` to install the `mcp` CLI.
Run `npm i mcp` to install the MCP CLI.

In the [dashboard](https://dashboard.mintlify.com/products/mcp) go to `MCP Server`, on this page toggle to see your unique installation command. This is the command to install your MCP Server with the `mcp` CLI.
In the [dashboard](https://dashboard.mintlify.com/products/mcp), navigate to the `MCP Server` section. On this page, toggle the view to see your unique installation command. This command will install your MCP Server using the MCP CLI.

<Note>
Make sure to toggle OpenAPI access to allow the MCP server to access **all**
endpoints in your OpenAPI spec.
Make sure to toggle OpenAPI access to allow the MCP Server to access **all**
endpoints in your OpenAPI specification.
</Note>

## 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 [your
subdomain] ```
<Step title="Install the Server through the CLI">
Run the following command to install the server:
```bash
npx mcp add [your subdomain]

Check warning on line 29 in advanced/mcp/generate.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/mcp/generate.mdx#L29 

Did you really mean 'npx'?

Check warning on line 29 in advanced/mcp/generate.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/mcp/generate.mdx#L29 

Did you really mean 'mcp'?
```
</Step>
<Step title="Add the authentication token if applicable">
If your API requires an authentication token, tell your end-customer to get
it and apply it when given this response: ``` > What is the Authorization
(basic token)? ``` Otherwise, you can skip this step.
<Step title="Add the Authentication Token (if applicable)">
If your API requires an authentication token, instruct your end-customer to provide it when prompted with this response:
```
> What is the Authorization (basic token)?
```
If authentication is not required, you can skip this step.
</Step>
<Step title="Start your MCP server">
You can now run: ```bash npm --prefix ~/.mcp/[your subdomain] start ```
<Step title="Start your MCP Server">
You can now run:
```bash
npm --prefix ~/.mcp/[your subdomain] start
```
</Step>
</Steps>
</Steps>
17 changes: 8 additions & 9 deletions advanced/rest-api/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,36 +7,35 @@ 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 would like 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.
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).

## 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 experience is grounded in your documentation and continuously kept up to date.

Responses include citations so you can point your users to the right places they need to get help.
Responses include citations, allowing you to point your users to the specific documentation pages they need for 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
frontend code, whereas the 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).
the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).
22 changes: 16 additions & 6 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@
{
"group": "Editing",
"icon": "pen-paintbrush",
"pages": ["development", "web-editor"]
"pages": [
"development",
"web-editor"
]
},
"settings/global",
{
Expand All @@ -37,7 +40,8 @@
]
},
"themes",
"migration"
"migration",
"quickstart"
]
},
{
Expand Down Expand Up @@ -135,14 +139,17 @@
"icon": "house-lock",
"pages": [
"advanced/dashboard/sso",
"advanced/dashboard/permissions"
"advanced/dashboard/permissions",
"advanced/dashboard/permissions",
"advanced/dashboard/sso"
]
},
{
"group": "Model Context Protocol",
"icon": "server",
"pages": [
"advanced/mcp/quickstart",
"advanced/mcp/generate",
"advanced/mcp/generate"
]
},
Expand All @@ -164,7 +171,8 @@
"advanced/rest-api/chat/create-topic",
"advanced/rest-api/chat/generate-message"
]
}
},
"advanced/rest-api/overview"
]
}
]
Expand Down Expand Up @@ -262,7 +270,9 @@
"groups": [
{
"group": "Changelog",
"pages": ["changelog/overview"]
"pages": [
"changelog/overview"
]
}
]
}
Expand Down Expand Up @@ -374,4 +384,4 @@
"publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"
}
}
}
}
Loading
Loading