You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Novu docs (https://github.com/novuhq/docs) use a Gitflow branching model with 2 primary branches. All changes first make their way into a trunk branch, and the trunk is periodically merged into the Mintlify deploy branch.
By default, the Mintlify "Suggest edit" feature opens the Github edit page on the deploy branch for the docs, which for repositories using a Gitflow branching model, is the incorrect branch for edits to be made on. This results in poor contributor DX and can result in edits erroneously being pushed against the deploy branch if branch merge checks are not enforced.
Proposed Feature
The mint.json should provide an optional feedback.suggestEditBranch configuration option to enable customisation of the "Suggest edits" branch. If the optional configuration option is not provided, the auto-generated repo.github.deployBranch option should be used.
Proposed Solution
The useUserFeedBack hook can be updated with the following code to support this backward compatible change:
Problem
Novu docs (https://github.com/novuhq/docs) use a Gitflow branching model with 2 primary branches. All changes first make their way into a trunk branch, and the trunk is periodically merged into the Mintlify deploy branch.
By default, the Mintlify "Suggest edit" feature opens the Github edit page on the deploy branch for the docs, which for repositories using a Gitflow branching model, is the incorrect branch for edits to be made on. This results in poor contributor DX and can result in edits erroneously being pushed against the deploy branch if branch merge checks are not enforced.
Proposed Feature
The
mint.json
should provide an optionalfeedback.suggestEditBranch
configuration option to enable customisation of the "Suggest edits" branch. If the optional configuration option is not provided, the auto-generatedrepo.github.deployBranch
option should be used.Proposed Solution
The
useUserFeedBack
hook can be updated with the following code to support this backward compatible change:Who will benefit from this feature?
I am willing to contribute to the https://github.com/mintlify/docs to support this feature.
The text was updated successfully, but these errors were encountered: