-
Notifications
You must be signed in to change notification settings - Fork 245
Draft from Sep 4 (4) #7267
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
base: main
Are you sure you want to change the base?
Draft from Sep 4 (4) #7267
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,7 +5,7 @@ description: "Contact Mintlify support for help with your documentation site, in | |
|
|
||
| ## Ask our docs | ||
|
|
||
| Use the keyboard shortcut <kbd>Cmd</kbd> + <kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>I</kbd> (Windows/Linux). This starts a chat with our AI assistant trained on our documentation. | ||
| Use the keyboard shortcut <kbd>Cmmmd</kbd> + <kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>I</kbd> (Windows/Linux). This starts a chat with our AI assistant trained on our documentation. | ||
|
|
||
| ## Watch video tutorials | ||
|
|
||
|
|
@@ -16,7 +16,7 @@ Visit our [YouTube](https://www.youtube.com/@GetMintlify/videos) channel for tut | |
| Send us a message from your [dashboard](https://app.mintlify.com/). Click the <Icon icon="headphones" /> support button in the top bar to open a support chat. | ||
|
|
||
| <Frame> | ||
| <img src="/images/support-button.png" alt="Support button in the top right of the dashboard." /> | ||
|  | ||
| </Frame> | ||
|
|
||
| <Info> | ||
|
|
@@ -25,4 +25,4 @@ Send us a message from your [dashboard](https://app.mintlify.com/). Click the <I | |
|
|
||
| ## Contact via email | ||
|
|
||
| If you can't access your dashboard, email us at <a href="mailto:[email protected]">[email protected]</a>. Include the URL of your [dashboard](https://app.mintlify.com/) with your organization and deployment in your email so we can help you faster. For example, `app.mintlify.com/your-org/your-deployment`. | ||
| If you can't access your dashboard, email us at <a href="mailto:[email protected]">[[email protected]](mailto:[email protected])</a>. Include the URL of your [dashboard](https://app.mintlify.com/) with your organization and deployment in your email so we can help you faster. For example, `app.mintlify.com/your-org/your-deployment`. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,7 +6,7 @@ | |
|
|
||
| ## Headings | ||
|
|
||
| Headings organize your content and create navigation anchors. They appear in the table of contents and help users scan your documentation. | ||
| fawefaewt and create navigation anchors. They appear in the table of contents and help users scan your documentation. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Headings intro replaced with garbageMedium Severity The headings introduction now starts with Reviewed by Cursor Bugbot for commit 6ff1a79. Configure here. |
||
|
|
||
| ### Create headings | ||
|
|
||
|
|
@@ -41,7 +41,7 @@ | |
| | Heading text | Generated ID | | ||
| | :--- | :--- | | ||
| | `Getting started` | `getting-started` | | ||
| | `Config.json options` | `config-json-options` | | ||
| | `What's new` | `what’s-new` | | ||
| | `Rate limits (per minute)` | `rate-limits-per-minute` | | ||
| | `Read/write access` | `read/write-access` | | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -568,6 +568,9 @@ | |
| ] | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "tab": "Example" | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Empty Example tab added to navigationMedium Severity
Reviewed by Cursor Bugbot for commit 6ff1a79. Configure here. |
||
| } | ||
| ], | ||
| "language": "en" | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,9 +5,13 @@ | |
| boost: 3 | ||
| --- | ||
|
|
||
| import SetupAgentPrompt from "/snippets/setup-agent-prompt.mdx"; | ||
| # header | ||
|
|
||
| body text | ||
|
|
||
| After you complete this guide, you'll have a live documentation site ready to customize and update. | ||
|  | ||
|
|
||
| import SetupAgentPrompt from "/snippets/setup-agent-prompt.mdx"; | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Placeholder content added to QuickstartHigh Severity The Quickstart now opens with Reviewed by Cursor Bugbot for commit 6ff1a79. Configure here. |
||
|
|
||
| <Visibility for="humans"> | ||
| <Tip> | ||
|
|
@@ -61,8 +65,6 @@ | |
| ## Deploy your documentation site | ||
|
|
||
| <Visibility for="humans"> | ||
| Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you name your site and answer a few questions about how you plan to use it. You can also connect your GitHub account and install the GitHub App to enable automatic deployments. | ||
|
|
||
| In the final onboarding step, describe the docs that you want to build. You can add links to your existing site, upload files, or select GitHub repositories to use as sources. The Mintlify agent generates a starting point for your docs while you watch a live preview. Answer any questions the agent asks to refine the result. To start with placeholder content instead, select **Skip, start from a blank template**. | ||
|
|
||
| After onboarding, your documentation site deploys and is accessible at your `.mintlifysite.com` URL. | ||
|
|
@@ -75,7 +77,7 @@ | |
| </Visibility> | ||
|
|
||
| <Visibility for="agents"> | ||
| Use the preceding CLI setup workflow. Initiate the corresponding `mint signup` or `mint login` command. Account verification and GitHub authorization open browser pages; have the user approve them. Continue the setup when they finish. Do not consider setup complete until `mint status` reports a subdomain and the deployed `.mintlifysite.com` URL loads. | ||
| </Visibility> | ||
|
|
||
| ## View your deployed site | ||
|
|
||


There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Draft test content on AI-native page
High Severity
The AI-native page now embeds an
Openapisnippet plus placeholderCardandAccordioncontent (jay and ben,tommy) that is unrelated to the page. This draft material would publish on a high-traffic docs page.Reviewed by Cursor Bugbot for commit 6ff1a79. Configure here.