Skip to content

Commit 09dbc71

Browse files
dino475dino475
committed
v2 of the support page
refactored after Han redid our docs
1 parent 883d97d commit 09dbc71

File tree

3 files changed

+139
-1
lines changed

3 files changed

+139
-1
lines changed

‎docs.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@
2424
"index",
2525
"quickstart",
2626
"installation",
27-
"editor"
27+
"editor",
28+
"support"
2829
]
2930
},
3031
{

‎images/chat-support.png‎

910 KB
Loading

‎support.mdx‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
title: "Support"
3+
icon: "circle-help"
4+
description: "We're here to help you get the most out of Mintlify"
5+
---
6+
7+
<Card title="Ask our docs" img="/images/chat-support.png" href="https://mintlify.com/docs/quickstart?share_chat=3524d1e4-c8bb-4367-87f8-4eb8be8edf4b">
8+
Ask our AI chat assistant that's been trained on our documentation
9+
</Card>
10+
11+
<CardGroup cols={2}>
12+
<Card title="Dashboard widget" icon="message-circle-more" iconType="regular" href="https://dashboard.mintlify.com/">
13+
Send us a message from the dashboard *click on support in the bottom left corner*
14+
</Card>
15+
<Card title="Email Us" icon="mail" iconType="regular" href="mailto:[email protected]">
16+
If you can't access the dashboard, email us at [email protected]
17+
</Card>
18+
<Card title="Ask AI" icon="bot" iconType="regular" href="https://mintlify.com/community">
19+
Ask our AI assistant that's been trained on our documentation
20+
</Card>
21+
<Card title="YouTube" icon="youtube" iconType="regular" href="https://www.youtube.com/@GetMintlify/videos">
22+
Watch our YouTube channel for tutorials and guides
23+
</Card>
24+
</CardGroup>
25+
26+
27+
**Frequently Asked Questions:**
28+
29+
<Accordion title="API Page Issues" icon="book-open">
30+
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:
31+
32+
<AccordionGroup>
33+
<Accordion title="All of my OpenAPI pages are completely blank">
34+
In this scenario, it's likely that either Mintlify cannot find your OpenAPI document,
35+
or your OpenAPI document is invalid.
36+
37+
Running `mintlify dev` locally should reveal some of these issues.
38+
39+
To verify your OpenAPI document will pass validation:
40+
41+
1. Visit [this validator](https://editor.swagger.io/)
42+
2. Switch to the "Validate text" tab
43+
3. Paste in your OpenAPI document
44+
4. Click "Validate it\!"
45+
46+
If the text box that appears below has a green border, your document has passed validation.
47+
This is the exact validation package Mintlify uses to validate OpenAPI documents, so if your document
48+
passes validation here, there's a great chance the problem is elsewhere.
49+
50+
Additionally, Mintlify does not support OpenAPI 2.0. If your document uses this version of the specification,
51+
you could encounter this issue. You can convert your document at [editor.swagger.io](https://editor.swagger.io/) (under Edit \> Convert to OpenAPI 3):
52+
53+
<Frame>
54+
![](/images/convert-oas-3.png)
55+
</Frame>
56+
</Accordion>
57+
<Accordion title="One of my OpenAPI pages is completely blank">
58+
This is usually caused by a misspelled `openapi` field in the page metadata. Make sure
59+
the HTTP method and path match the HTTP method and path in the OpenAPI document exactly.
60+
61+
Here's an example of how things might go wrong:
62+
63+
```md get-user.mdx
64+
---
65+
openapi: "GET /users/{id}/"
66+
---
67+
```
68+
69+
```yaml openapi.yaml
70+
paths:
71+
"/users/{id}":
72+
get: ...
73+
```
74+
Notice that the path in the `openapi` field has a trailing slash, whereas the path in the OpenAPI
75+
document does not.
76+
77+
Another common issue is a misspelled filename. If you are specifying a particular OpenAPI document
78+
in the `openapi` field, ensure the filename is correct. For example, if you have two OpenAPI
79+
documents `openapi/v1.json` and `openapi/v2.json`, your metadata might look like this:
80+
81+
```md api-reference/v1/users/get-user.mdx
82+
---
83+
openapi: "v1 GET /users/{id}"
84+
---
85+
```
86+
</Accordion>
87+
<Accordion title="Requests from the API Playground don't work">
88+
If you have a custom domain configured, this could be an issue with your reverse proxy. By
89+
default, requests made via the API Playground start with a `POST` request to the
90+
`/api/request` path on the docs site. If your reverse proxy is configured to only allow `GET`
91+
requests, then all of these requests will fail. To fix this, configure your reverse proxy to
92+
allow `POST` requests to the `/api/request` path.
93+
94+
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`, as described [here](/settings/global#api-configurations). This will
95+
likely require you to configure CORS on your server, as these requests will now come directly
96+
from your users' browsers.
97+
</Accordion>
98+
</AccordionGroup>
99+
</Accordion>
100+
101+
<Accordion title="Docs page won't load (error 404)" icon="ban" iconType="regular">
102+
Check to see if you have `/api` in the URL. This is a reserved folder in production environments, which produces a 404 error.
103+
</Accordion>
104+
105+
<Accordion title="GitHub app issues" icon="merge">
106+
It is always okay to reset the GitHub app to sort out connection issues.
107+
108+
To do this, you can uninstall the Mintlify app through GitHub:
109+
110+
- go to [installations](https://github.com/settings/installations) -\> click un-install
111+
- go to [app authorizations](https://github.com/settings/apps/authorizations) -\> click revoke
112+
113+
Then, head to the Mintlify dashboard to reinstall the app (Make sure to install the GitHub app first, then authorize your account):
114+
115+
- [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings)
116+
- [Account settings](https://dashboard.mintlify.com/settings/account)
117+
</Accordion>
118+
119+
<Accordion title="SVG JSX" icon="image">
120+
It is always okay to reset the GitHub app to sort out connection issues.
121+
122+
To do this, you can uninstall the Mintlify app through GitHub:
123+
124+
- go to [installations](https://github.com/settings/installations) -\> click un-install
125+
- go to [app authorizations](https://github.com/settings/apps/authorizations) -\> click revoke
126+
127+
Then, head to the Mintlify dashboard to reinstall the app (Make sure to install the GitHub app first, then authorize your account):
128+
129+
- [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings)
130+
- [Account settings](https://dashboard.mintlify.com/settings/account)
131+
</Accordion>
132+
133+
134+
<Info>
135+
We do our best to respond to all requests within 24 hours but delays may occur during busy times
136+
</Info>
137+

0 commit comments

Comments
 (0)