Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do not merge anahita secret customer onboarding page #342

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 4 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
Binary file added .DS_Store
Binary file not shown.
160 changes: 160 additions & 0 deletions customer-onboarding.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
---
title: "Mintlify Onboarding Checklist"
description: "Everything you need to get started on Mintlify"
icon: 'bolt'
---

This guide will walk you through the tools you need to get started with Mintlify, setting up your Mintlify account, linking it with Github, and using our starter kit template to build out highly functional and beautiful documentation!
Copy link
Member

Choose a reason for hiding this comment

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

This is wayyy too much

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
This guide will walk you through the tools you need to get started with Mintlify, setting up your Mintlify account, linking it with Github, and using our starter kit template to build out highly functional and beautiful documentation!
This guide will walk you through the tools you need to get started with Mintlify to build highly functional and beautiful documentation!


<Steps>

<Step title="The essentials">
Before you begin creating your documentation on Mintlify, make sure you have the following installed:
- Your favorite code editor/IDE
- The Github desktop app
- Installing git

<Tabs>

<Tab title="Code editor" icon="pen">
We recommend installing [Visual Studio Code](https://code.visualstudio.com/) or [Cursor](https://www.cursor.com/). These provide an integrated development environment (IDE) that acts as a source-code editor and debugger. This tool is what you will use to edit your pages in MDX, add components such as images & embeds, and create the structure of your documentation.

<Frame>
<img src="/images/customer-onboarding/vscode.png" />
</Frame>

<Tip>
### We highly recommend installing [Mintlify's VSCode Extension](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets)
The Mintlify VSCode extension allows you to easily incorporate components as you write documentation. To create an accordion for your FAQ page, type `<` followed by a few characters for the intended component, as shown below:

<Frame>
<img src="https://cdn.prod.website-files.com/66f29fc1a009998749da917b/66fb58c40b491206812c58ec_66fb584e696b2cedce161e50_tip.gif" />
</Frame>
</Tip>

</Tab>

<Tab title="Github Desktop App">
Make sure you download the [Github Desktop App](https://desktop.github.com/download/) so you can clone and edit your docs repo locally to stage your changes and preview them before they go live!

<Frame>
<img src="/images/customer-onboarding/githubdesktop.png" />
</Frame>

</Tab>
<Tab title="Installing git">
Make sure you install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) so you can use commands such as `git-clone` and `git-commit` to make changes to your docs.

<Frame>
<img src="/images/customer-onboarding/git.png" />
</Frame>

</Tab>

</Tabs>

</Step>

<Step title="Signing up for a Mintlify account">
<Tabs>
<Tab title="Signing Up">
Head over to our [_Get Started_](https://dashboard.mintlify.com/signup) page. You can sign up using your email or through single sign-on (SSO) with Google.

<Frame>
<img src="images/customer-onboarding/signup.png" />
</Frame>
</Tab>

<Tab title="Choosing Company Name">

Once you've logged in, you can establish your _Company Name_.

<Frame>
<img src="/images/customer-onboarding/companyname.png" />
</Frame>
</Tab>
</Tabs>

</Step>

<Step title="Connect your Github account to Mintlify and set up your documentation repository">
This involves 3 steps:
- Connecting your Github account to Mintlify
- Creating your documentation repo to store all of your content
- Cloning the repo locally on your desktop to make updates

<Frame>
<img src="/images/customer-onboarding/signup.gif" />
</Frame>

<Tabs>

<Tab title="Connect your Github account">
You can log in to your Github account to make the connection.

<Warning>
### Don't want to authorize Github OAuth?
- Clone our starter kit template into your Github repo manually
- Make the connection between the repo and Mintlify by entering your Github username and the repository where you wish it to be cloned.
</Warning>

</Tab>

<Tab title="Create your docs repo">
By clicking this step, the starter kit template is automatically cloned into your Github repo. The starter kit is a great starting point that contains a few page examples as well as the `mint.json` which determines both the navigation & branding of your docs (colors, logos, structure, etc)
</Tab>
<Tab title="Clone repo locally to make an edit">
The final step is to create a copy of the repo on your desktop so you can make an edit and push your changes live to experience the magic of Mintlify!
</Tab>
</Tabs>
</Step>
<Step title="Install Mintlify globally">
Install our Mintlify CLI to preview changes locally to your docs.
<Note>
**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.
</Note>
<Frame>
<img src="/images/customer-onboarding/npm.gif" />
</Frame>
**Step 1**: Install Mintlify
<Tabs>
<Tab title="npm">
```
npm i -g mintlify
```
</Tab>
<Tab title="yarn">
```
yarn global add mintlify
```
</Tab>
</Tabs>

**Step 2**: Navigate to the docs directory (where the `mint.json` file is located) and execute the following command:
```
mintlify dev
```
A local preview of your documentation will be available at `http://localhost:3000`.
</Step>
<Step title="Installing Github App">
The next step is to install our Github app. This ensures that your updates are automatically deployed when you push changes. You can find the installation link in the dashboard, on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository.
<Frame>
<img src="/images/customer-onboarding/gitapp.png"/>
</Frame>
</Step>

<Step title="Make edits to your docs">
Now you are all set to make any changes to your docs. Use VSCode or Cursor to make changes, view them locally and then commit and push those changes to github directly through your code editor ! If the Github app is unable to successfully deploy your changes, you can manually update your docs through our dashboard.
<Frame>
<img src="/images/customer-onboarding/manual_update.png" />
</Frame>
</Step>








</Steps>
Binary file added images/customer-onboarding/companyname.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/customer-onboarding/git.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/customer-onboarding/gitapp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/customer-onboarding/githubdesktop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/customer-onboarding/manual_update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/customer-onboarding/npm.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/customer-onboarding/signup.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/customer-onboarding/signup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/customer-onboarding/vscode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,12 @@
"content/components/sticky-examples"
]
},
{
"group": "Customer Onboarding",
"pages": [
"customer-onboarding"
]
},
{
"group": "Changelog",
"pages": ["changelog/overview"]
Expand Down