Skip to content

Commit c3b4610

Browse files
committed
added content to the SVG tip
added an image and more information
1 parent 09dbc71 commit c3b4610

File tree

2 files changed

+24
-33
lines changed

2 files changed

+24
-33
lines changed

images/svg-jsx.png

439 KB
Loading

support.mdx

Lines changed: 24 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@ description: "We're here to help you get the most out of Mintlify"
2626

2727
**Frequently Asked Questions:**
2828

29+
<Accordion title="GitHub app issues" icon="merge">
30+
The GitHub app can be termpermental and resetting the connection is a great way to solve issues.
31+
32+
To do this, you can uninstall the Mintlify app through GitHub.
33+
- go to [installations](https://github.com/settings/installations) -\> click un-install
34+
- go to [app authorizations](https://github.com/settings/apps/authorizations) -\> click revoke
35+
36+
Then, head to the dashboard to reinstall the app.
37+
- Make sure to install the GitHub app first at [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings)
38+
- Then authorize your account [Account settings](https://dashboard.mintlify.com/settings/account)
39+
</Accordion>
40+
2941
<Accordion title="API Page Issues" icon="book-open">
3042
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:
3143

@@ -38,17 +50,11 @@ description: "We're here to help you get the most out of Mintlify"
3850

3951
To verify your OpenAPI document will pass validation:
4052

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.
53+
1. Run `mintlify openapi-check <openapiFilenameOrUrl>` in your CLI
54+
2. Check the spec for errors with [this validator](https://editor.swagger.io/)
4955

5056
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):
57+
you could encounter this issue. You can convert your document at [editor.swagger.io](https://editor.swagger.io/)
5258

5359
<Frame>
5460
![](/images/convert-oas-3.png)
@@ -91,7 +97,7 @@ description: "We're here to help you get the most out of Mintlify"
9197
requests, then all of these requests will fail. To fix this, configure your reverse proxy to
9298
allow `POST` requests to the `/api/request` path.
9399

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
100+
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](/core-concepts/settings#param-proxy). This will
95101
likely require you to configure CORS on your server, as these requests will now come directly
96102
from your users' browsers.
97103
</Accordion>
@@ -102,32 +108,17 @@ description: "We're here to help you get the most out of Mintlify"
102108
Check to see if you have `/api` in the URL. This is a reserved folder in production environments, which produces a 404 error.
103109
</Accordion>
104110

105-
<Accordion title="GitHub app issues" icon="merge">
106-
It is always okay to reset the GitHub app to sort out connection issues.
107111

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
112+
<Accordion title="Issues adding SVG to a card" icon="image">
113+
We support a specific type of SVG, called JSX, and as such the image will need to be converted.
114+
To do this you can:
115+
1. Use [this](https://react-svgr.com/playground/) converter to generate JSX compatible SVG code
116+
2. Make sure you only copy the code inside the `<svg/>` tag
126117

127-
Then, head to the Mintlify dashboard to reinstall the app (Make sure to install the GitHub app first, then authorize your account):
118+
![title](/images/svg-jsx.png)
128119

129-
- [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings)
130-
- [Account settings](https://dashboard.mintlify.com/settings/account)
120+
3. Paste this into your card
121+
4. You might need to decrease the height and width to make the image fit!
131122
</Accordion>
132123

133124

0 commit comments

Comments
 (0)