-
Notifications
You must be signed in to change notification settings - Fork 214
Onboarding updates #2336
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
Onboarding updates #2336
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation changes
This PR makes several updates to support the new onboarding flow.
mintlify-communityrepo vs. using your own repoFor Reviewers
When reviewing documentation PRs, please consider:
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience
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.
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.installation.mdx): Expanded with prerequisites, cloning instructions (own vs Mintlify-hosted), install/update commands, local preview options, additional maintenance commands, formatting tips, and troubleshooting.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.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.mdx: Renames to “Web editor” and aligns copy/alt text; adds tip for signing commits; minor UX copy updates.docs.json)editorandinstallationfrom "Get started" to "Create content"; updates ordering accordingly.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.