diff --git a/deploy/github.mdx b/deploy/github.mdx index 1aa7a99a1..1dca76f0e 100644 --- a/deploy/github.mdx +++ b/deploy/github.mdx @@ -15,7 +15,42 @@ Mintlify uses a GitHub App to automatically sync your documentation with your Gi See your repository in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard. -If your repository is in the `mintlify-community` organization, the GitHub App is automatically configured and managed by Mintlify. You can use the web editor to make changes to your documentation. If you want to work on your documentation locally, clone the repository to your own organization and update your Git settings to use your own repository. +If your repository is in the `mintlify-community` organization, the GitHub App is automatically configured and managed by Mintlify. You can use the web editor to make changes to your documentation. If you want to work on your documentation locally, you can [migrate to your own repository](#migrate-to-your-own-repository). + +## Migrate to your own repository + +If you started with a Mintlify-hosted repository and want to move your documentation to your own GitHub account, you can migrate at any time. This copies all your documentation files to a new repository under your GitHub account. + +### Prerequisites + +You need a GitHub account with permission to create repositories. + +### Migration steps + + + + Navigate to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard. + + + Click **Create new repo from current docs**. + + + If prompted, complete the GitHub OAuth flow to grant Mintlify permission to create a repository in your account. + + + Mintlify copies your documentation files to a new repository in your GitHub account. The repository is named `docs`, `mintlify-docs`, or a similar available name. + + + +### What happens during migration + +When you migrate: + +- A new repository is created in your GitHub account with all your current documentation files. +- Your deployment is updated to point to the new repository. +- The Mintlify-hosted repository is no longer used for deployments. + +After migration, you can clone the new repository locally, make changes in your preferred editor, and push updates to trigger deployments. ## Install the GitHub App diff --git a/quickstart.mdx b/quickstart.mdx index e4ca755d7..0210bd5d6 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -33,7 +33,7 @@ Choose your repository approach. - Not sure which to choose? Start with **Mintlify-hosted**. You can migrate to your own repository anytime if it better suits your needs. + Not sure which to choose? Start with **Mintlify-hosted**. You can [migrate to your own repository](/deploy/github#migrate-to-your-own-repository) anytime if it better suits your needs. ## Deploy your documentation site