Skip to content
Merged
Show file tree
Hide file tree
Changes from 8 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
3 changes: 1 addition & 2 deletions api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ description: "Common issues with API References"
icon: "message-square-warning"
---

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:
If your API pages aren't displaying correctly, check these common configuration issues:

<AccordionGroup>
<Accordion title="All of my OpenAPI pages are completely blank">
Expand Down
9 changes: 8 additions & 1 deletion components/cards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,14 @@ You can group cards in [columns](/components/columns).

<ResponseField name="icon" type="string or svg">
A [Font Awesome icon](https://fontawesome.com/icons), [Lucide
icon](https://lucide.dev/icons), or SVG code in `icon={}`
icon](https://lucide.dev/icons), or JSX compatible SVG code in `icon={}`.

To generate JSX compatible SVG code:

1. Use the [SVGR converter](https://react-svgr.com/playground/).
2. Copy the code inside the `<svg/>` tag.
3. Paste the code into your card. Make sure to only copy and paste the code inside the `<svg/>` tag.
4. You may need to decrease the height and width to make the image fit.
</ResponseField>

<ResponseField name="iconType" type="string">
Expand Down
25 changes: 25 additions & 0 deletions contact-support.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Contact Support"
icon: "circle-help"
description: "We're here to help you get the most out of Mintlify"
---

## Ask our docs

Select <kbd>Command</kbd> + <kbd>I</kbd> to start a chat with our AI assistant trained on our documentation.

## Watch video tutorials

Visit our [YouTube](https://www.youtube.com/@GetMintlify/videos) channel for tutorials and guides on using Mintlify.

## Message support

Send us a message from your [dashboard](https://dashboard.mintlify.com/) by selecting **Support** in the sidebar.

<Info>
We aim to respond to all requests within 24 hours, but delays may occur during busy times.
</Info>

## Email support

If you can't access your dashboard, please email us at <a href="mailto:[email protected]">[email protected]</a>.
6 changes: 3 additions & 3 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@
"index",
"quickstart",
"installation",
"editor",
"support"
"editor"
]
},
{
Expand Down Expand Up @@ -160,7 +159,8 @@
"advanced/dashboard/roles"

]
}
},
"contact-support"
]
},
{
Expand Down
4 changes: 4 additions & 0 deletions navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@

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.

<Info>
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 if their URLs contain `/api`.

Check warning on line 12 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

navigation.mdx#L12

'if' is repeated!
</Info>

## Pages

Pages are the most fundamental navigation component.
Expand Down
38 changes: 23 additions & 15 deletions settings/github.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,19 @@
---
title: GitHub
title: "GitHub"
description: "Sync your docs with a GitHub repo"
icon: 'github'
icon: "github"
---

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

## Installation

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

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

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

<Frame>
<img className="h-80" src="/images/github/select-repos.png" />
Expand Down Expand Up @@ -50,8 +43,8 @@

<Info>
If you are concerned about the write permissions, the GitHub App will only
have access to the repos you give it access to _and_ if you have branch

Check warning on line 46 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/github.mdx#L46

Did you really mean '_and_'?
protections on it _cannot_ push directly to your branches - it abides by your

Check warning on line 47 in settings/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/github.mdx#L47

Did you really mean '_cannot_'?
branch protection rules.
</Info>

Expand All @@ -60,3 +53,18 @@
When installing our GitHub app, you will be prompted to select all repositories
or a subset of them. This selection can be changed at any time by going to the
[GitHub app settings](https://github.com/apps/mintlify/installations/new).

## Troubleshooting

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

<Steps>
<Step title="Uninstall the Mintlify app through GitHub.">
1. In GitHub, go to [installations](https://github.com/settings/installations) and select **Configure** next to the Mintlify app. Scroll down and select **Uninstall**.
2. Go to [Authorized GitHub Apps](https://github.com/settings/apps/authorizations) and select **Revoke** next to the Mintlify app.
</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.
</Step>
</Steps>
135 changes: 0 additions & 135 deletions support.mdx

This file was deleted.