-
Notifications
You must be signed in to change notification settings - Fork 84
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
Clicking on "Suggest edits" opens main branch edit page #72
Comments
Mintlify have made the previously public After some digging into the const { owner, repo, deployBranch, contentDirectory: deploymentPath } = mintConfig.repo.github;
href = `https://github.com/${owner}/${repo}/edit/${deployBranch}/${removeFirstSlash(deploymentPath)}${removeFirstSlash(`${path}.mdx`)}` The Mintlify platform appends the The solution must therefore be provided via Mintlify. One backward compatible solution would be to provide an additional |
Raised mintlify/docs#99 |
Thanks @richardfontein 🙌🏻 |
When clicking on the "Suggest edits" button from the documentation site, the Github edit page is opened up on the
main
branch. This behaviour conflicts with the Publishing Changes section in the Readme which asks for changes to be submitted against thestaging
branch, and results in a non-optimal DX for contributors.For example, my previous PR (#70) was opened through the "Suggest edits" feature and defaulted to merging to main - this branch mismatch was not caught during review.
Unfortunately, it's not possible to setup Github branch protection to enforce that pull requests come from a specific branch, but it is possible to setup a Github workflow for this check (see https://stackoverflow.com/a/75414339/19305547).
Possible fixes:
main
come only fromstaging
The text was updated successfully, but these errors were encountered: