diff --git a/advanced/rest-api/overview.mdx b/advanced/rest-api/overview.mdx index 49b2810..269f205 100644 --- a/advanced/rest-api/overview.mdx +++ b/advanced/rest-api/overview.mdx @@ -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 @@ -19,4 +19,4 @@ associated with the entire org and can be used across multiple deployments. - + \ No newline at end of file diff --git a/advanced/subpath/cloudflare.mdx b/advanced/subpath/cloudflare.mdx index 763b44e..522f316 100644 --- a/advanced/subpath/cloudflare.mdx +++ b/advanced/subpath/cloudflare.mdx @@ -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. Create a Cloudflare worker @@ -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). \ No newline at end of file diff --git a/advanced/subpath/route53-cloudfront.mdx b/advanced/subpath/route53-cloudfront.mdx index e181941..9a37cef 100644 --- a/advanced/subpath/route53-cloudfront.mdx +++ b/advanced/subpath/route53-cloudfront.mdx @@ -40,7 +40,7 @@ After creating the distribution, navigate to the `Origins` tab. ![Cloudfront Origins](/images/cloudfront/origins.png) -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. For instance, if your landing page is hosted on Webflow, you can use the @@ -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. @@ -142,4 +142,4 @@ Click `Create records`. You may need to remove the existing A record if one currently exists. -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. \ No newline at end of file diff --git a/advanced/subpath/vercel.mdx b/advanced/subpath/vercel.mdx index b474b69..6ec17f4 100644 --- a/advanced/subpath/vercel.mdx +++ b/advanced/subpath/vercel.mdx @@ -28,7 +28,7 @@ following configuration to your `vercel.json` file. ``` - 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) - + \ No newline at end of file diff --git a/advanced/user-auth/overview.mdx b/advanced/user-auth/overview.mdx index 06038cb..0b6832f 100644 --- a/advanced/user-auth/overview.mdx +++ b/advanced/user-auth/overview.mdx @@ -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: @@ -38,7 +38,7 @@ User Auth is an enterprise feature. { userContext.org === undefined ? <>To access this feature, first create an account at the Mintlify dashboard. : userContext.org.plan !== 'enterprise' - ? <>You are currently on the ${userContext.org.plan ?? 'free'} plan. To speak to our team about upgrading, contact our sales team. + ? <>You are currently on the {userContext.org.plan ?? 'free'} plan. To speak to our team about upgrading, contact our sales team. : <>To request this feature for your enterprise org, contact our team. } @@ -47,7 +47,7 @@ User Auth is an enterprise feature. { userContext.org === undefined ? <>To access this feature, first create an account at the Mintlify dashboard. : userContext.org.plan !== 'enterprise' - ? <>You are currently on the ${userContext.org.plan ?? 'free'} plan. To speak to our team about upgrading, contact our sales team. + ? <>You are currently on the {userContext.org.plan ?? 'free'} plan. To speak to our team about upgrading, contact our sales team. : <>To request this feature for your enterprise org, contact our team. } ``` @@ -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. @@ -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 that an empty array in the page metadata is interpreted as "No groups should see this page." +Note that an empty array in the page metadata is interpreted as "No groups should see this page." \ No newline at end of file diff --git a/content/components/sticky-examples.mdx b/content/components/sticky-examples.mdx index b44d3ba..f1b5883 100644 --- a/content/components/sticky-examples.mdx +++ b/content/components/sticky-examples.mdx @@ -4,13 +4,13 @@ description: "Display code blocks at the top-right of the page on desktop device icon: "sidebar-flip" --- -The `` and `` 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 `` and `` 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. `` and `` show up like regular code blocks on mobile. ## Request Example -The `` 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 ``. +The `` 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 ``. Please set a name on every code block you put inside RequestExample. @@ -41,4 +41,4 @@ The `` component is the same as `` but will sho ```` - + \ No newline at end of file diff --git a/development.mdx b/development.mdx index 1558101..5afe776 100644 --- a/development.mdx +++ b/development.mdx @@ -87,7 +87,7 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a ## Troubleshooting - + 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` @@ -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. - + \ No newline at end of file diff --git a/image-embeds.mdx b/image-embeds.mdx index 5c12f77..903419a 100644 --- a/image-embeds.mdx +++ b/image-embeds.mdx @@ -144,6 +144,6 @@ Loads another HTML page within the document. 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/). - + \ No newline at end of file diff --git a/integrations/analytics/hotjar.mdx b/integrations/analytics/hotjar.mdx index a872a8f..063051a 100644 --- a/integrations/analytics/hotjar.mdx +++ b/integrations/analytics/hotjar.mdx @@ -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": { @@ -11,4 +11,4 @@ Add the following to your `mint.json` file to send analytics to HotJar. "hjsv": "required" } } -``` +``` \ No newline at end of file diff --git a/integrations/analytics/posthog.mdx b/integrations/analytics/posthog.mdx index b78cabb..56d233b 100644 --- a/integrations/analytics/posthog.mdx +++ b/integrations/analytics/posthog.mdx @@ -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. + + \ No newline at end of file diff --git a/integrations/sdks/speakeasy.mdx b/integrations/sdks/speakeasy.mdx index d45628b..7aaa37d 100644 --- a/integrations/sdks/speakeasy.mdx +++ b/integrations/sdks/speakeasy.mdx @@ -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 @@ -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 @@ -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 @@ -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. \ No newline at end of file diff --git a/mint.json b/mint.json index 0636b03..b6e13a7 100644 --- a/mint.json +++ b/mint.json @@ -122,7 +122,8 @@ }, { "group": "Advanced", - "pages": [{ + "pages": [ + { "icon": "code", "group": "Custom Scripts", "pages": [ @@ -196,7 +197,10 @@ }, { "group": "SDKs", - "pages": ["integrations/sdks/speakeasy", "integrations/sdks/stainless"] + "pages": [ + "integrations/sdks/speakeasy", + "integrations/sdks/stainless" + ] }, { "group": "Support", @@ -208,7 +212,10 @@ }, { "group": "Privacy", - "pages": ["integrations/privacy/overview", "integrations/privacy/osano"] + "pages": [ + "integrations/privacy/overview", + "integrations/privacy/osano" + ] }, { "group": "Components", @@ -240,7 +247,9 @@ }, { "group": "Changelog", - "pages": ["changelog/overview"] + "pages": [ + "changelog/overview" + ] } ], "footer": { @@ -324,4 +333,4 @@ "publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8" } } -} +} \ No newline at end of file diff --git a/page.mdx b/page.mdx index 4ac69b0..26cdbbf 100644 --- a/page.mdx +++ b/page.mdx @@ -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 @@ -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 doesn’t 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 @@ -160,7 +160,7 @@ 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. @@ -168,4 +168,4 @@ quotes. "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. \ No newline at end of file diff --git a/reusable-snippets.mdx b/reusable-snippets.mdx index 7aacc90..67b36cc 100644 --- a/reusable-snippets.mdx +++ b/reusable-snippets.mdx @@ -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. Any page in the `snippets` directory will be treated as a snippet and will not @@ -48,7 +48,7 @@ import MySnippet from '/snippets/path/to/my-snippet.mdx'; ## Header -Lorem impsum dolor sit amet. +Lorem ipsum dolor sit amet. ``` @@ -132,4 +132,4 @@ export const ClientComponent = () => { return
} } -``` +``` \ No newline at end of file diff --git a/settings/gitlab.mdx b/settings/gitlab.mdx index 576ba17..126cdca 100644 --- a/settings/gitlab.mdx +++ b/settings/gitlab.mdx @@ -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 @@ -54,7 +54,7 @@ Webhooks allow us to receive events when changes are made so that we can automatically trigger deployments. - + @@ -64,7 +64,7 @@ automatically trigger deployments. - Paste the Webhook token generated after setting up the connection. + Paste the webhook token generated after setting up the connection. @@ -80,7 +80,7 @@ automatically trigger deployments. - 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. @@ -95,4 +95,4 @@ automatically trigger deployments. [here](https://mintlify.com/enterprise). -[git-settings]: https://dashboard.mintlify.com/settings/deployment/git-settings +[git-settings]: https://dashboard.mintlify.com/settings/deployment/git-settings \ No newline at end of file diff --git a/settings/navigation.mdx b/settings/navigation.mdx index d5c2283..a8f249b 100644 --- a/settings/navigation.mdx +++ b/settings/navigation.mdx @@ -235,4 +235,4 @@ repository. Use the `topbarCtaButton` field with the `type` set to `github`. "type": "github", "url": "https://github.com/mintlify/docs" } -``` +``` \ No newline at end of file diff --git a/settings/versioning.mdx b/settings/versioning.mdx index dbafd45..2595daf 100644 --- a/settings/versioning.mdx +++ b/settings/versioning.mdx @@ -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`. - + \ No newline at end of file diff --git a/web-editor.mdx b/web-editor.mdx index 25de127..5d90a7e 100644 --- a/web-editor.mdx +++ b/web-editor.mdx @@ -22,8 +22,8 @@ If you understand git workflows and our integrations already, you can skip to [h ### Git basics -While 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. +While 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: @@ -33,7 +33,7 @@ Git terminology: - **Branch**: A separate line of development. It's a working copy of the code that allows you to work on changes without affecting the main version. -- **Pull request:** A request to merge changes from a working branch into the main branch. This is used for reviewing content before making changes live. +- **Pull request**: A request to merge changes from a working branch into the main branch. This is used for reviewing content before making changes live. ### Making updates @@ -289,4 +289,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 [support@mintlify.com](mailto:support@mintlify.com) +Email us at [support@mintlify.com](mailto:support@mintlify.com) \ No newline at end of file