docs.pulsar.byte8.io

Pulsar Documentation

Public documentation site for Pulsar - Magento Monitoring & Synthetic Checks.

URL: https://docs.pulsar.byte8.io

Built with Docusaurus.

Development

# Install dependencies
pnpm install

# Start development server (port 3006)
pnpm start

# Build for production
pnpm build

# Serve production build locally
pnpm serve

Deployment

This site will be deployed to GitHub Pages at docs.pulsar.byte8.io via a separate repository.

# Deploy to GitHub Pages
GIT_USER=<username> pnpm deploy

Structure

docs/
├── intro.md                    # Landing page (/)
├── getting-started/
│   ├── quick-start.md
│   └── adding-sites.md
├── monitoring/
│   ├── http-checks.md
│   ├── browser-checks.md
│   ├── checkout-flows.md
│   └── error-patterns.md
├── alerts/
│   ├── overview.md
│   ├── email-notifications.md
│   ├── slack-integration.md
│   └── webhooks.md
└── api/
    ├── graphql.md
    └── authentication.md

Theme

Custom CSS in src/css/custom.css matches the Pulsar web app color palette: