Skip to content

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

Merged
merged 3 commits into from
May 15, 2025
Merged

Conversation

ethanpalm
Copy link
Contributor

This PR updates https://mintlify.com/docs/quickstart

Summary of changes:

  • Move info on installing the GitHub App to Getting Started section since its relevant to both workflows
  • Add section on authorizing your GitHub account, including that you may need an admin to approve
  • Change Development Workflows to Mintlify Workflows since it seems more meaningful to more users

@ethanpalm ethanpalm merged commit d692223 into main May 15, 2025
4 checks passed
@ethanpalm ethanpalm deleted the git-platform-signup branch May 15, 2025 18:22
@ethanpalm ethanpalm restored the git-platform-signup branch May 15, 2025 19:31
</Frame>

<Info>
Remember to update the GitHub App permissions if you move the documentation to a different repository.
Copy link
Member

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
Copy link
Member

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.

Copy link
Member

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

Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants