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

Open
wants to merge 5 commits 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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ mintlify dev

### Publishing Changes

Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.
Install our GitHub App to auto-propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install it on your dashboard.

#### Troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a
<AccordionGroup>
<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:
This may be due to an outdated version of the 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`
Expand Down
2 changes: 1 addition & 1 deletion essentials/images.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets y
![title](/path/image.jpg)
```

Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like [Cloudinary](https://cloudinary.com/) or [S3](https://aws.amazon.com/s3/). You can then use that URL and embed.
Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like [Cloudinary](https://cloudinary.com/) or [S3](https://aws.amazon.com/s3/). You can then use that URL and embed it.

### Using Embeds

Expand Down
2 changes: 1 addition & 1 deletion quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Learn how to update your docs locally and deploy them to the public.

## Update your docs

Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own.
Add content directly to your files with MDX syntax and React components. You can use any of our components, or even build your own.

<CardGroup>

Expand Down
2 changes: 1 addition & 1 deletion snippets/snippet-intro.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
One of the core principles of software development is DRY (Don't Repeat
Yourself). This is a principle that apply to documentation as
Yourself). This is a principle that applies to documentation as
well. If you find yourself repeating the same content in multiple places, you
should consider creating a custom snippet to keep your content in sync.