Skip to content

Commit 6e087ef

Browse files
committed
move github troubleshooting info
1 parent e99db7e commit 6e087ef

File tree

2 files changed

+23
-29
lines changed

2 files changed

+23
-29
lines changed

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 & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,6 @@ export function openSearch(e) {
3333
## Frequently Asked Questions
3434

3535
<AccordionGroup>
36-
<Accordion title="GitHub app issues" icon="merge">
37-
The GitHub app can be temperamental and resetting the connection is a great way to solve issues.
38-
39-
<Steps>
40-
<Step title="Uninstall the Mintlify app through GitHub">
41-
1. In GitHub, go to [installations](https://github.com/settings/installations) and select **Configure** next to the Mintlify app. Scroll down and select **Uninstall**.
42-
2. Go to [Authorized GitHub Apps](https://github.com/settings/apps/authorizations) and select **Revoke** next to the Mintlify app.
43-
</Step>
44-
<Step title="Reinstall the Mintlify app">
45-
1. In your Mintlify dashboard, go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) and install the GitHub app.
46-
2. Authorize your account in the [My Profile](https://dashboard.mintlify.com/settings/account) section of your dashboard.
47-
</Step>
48-
</Steps>
49-
</Accordion>
5036

5137
<Accordion title="API page issues" icon="book-open">
5238
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:

0 commit comments

Comments
 (0)