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
Binary file added images/github/revalidate-settings-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/github/revalidate-settings-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions settings/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@

Mintlify uses a GitHub App to automatically sync your documentation with your GitHub repository.

## Installing the GitHub App

Check warning on line 9 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/github.mdx#L9

'Installing the GitHub App' should use sentence-style capitalization.

Install the Mintlify GitHub App on the GitHub account or organization that owns your docs repository. You must have organization ownership or admin permissions in a repository to install the app. If you lack the necessary permissions, the repository owner must approve the installation request.

Check warning on line 11 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/github.mdx#L11

Use 'administrator' instead of 'admin'.

Install the Mintlify GitHub App through your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app).

<Tip>
We recommend granting access only to the repository where your docs are hosted.

Check warning on line 16 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/github.mdx#L16

Try to avoid using first-person plural like 'We'.

Check warning on line 16 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/github.mdx#L16

In general, use active voice instead of passive voice ('are hosted').
</Tip>

<Frame>
Expand All @@ -22,7 +22,7 @@

## Permissions

When you install the GitHub app, you will be prompted to grant the following permissions:

Check warning on line 25 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/github.mdx#L25

Avoid using 'will'.

Check warning on line 25 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/github.mdx#L25

In general, use active voice instead of passive voice ('be prompted').

Read permissions:
* `metadata`: Basic repository information
Expand All @@ -35,19 +35,21 @@
* `workflows`: Manage GitHub Actions for docs deployments

<Info>
The app only accesses repositories that you explicitly grant it access to. If you have branch protection rules enabled, the app cannot push directly to protected branches.

Check warning on line 38 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/github.mdx#L38

Use 'can't' instead of 'cannot'.
</Info>

## Managing repository access

When installing our GitHub App, you can grant access to all of your repositories or specific ones. We recommend only granting access to the repositories where your documentation is located. You can modify this selection anytime in your [GitHub app settings](https://github.com/apps/mintlify/installations/new).

Check warning on line 43 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/github.mdx#L43

Try to avoid using first-person plural like 'our'.

Check warning on line 43 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/github.mdx#L43

Try to avoid using first-person plural like 'We'.

Check warning on line 43 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/github.mdx#L43

In general, use active voice instead of passive voice ('is located').

## Configuring docs source

Change the organization, repository, or branch that your documentation is built from in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) section of your dashboard.

Check warning on line 47 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/github.mdx#L47

In general, use active voice instead of passive voice ('is built').

## Troubleshooting

### GitHub app connection issues

If you encounter problems with the GitHub app, resetting the connection can solve most problems.

<Steps>
Expand All @@ -57,6 +59,32 @@
</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.

Check warning on line 62 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/github.mdx#L62

Avoid first-person pronouns such as 'My'.
</Step>
</Steps>

### Feedback add-ons are unavailable

If you cannot enable the edit suggestions or raise issues options in your dashboard and your repository is public, revalidate your Git settings.

Check warning on line 68 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/github.mdx#L68

Use 'can't' instead of 'cannot'.

<Steps>
<Step title="Navigate to Git Settings">
Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard.
</Step>
<Step title="Revalidate your settings">
Click the green check mark in the corner of the Git settings box to revalidate your repository settings. This will force update your repository settings to reflect whether your repository is public or private.

Check warning on line 75 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/github.mdx#L75

Avoid using 'will'.

<Frame>
<img
src="/images/github/revalidate-settings-light.png"
alt="The Git Settings page in the Mintlify dashboard. An orange arrow points to the green check mark that revalidates the repository settings."
className="block dark:hidden"
/>
<img
src="/images/github/revalidate-settings-dark.png"
alt="The Git Settings page in the Mintlify dashboard. An orange arrow points to the green check mark that revalidates the repository settings."
className="hidden dark:block"
/>
</Frame>
</Step>
</Steps>