From bcc79dc550c554747fc31195157782a959898f72 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 15 May 2025 09:51:33 -0700 Subject: [PATCH 1/3] Guide through the GItHub auth flow --- quickstart.mdx | 56 +++++++++++++++++++++++++++++++------------------- 1 file changed, 35 insertions(+), 21 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 871f48c64..6ef2c71c5 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -31,6 +31,36 @@ You can find your URL from the Overview page of the dashboard. This URL is instantly available and will update whenever you make changes to your documentation. It's perfect for testing and sharing with your team during development. +### Install the GitHub App + +Mintlify provides a GitHub App that automates the deployment process when you push changes to your repository. If you don't already have a GitHub account, you will need to [sign up for GitHub](https://github.com/signup). + +You can install the GitHub App by following the instructions from the onboarding checklist or from your dashboard. + +1. Navigate to **Settings** in your Mintlify dashboard. +2. Select **GitHub App** from the sidebar. +3. Select **Install GitHub App**. This will open a new tab to the GitHub App installation page. +4. Select the organization or user account where you want to install the app. Then select the repositories that you want t oconnect. + + + GitHub App Installation + GitHub App Installation + + + + Remember to update the GitHub App permissions if you move the documentation to a different repository. + + +### Authorize your GitHub Account + +1. Navigate to **Settings** in your Mintlify dashboard. +2. Select **My Profile** from the sidebar. +3. Select **Authorize GitHub account**. This will open a new tab to the GitHub authorization page. + + + You may need an admin for your GitHub organization to authorize your account depending on your organization's settings. + + ## Development Workflows Mintlify offers two different workflows for creating and maintaining your documentation. @@ -73,23 +103,6 @@ pnpm add -g mint You need Node.js version 19 or higher installed on your machine. If you encounter installation issues, check the troubleshooting guide. -### Install the GitHub App - -Mintlify provides a GitHub App that automates the deployment process when you push changes to your repository. - -You can install the GitHub App by following the instructions from the onboarding checklist or by navigating to `Settings` > `Organization` > `GitHub`. - -Click `Install GitHub App`. Select the repositories you want to connect. - - - GitHub App Installation - GitHub App Installation - - - - Remember to update the GitHub App permissions if you move the documentation to a different repository. - - ### Edit the Documentation Now that your environment is set up, you can start editing your documentation files. As an example, let's update the title of the introduction page: @@ -141,19 +154,20 @@ Once the deployment is complete, your last update will be available at ` If you haven't installed the GitHub App, you will be prompted to do so upon opening the web editor. - Web Editor - Web Editor + The Mintlify web editor in the visual editor mode + The Mintlify web editor in the visual editor mode ### Edit the Documentation From 0ec637357387f452483a4618de12c38597d1e760 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 15 May 2025 09:55:44 -0700 Subject: [PATCH 2/3] change `Development` to `Mintlify` --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index 6ef2c71c5..d60c03e3b 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -61,7 +61,7 @@ You can install the GitHub App by following the instructions from the onboarding You may need an admin for your GitHub organization to authorize your account depending on your organization's settings. -## Development Workflows +## Mintlify Workflows Mintlify offers two different workflows for creating and maintaining your documentation. From 8e257a79b8987f491e96c5cfd052fa2bc763ded8 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 15 May 2025 11:19:59 -0700 Subject: [PATCH 3/3] reviewer feedback --- quickstart.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index d60c03e3b..b044a8b6a 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -33,7 +33,7 @@ This URL is instantly available and will update whenever you make changes to you ### Install the GitHub App -Mintlify provides a GitHub App that automates the deployment process when you push changes to your repository. If you don't already have a GitHub account, you will need to [sign up for GitHub](https://github.com/signup). +Mintlify provides a GitHub App that automates the deployment process when you push changes to your repository. You can install the GitHub App by following the instructions from the onboarding checklist or from your dashboard. @@ -61,7 +61,7 @@ You can install the GitHub App by following the instructions from the onboarding You may need an admin for your GitHub organization to authorize your account depending on your organization's settings. -## Mintlify Workflows +## Editing Workflows Mintlify offers two different workflows for creating and maintaining your documentation.