Update from support feedback: document GitHub connection reset and editor recovery#6433
Open
mintlify-development[bot] wants to merge 1 commit into
Open
Update from support feedback: document GitHub connection reset and editor recovery#6433mintlify-development[bot] wants to merge 1 commit into
mintlify-development[bot] wants to merge 1 commit into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Expand the GitHub deployment troubleshooting section to cover editor lock-out, the full GitHub App reset sequence, and recovering previous Mintlify-hosted content when the wrong repository is connected.
Changes
public_reposcope symptom.Context
Recent support threads showed repeated confusion where users lost editor access after opening Git Settings or connecting to an empty/wrong GitHub repository, and support was manually walking each user through the same reset sequence.
Note
Low Risk
Documentation-only changes to
deploy/github.mdxwith no product or runtime impact.Overview
Expands GitHub deployment troubleshooting so support can point users to self-serve steps instead of repeating the same reset walkthrough.
Under Configure docs source, adds a Warning that selecting a new Git repository replaces Mintlify-hosted content in the web editor, with guidance to download a setup-wizard zip first and avoid saving if they are only browsing Git Settings.
GitHub app connection issues now lists common symptoms (editor GitHub App Installation Required, missing repo list, OAuth stuck on
public_repo), stresses completing all four steps in order, and documents uninstall → revoke → reinstall → Authorize GitHub account with updated GitHub links and clearer step copy.Adds two sections: Editor shows "GitHub App Installation Required" (Mintlify-hosted content still intact vs. wrong repo connected) and Recover the previous Mintlify-hosted content (contact support for a zip; backup before connecting).
Reviewed by Cursor Bugbot for commit 24dfd0d. Bugbot is set up for automated code reviews on this repo. Configure here.