Skip to content

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Dec 10, 2025

Updated the quickstart guide to better highlight Mintlify's Git-based workflow and GitHub integration throughout the documentation. Added explicit Git commands, clarified automatic deployment mechanisms, and emphasized version control benefits.

Files changed:

  • quickstart.mdx - Enhanced GitHub connection section, added Git commands to code-based workflow, clarified web editor's GitHub integration, and added tips about branches and pull requests

Note

Revamps quickstart.mdx to highlight GitHub-based workflows, adding explicit Git commands and clarifying automatic deployments and branch/PR usage.

  • Docs (quickstart.mdx)
    • GitHub integration:
      • Rename section to Connect your GitHub repository and add Install the GitHub App and Authorize your GitHub account subsections.
      • Explain Git-based workflow benefits and that the GitHub App monitors repos and triggers deployments.
    • Code-based workflow:
      • Add explicit Git commands for committing and pushing changes.
      • Clarify that deployments are triggered via the GitHub App and can be monitored in GitHub or the dashboard.
      • Add tip encouraging branches and PRs for review.
    • Web editor workflow:
      • Clarify that publishing commits to GitHub and triggers deployment.
      • Note branch support in the editor and recommend using branches/PRs.
    • Minor copy updates to emphasize Git-based version control throughout.

Written by Cursor Bugbot for commit 6c15bee. This will update automatically on new commits. Configure here.

mintlify bot added 4 commits December 10, 2025 23:00
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
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.

1 participant