Skip to content

Commit 63d2c68

Browse files
authored
Update support content (#767)
* move github troubleshooting info * remove duplicate API troubleshooting info * move SVG info to cards page * move `/api` 404 info to navigation * move and rename support * update support info * copyedits * fix wording * typo fix
1 parent e99db7e commit 63d2c68

File tree

7 files changed

+64
-156
lines changed

7 files changed

+64
-156
lines changed

api-playground/troubleshooting.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ description: "Common issues with API References"
44
icon: "message-square-warning"
55
---
66

7-
API pages are complicated. As a result, there are a lot of things that can go wrong.
8-
Here's a list of common issues we've seen customers run into:
7+
If your API pages aren't displaying correctly, check these common configuration issues:
98

109
<AccordionGroup>
1110
<Accordion title="All of my OpenAPI pages are completely blank">

components/cards.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,14 @@ You can group cards in [columns](/components/columns).
9292

9393
<ResponseField name="icon" type="string or svg">
9494
A [Font Awesome icon](https://fontawesome.com/icons), [Lucide
95-
icon](https://lucide.dev/icons), or SVG code in `icon={}`
95+
icon](https://lucide.dev/icons), or JSX compatible SVG code in `icon={}`.
96+
97+
To generate JSX compatible SVG code:
98+
99+
1. Use the [SVGR converter](https://react-svgr.com/playground/).
100+
2. Copy the code inside the `<svg/>` tag.
101+
3. Paste the code into your card. Make sure to only copy and paste the code inside the `<svg/>` tag.
102+
4. You may need to decrease the height and width to make the image fit.
96103
</ResponseField>
97104

98105
<ResponseField name="iconType" type="string">

contact-support.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "Contact Support"
3+
icon: "circle-help"
4+
description: "We're here to help you get the most out of Mintlify"
5+
---
6+
7+
## Ask our docs
8+
9+
Select <kbd>Command</kbd> + <kbd>I</kbd> to start a chat with our AI assistant trained on our documentation.
10+
11+
## Watch video tutorials
12+
13+
Visit our [YouTube](https://www.youtube.com/@GetMintlify/videos) channel for tutorials and guides on using Mintlify.
14+
15+
## Message support
16+
17+
Send us a message from your [dashboard](https://dashboard.mintlify.com/) by selecting **Support** in the sidebar.
18+
19+
<Info>
20+
We aim to respond to all requests within 24 hours, but delays may occur during busy times.
21+
</Info>
22+
23+
## Email support
24+
25+
If you can't access your dashboard, please email us at <a href="mailto:[email protected]">[email protected]</a>.

docs.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@
2424
"index",
2525
"quickstart",
2626
"installation",
27-
"editor",
28-
"support"
27+
"editor"
2928
]
3029
},
3130
{
@@ -160,7 +159,8 @@
160159
"advanced/dashboard/roles"
161160

162161
]
163-
}
162+
},
163+
"contact-support"
164164
]
165165
},
166166
{

navigation.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ The [navigation](settings#param-navigation) property in [docs.json](settings) de
88

99
With proper navigation configuration, you can organize your content into a logical hierarchy that makes it easy for users to find exactly what they're looking for.
1010

11+
<Info>
12+
Do not use `api` as a title for any navigation element. The `/api` path is reserved in production and will cause pages to return 404 errors if their URLs contain `/api`.
13+
</Info>
14+
1115
## Pages
1216

1317
Pages are the most fundamental navigation component.

settings/github.mdx

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,19 @@
11
---
2-
title: GitHub
2+
title: "GitHub"
33
description: "Sync your docs with a GitHub repo"
4-
icon: 'github'
4+
icon: "github"
55
---
66

7-
Mintlify integrates with the GitHub API, enabling synchronization between your
8-
docs and your GitHub repository. This integration is made possible through the
9-
utilization of
10-
[GitHub Apps](https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps#about-github-apps).
7+
Mintlify uses a GitHub App to automatically sync your documentation with your GitHub repository.
118

129
## Installation
1310

14-
To begin, you need to install the Mintlify GitHub App into the GitHub account
15-
where your docs repo resides. Installing a GitHub App requires either
16-
organization ownership or admin permissions in a repository. If you lack the
17-
necessary permissions, the repository owner will need to approve the request.
18-
You can access the installation page by logging into the
19-
[Mintlify dashboard](https://dashboard.mintlify.com).
11+
Install the Mintlify GitHub App on the GitHub account or organization that owns your docs repository. Installing a GitHub App requires either
12+
organization ownership or admin permissions in a repository. If you lack the necessary permissions, the repository owner will need to approve the request.
2013

21-
For GitHub Apps, you can choose to only give permissions to a single repository.
22-
We highly recommend you do so as we only need access to the repository where
23-
your docs are hosted.
14+
You can install the Mintlify GitHub App through your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app).
15+
16+
We recommend granting access only to the repository where your docs are hosted.
2417

2518
<Frame>
2619
<img className="h-80" src="/images/github/select-repos.png" />
@@ -60,3 +53,18 @@ and pull requests which is why we need write access to `pull requests` and
6053
When installing our GitHub app, you will be prompted to select all repositories
6154
or a subset of them. This selection can be changed at any time by going to the
6255
[GitHub app settings](https://github.com/apps/mintlify/installations/new).
56+
57+
## Troubleshooting
58+
59+
If you encounter problems with the GitHub app, resetting the connection can solve most problems.
60+
61+
<Steps>
62+
<Step title="Uninstall the Mintlify app through GitHub.">
63+
1. In GitHub, go to [installations](https://github.com/settings/installations) and select **Configure** next to the Mintlify app. Scroll down and select **Uninstall**.
64+
2. Go to [Authorized GitHub Apps](https://github.com/settings/apps/authorizations) and select **Revoke** next to the Mintlify app.
65+
</Step>
66+
<Step title="Reinstall the Mintlify app.">
67+
1. In your Mintlify dashboard, go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) and install the GitHub app.
68+
2. Authorize your account in the [My Profile](https://dashboard.mintlify.com/settings/account) section of your dashboard.
69+
</Step>
70+
</Steps>

support.mdx

Lines changed: 0 additions & 135 deletions
This file was deleted.

0 commit comments

Comments
 (0)