Skip to content
Closed
Show file tree
Hide file tree
Changes from all 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
17 changes: 4 additions & 13 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"group": "Getting started",
"pages": [
"index",
"test-latency",
"quickstart",
"installation",
"editor"
Expand Down Expand Up @@ -224,9 +225,7 @@
"groups": [
{
"group": "API Reference",
"pages": [
"api-reference/introduction"
]
"pages": ["api-reference/introduction"]
},
{
"group": "Admin",
Expand All @@ -251,9 +250,7 @@
"groups": [
{
"group": "Changelog",
"pages": [
"changelog"
]
"pages": ["changelog"]
}
]
}
Expand Down Expand Up @@ -354,13 +351,7 @@
"background": "/images/thumbnail/background.svg"
},
"contextual": {
"options": [
"copy",
"chatgpt",
"claude",
"cursor",
"vscode"
]
"options": ["copy", "chatgpt", "claude", "cursor", "vscode"]
},
"redirects": [
{
Expand Down
94 changes: 94 additions & 0 deletions test-latency.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
title: "Test latency "
sidebarTitle: "Testlatency"

Check warning on line 3 in test-latency.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

test-latency.mdx#L3

Did you really mean 'Testlatency'?
description: "Test latency"
icon: "terminal"
---


## Installing the CLI

<Info>
**Prerequisite**: Please install [Node.js](https://nodejs.org/en) before proceeding.
</Info>

<Steps>
<Step title="Install the CLI.">
Run the following command to install the [CLI](https://www.npmjs.com/package/mint):

<CodeGroup>
```bash npm
npm i -g mint
```

```bash pnpm
pnpm add -g mint
```
</CodeGroup>

</Step>
<Step title="Preview locally.">
Navigate to your docs directory (where your `docs.json` file is located) and execute the following command:

```bash
mint dev
```

A local preview of your documentation will be available at `http://localhost:3000`.
</Step>
</Steps>

Alternatively, if you do not want to install the CLI globally, you can run a one-time script:

```bash
npx mint dev
```

<Frame type="simple" caption="Application Configuration in Smartcar Dashboard">

Check warning on line 47 in test-latency.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

test-latency.mdx#L47

Did you really mean 'Smartcar'?
<img src="/images/installation/local-development-light.png" alt="Application Configuration in Smartcar Dashboard" />
</Frame>



<AccordionGroup>
<Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
This may be due to an outdated version of node. Try the following:

1. Remove the currently-installed version of the mint CLI: `npm uninstall -g mint`
2. Upgrade to Node.js.
3. Reinstall the mint CLI: `npm install -g mint`
</Accordion>
<Accordion title="Issue: Encountering an unknown error">
**Solution**: Go to the root of your device and delete the `~/.mintlify` folder. Afterwards, run `mint dev` again.
</Accordion>
<Accordion title="Error: permission denied">
This is due to not having the required permissions to globally install node packages.

**Solution**: Try running `sudo npm i -g mint`. You will be prompted for your password, which is the one you use to unlock your computer.
</Accordion>
<Accordion title="The local preview doesn't look the same as my docs do on the web">
This is likely due to an outdated version of the CLI.

**Solution:** Run `mint update` to get the latest changes.
</Accordion>
<Accordion title="mintlify vs. mint package">
If you have any problems with the CLI package, you should first run `npm ls -g`. This command shows what packages are globally installed on your machine.

If you don't use npm or don't see it in the -g list, try `which mint` to locate the installation.

If you have a package named `mint` and a package named `mintlify` installed, you should uninstall `mintlify`.

1. Uninstall the old package:
```bash
npm uninstall -g mintlify
```
2. Clear your npm cache:
```bash
npm cache clean --force
```
3. Reinstall the new package:
```bash
npm i -g mint
```
</Accordion>
</AccordionGroup>