Skip to main content

​
Who this is for

These docs live in the allthingslinux monorepo. All Things Linux is a volunteer-driven 501(c)(3) non-profit; contributions here support public, open-source work. See About All Things Linux for mission and community links. Use this page if you want to fix a typo, add a guide, or follow our documentation workflow.

​
Repository layout

The documentation app is under apps/docs/. It is a normal package in the pnpm workspace (@atl/docs). Site configuration is in docs.json; pages are MDX files next to that file.

​
Local preview

From the repository root: 
pnpm install
pnpm --filter @atl/docs dev
Or from apps/docs: 
pnpm dev
This runs mint dev and serves a preview (default port 3000).

​
Quality checks

Before opening a pull request: 
pnpm --filter @atl/docs exec mint validate
pnpm --filter @atl/docs exec mint broken-links
CI runs the same checks when apps/docs/** changes.

​
Writing standards

Follow Contribute to the documentation for style and review expectations. Agent-oriented instructions for editors live in AGENTS.md.