Configuring Mintlify After GitHub Repository Transfer
I had the opportunity to transfer a documentation GitHub repository from my personal account to an Organization.
This repository was integrated with Mintlify for automatic documentation site deployment, but after the repository transfer, the integration was naturally broken and deployments started failing.
This is a note on the procedure to change Mintlify settings after GitHub repository transfer and re-enable automatic deployment.
Prerequisites
- Integration between Mintlify and GitHub repository is already completed
- GitHub repository Transfer is completed
- Example in this case:
shige/docs→codenote-net/mintlify
- Example in this case:
Mintlify Configuration Change Procedure
The procedure is very simple. Just update the connected repository information from the Mintlify dashboard.
- Access Mintlify Dashboard Log in to the Mintlify Dashboard and select the target project.
- Navigate to Git Settings
Click
Settings>Deployment>Git Settingsin the sidebar to open the Git integration settings screen. - Update Repository Information
Click the
Configure GitHubbutton in theRepo settingssection. Here, update the following two items with the new information after transfer:- GitHub organization: Target Organization name (e.g.,
codenote-net) - Repository: Repository name after transfer (e.g.,
mintlify) After entering the information, click theSavebutton to save the changes.
- GitHub organization: Target Organization name (e.g.,
Verify Mintlify and GitHub Integration
After changing the settings, try pushing a commit to the main branch of the new repository. If a new deployment is triggered in the Mintlify dashboard and the build succeeds, the configuration is complete.
Summary
Repository transfers are rare occurrences, so related changes to external service integrations are easily forgotten. Especially with documentation sites automated through CI/CD, when you push but nothing updates, you might wonder “why?” for a moment.
The procedure itself is very simple, so if you encounter the same situation, please remember these steps.
That’s all from the Gemba.