unfault website and documentation

The marketing website and developer documentation for unfault, served at unfault.dev.

Stack

• Astro - Static site generator
• Starlight - Documentation theme
• React - Interactive components
• TailwindCSS - Styling
• starlight-llms-txt - AI-friendly documentation export

Local Development

cd www
npm install
npm run dev

The site runs at http://localhost:4321.

Project Structure

www/
├── public/                      # Static assets (logos, images)
├── src/
│   ├── components/              # React/Astro components
│   ├── content/
│   │   └── docs/
│   │       └── docs/            # Documentation content (MDX)
│   │           ├── index.mdx    # Welcome page
│   │           ├── installation.mdx
│   │           ├── quick-start.mdx
│   │           ├── concepts/    # Explanation docs
│   │           ├── tutorials/   # Learning-oriented guides
│   │           ├── guides/      # How-to guides
│   │           ├── contributing/# Contributor docs
│   │           └── reference/   # Reference material
│   ├── pages/                   # Marketing pages
│   └── styles/                  # Global styles
├── astro.config.mjs             # Astro + Starlight config
└── package.json

Documentation Guidelines

All documentation follows the Diataxis framework:

Type	Purpose	Question it answers
Tutorials	Learning-oriented	"Can you teach me to...?"
How-to Guides	Task-oriented	"How do I...?"
Reference	Information-oriented	"What is...?"
Explanation	Understanding-oriented	"Why...?"

Voice and Tone

Write like a senior engineer helping another engineer. Calm, precise, practical. No hype, no urgency. Assume competence.

See AGENTS.md for the complete voice guide.

Building for Production

npm run build

Output goes to ./dist/.

Adding Documentation

1. Create an .mdx file in the appropriate folder under src/content/docs/docs/
2. Add frontmatter with title, description, and slug
3. If needed, update the sidebar in astro.config.mjs

Example frontmatter:

---
title: Your Page Title
description: A brief description for SEO and link previews.
slug: docs/section/page-name
---

LLM-friendly Output

The site generates two files for AI consumption:

• https://unfault.dev/llms.txt - Condensed documentation
• https://unfault.dev/llms-full.txt - Full documentation

These are automatically generated by the starlight-llms-txt plugin.