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

# Development

> Run the Hostifer docs site locally and validate changes

<Info>
  **Prerequisites**: - Node.js version 19 or higher - A documentation workspace
  with a `docs.json` file
</Info>

Use this workflow to preview the docs site while you edit Hostifer content.

<Steps>
  <Step title="Install the Mintlify CLI">
    ```bash theme={null}
    npm i -g mint
    ```
  </Step>

  <Step title="Start a local preview">
    Navigate to the documentation folder and run:

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

    Your local preview is available at `http://localhost:3000`.
  </Step>
</Steps>

## Custom ports

Mintlify uses port 3000 by default. Change it with the `--port` flag when needed.

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

If port 3000 is busy, Mintlify picks the next available port automatically.

```md theme={null}
Port 3000 is already in use. Trying 3001 instead.
```

## Validate links before publishing

Run the broken link check before you publish changes.

```bash theme={null}
mint broken-links
```

## What the guide section covers

Use the guide pages to explain Hostifer onboarding and the docs workflow.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Walk through account setup, project creation, and your first deployment.
  </Card>

  <Card title="API introduction" icon="book-open" href="/api-reference/introduction">
    Review auth headers, SSE logs, and webhook expectations.
  </Card>

  <Card title="Docs settings" icon="gear" href="/essentials/settings">
    Understand the docs site configuration in `docs.json`.
  </Card>

  <Card title="Navigation" icon="map" href="/essentials/navigation">
    Organize the docs sidebar for new pages.
  </Card>
</CardGroup>

## Troubleshooting

<AccordionGroup>
  <Accordion title="The preview does not load">
    Make sure you are running `mint dev` from the directory that contains `docs.json`.
  </Accordion>

  <Accordion title="Links or pages do not appear in the sidebar">
    Check `docs.json` and make sure the page path is included under the right tab
    and group.
  </Accordion>

  <Accordion title="You see a sample page you no longer want">
    Remove the page from navigation or replace the starter content with Hostifer content.
  </Accordion>
</AccordionGroup>

## Helpful references

<Card title="Global settings" icon="gear" href="/essentials/settings">
  Learn how the docs site is configured.
</Card>
