Apply apple theme to documentation #3389
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,6 +1,6 @@ | ||||||
| --- | ||||||
| title: "Introduction" | ||||||
| description: "Core documentation, fresh as a crisp apple. AI-native, juicy insights, cultivated for developers." | ||||||
|
Contributor
There was a problem hiding this comment. This frontmatter description reads pretty metaphor-heavy compared to the rest of the docs. If the goal is to keep the intro crisp and consistent, I'd revert to the more literal copy.
Suggested change
|
||||||
| mode: "frame" | ||||||
| keywords: ["overview", "platform", "getting started", "features"] | ||||||
| --- | ||||||
|
|
@@ -21,8 +21,8 @@ | |||||
| </h3> | ||||||
| <span className="mt-1.5">{description}</span> | ||||||
| </a> | ||||||
| ); | ||||||
| }; | ||||||
|
|
||||||
| <div className="relative"> | ||||||
| <div className="absolute -top-14 left-0 right-0 opacity-80"> | ||||||
|
|
@@ -40,11 +40,11 @@ | |||||
|
|
||||||
| <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 🍎 | ||||||
|
Contributor
There was a problem hiding this comment. I'd keep headings emoji-free; it tends to look noisy in nav/search snippets.
Suggested change
|
||||||
| </h1> | ||||||
|
|
||||||
| <div className="max-w-xl mx-auto px-4 mt-4 text-lg text-center text-gray-500 dark:text-zinc-500"> | ||||||
| Core documentation, fresh as a crisp apple. AI-native, juicy insights, cultivated for developers and teams who appreciate the harvest of knowledge. | ||||||
|
Contributor
There was a problem hiding this comment. Same note here—keeping this line literal makes the page read more like documentation than marketing copy.
Suggested change
|
||||||
| </div> | ||||||
|
|
||||||
| <div className="px-6 lg:px-0 mt-12 lg:mt-24 grid sm:grid-cols-2 gap-x-6 gap-y-4"> | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,42 +1,42 @@ | ||||||
| --- | ||||||
| title: "Quickstart" | ||||||
| description: "Plant your documentation orchard and pick your first apple of knowledge." | ||||||
|
Contributor
There was a problem hiding this comment. Quickstart descriptions tend to work better when they stay literal and goal-oriented (helps scanning and SEO).
Suggested change
|
||||||
| keywords: ["quickstart","deploy","get started","first steps","tutorial","setup","onboarding"] | ||||||
| --- | ||||||
|
|
||||||
| After you complete this guide, you'll have a flourishing documentation orchard ready to harvest and cultivate. 🍎 | ||||||
|
Contributor
There was a problem hiding this comment. I'd remove the emoji and keep the outcome statement straightforward.
Suggested change
|
||||||
|
|
||||||
| ## Before you begin | ||||||
|
|
||||||
| Our docs-as-code approach is like tending an apple orchard. 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> - think of it as your digital apple tree. | ||||||
|
|
||||||
| When you connect your documentation repository to your project, you can cultivate your documentation locally or in the web editor and sync any changes to your remote orchard. | ||||||
|
|
||||||
| <Tip> | ||||||
| Using an AI tool to help maintain your documentation orchard? | ||||||
|
|
||||||
| Run `npx skills add https://mintlify.com/docs` to add the Applify [skill](/ai/skillmd). | ||||||
|
Contributor
There was a problem hiding this comment. The command points at
Suggested change
|
||||||
|
|
||||||
| This skill helps AI coding tools understand your apple orchard's structure, components, and best practices for cultivating documentation. Plant this skill for better results when asking AI tools to tend your knowledge trees. | ||||||
| </Tip> | ||||||
|
|
||||||
| ## 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 orchard, and install the GitHub App to enable automatic cultivation. | ||||||
|
|
||||||
| After onboarding, your documentation orchard is planted and accessible at your `.mintlify.app` URL. | ||||||
|
|
||||||
| <AccordionGroup> | ||||||
| <Accordion title="Optional: Skip connecting GitHub during onboarding"> | ||||||
| If you want to plant your orchard quickly without connecting your own repository, you can skip the GitHub connection during onboarding. We'll prepare a private apple grove in a private organization and automatically configure the GitHub App for you. | ||||||
|
|
||||||
| This lets you start harvesting knowledge immediately and migrate to your own orchard later. | ||||||
| </Accordion> | ||||||
| </AccordionGroup> | ||||||
|
|
||||||
| ## View your apple orchard | ||||||
|
|
||||||
| 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/). | ||||||
|
|
||||||
|
|
@@ -55,16 +55,16 @@ | |||||
| </Frame> | ||||||
|
|
||||||
| <Tip> | ||||||
| Your orchard is ready to explore immediately. Use this URL for testing and sharing fresh apples with your team. Before sharing with your users, you may want to add a [custom domain](/customize/custom-domain). | ||||||
| </Tip> | ||||||
|
|
||||||
| ## Pick your first apple | ||||||
|
|
||||||
| <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. | ||||||
|
|
||||||
| <CodeGroup> | ||||||
|
|
||||||
|
|
@@ -112,7 +112,7 @@ | |||||
| git push | ||||||
| ``` | ||||||
|
|
||||||
| Your changes are automatically cultivated and harvested. View your cultivation status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard. | ||||||
|
Contributor
There was a problem hiding this comment. This wording swap makes it harder for users to connect the docs to what they see in the dashboard (deployments). I'd keep the original phrasing.
Suggested change
|
||||||
| </Step> | ||||||
| </Steps> | ||||||
| </Tab> | ||||||
|
|
@@ -142,7 +142,7 @@ | |||||
| Click the **Publish** button in the top-right of the web editor toolbar. | ||||||
| </Step> | ||||||
| <Step title="View live"> | ||||||
| On the [Overview](https://dashboard.mintlify.com/) page of your dashboard, you can see your orchard's cultivation status. When the harvest is complete, refresh your documentation site to see your fresh apples live. | ||||||
| </Step> | ||||||
| </Steps> | ||||||
| </Tab> | ||||||
|
|
@@ -151,7 +151,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. | ||||||
| </Card> | ||||||
|
|
||||||
| <Card title="Explore CLI commands" icon="terminal" horizontal href="/installation"> | ||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This introduces a partial rebrand (name + palette) while the rest of the doc site still references Mintlify (schema, URLs,
.mintlify.app, dashboard). If this isn't intended to be a full rebrand, I'd keep the existing values.