Skip to main content

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.

​
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: 
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: 
pnpm --filter @atl/docs dev
Open http://localhost:3000 (or the port the CLI prints). Edits to MDX and docs.json hot-reload.
You can also cd apps/docs and run pnpm dev—it invokes the same mint dev script.

​
Step 3: Validate before a pull request

From the repo root: 
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

Development

Ports, link checks, and CLI updates.

Contributing

How we review doc changes in the monorepo.

Write with MDX

Structure pages and use Mintlify components.

API introduction

How the sample OpenAPI spec powers the playground.
Deployments for this site are managed in the Mintlify dashboard (GitHub app). After merge to the connected branch, production updates follow Mintlify’s pipeline.