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
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
"index",
"quickstart",
"installation",
"editor"
"editor",
"support"
]
},
{
Expand Down
Binary file added images/svg-jsx.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
127 changes: 127 additions & 0 deletions support.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
---
title: "Support"
icon: "circle-help"
description: "We're here to help you get the most out of Mintlify"
---

<Card title="Ask our docs" icon="message-circle-question" href="https://mintlify.com/docs/quickstart?share_chat=3524d1e4-c8bb-4367-87f8-4eb8be8edf4b">
Ask our AI chat assistant that's been trained on our documentation.
</Card>

<CardGroup cols={2}>
<Card title="Dashboard widget" icon="messages-square" href="https://dashboard.mintlify.com/">
Send us a message from your dashboard. Select **Support** in your dashboard's sidebar.
</Card>
<Card title="Email Us" icon="mail" href="mailto:[email protected]">
If you can't access your dashboard, email us at [email protected].
</Card>
<Card title="Ask AI" icon="bot" href="https://mintlify.com/community">
Join our community and ask our AI assistant that's been trained on our documentation.
</Card>
<Card title="YouTube" icon="youtube" href="https://www.youtube.com/@GetMintlify/videos">
Watch tutorials and guides on our YouTube channel.
</Card>
</CardGroup>

## Frequently Asked Questions

<Accordion title="GitHub app issues" icon="merge">
The GitHub app can be temperamental and resetting the connection is a great way to solve issues.

<Steps>
<Step title="Uninstall the Mintlify app through GitHub">
1. In GitHub, go to [installations](https://github.com/settings/installations) and select **Configure** next to the Mintlify app. Scroll down and select **Uninstall**.
2. Go to [Authorized GitHub Apps](https://github.com/settings/apps/authorizations) and select **Revoke** next to the Mintlify app.
</Step>
<Step title="Reinstall the Mintlify app">
1. In your Mintlify dashboard, go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) and install the GitHub app.
2. Authorize your account in the [My Profile](https://dashboard.mintlify.com/settings/account) section of your dashboard.
</Step>
</Steps>
</Accordion>

<Accordion title="API page issues" icon="book-open">
API pages are complicated. As a result, there are a lot of things that can go wrong. Here's a list of common issues we've seen customers run into:

<AccordionGroup>
<Accordion title="All of my OpenAPI pages are completely blank">
In this scenario, it's likely that either Mintlify cannot find your OpenAPI document or your OpenAPI document is invalid.

Running `mint dev` locally should reveal some of these issues.

To verify your OpenAPI document will pass validation:

1. Run `mint openapi-check <openapiFilenameOrUrl>` in your CLI.
2. Validate your OpenAPI spec with [Swagger Editor](https://editor.swagger.io/).

Additionally, Mintlify does not support OpenAPI 2.0. If your document uses OpenAPI 2.0, you may encounter this issue. You can convert your document with [Swagger Editor](https://editor.swagger.io/).

<Frame>
!["Convert to OpenAPI 3" menu item highlighted in the Swagger Editor](/images/convert-oas-3.png)
</Frame>
</Accordion>
<Accordion title="One of my OpenAPI pages is completely blank">
This is usually caused by a misspelled `openapi` field in the page metadata. Make sure that the HTTP method and path match the HTTP method and path in the OpenAPI document exactly.

Here's an example of how things might go wrong:

```md get-user.mdx
---
openapi: "GET /users/{id}/"
---
```

```yaml openapi.yaml
paths:
"/users/{id}":
get: ...
```
Notice that the path in the `openapi` field has a trailing slash, whereas the path in the OpenAPI
document does not.

Another common issue is a misspelled filename. If you are specifying a particular OpenAPI document
in the `openapi` field, ensure the filename is correct. For example, if you have two OpenAPI
documents `openapi/v1.json` and `openapi/v2.json`, your metadata might look like this:

```md api-reference/v1/users/get-user.mdx
---
openapi: "v1 GET /users/{id}"
---
```
</Accordion>
<Accordion title="Requests from the API Playground don't work">
If you have a custom domain configured, this could be an issue with your reverse proxy. By
default, requests made via the API Playground start with a `POST` request to the
`/api/request` path on the docs site. If your reverse proxy is configured to only allow `GET`
requests, then all of these requests will fail. To fix this, configure your reverse proxy to
allow `POST` requests to the `/api/request` path.

Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure Mintlify to send requests directly to your backend with the `api.playground.proxy` setting in the `docs.json`. See the [configurations for the API playground](/settings#param-proxy) for more information. This will
likely require you to configure CORS on your server, as these requests will now come directly
from your users' browsers.
</Accordion>
</AccordionGroup>
</Accordion>

<Accordion title="Docs page won't load (error 404)" icon="ban" iconType="regular">
Check to see if you have `/api` in the URL. This is a reserved folder in production environments, which produces a 404 error.
</Accordion>


<Accordion title="Issues adding SVG to a card" icon="image">
We support a specific type of SVG, called JSX, and as such the image will need to be converted.

1. Use the [SVGR converter](https://react-svgr.com/playground/) to generate JSX compatible SVG code.
2. Copy the code inside the `<svg/>` tag.

![Output from the SVGR converter with the code inside <svg> and </svg> tags highlighted.](/images/svg-jsx.png)

3. Paste the code into your card. Make sure you only copy and paste the code inside the `<svg/>` tag.
4. You may need to decrease the height and width to make the image fit.
</Accordion>


<Info>
We do our best to respond to all requests within 24 hours but delays may occur during busy times.
</Info>

Loading