-
Notifications
You must be signed in to change notification settings - Fork 207
v2 of the support page #674
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+129
−1
Merged
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
09dbc71
v2 of the support page
dino475 c3b4610
added content to the SVG tip
dino475 817e220
Merge branch 'main' into new-support-page
dino475 527cd15
Add steps for uninstall/reinstall GitHub app
ethanpalm 7b0f4ac
Update support.mdx
dino475 3b91f61
Update support.mdx
dino475 5d5c811
Update support.mdx
dino475 bcc61cc
Update support.mdx
dino475 a8cbd0b
Update support.mdx
dino475 9562f8b
Update support.mdx
dino475 6065bb6
Update support.mdx
dino475 cafec36
Update support.mdx
dino475 7d89a2f
Update support.mdx
dino475 947b0e0
Update support.mdx
dino475 7dbc08a
Update support.mdx
dino475 af8e0f2
Update support.mdx
dino475 091fc15
Update support.mdx
dino475 603dc3a
Update support.mdx
dino475 e2b6d30
update link
ethanpalm cd2ea23
Merge branch 'new-support-page' of https://github.com/mintlify/docs i…
ethanpalm a787ec4
Apply suggestions from code review
dino475 431b264
Apply suggestions from code review
dino475 4bc5b07
update support.mdx
dino475 7e83d8b
remove unused image
ethanpalm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,7 +24,8 @@ | |
"index", | ||
"quickstart", | ||
"installation", | ||
"editor" | ||
"editor", | ||
"support" | ||
] | ||
}, | ||
{ | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,137 @@ | ||
--- | ||
title: "Support" | ||
icon: "circle-help" | ||
description: "We're here to help you get the most out of Mintlify" | ||
--- | ||
|
||
<Card title="Ask our docs" img="/images/chat-support.png" href="https://mintlify.com/docs/quickstart?share_chat=3524d1e4-c8bb-4367-87f8-4eb8be8edf4b"> | ||
Ask our AI chat assistant that's been trained on our documentation | ||
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
</Card> | ||
|
||
<CardGroup cols={2}> | ||
<Card title="Dashboard widget" icon="message-circle-more" iconType="regular" href="https://dashboard.mintlify.com/"> | ||
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Send us a message from the dashboard *click on support in the bottom left corner* | ||
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
</Card> | ||
<Card title="Email Us" icon="mail" iconType="regular" href="mailto:[email protected]"> | ||
If you can't access the dashboard, email us at [email protected] | ||
</Card> | ||
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
<Card title="Ask AI" icon="bot" iconType="regular" href="https://mintlify.com/community"> | ||
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Ask our AI assistant that's been trained on our documentation | ||
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
</Card> | ||
<Card title="YouTube" icon="youtube" iconType="regular" href="https://www.youtube.com/@GetMintlify/videos"> | ||
Watch our YouTube channel for tutorials and guides | ||
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
</Card> | ||
</CardGroup> | ||
|
||
|
||
**Frequently Asked Questions:** | ||
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
<Accordion title="API Page Issues" icon="book-open"> | ||
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
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: | ||
|
||
<AccordionGroup> | ||
<Accordion title="All of my OpenAPI pages are completely blank"> | ||
In this scenario, it's likely that either Mintlify cannot find your OpenAPI document, | ||
or your OpenAPI document is invalid. | ||
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Running `mintlify dev` locally should reveal some of these issues. | ||
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
To verify your OpenAPI document will pass validation: | ||
|
||
1. Visit [this validator](https://editor.swagger.io/) | ||
2. Switch to the "Validate text" tab | ||
3. Paste in your OpenAPI document | ||
4. Click "Validate it\!" | ||
|
||
If the text box that appears below has a green border, your document has passed validation. | ||
This is the exact validation package Mintlify uses to validate OpenAPI documents, so if your document | ||
passes validation here, there's a great chance the problem is elsewhere. | ||
|
||
Additionally, Mintlify does not support OpenAPI 2.0. If your document uses this version of the specification, | ||
you could encounter this issue. You can convert your document at [editor.swagger.io](https://editor.swagger.io/) (under Edit \> Convert to OpenAPI 3): | ||
|
||
<Frame> | ||
 | ||
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
</Frame> | ||
</Accordion> | ||
<Accordion title="One of my OpenAPI pages is completely blank"> | ||
This is usually caused by a misspelled `openapi` field in the page metadata. Make sure | ||
the HTTP method and path match the HTTP method and path in the OpenAPI document exactly. | ||
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Here's an example of how things might go wrong: | ||
|
||
```md get-user.mdx | ||
--- | ||
openapi: "GET /users/{id}/" | ||
--- | ||
``` | ||
|
||
```yaml openapi.yaml | ||
paths: | ||
"/users/{id}": | ||
get: ... | ||
``` | ||
Notice that the path in the `openapi` field has a trailing slash, whereas the path in the OpenAPI | ||
document does not. | ||
|
||
Another common issue is a misspelled filename. If you are specifying a particular OpenAPI document | ||
in the `openapi` field, ensure the filename is correct. For example, if you have two OpenAPI | ||
documents `openapi/v1.json` and `openapi/v2.json`, your metadata might look like this: | ||
|
||
```md api-reference/v1/users/get-user.mdx | ||
--- | ||
openapi: "v1 GET /users/{id}" | ||
--- | ||
``` | ||
</Accordion> | ||
<Accordion title="Requests from the API Playground don't work"> | ||
If you have a custom domain configured, this could be an issue with your reverse proxy. By | ||
default, requests made via the API Playground start with a `POST` request to the | ||
`/api/request` path on the docs site. If your reverse proxy is configured to only allow `GET` | ||
requests, then all of these requests will fail. To fix this, configure your reverse proxy to | ||
allow `POST` requests to the `/api/request` path. | ||
|
||
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 | ||
likely require you to configure CORS on your server, as these requests will now come directly | ||
from your users' browsers. | ||
</Accordion> | ||
</AccordionGroup> | ||
</Accordion> | ||
|
||
<Accordion title="Docs page won't load (error 404)" icon="ban" iconType="regular"> | ||
Check to see if you have `/api` in the URL. This is a reserved folder in production environments, which produces a 404 error. | ||
</Accordion> | ||
|
||
<Accordion title="GitHub app issues" icon="merge"> | ||
It is always okay to reset the GitHub app to sort out connection issues. | ||
|
||
To do this, you can uninstall the Mintlify app through GitHub: | ||
|
||
- go to [installations](https://github.com/settings/installations) -\> click un-install | ||
- go to [app authorizations](https://github.com/settings/apps/authorizations) -\> click revoke | ||
|
||
Then, head to the Mintlify dashboard to reinstall the app (Make sure to install the GitHub app first, then authorize your account): | ||
|
||
- [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) | ||
- [Account settings](https://dashboard.mintlify.com/settings/account) | ||
</Accordion> | ||
|
||
<Accordion title="SVG JSX" icon="image"> | ||
It is always okay to reset the GitHub app to sort out connection issues. | ||
|
||
To do this, you can uninstall the Mintlify app through GitHub: | ||
|
||
- go to [installations](https://github.com/settings/installations) -\> click un-install | ||
- go to [app authorizations](https://github.com/settings/apps/authorizations) -\> click revoke | ||
|
||
Then, head to the Mintlify dashboard to reinstall the app (Make sure to install the GitHub app first, then authorize your account): | ||
|
||
- [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) | ||
- [Account settings](https://dashboard.mintlify.com/settings/account) | ||
</Accordion> | ||
|
||
|
||
<Info> | ||
We do our best to respond to all requests within 24 hours but delays may occur during busy times | ||
dino475 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
</Info> | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.