diff --git a/development.mdx b/development.mdx
index a36c3c707..b6d14b003 100644
--- a/development.mdx
+++ b/development.mdx
@@ -4,15 +4,14 @@ description: 'Preview changes locally to update your docs'
---
-
-**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.
-
+ **Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.
**Step 1**: Install Mintlify:
-
+test
+
```bash npm
npm i -g mintlify
```
@@ -20,40 +19,14 @@ description: 'Preview changes locally to update your docs'
```bash yarn
yarn global add mintlify
```
-
- ```bash pnpm
- pnpm add -g mintlify
- ```
-
-**Step 2**: Navigate to the docs directory (where the `docs.json` file is located) and execute the following command:
+**Step 2**: Navigate to the docs directory (where the `mint.json` file is located) and execute the following command:
```bash
mintlify dev
```
-Alternatively, if you do not want to install Mintlify globally you can use a run script available:
-
-
- ```bash npm
- npx mintlify dev
- ```
-
- ```bash yarn
- yarn dlx mintlify dev
- ```
-
- ```bash pnpm
- pnpm dlx mintlify dev
- ```
-
-
-
-
- Yarn's "dlx" run script requires yarn version >2. See [here](https://yarnpkg.com/cli/dlx) for more information.
-
-
A local preview of your documentation will be available at `http://localhost:3000`.
### Custom Ports
@@ -75,7 +48,6 @@ Port 3000 is already in use. Trying 3001 instead.
Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, please update the CLI:
-
```bash npm
npm i -g mintlify@latest
```
@@ -83,11 +55,6 @@ Please note that each CLI release is associated with a specific version of Mintl
```bash yarn
yarn global upgrade mintlify
```
-
- ```bash pnpm
- pnpm up --global mintlify
- ```
-
## Validating Links
@@ -103,10 +70,7 @@ mintlify broken-links
If the deployment is successful, you should see the following:
- 
+
## Code Formatting
@@ -116,16 +80,17 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a
## Troubleshooting
-
-
+
This may be due to an outdated version of node. Try the following:
+
1. Remove the currently-installed version of mintlify: `npm remove -g mintlify`
+
2. Upgrade to Node v19 or higher.
+
3. Reinstall mintlify: `npm install -g mintlify`
-
Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again.
-
+
\ No newline at end of file
diff --git a/quickstart.mdx b/quickstart.mdx
index 76ec6868b..b530e072f 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -1,20 +1,13 @@
----
-title: "Quickstart"
-description: "Start building modern documentation in under five minutes"
-icon: "rocket"
----
+#
- 
- 
+
+
+
+# Ruhan Test
+
## Getting Started
Welcome! Follow the instructions below to learn how to deploy, update and
@@ -27,36 +20,26 @@ Mintlify docs are rendered from MDX files and configurations defined in our
your docs with your code, and make source control effortless. Onboard through the [dashboard](https://dashboard.mintlify.com) or clone our [starter kit](https://github.com/mintlify/starter) to get started.
-
-
Install our GitHub app to ensure that your updates are automatically deployed when you push changes. You can find the installation link in the [dashboard](https://dashboard.mintlify.com/settings), on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository.
- 
+ 
-
-
- If you want your docs to live alongside your code as a monorepo setup, you
- can: 1. Move your docs content to your monorepo. 2. Specify the path to your
- `docs.json` in the
- [dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)
-
- 
- 
-
-
+
+ If you want your docs to live alongside your code as a monorepo setup, you
+ can: 1. Move your docs content to your monorepo. 2. Specify the path to your
+ `mint.json` in the
+ [dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)
+
+
+
+
+
+
### Updating the Content
@@ -66,25 +49,23 @@ your docs.
-
1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
+
2. Once git is installed, clone your docs repository using `git clone `. If you haven't set it up yet, now would be a good time to do so with these [SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
+
3. Use your favorite IDE to open the repository.
+
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
Learn more about this in our [local development guide](/development).
-
-
Learn more about how to use the web editor on our [guide](/web-editor).
-
-
- Easily customize colors, logos and buttons among other configurations in our `docs.json` file. Start with these basic configurations:
+ Easily customize colors, logos and buttons among other configurations in our `mint.json` file. Start with these basic configurations:
```json
"name": "Your Company"
@@ -102,11 +83,9 @@ your docs.
```
A full list of supported configurations can be found at [global settings](/settings/global).
-
-
Add content with simple MDX files. Initiate your pages with this template:
```md
@@ -118,25 +97,21 @@ your docs.
```
Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components).
-
-
Once ready, commit and push your changes to update your docs site. Here is a [guide](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) on how to do that. If the GitHub app is unable to successfully deploy your changes, you can manually update your docs through our [dashboard](https://dashboard.mintlify.com).
-
- 
-
-
+
+ 
+
-
You can easily set up your API references using an OpenAPI document.
- 1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `docs.json` with a URL.
+ 1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `mint.json` with a URL.
```json
"openapi": "link-to-your-openapi-file"
@@ -148,18 +123,15 @@ your docs.
npx @mintlify/scraping@latest openapi-file
```
- 3. Finally, include the generated endpoint MDX files to your `docs.json` under `navigation`.
+ 3. Finally, include the generated endpoint MDX files to your `mint.json` under `navigation`.
For a complete guide on using Mintlify with OpenAPI, check out [this guide](/api-playground/openapi/setup). [This guide](/api-playground/openapi/writing-openapi) explains how to configure your API authentication methods. For manual API references definition, explore [our syntax](/api-playground/overview).
-
-
Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your [dashboard](https://dashboard.mintlify.com/analytics).
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
-
@@ -171,16 +143,14 @@ your docs.
### Publishing
+ Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.
-Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.
-
-Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain.
-
-
+ Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain.
+ 
Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
support or want to give some feedback? You can join our
[community](https://mintlify.com/community) or drop us an email at
-[support@mintlify.com](mailto:support@mintlify.com).
+[support@mintlify.com](mailto:support@mintlify.com).
\ No newline at end of file