Skip to content

Conversation

@cdxker
Copy link
Contributor

@cdxker cdxker commented Dec 19, 2025

Streamlined the quickstart guide with more concise language and clearer structure. Removed unnecessary words and simplified instructions throughout all sections to improve readability and reduce cognitive load.

Files changed:

  • quickstart.mdx - Condensed all sections with shorter, more direct language

Note

Condenses quickstart.mdx with shorter headings and clearer, more direct steps across repository selection, deployment, viewing, and first-change workflows.

  • Documentation (quickstart.mdx)
    • Concise structure and headings: Renames sections (e.g., Before you beginChoose your repository, Deploy your documentation siteDeploy your site, View your deployed siteView your site).
    • Repository options: Clarifies choices with bold "Choose this if" bullet lists; simplifies descriptions for Mintlify-hosted vs own repo.
    • Deployment steps:
      • Mintlify-hosted: shorter instructions for account creation, skipping GitHub, onboarding, and deployment URL.
      • Own repository: streamlined GitHub connect, onboarding, GitHub App install, optional repo selection (Git settings), and auto-deploy note.
    • Tips/Info: Tightens wording; keeps links to GitHub App and custom domain.
    • View site: Shortens copy; keeps dashboard location for URL and illustrative frames.
    • Make your first change: Simplifies editor navigation, edit to index.mdx frontmatter snippet, publish, and view-live instructions.
    • Next steps: Unchanged cards retained for editor, local dev, and custom domain.

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

cdxker and others added 4 commits December 18, 2025 18:05
Co-Authored-By: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
Co-Authored-By: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
Co-Authored-By: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
Co-Authored-By: mintlify-development[bot] <109878554+mintlify-development[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.

4 participants