SlopOS Documentation

Official documentation for SlopOS, the operating system that boots when the Wheel of Fate allows it.

Writing

Pages live in content/docs/, one MDX file each; sidebar order is set by the meta.json in each folder. Read STYLE.md before writing or editing a page, and check facts against the SlopOS source rather than other pages. Diagrams are React components in components/diagrams/.

Development

This site is built with Fumadocs, Next.js, and Bun.

Install dependencies:

bun install

Run the development server:

bun run dev

View your local preview at http://localhost:3000.

Useful checks:

bun run types:check
bun run lint
bun run build

Publishing

Deploy the repository on Vercel. Vercel detects bun.lock and uses Bun for dependency installation.

License

Documentation content follows the main SlopOS license: GPL-3.0-or-later.