Skip to content

morgenruf/docs

Repository files navigation

Morgenruf Documentation

Docs License: MIT

πŸ“š Source for docs.morgenruf.dev β€” the official Morgenruf documentation site.

Overview

This repo contains the HTML documentation for Morgenruf, a self-hosted Slack standup bot with per-project tracking and Kubernetes-ready deployment.

Pages

  • Getting Started β€” Installation, configuration, and first standup
  • Configuration β€” All environment variables and options
  • Slash Commands β€” Full command reference
  • API Reference β€” REST API for integrations
  • Deployment β€” Docker, Kubernetes/Helm, and cloud deployment guides
  • FAQ β€” Frequently asked questions

Structure

  • index.html β€” Home / overview
  • getting-started.html β€” Installation guide
  • configuration.html β€” Configuration reference
  • self-hosting.html β€” Self-hosting guide (k8s, Docker)
  • helm.html β€” Helm chart reference
  • faq.html β€” Frequently asked questions

Local Development

# Serve locally (Python)
python -m http.server 8080

# Or with Node
npx serve .

Then open http://localhost:8080.

Deployment

Docs are automatically deployed to GitHub Pages via .github/workflows/pages.yml on every push to main.

Contributing

Found a mistake or want to improve the docs? PRs welcome! Please keep the existing HTML/CSS style consistent.

See also github.com/morgenruf/morgenruf/blob/main/CONTRIBUTING.md.

About

πŸ“š Morgenruf documentation β€” docs.morgenruf.dev

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors