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

docs: Fix spelling and grammar issues across documentation #385

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
4 changes: 2 additions & 2 deletions advanced/rest-api/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: Introduction

Leverage the external API to programmatically trigger an update when desired.
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
functionality to the API over time. Let us know what else you want to see in
[our community](https://mintlify.com/community)!

## Authentication
Expand All @@ -19,4 +19,4 @@ associated with the entire org and can be used across multiple deployments.

<Frame>
<img src="/images/external-api-key.png" />
</Frame>
</Frame>
6 changes: 3 additions & 3 deletions advanced/subpath/cloudflare.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx";
## Create Cloudflare Worker

Navigate to the `Workers & Pages > Create application > Create worker`. You
should be able to presented with the following screen where you can create a new
Cloudlfare worker.
should be presented with the following screen where you can create a new
Cloudflare worker.

<Frame>
<img alt="Create a Cloudflare worker" src="/images/cloudflare/worker.png" />
Expand Down Expand Up @@ -81,4 +81,4 @@ async function handleRequest(request) {
```

Click on `Deploy` and wait for the changes to propagate (it can take up to a few
hours).
hours).
10 changes: 5 additions & 5 deletions advanced/subpath/route53-cloudfront.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ After creating the distribution, navigate to the `Origins` tab.

<Frame>![Cloudfront Origins](/images/cloudfront/origins.png)</Frame>

We want to find a staging URL that mirrors where the main domain (example.com). This is highly variant depending on how your landing page is hosted.
We want to find a staging URL that mirrors where the main domain (example.com) is hosted. This is highly variant depending on how your landing page is hosted.

<Info>
For instance, if your landing page is hosted on Webflow, you can use the
Expand All @@ -66,10 +66,10 @@ By this point, you should have two Origins - one with `[SUBDOMAIN].mintlify.app`

## Set Behaviors

Behaviors in Cloudfront enables control over the subpath logic. At a high level, we're looking to create the following logic.
Behaviors in Cloudfront enables control over the subpath logic. At a high level, we're looking to create the following logic:

- **If a user lands on /docs**, go to `[SUBDOMAIN].mintlify.dev`
- **If a user lands on any other page**, go the current landing page
- **If a user lands on /docs**, go to `[SUBDOMAIN].mintlify.dev`.
- **If a user lands on any other page**, go to the current landing page.

We're going to create three behaviors by clicking on the `Create behavior` button.

Expand Down Expand Up @@ -142,4 +142,4 @@ Click `Create records`.
You may need to remove the existing A record if one currently exists.
</Note>

And voila! You should be able to have your documentation served at `/docs` for your primary domain.
And voila! You should be able to have your documentation served at `/docs` for your primary domain.
4 changes: 2 additions & 2 deletions advanced/subpath/vercel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ following configuration to your `vercel.json` file.
```

<Note>
For more information, you can also refer to Vercel's offical guide on check
For more information, you can also refer to Vercel's official guide on check
out the [Project Configuration:
Rewrites](https://vercel.com/docs/projects/project-configuration#rewrites)
</Note>
</Note>
9 changes: 5 additions & 4 deletions advanced/user-auth/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: 'Introduction'
description: 'Give your users a personalized docs experience'
---

User Auth allows you to identify and authenticate your users so that you can personalize docs content for them. your users.
User Auth allows you to identify and authenticate your users so that you can personalize docs content for them.

Example use cases:

Expand Down Expand Up @@ -38,7 +38,7 @@ User Auth is an enterprise feature. {
userContext.org === undefined
? <>To access this feature, first create an account at the <a href="https://dashboard.mintlify.com/login">Mintlify dashboard</a>.</>
: userContext.org.plan !== 'enterprise'
? <>You are currently on the ${userContext.org.plan ?? 'free'} plan. To speak to our team about upgrading, <a href="mailto:[email protected]">contact our sales team</a>.</>
? <>You are currently on the {userContext.org.plan ?? 'free'} plan. To speak to our team about upgrading, <a href="mailto:[email protected]">contact our sales team</a>.</>
: <>To request this feature for your enterprise org, <a href="mailto:[email protected]">contact our team</a>.</>
}

Expand All @@ -47,7 +47,7 @@ User Auth is an enterprise feature. {
userContext.org === undefined
? <>To access this feature, first create an account at the <a href="https://dashboard.mintlify.com/login">Mintlify dashboard</a>.</>
: userContext.org.plan !== 'enterprise'
? <>You are currently on the ${userContext.org.plan ?? 'free'} plan. To speak to our team about upgrading, <a href="mailto:[email protected]">contact our sales team</a>.</>
? <>You are currently on the {userContext.org.plan ?? 'free'} plan. To speak to our team about upgrading, <a href="mailto:[email protected]">contact our sales team</a>.</>
: <>To request this feature for your enterprise org, <a href="mailto:[email protected]">contact our team</a>.</>
}
```
Expand All @@ -59,6 +59,7 @@ User Auth is an enterprise feature. {
### Prefilling API Keys

If you return API Playground inputs in the user info, they will automatically be prefilled in the API Playground. Make sure the name of the field in the user info is an exact match of the name in the API Playground.

### Showing/Hiding Pages

By default, every page is visible to every user. If you want to restrict which pages are visible to your users, you can add a `groups` field in your page metadata.
Expand All @@ -81,4 +82,4 @@ Here's a table that displays whether a page is shown for different combinations
| `groups: []` in metadata | ❌ | ❌ | ❌ |
| `groups: ['admin']` in metadata | ❌ | ❌ | ✅ |

<Note>Note that an empty array in the page metadata is interpreted as "No groups should see this page."</Note>
<Note>Note that an empty array in the page metadata is interpreted as "No groups should see this page."</Note>
6 changes: 3 additions & 3 deletions content/components/sticky-examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ description: "Display code blocks at the top-right of the page on desktop device
icon: "sidebar-flip"
---

The `<RequestExample>` and `<ResponseExample>` stick code blocks to the top-right of a page even as you scroll. The components work on all pages even if you don't use an API playground.
The `<RequestExample>` and `<ResponseExample>` stick code blocks to the top-right of a page even as you scroll. The components work on all pages, even if you don't use an API playground.

`<RequestExample>` and `<ResponseExample>` show up like regular code blocks on mobile.

## Request Example

The `<RequestExample>` component works similar to [CodeGroup](/content/components/code-groups), but displays the request content on the right sidebar. Thus, you can put multiple code blocks inside `<RequestExample>`.
The `<RequestExample>` component works similarly to [CodeGroup](/content/components/code-groups), but displays the request content on the right sidebar. Thus, you can put multiple code blocks inside `<RequestExample>`.

Please set a name on every code block you put inside RequestExample.

Expand Down Expand Up @@ -41,4 +41,4 @@ The `<ResponseExample>` component is the same as `<RequestExample>` but will sho

</ResponseExample>
````
</ResponseExample>
</ResponseExample>
4 changes: 2 additions & 2 deletions development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a
## Troubleshooting

<AccordionGroup>
<Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
<Accordion title='Error: Could not load the "sharp" module using the `darwin-arm64` runtime'>

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`
Expand All @@ -99,4 +99,4 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a

Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again.
</Accordion>
</AccordionGroup>
</AccordionGroup>
4 changes: 2 additions & 2 deletions image-embeds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,6 @@ Loads another HTML page within the document.

<Tip>
Although not required, we recommend adding the `alt` and `title` attributes to
images for better SEO and accessability. Learn more at [image
images for better SEO and accessibility. Learn more at [image
SEO](https://yoast.com/image-seo-alt-tag-and-title-tag-optimization/).
</Tip>
</Tip>
6 changes: 3 additions & 3 deletions integrations/analytics/hotjar.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "HotJar"
title: "Hotjar"
---

Add the following to your `mint.json` file to send analytics to HotJar.
Add the following to your `mint.json` file to send analytics to Hotjar.

```json Analytics options in mint.json
"analytics": {
Expand All @@ -11,4 +11,4 @@ Add the following to your `mint.json` file to send analytics to HotJar.
"hjsv": "required"
}
}
```
```
4 changes: 3 additions & 1 deletion integrations/analytics/posthog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,6 @@ You only need to include `apiHost` if you are self-hosting PostHog. We send even

## Session Recordings

You need to add the URL for your docs website to Posthog's "Authorized domains for recordings" before you can receive session recordings. The option to add your URL is in Posthog's project settings.
You need to add the URL for your docs website to PostHog's "Authorized domains for recordings" before you can receive session recordings. The option to add your URL is in PostHog's project settings.
</fileContent>
</invoke>
8 changes: 4 additions & 4 deletions integrations/sdks/speakeasy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Speakeasy
description: Automate your SDK usage snippets in the API playground
---

You can integrate Speakeasy-generated code snippets from your SDKs directly into your Mintlify API reference documentation. SDK usage snippets are shown in the [interactive playground](https://mintlify.com/docs/api-playground/overview) of your Mintlify-powered documentation.
You can integrate Speakeasy-generated code snippets from your SDKs directly into your Mintlify API Reference documentation. SDK usage snippets are shown in the [interactive playground](https://mintlify.com/docs/api-playground/overview) of your Mintlify-powered documentation.

## Speakeasy SDK Repository Changes

Expand All @@ -22,7 +22,7 @@ Code samples will be generated in the form of an [OpenAPI overlay file](https://

## Mintlify Docs Repository Changes

The workflow files produced will automatically bundle your source OpenAPI spec and Speakeasy code samples into a single output file, `openapi.yaml`. Mintlify will use this output file when constructing your API reference.
The workflow files produced will automatically bundle your source OpenAPI spec and Speakeasy code samples into a single output file, `openapi.yaml`. Mintlify will use this output file when constructing your API Reference.

### Interactive CLI Set Up

Expand All @@ -45,7 +45,7 @@ Provide a name and path for the OpenAPI spec. This will be the final spec used b

![](/images/speakeasy-3.webp)

Finally, Add your `SPEAKEASY_API_KEY` as a repository secret to your Minlify repo under `Settings > Secrets & Variables > Actions`. Find the Speakeasy API key in the Speakeasy dashboard under the **API Keys** tab.
Finally, Add your `SPEAKEASY_API_KEY` as a repository secret to your Mintlify repo under `Settings > Secrets & Variables > Actions`. Find the Speakeasy API key in the Speakeasy dashboard under the **API Keys** tab.

## Manual Set Up

Expand Down Expand Up @@ -94,4 +94,4 @@ jobs:
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
```

Finally, make sure you add your `SPEAKEASY_API_KEY` as a repository secret to your Minlify repo under `Settings > Secrets & Variables > Actions`. Find the Speakeasy API key in the Speakeasy dashboard under the **API Keys** tab.
Finally, make sure you add your `SPEAKEASY_API_KEY` as a repository secret to your Mintlify repo under `Settings > Secrets & Variables > Actions`. Find the Speakeasy API key in the Speakeasy dashboard under the **API Keys** tab.
19 changes: 14 additions & 5 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,8 @@
},
{
"group": "Advanced",
"pages": [{
"pages": [
{
"icon": "code",
"group": "Custom Scripts",
"pages": [
Expand Down Expand Up @@ -196,7 +197,10 @@
},
{
"group": "SDKs",
"pages": ["integrations/sdks/speakeasy", "integrations/sdks/stainless"]
"pages": [
"integrations/sdks/speakeasy",
"integrations/sdks/stainless"
]
},
{
"group": "Support",
Expand All @@ -208,7 +212,10 @@
},
{
"group": "Privacy",
"pages": ["integrations/privacy/overview", "integrations/privacy/osano"]
"pages": [
"integrations/privacy/overview",
"integrations/privacy/osano"
]
},
{
"group": "Components",
Expand Down Expand Up @@ -240,7 +247,9 @@
},
{
"group": "Changelog",
"pages": ["changelog/overview"]
"pages": [
"changelog/overview"
]
}
],
"footer": {
Expand Down Expand Up @@ -324,4 +333,4 @@
"publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"
}
}
}
}
8 changes: 4 additions & 4 deletions page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ sidebarTitle: "Short title"
Want an icon for your sidebar item like the ones in
[components](/content/components/accordions)? You can set an `icon` attribute in
the metadata! All icons from [Font Awesome](https://fontawesome.com/icons) are
available for us. You can also set an icon type (optional). If not set, the icon
available for use. You can also set an icon type (optional). If not set, the icon
type will be regular.

```md
Expand Down Expand Up @@ -123,7 +123,7 @@ title: "Page with no ToC"
### Wide Mode

In *Wide Mode*, you can hide the table of contents (ToC) on the right side of the page. This is
particularly useful if your page doesnt have any headings or if you prefer to utilize the
particularly useful if your page doesn't have any headings or if you prefer to utilize the
extra horizontal space for other content.

```md
Expand Down Expand Up @@ -160,12 +160,12 @@ url: "https://www.npmjs.com/package/mintlify"

## Search Engine Optimization

You can set meta tags like the image set when shared on social media by passing
You can set meta tags like the image when shared on social media by passing
them into your page's metadata. Meta tags with colons need to be wrapped in
quotes.

```md
"twitter:image": "/images/your-photo.jpg"
```

See [our SEO page](/settings/seo) for all supported meta tags.
See [our SEO page](/settings/seo) for all supported meta tags.
6 changes: 3 additions & 3 deletions reusable-snippets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ should consider creating a custom snippet to keep your content in sync.

## Creating a custom snippet

**Pre-condition**: You must create your snippet file in the `snippets` directory.
**Precondition**: You must create your snippet file in the `snippets` directory.

<Note>
Any page in the `snippets` directory will be treated as a snippet and will not
Expand Down Expand Up @@ -48,7 +48,7 @@ import MySnippet from '/snippets/path/to/my-snippet.mdx';

## Header

Lorem impsum dolor sit amet.
Lorem ipsum dolor sit amet.

<MySnippet word="bananas" />
```
Expand Down Expand Up @@ -132,4 +132,4 @@ export const ClientComponent = () => {
return <div id="client-component"></div>
}
}
```
```
10 changes: 5 additions & 5 deletions settings/gitlab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ changes between GitLab and Mintlify.

- We use Access tokens to pull information from GitLab.
- We use Webhooks so GitLab can notify Mintlify when changes are made.
- This allows Mintlify to create preview deployments when a MR is created.
- This allows Mintlify to create preview deployments when a merge request is created.

## Set up the connection

Expand Down Expand Up @@ -54,7 +54,7 @@ Webhooks allow us to receive events when changes are made so that we can
automatically trigger deployments.

<Steps>
<Step title="Navigate to Settings > Webhooks and click 'Add new Webhook'">
<Step title="Navigate to Settings > Webhooks and click 'Add new webhook'">
<Frame>
<img src="/images/gitlab/gitlab-webhook.png" />
</Frame>
Expand All @@ -64,7 +64,7 @@ automatically trigger deployments.

</Step>
<Step title="Paste token">
Paste the Webhook token generated after setting up the connection.
Paste the webhook token generated after setting up the connection.
<Frame>
<img src="/images/gitlab/gitlab-show-webtoken.png" />
</Frame>
Expand All @@ -80,7 +80,7 @@ automatically trigger deployments.
</Frame>
</Step>
<Step title="Test the Webhook">
After creating the Webhook, click the "Test" dropdown and select "Push events" to send a sample payload to ensure it's configured correctly. It'll say "Hook executed successfully: HTTP 200" if configured correctly.
After creating the webhook, click the "Test" dropdown and select "Push events" to send a sample payload to ensure it's configured correctly. It'll say "Hook executed successfully: HTTP 200" if configured correctly.

This will help you verify that everything is working correctly and that your documentation will sync properly with your GitLab repository.
<Frame>
Expand All @@ -95,4 +95,4 @@ automatically trigger deployments.
[here](https://mintlify.com/enterprise).
</Note>

[git-settings]: https://dashboard.mintlify.com/settings/deployment/git-settings
[git-settings]: https://dashboard.mintlify.com/settings/deployment/git-settings
2 changes: 1 addition & 1 deletion settings/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -235,4 +235,4 @@ repository. Use the `topbarCtaButton` field with the `type` set to `github`.
"type": "github",
"url": "https://github.com/mintlify/docs"
}
```
```
2 changes: 1 addition & 1 deletion settings/versioning.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -111,4 +111,4 @@ Common errors and how to fix them
navigation, make sure you spelled the version the same as in your `versions`
array in `mint.json`.
</Accordion>
</AccordionGroup>
</AccordionGroup>
Loading
Loading