Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Dec 16, 2025

Documentation changes

This PR makes several updates to support the new onboarding flow.

  • GitHub App: clarify when you need to install the app
  • Preview locally: adds a new page about local previews. This serves two purposes. 1) emphasize when you need to have a local clone of your repo 2) a step toward simplifying the CLI installation page in a future PR
  • Branches and Git guides: expand these to help people who are new to Git succeed with Mintlify
  • CLI installation: Some small edits for clarity while people are onboarding
  • Local setup: new page on cloning a local copy of your repo, including for Mintlify-hosted sites
  • Quickstart: significantly revise to focus on just core getting started steps. Make it more truly a quickstart rather than trying to fit every possible path to getting started.
    • Understand and choose between skipping GitHub onboarding and using a mintlify-community repo vs. using your own repo
    • Deploy your site using the selected method
    • Make your first change in the web editor
    • Next steps to work locally, learn more about the web editor, or set a custom domain

For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Overhauls onboarding docs: refocuses quickstart, expands CLI install and Git/branches guides, clarifies GitHub App usage, renames and updates the web editor, and adjusts navigation.

  • Onboarding/Getting started
    • Quickstart (quickstart.mdx): Rewritten to choose repo approach (Mintlify-hosted vs own), tabbed deploy steps, viewing site, first change via web editor, and next-step cards.
    • CLI install (installation.mdx): Expanded with prerequisites, cloning instructions (own vs Mintlify-hosted), install/update commands, local preview options, additional maintenance commands, formatting tips, and troubleshooting.
  • Git & branching guides
    • guides/git-concepts.mdx: Retitled and expanded with “Why Git,” beginner path, core concepts, common workflows, and best practices.
    • guides/branches.mdx: Retitled and expanded with naming conventions, web editor/local flows for create/save/switch, and merge guidance; adds workflow diagram.
  • GitHub integration
    • deploy/github.mdx: Clarifies when the GitHub App is needed, updates installation guidance, permissions wording, repo access management, config of docs source, and adds troubleshooting (deployment triggers, connection reset).
  • Editor
    • editor.mdx: Renames to “Web editor” and aligns copy/alt text; adds tip for signing commits; minor UX copy updates.
  • Navigation (docs.json)
    • Moves editor and installation from "Get started" to "Create content"; updates ordering accordingly.
  • Other
    • ai-native.mdx: Title tweak and minor wording adjustment.
    • migration.mdx: Title updated to “Migrate to Mintlify.”

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

@ethanpalm ethanpalm merged commit 7c4f314 into main Dec 16, 2025
5 checks passed
@ethanpalm ethanpalm deleted the onboarding-updates branch December 16, 2025 23:19
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.

2 participants