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
24 changes: 12 additions & 12 deletions index.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Introduction"
description: "Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers."
title: "Welcome to Peach Docs"
description: "Sweet, juicy documentation that's ripe with features. AI-native, beautiful out-of-the-box, and grown fresh for developers."
mode: "frame"
keywords: ["overview", "platform", "getting started", "features"]
keywords: ["overview", "platform", "getting started", "features", "peach", "sweet", "juicy"]
---

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

Check warning on line 24 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L24

Use semicolons judiciously.
};

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.

<div className="relative">
<div className="absolute -top-14 left-0 right-0 opacity-80">
Expand All @@ -40,34 +40,34 @@

<div className="relative z-10 px-4 py-16 lg:py-48 lg:pb-24 max-w-3xl mx-auto">
<h1 className="block text-4xl font-medium text-center text-gray-900 dark:text-zinc-50 tracking-tight">
Documentation
🍑 Peach Documentation
</h1>

<div className="max-w-xl mx-auto px-4 mt-4 text-lg text-center text-gray-500 dark:text-zinc-500">
Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers and teams.
Sweet, juicy documentation that's ripe with features. AI-native, beautiful out-of-the-box, and grown fresh for developers and teams.
</div>

<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="rocket" title="Quick harvest" description="Plant your first docs site in minutes with our step-by-step growing guide" href="/quickstart" />

<HeroCard
filename="cli"
title="CLI installation"
description="Install the CLI to preview and develop your docs locally"
title="Gardening tools"
description="Install the CLI to cultivate and grow your docs in your local orchard"
href="/installation"
/>

<HeroCard
filename="editor"
title="Web editor"
description="Make quick updates and manage content with our browser-based editor"
title="Orchard manager"
description="Prune and tend your content with our browser-based gardening interface"
href="/editor/index"
/>

<HeroCard
filename="components"
title="Components"
description="Build rich, interactive documentation with our ready-to-use components"
title="Fresh ingredients"
description="Build rich, interactive documentation with our ready-to-harvest components"
href="/components/accordions"
/>
</div>
Expand Down
24 changes: 12 additions & 12 deletions installation.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Install the CLI"
description: "Use the CLI to preview docs locally, test changes in real-time, and catch issues before deploying your documentation site."
keywords: ["CLI", "npm", "local development", "Node.js"]
title: "Gardening tools setup"
description: "Use the CLI to tend your docs locally, test changes in real-time, and catch pests before harvesting your documentation orchard."
keywords: ["CLI", "npm", "local development", "Node.js", "peach", "gardening", "tools"]
---

<img
Expand All @@ -15,17 +15,17 @@
alt="Decorative graphic representing the CLI."
/>

Use the [CLI](https://www.npmjs.com/package/mint) to preview your documentation locally as you write and edit. View changes in real-time before deploying, test your documentation site's appearance and functionality, and catch issues like broken links or accessibility problems.
Use the [CLI](https://www.npmjs.com/package/mint) to tend your documentation orchard locally as you plant and prune. View changes in real-time before harvesting, test your documentation orchard's appearance and functionality, and catch pests like broken links or accessibility problems.

Check warning on line 18 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L18

Use 'capability' or 'feature' instead of 'functionality'.

The CLI also has utilities for maintaining your documentation, including commands to rename files, validate OpenAPI specifications, and migrate content between formats.
The CLI also has utilities for maintaining your documentation orchard, including commands to rename files, validate OpenAPI specifications, and migrate content between formats.

## Prerequisites

- [Node.js](https://nodejs.org/en) v20.17.0+ (LTS versions recommended) installed

Check warning on line 24 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L24

Spell out 'LTS', if it's unfamiliar to the audience.
- [Git](https://git-scm.com/downloads) installed
- Your documentation repository cloned locally
- Your documentation orchard repository cloned locally

### Clone your repository
### Clone your orchard

<Steps>
<Step title="Locate your repository">
Expand Down Expand Up @@ -59,9 +59,9 @@
</Step>
</Steps>

## Install the CLI
## Install your gardening tools

Run the following command to install the CLI:
Run the following command to install your gardening tools:

<CodeGroup>
```bash npm
Expand All @@ -73,15 +73,15 @@
```
</CodeGroup>

## Preview locally
## Tend your orchard locally

Navigate to your documentation directory containing your `docs.json` file and run:
Navigate to your documentation orchard containing your `docs.json` file and run:

```bash
mint dev
```

A local preview of your documentation is available at `http://localhost:3000`.
A local view of your documentation orchard is available at `http://localhost:3000`.

Alternatively, if you do not want to install the CLI globally, you can run a one-time script:

Expand Down Expand Up @@ -181,7 +181,7 @@
mint broken-links
```

The command ignores files matching [.mintignore](/organize/mintignore) patterns. Links that point to ignored files are reported as broken.

Check warning on line 184 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L184

In general, use active voice instead of passive voice ('are reported').

### Find accessibility issues

Expand Down Expand Up @@ -294,7 +294,7 @@
```
</Accordion>
<Accordion title="Client version shows 'none' after installation">
If you run `mint version` and the client version displays as `none`, the CLI may be unable to download the client application due to a corporate firewall or VPN blocking the download.

Check warning on line 297 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L297

Use 'app' instead of 'application'.

Check warning on line 297 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L297

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

**Solution:** Ask your IT administrator to whitelist `releases.mintlify.com` to enable local development with the CLI.
</Accordion>
Expand Down
22 changes: 11 additions & 11 deletions quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
title: "Quickstart"
description: "Deploy your documentation site and make your first change."
keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"]
title: "Quick harvest"
description: "Plant your documentation orchard and make your first sweet change."
keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding", "peach", "harvest", "plant"]
---

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

## Before you begin

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

When you connect your documentation repository to your Mintlify deployment, you can work on your documentation locally or in the web editor and sync any changes to your remote repository.

## Deploy your documentation site
## Plant your documentation orchard

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.
Go to [mintlify.com/start](https://mintlify.com/start) and complete the planting process. During setup, you'll connect your GitHub account, create or select a repository for your documentation orchard, and install the GitHub App to enable automatic harvesting.

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

<AccordionGroup>
<Accordion title="Optional: Skip connecting GitHub during onboarding">
Expand All @@ -26,9 +26,9 @@
</Accordion>
</AccordionGroup>

## View your deployed site
## View your growing orchard

Your documentation site is now deployed at `https://<your-project-name>.mintlify.app`.
Your documentation orchard is now flourishing at `https://<your-project-name>.mintlify.app`.

Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).

Expand All @@ -47,16 +47,16 @@
</Frame>

<Tip>
Your site is ready to view immediately. Use this URL for testing and sharing with your team. Before sharing with your users, you may want to add a [custom domain](/customize/custom-domain).
Your orchard is ripe for viewing immediately. Use this URL for testing and sharing with your gardening team. Before sharing with your harvest enthusiasts, you may want to add a [custom domain](/customize/custom-domain).
</Tip>

## Make your first change
## Make your first sweet change

<Tabs>
<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 59 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L59

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

<CodeGroup>

Expand Down Expand Up @@ -138,7 +138,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 141 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L141

Avoid using 'will'.
</Card>
<Card title="Explore CLI commands" icon="terminal" horizontal href="/installation#additional-commands">
Find broken links, check accessibility, validate OpenAPI specs, and more.
Expand Down
Loading