Skip to content

Welcome to NFRAOPS

This is the GitHub organization website for NFRAOPS, built with MkDocs and featuring a ClickHouse-inspired dark theme.

Quick Navigation

  • Architecture - System architecture and design decisions
  • Diagrams - PlantUML diagrams and visual documentation
  • Elements - Markdown element usage guides
  • About - About this site

Getting Started

This site is built with MkDocs and served locally using:

make serve

For detailed setup instructions, see the repository README.

Features

  • Static Documentation: Pure MkDocs static site, no server-side processing
  • ClickHouse Theme: Dark theme inspired by ClickHouse design (pure black background, neon accents)
  • Poetry-Powered: Modern Python dependency management with Poetry
  • Automated Deployment: Auto-deploys to GitHub Pages on push to main branch
  • Container Support: Docker support for consistent development environments