diff --git a/README.md b/README.md index 4cbe0750c..56f3a6c29 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/development.mdx b/development.mdx index c2f2ccdae..b1f3381bf 100644 --- a/development.mdx +++ b/development.mdx @@ -91,7 +91,7 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a - 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` diff --git a/essentials/images.mdx b/essentials/images.mdx index 60ad42d38..54cc9031b 100644 --- a/essentials/images.mdx +++ b/essentials/images.mdx @@ -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 diff --git a/quickstart.mdx b/quickstart.mdx index c44cfaaf3..f1804fbb1 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -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. diff --git a/snippets/snippet-intro.mdx b/snippets/snippet-intro.mdx index c57e7c756..e20fbb6fc 100644 --- a/snippets/snippet-intro.mdx +++ b/snippets/snippet-intro.mdx @@ -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.