-
Notifications
You must be signed in to change notification settings - Fork 180
Quickstart: guide through the GitHub setup #709
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
Conversation
</Frame> | ||
|
||
<Info> | ||
Remember to update the GitHub App permissions if you move the documentation to a different repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh this is great
Remember to update the GitHub App permissions if you move the documentation to a different repository. | ||
</Info> | ||
|
||
### Authorize your GitHub Account |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just to note - authorizing is not required. it is purely for associating commits with the proper author if you're making edits through the web editor.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it might be worth taking it out of the quickstart and putting it elsewhere
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can see a page on the Git flow and setting up GitHub being helpful especially for people who haven't done docs as code before. Would best practice be to authorize your account or would we ever not want people to authorize?
For now, most people probably use the quickstart to get set up and we've got some feedback that people don't know you need to authorize to have commits associated with authors, so including it here should help solve that
This PR updates https://mintlify.com/docs/quickstart
Summary of changes:
Development Workflows
toMintlify Workflows
since it seems more meaningful to more users