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

# Quickstart

> Clone the All Things Linux monorepo and preview this documentation site in a few minutes

## Prerequisites

* **Node.js** 24 or newer (see the monorepo root `package.json` engines)
* **pnpm** (version pinned in the root `package.json`)
* Git

## Step 1: Clone and install

Clone the organization repository and install dependencies from the **monorepo root**:

```bash theme={null}
git clone https://github.com/allthingslinux/monorepo.git
cd monorepo
pnpm install
```

## Step 2: Preview the docs

Run the Mintlify dev server for the `@atl/docs` package:

```bash theme={null}
pnpm --filter @atl/docs dev
```

Open **[http://localhost:3000](http://localhost:3000)** (or the port the CLI prints). Edits to MDX and `docs.json` hot-reload.

<Tip>
  You can also `cd apps/docs` and run `pnpm dev`—it invokes the same `mint dev`
  script.
</Tip>

## Step 3: Validate before a pull request

From the repo root:

```bash theme={null}
pnpm --filter @atl/docs exec mint validate
pnpm --filter @atl/docs exec mint broken-links
```

Fix any reported issues, then push your branch and open a PR.

## Next steps

<CardGroup cols={2}>
  <Card title="Development" icon="laptop-code" href="/development">
    Ports, link checks, and CLI updates.
  </Card>

  <Card title="Contributing" icon="git-pull-request" href="/contributing">
    How we review doc changes in the monorepo.
  </Card>

  <Card title="Write with MDX" icon="pen-to-square" href="/essentials/markdown">
    Structure pages and use Mintlify components.
  </Card>

  <Card title="API introduction" icon="book" href="/api-reference/introduction">
    How the sample OpenAPI spec powers the playground.
  </Card>
</CardGroup>

<Note>
  Deployments for this site are managed in the **Mintlify dashboard** (GitHub
  app). After merge to the connected branch, production updates follow
  Mintlify’s pipeline.
</Note>