Skip to content

Quickstart guide content updates #5865

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.

Sign up for GitHub

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −31
Open

Quickstart guide content updates #5865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 9 additions & 29 deletions index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@

export const HeroCard = ({ filename, title, description, href }) => {
return (
<a className="group cursor-pointer pb-8" href={href}>

Check warning on line 11 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L11 

Use 'classnames?' instead of 'className'.
<img
src={`https://raw.githubusercontent.com/mintlify/docs/refs/heads/main/images/hero/${filename}.png`}

Check warning on line 13 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L13 

Use 'PNG' instead of 'png'.
className="block dark:hidden pointer-events-none group-hover:scale-105 transition-all duration-100"
/>
<img
Expand All @@ -22,21 +22,16 @@
</h3>
<span className="mt-1.5">{description}</span>
</a>
);

Check warning on line 25 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L25 

Use semicolons judiciously.
};

Check warning on line 26 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L26 

Use semicolons judiciously.

faewfawfawefawefaewfewaf

Check warning on line 28 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L28 

Did you really mean 'faewfawfawefawefaewfewaf'?
Copy link
Copy Markdown

@cursor cursor Bot May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gibberish on homepage

Medium Severity

The line faewfawfawefawefaewfewaf is invalid stray text between the HeroCard export and the page layout. It was added in this commit and will render as visible junk on the introduction page.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit c083ef7. Configure here.


<div className="relative">
<div className="absolute -top-14 left-0 right-0 opacity-80">
<img
src="/images/hero/background-light.svg"
className="block dark:hidden pointer-events-none w-full h-auto"
alt="Decorative background image."
/>
<img
src="/images/hero/background-dark.svg"
className="hidden dark:block pointer-events-none w-full h-auto"
alt="Decorative background image."
/>
<img src="/images/hero/background-light.svg" className="block dark:hidden pointer-events-none w-full h-auto" alt="Decorative background image." />

<img src="/images/hero/background-dark.svg" className="hidden dark:block pointer-events-none w-full h-auto" alt="Decorative background image." />
</div>

<div className="relative z-10 px-4 py-16 lg:py-48 lg:pb-24 max-w-3xl mx-auto">
Expand All @@ -51,26 +46,11 @@
<div className="px-6 lg:px-0 mt-12 lg:mt-24 grid sm:grid-cols-2 gap-x-6 gap-y-4">
<HeroCard filename="rocket" title="Quickstart" description="Deploy your first docs site in minutes with our step-by-step guide" href="/quickstart" />

<HeroCard
filename="cli"
title="CLI installation"
description="Install the CLI to preview and develop your docs locally"
href="/installation"
/>
<HeroCard filename="cli" title="CLI installation" description="Install the CLI to preview and develop your docs locally" href="/installation" />

<HeroCard
filename="editor"
title="Web editor"
description="Make quick updates and manage content with our browser-based editor"
href="/editor/index"
/>
<HeroCard filename="editor" title="Web editor" description="Make quick updates and manage content with our browser-based editor" href="/editor/index" />

<HeroCard
filename="components"
title="Components"
description="Build rich, interactive documentation with our ready-to-use components"
href="/components/accordions"
/>
<HeroCard filename="components" title="Components" description="Build rich, interactive documentation with our ready-to-use components" href="/components/accordions" />
</div>
</div>
</div>
</div>
6 changes: 4 additions & 2 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx";

After you complete this guide, you'll have a live documentation site ready to customize and update.

## Before you begin
## Before you begin

<Accordion title="sean is awesome ">
</Accordion>
Copy link
Copy Markdown

@cursor cursor Bot May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Test accordion in quickstart

Low Severity

An empty <Accordion title="sean is awesome "> was added under "Before you begin". It is unrelated onboarding content and looks like personal or test markup left in the guide.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit c083ef7. Configure here.


Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation <Tooltip tip="Your documentation's source code where all files and their history are stored. The web editor connects to your documentation repository to access and modify content, or you can edit files locally in your preferred IDE.">repository</Tooltip>.

Expand Down Expand Up @@ -75,7 +78,6 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa
```

```bash pnpm
pnpm add -g mint
```

</CodeGroup>
Expand Down
Loading