diff --git a/index.mdx b/index.mdx index 8f88a0448..33c52ce51 100644 --- a/index.mdx +++ b/index.mdx @@ -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 }) => { @@ -40,34 +40,34 @@ export const HeroCard = ({ filename, title, description, href }) => {

- Documentation + 🍑 Peach Documentation

- 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.
- +
diff --git a/installation.mdx b/installation.mdx index 4abf2e3da..47c37652e 100644 --- a/installation.mdx +++ b/installation.mdx @@ -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"] --- 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. -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 - [Git](https://git-scm.com/downloads) installed -- Your documentation repository cloned locally +- Your documentation orchard repository cloned locally -### Clone your repository +### Clone your orchard @@ -59,9 +59,9 @@ The CLI also has utilities for maintaining your documentation, including command -## Install the CLI +## Install your gardening tools -Run the following command to install the CLI: +Run the following command to install your gardening tools: ```bash npm @@ -73,15 +73,15 @@ Run the following command to install the CLI: ``` -## 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: diff --git a/quickstart.mdx b/quickstart.mdx index bc56bad0b..918929028 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,10 +1,10 @@ --- -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 @@ -12,11 +12,11 @@ Mintlify uses a docs-as-code approach to manage your documentation. Every page o 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. @@ -26,9 +26,9 @@ After onboarding, your documentation site is deployed and accessible at your `.m -## View your deployed site +## View your growing orchard -Your documentation site is now deployed at `https://.mintlify.app`. +Your documentation orchard is now flourishing at `https://.mintlify.app`. Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/). @@ -47,10 +47,10 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa - 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). -## Make your first change +## Make your first sweet change