Status Page Overview

Service health dashboard with incidents and uptime tracking

Last updated: March 15, 2026

status-pageoverview

Status Page Overview

MinimalDoc includes a standalone status page for service health monitoring.

Features

Feature Description
Component Status Track multiple services
Incidents Document and track issues
Maintenance Schedule downtime windows
Uptime Grid 90-day visual display
SLA Display Track uptime percentages
Health Checks Live endpoint polling
RSS Feed Subscribe to updates
JSON API Machine-readable status

Quick Start

  1. Create status directory:
docs/
├── config.yaml          # Status settings here
└── __status__/
    ├── components.yaml  # Service definitions
    ├── incidents/
    └── maintenance/
  1. Enable in config:
status:
  enabled: true
  title: "Service Status"
  path: "status"
  1. Build:
minimaldoc build --status

Directory Structure

docs/
├── config.yaml              # Site config (includes status settings)
└── __status__/
    ├── components.yaml      # Service definitions
    ├── incidents/
    │   └── YYYY-MM-DD-incident-name.md
    └── maintenance/
        └── YYYY-MM-DD-maintenance-name.md

The __status__ prefix avoids conflicts with documentation content.

Generated Output

public/
└── status/
    ├── index.html           # Main dashboard
    ├── history.html         # Incident history
    ├── incident/
    │   └── *.html           # Individual incidents
    ├── status.json          # JSON API
    └── feed.xml             # RSS feed

Status Dashboard

The main dashboard displays:

  • Overall system status with color indicator
  • Component list grouped by category
  • Live health check results with latency (if configured)
  • Recent incidents section
  • Scheduled maintenance section
  • 90-day uptime grid per component

Status Values

Status Color Description
operational Green Fully functional
degraded Yellow Reduced performance
partial_outage Orange Some features unavailable
major_outage Red Service unavailable
maintenance Blue Planned maintenance

Overall Status

Calculated from component statuses:

Components Overall Status
All operational Operational
Any degraded Degraded Performance
Any partial outage Partial Outage
Any major outage Major Outage
Any in maintenance Under Maintenance

Configuration Options

status:
  enabled: true
  title: "Service Status"
  description: "Current status of our services"
  path: "status"
  show_history: true
  history_months: 12
  rss_enabled: true
Option Default Description
enabled false Enable status page
title "Service Status" Page title
description "" Page description
path "status" Output path
show_history true Show incident history
history_months 12 Months of history
rss_enabled true Generate RSS feed

Next Steps