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 issues in documentation files #370

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
2 changes: 1 addition & 1 deletion content/components/icons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ The icon will be placed inline when used in a paragraph.

<ResponseField name="size" type="number">
The size of the icon in pixels
</ResponseField>
</ResponseField>
4 changes: 2 additions & 2 deletions integrations/privacy/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ description: "Integrate with a data privacy platform"

## Enabling Data Privacy Integrations

You can add data privacy platforms onto your docs. Add the `integrations` field into your `mint.json` file with your respective scripts.
You can add a data privacy platform onto your docs. Add the `integrations` field into your `mint.json` file with your respective scripts.

```json
"integrations": {
"osano": "SOURCE"
}
```

If you'd like to request a data privacy platform integration, please let us know in [our community](https://mintlify.com/community).
If you'd like to request a data privacy platform integration, please let us know in [our community](https://mintlify.com/community).
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"
}
}
}
}
2 changes: 1 addition & 1 deletion quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -178,4 +178,4 @@ your docs.
Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
support or want to give some feedback? You can join our
[community](https://mintlify.com/community) or drop us an email at
[[email protected]](mailto:[email protected]).
[[email protected]](mailto:[email protected]).
6 changes: 3 additions & 3 deletions settings/custom-domain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To set up your documentation on a custom subdomain, you'll need to set your desi

## Verification with Vercel

If Vercel happens to be your domain provider, you will have to add a verification `TXT` record. This information will show on your dashboard after submitting your custom subdomain, as well as be emailed to you.
If Vercel is your domain provider, you will need to add a verification `TXT` record. This information will show on your dashboard after submitting your custom subdomain, as well as be emailed to you.

## Configuring your DNS

Expand All @@ -47,6 +47,6 @@ CNAME | docs | cname.vercel-dns.com.
<img alt="DNS" src="https://mintlify-assets.b-cdn.net/mintlify-dns.png" />
</Frame>

If you are using Cloudflare for your DNS provider, you'll need to have the full strict security option enabled for the https setting.
If you are using Cloudflare for your DNS provider, you'll need to have the "full strict" security option enabled for the https setting.

Please [contact support](mailto:[email protected]) if you don't see the custom subdomain set up after the above configuration.
Please [contact support](mailto:[email protected]) if you do not see the custom subdomain set up after the above configuration.
2 changes: 1 addition & 1 deletion settings/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -238,4 +238,4 @@ repository. Use the `topbarCtaButton` field with the `type` set to `github`.
"type": "github",
"url": "https://github.com/mintlify/docs"
}
```
```
11 changes: 6 additions & 5 deletions web-editor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ description: 'Edit your docs directly from the dashboard with live previews.'
features and fixing bugs. We'd love to get your feedback on what we can improve at [[email protected]](mailto:[email protected]).
</Warning>

Web Editor is the preferred way to edit docs directly without having to open your IDE or run `mintlify dev`.
While the 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.

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.
Expand All @@ -22,8 +23,8 @@ If you understand git workflows and our integrations already, you can skip to [h

### Git basics

While Web Editor means you dont need to go to GitHub or your command line to make
changes, its still helpful to know the basics of git.
While the 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.

Git terminology:

Expand Down Expand Up @@ -268,7 +269,7 @@ We do have a few current limitations in the editor that we're working to resolve
</Accordion>

<Accordion title="WYSIWYG navigation tree">
You currently cannot live-update your navigation based on added/edited files. You
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 `mint.json`
</Accordion>

Expand All @@ -294,4 +295,4 @@ We do have a few current limitations in the editor that we're working to resolve
If you have any bug reports, feature requests, or other general feedback, we'd love to hear
where we can improve.

Email us at [[email protected]](mailto:[email protected])
Email us at [[email protected]](mailto:[email protected])