> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rmitnct.club/llms.txt
> Use this file to discover all available pages before exploring further.

# Documenting

> Learn how to contribute to our documentation.

<Info>
  **Prerequisite**: You should have installed [Node.js](https://nodejs.org)
  (version 20 or higher) and cloned the [NCTHub
  Monorepo](https://github.com/rmit-nct/hub) to your local machine.
</Info>

Step 1. Install Mintlify on your local machine:

<CodeGroup>
  ```bash bun theme={null}
  bun i -g mintlify
  ```

  ```bash npm theme={null}
  npm i -g mintlify
  ```

  ```bash yarn theme={null}
  yarn global add mintlify
  ```
</CodeGroup>

Step 2. Go to the docs are located (navigate to `apps/docs`) and run the following command:

```bash theme={null}
mintlify dev
```

The documentation website is now available at `http://localhost:3000`.

<Tip>Use `cd apps/docs` to navigate to the docs folder.</Tip>

### Custom Ports

Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333:

```bash theme={null}
mintlify dev --port 3333
```

You will see an error like this if you try to run Mintlify in a port that's already taken:

```md theme={null}
Error: listen EADDRINUSE: address already in use :::3000
```

## Mintlify Versions

Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production.

<CodeGroup>
  ```bash bun theme={null}
  bun i -g mintlify@latest
  ```

  ```bash npm theme={null}
  npm i -g mintlify@latest
  ```

  ```bash yarn theme={null}
  yarn global add mintlify@latest
  ```
</CodeGroup>