Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
keywords: ["overview", "platform", "getting started", "features"]
---

hello world
Copy link

Choose a reason for hiding this comment

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

Test text "hello world" added to index page

High Severity

The text hello world was added to the top of index.mdx (the Introduction page), but the PR description only mentions adding "sup fella" to the quickstart page. This appears to be accidentally committed test content that would be visible to users on the documentation landing page.

Fix in Cursor Fix in Web


export const HeroCard = ({ filename, title, description, href }) => {
return (
<a className="group cursor-pointer pb-8" href={href}>
Expand All @@ -21,8 +23,8 @@
</h3>
<span className="mt-1.5">{description}</span>
</a>
);

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.
};

Check warning on line 27 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L27

Use semicolons judiciously.

<div className="relative">
<div className="absolute -top-14 left-0 right-0 opacity-80">
Expand Down
2 changes: 2 additions & 0 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
keywords: ["quickstart","deploy","get started","first steps","tutorial","setup","onboarding"]
---

sup fella
Copy link

Choose a reason for hiding this comment

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

Test text accidentally added to documentation page

High Severity

The text sup fella is informal test content added to the top of the public-facing quickstart.mdx documentation page. As indicated by the PR title prefix [Test], this appears to be a test change that would be visible to all users visiting the quickstart guide if merged.

Fix in Cursor Fix in Web


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

## Before you begin
Expand All @@ -24,7 +26,7 @@

Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments.

After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL.

Check warning on line 29 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L29

In general, use active voice instead of passive voice ('is deployed').

<AccordionGroup>
<Accordion title="Optional: Skip connecting GitHub during onboarding">
Expand Down Expand Up @@ -64,7 +66,7 @@
<Tab title="CLI">
<Steps>
<Step title="Install the CLI">
The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability.

Check warning on line 69 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L69

Spell out 'LTS', if it's unfamiliar to the audience.

<CodeGroup>

Expand Down Expand Up @@ -151,7 +153,7 @@
## Next steps

<Card title="Use the web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
Edit documentation in your browser and preview how your pages will look when published.

Check warning on line 156 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L156

Avoid using 'will'.
</Card>

<Card title="Explore CLI commands" icon="terminal" horizontal href="/installation">
Expand Down
Loading