diff --git a/docs.json b/docs.json index 0777ac563..65b807210 100644 --- a/docs.json +++ b/docs.json @@ -1,11 +1,11 @@ { "$schema": "https://mintlify.com/docs.json", "theme": "almond", - "name": "Mintlify", + "name": "Bananify", "colors": { - "primary": "#166E3F", - "light": "#26BD6C", - "dark": "#166E3F" + "primary": "#FFD700", + "light": "#FFF900", + "dark": "#B8860B" }, "favicon": "/favicon.ico", "icons": { diff --git a/index.mdx b/index.mdx index 8f88a0448..5ae1ad550 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 the Banana Grove" +description: "Meet the sweetest documentation platform. Peel back the layers of complex docs with our a-peel-ing, banana-themed experience." mode: "frame" -keywords: ["overview", "platform", "getting started", "features"] +keywords: ["banana", "fruity docs", "getting started", "yellow features"] --- export const HeroCard = ({ filename, title, description, href }) => { @@ -40,34 +40,34 @@ export const HeroCard = ({ filename, title, description, href }) => {

- Documentation + 🍌 Banana Documentation 🍌

- Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers and teams. + Welcome to the ripest documentation experience! Our banana-themed platform makes creating docs a-peel-ing and fun. Split from boring docs and go bananas with our fruity features.
- +
diff --git a/installation.mdx b/installation.mdx index 4abf2e3da..bf9b6b291 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: "🍌 Install the Banana CLI" +description: "Use the Banana CLI to preview your fruity docs locally, test changes in real-time, and catch issues before deploying - it's bananas how useful it is!" +keywords: ["Banana CLI", "npm", "local development", "Node.js", "fruity 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 [Banana CLI](https://www.npmjs.com/package/mint) to preview your fruity documentation locally as you write and edit. View changes in real-time before deploying, test your banana documentation site's appearance and functionality, and catch issues like broken links or accessibility problems - no rotten code allowed! -The CLI also has utilities for maintaining your documentation, including commands to rename files, validate OpenAPI specifications, and migrate content between formats. +The Banana CLI also has utilities for maintaining your documentation, including commands to rename files, validate OpenAPI specifications, and migrate content between formats. It's the top banana for doc maintenance! -## Prerequisites +## Prerequisites (don't go bananas without these!) -- [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 +- [Node.js](https://nodejs.org/en) v20.17.0+ (LTS versions recommended) installed - make sure it's ripe! +- [Git](https://git-scm.com/downloads) installed - for version control that's bananas good +- Your banana documentation repository cloned locally -### Clone your repository +### Clone your banana repository - + 1. Go to the [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard. 2. Note your repository location. It is one of these formats: - - `mintlify-community/docs-{org-name}-{id}` (Mintlify-hosted repository) - - `your-org/your-repo` (your own GitHub repository) + - `mintlify-community/docs-{org-name}-{id}` (Bananify-hosted repository - hosted in the banana grove!) + - `your-org/your-repo` (your own GitHub repository - your personal banana plantation!) - + - - Replace `your-org/your-repo` with your actual repository details from [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings). + + Replace `your-org/your-repo` with your actual repository details from [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) - time to harvest your docs! ```bash git clone https://github.com/your-org/your-repo @@ -46,7 +46,7 @@ The CLI also has utilities for maintaining your documentation, including command ``` - **GitHub App required.** To enable automatic deployments when you push changes, you must install the GitHub app. See [GitHub](/deploy/github) for more information. + **🍌 GitHub App required.** To enable automatic deployments when you push changes, you must install the GitHub app - it's bananas useful! See [GitHub](/deploy/github) for more information. diff --git a/quickstart.mdx b/quickstart.mdx index bc56bad0b..1e4e37a6b 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,36 +1,36 @@ --- -title: "Quickstart" -description: "Deploy your documentation site and make your first change." -keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"] +title: "🍌 Banana Quick-peel" +description: "Deploy your banana-themed docs site and make your first a-peel-ing change!" +keywords: ["banana quickstart", "deploy", "go bananas", "first peel", "banana tutorial", "setup", "banana boarding"] --- -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 ripe, live banana documentation site ready to customize and make even more a-peel-ing! -## Before you begin +## Before you go bananas -Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation repository. +Bananify uses a docs-as-code approach to manage your fruity documentation. Every page on your site has a corresponding file stored in your banana documentation repository. -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. +When you connect your documentation repository to your Bananify deployment, you can work on your banana docs locally or in the web editor and sync any changes to your remote repository. It's bananas how easy it is! -## Deploy your documentation site +## Deploy your banana documentation site -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 banana-boarding process. During banana-boarding, you'll connect your GitHub account, create or select a repository for your fruity documentation, and install the GitHub App to enable automatic deployments. -After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL. +After banana-boarding, your documentation site is deployed and accessible at your `.mintlify.app` URL - ripe and ready to go! - - If you want to get started quickly without connecting your own repository, you can skip the GitHub connection during onboarding. Mintlify creates a private repository in a private organization and automatically configures the GitHub App for you. + + If you want to get started quickly without connecting your own repository, you can skip the GitHub connection during banana-boarding. Bananify creates a private repository in a private organization and automatically configures the GitHub App for you - no split decisions needed! - This lets you use the web editor immediately and migrate to your own repository later. + This lets you use the web editor immediately and migrate to your own repository later when you're ready to go full banana. -## View your deployed site +## View your ripe banana site -Your documentation site is now deployed at `https://.mintlify.app`. +Your banana documentation site is now deployed at `https://.mintlify.app` - sweet! -Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/). +Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/) - it's the top banana! - 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 banana site is ripe and ready to view immediately! Use this URL for testing and sharing with your bunch. Before sharing with your users, you may want to add a [custom domain](/customize/custom-domain) to make it even more a-peel-ing. -## Make your first change +## Make your first a-peel-ing change - - The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability. + + The Banana CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability - no rotten versions! @@ -71,78 +71,78 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa - See [Install the CLI](/installation) for full details and troubleshooting. + See [Install the Banana CLI](/installation) for full details and troubleshooting - we'll help you split any problems! - - If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/installation#clone-your-repository). + + If you haven't already cloned your repository locally, follow the instructions in [Clone your banana repository](/installation#clone-your-repository) - don't let it slip away! - - Open `index.mdx` in your preferred editor and update the description in the frontmatter: + + Open `index.mdx` in your preferred editor and update the description in the frontmatter to something more a-peel-ing: ```mdx --- - title: "Introduction" - description: "Your custom description here" + title: "Welcome to the Banana Grove" + description: "Your custom banana description here - make it sweet!" --- ``` - - Run the following command from your documentation directory: + + Run the following command from your banana documentation directory: ```bash mint dev ``` - View your preview at `http://localhost:3000`. + View your sweet preview at `http://localhost:3000` - it's bananas how good it looks! - + Commit and push your changes to trigger a deployment: ```bash git add . - git commit -m "Update description" + git commit -m "Add banana flavor to description" git push ``` - Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard. + Bananify automatically deploys your changes - it's bananas how fast it is! View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard. - - Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard. + + Navigate to the [banana web editor](https://dashboard.mintlify.com/editor) in your dashboard - time to go bananas with editing! - - Open the **Introduction** page and update the description. + + Open the **Welcome to the Banana Grove** page and update the description to make it more a-peel-ing. - Introduction page open in the web editor with the description edited to say Hello world!. - Introduction page open in the web editor with the description edited to say Hello world!. - - Click the **Publish** button in the top-right of the web editor toolbar. + + Click the **Publish** button in the top-right of the web editor toolbar - let's make these changes ripe for the world! - - On the [Overview](https://dashboard.mintlify.com/) page of your dashboard, you can see your site's deployment status. When it finishes deploying, refresh your documentation site to see your changes live. + + On the [Overview](https://dashboard.mintlify.com/) page of your dashboard, you can see your banana site's deployment status. When it finishes deploying, refresh your documentation site to see your sweet changes live - it's bananas! -## Next steps +## Next banana steps - - Edit documentation in your browser and preview how your pages will look when published. + + Edit your fruity documentation in your browser and preview how your pages will look when published - it's bananas how easy it is! - - Find broken links, check accessibility, validate OpenAPI specs, and more. + + Find broken links, check accessibility, validate OpenAPI specs, and more - no monkeying around with quality! - - Use your own domain for your documentation site. + + Use your own domain for your banana documentation site - make it the top banana! \ No newline at end of file