Skip to content
Merged
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 advanced/dashboard/sso.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
<a href="mailto:[email protected]">contact sales</a> for more information.
</Info>

Use single sign-on to your dashboard via SAML and OIDC. If you use Okta or Google Workspace, we have provider-specific documentation for setting up SSO, but if you use another provider, please contact us!

Check warning on line 11 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L11

Did you really mean 'Okta'?

## Okta

Check warning on line 13 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L13

Did you really mean 'Okta'?

<Tabs>
<Tab title="SAML">
Expand Down Expand Up @@ -46,7 +46,7 @@
</Step>
<Step title="Send us your IdP information">
Once the application is set up, navigate to the General tab and locate the client ID & client secret.
Please securely provide us with these, along with your Okta instance URL (e.g. `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.

Check warning on line 49 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L49

Did you really mean 'Okta'?
</Step>
</Steps>
</Tab>
Expand Down Expand Up @@ -91,4 +91,4 @@
</Steps>
</Tab>

</Tabs>
</Tabs>
4 changes: 2 additions & 2 deletions advanced/subpath/cloudflare.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@

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

<Frame>
<img alt="Create a Cloudflare worker" src="/images/cloudflare/worker.png" />
</Frame>

<Warning>
Keep in mind: If your DNS provider is Cloudflare you should not use proxying for the CNAME record

Check warning on line 17 in advanced/subpath/cloudflare.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/subpath/cloudflare.mdx#L17

Did you really mean 'proxying'?
</Warning>

### Add custom domain
Expand All @@ -32,7 +32,7 @@
</Frame>

If you have trouble setting up a custom subdirectory,
[contact our support team](mailto:sales@mintlify.com) and we'll walk you through
[contact our support team](https://mintlify.com/docs/support) and we'll walk you through
upgrading your hosting with us.

### Edit Worker Script
Expand Down
4 changes: 2 additions & 2 deletions advanced/subpath/route53-cloudfront.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
description: "Host documentation at a /docs subdirectory using AWS services"
---

## Create Cloudfront Distribution

Check warning on line 7 in advanced/subpath/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/subpath/route53-cloudfront.mdx#L7

Did you really mean 'Cloudfront'?

Navigate to [Cloudfront](https://aws.amazon.com/cloudfront) inside the AWS console and click on `Create distribution`

Expand Down Expand Up @@ -40,16 +40,16 @@
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.

<Info>
For instance, if your landing page is hosted on Webflow, you can use the

Check warning on line 43 in advanced/subpath/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/subpath/route53-cloudfront.mdx#L43

Did you really mean 'Webflow'?
Webflow's staging URL. It would look like `.webflow.io`.

Check warning on line 44 in advanced/subpath/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/subpath/route53-cloudfront.mdx#L44

Did you really mean 'Webflow's'?

If you use Vercel, you use the `.vercel.app` domain available for every project.

Check warning on line 46 in advanced/subpath/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/subpath/route53-cloudfront.mdx#L46

Did you really mean 'Vercel'?

</Info>
<Note>

If you're unsure on how to get a staging URL for your landing page, [contact
support](mailto:support@mintlify.com) and we'd be happy to help
support](https://mintlify.com/docs/support) and we'd be happy to help

</Note>

Expand All @@ -59,11 +59,11 @@
![Cloudfront Default Origins](/images/cloudfront/default-origin.png)
</Frame>

By this point, you should have two Origins - one with `[SUBDOMAIN].mintlify.app` and another with with staging URL.

Check warning on line 62 in advanced/subpath/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/subpath/route53-cloudfront.mdx#L62

'with' is repeated!

## Set Behaviors

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

Check warning on line 66 in advanced/subpath/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/subpath/route53-cloudfront.mdx#L66

Did you really mean 'Cloudfront'?

Check warning on line 66 in advanced/subpath/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/subpath/route53-cloudfront.mdx#L66

Did you really mean 'subpath'?

- **If a user lands on /docs**, go to `[SUBDOMAIN].mintlify.dev`
- **If a user lands on any other page**, go the current landing page
Expand Down Expand Up @@ -113,7 +113,7 @@

## Connecting it with Route53

Now, we're going to bring the functionality of the Cloudfront distribution into your primary domain.

Check warning on line 116 in advanced/subpath/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/subpath/route53-cloudfront.mdx#L116

Did you really mean 'Cloudfront'?

<Note>
For this section, you can also refer to AWS's official guide on [Configuring
Expand All @@ -139,4 +139,4 @@
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.
2 changes: 1 addition & 1 deletion guides/migration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
</Card>
</CardGroup>

Don't see your docs provider or have a home grown system? We can still help\! Please get in touch at [support@mintlify.com](mailto:support@mintlify.com).
Don't see your docs provider or have a home grown system? We can still help\! Please [contact support](https://mintlify.com/docs/support).

## Commands

Expand Down Expand Up @@ -141,7 +141,7 @@

</CodeGroup>

Provide the relative path or URL to the OpenAPI file to generate frontmatter files for each endpoint.

Check warning on line 144 in guides/migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/migration.mdx#L144

Did you really mean 'frontmatter'?

```
mintlify-scrape openapi-file [openApiFilename]
Expand Down
2 changes: 1 addition & 1 deletion quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -252,4 +252,4 @@ If you encounter any issues during the setup process, check our common troublesh
</AccordionGroup>


Need more help? [Contact our Support Team](mailto:support@mintlify.com).
Need more help? [Contact our Support Team](https://mintlify.com/docs/support).
6 changes: 3 additions & 3 deletions translations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
* **Ambiguous link anchors**: Accurately describe where a link goes and avoid ambiguous link anchors like `Click here`. When possible, use the exact title of the page or resource that a link points to.
* **Avoid**: "Click `[here](path/to/getting-started-guide)` to learn more about the setup process."
* **Better**: "Learn more about the setup process in our `[getting started guide](path/to/getting-started-guide)`."
* **Nominalizations**: Verbs or adjectives turned into nouns, often ending in -ion, -ment, or -ness. Use active verbs instead.

Check warning on line 96 in translations.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

translations.mdx#L96

Did you really mean 'Nominalizations'?
* **Avoid**: "The configuration of your navigation requires a valid `docs.json`."
* **Better**: "You must have a valid `docs.json` to configure your navigation."
* **Stacked modifiers**: Multiple nouns or adjectives grouped together create ambiguity about relationships between words.
Expand Down Expand Up @@ -154,7 +154,7 @@
- Confirm that your content uses valid `MDX` formatting.
- Confirm that your `docs.json` file is properly configured.

If you're still running into problems, please [contact support](mailto:support@mintlify.com).
If you're still running into problems, please [contact support](https://mintlify.com/docs/support).
</Accordion>

<Accordion title="Why do translation PRs sometimes include unchanged sections?">
Expand All @@ -166,10 +166,10 @@
<Accordion title="My desired language isn't available.">
We offer translations for all languages supported by the [languages](/navigation#languages) feature.

If the language you'd like to translate to is not listed, please [contact support](mailto:support@mintlify.com) and we'll be happy to assist.
If the language you'd like to translate to is not listed, please [contact support](https://mintlify.com/docs/support) and we'll be happy to assist.
</Accordion>

<Accordion title="Can I define specific translations for words or prevent terms from being translated?">
The translation service does not support custom translation rules for specific terms or phrases. We are developing this feature for a future release.
</Accordion>
</AccordionGroup>
</AccordionGroup>