mkdocs.yaml

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
# ==============================================================================
# SinLess Games Infrastructure Docs
# ==============================================================================
#
# Production MkDocs configuration for the Infrastructure repository.
#
# Build:
#   mkdocs build --clean --strict
#
# Serve locally:
#   mkdocs serve -a 127.0.0.1:8000
#
# Docs root:
#   Docs/
#
# Output:
#   site/
# ==============================================================================

# ------------------------------------------------------------------------------
# Core site metadata
# ------------------------------------------------------------------------------

site_name: SinLess Games Infrastructure Docs
site_description: Architecture, operations, platform, network, Kubernetes, GitOps, and infrastructure documentation for the Infrastructure repository.
site_author: SinLess Games LLC
site_url: https://docs.sinlessgames.com

repo_url: https://github.com/Sinless777/Infrastructure
repo_name: Sinless777/Infrastructure
edit_uri: edit/main/Docs/

docs_dir: Docs
site_dir: site
use_directory_urls: true
strict: true

# Files under Docs/ that should not be published as static site assets.
exclude_docs: |
  Dockerfile
  nginx.conf
  requirements.txt

# ------------------------------------------------------------------------------
# Theme
# ------------------------------------------------------------------------------

theme:
  name: material
  language: en

  favicon: Network/Rack-Diagram.svg
  logo: Network/Rack-Diagram.svg

  # Keep the docs site self-contained and avoid external font calls.
  font: false

  icon:
    repo: fontawesome/brands/github
    logo: material/server-network

  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue grey
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue grey
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

  features:
    # Navigation
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.footer

    # Table of contents
    - toc.follow

    # Search
    - search.highlight
    - search.share
    - search.suggest

    # Code blocks
    - content.code.copy
    - content.code.select
    - content.code.annotate

    # Page actions
    - content.action.edit
    - content.action.view

    # Content tabs
    - content.tabs.link

# ------------------------------------------------------------------------------
# Plugins
# ------------------------------------------------------------------------------

plugins:
  - search:
      lang: en
      separator: '[\s\-\.]+'

  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true
      auto_caption: false
      caption_position: bottom
      skip_classes:
        - skip-lightbox

  - git-revision-date-localized:
      type: timeago
      timezone: America/Boise
      locale: en
      enable_creation_date: true
      fallback_to_build_date: true

  - redirects:
      redirect_maps: {}

  - macros:
      on_error_fail: true
      on_undefined: strict

  - include-markdown:
      preserve_includer_indent: true
      dedent: false
      comments: false

  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
        reduce_boolean_attributes: true
        remove_empty_space: true

# ------------------------------------------------------------------------------
# Markdown extensions
# ------------------------------------------------------------------------------

markdown_extensions:
  # Python Markdown built-ins
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - sane_lists
  - tables

  - toc:
      permalink: true
      toc_depth: 2-4
      title: On this page

  # PyMdown extensions
  - pymdownx.betterem:
      smart_enable: all

  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde

  - pymdownx.details

  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      auto_title: true

  - pymdownx.inlinehilite
  - pymdownx.keys

  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: Sinless777
      repo: Infrastructure

  - pymdownx.smartsymbols

  - pymdownx.snippets:
      base_path:
        - Docs
      check_paths: true

  - pymdownx.superfences:
      preserve_tabs: true
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

  - pymdownx.tabbed:
      alternate_style: true

  - pymdownx.tasklist:
      custom_checkbox: true

# ------------------------------------------------------------------------------
# Extra metadata / template variables
# ------------------------------------------------------------------------------

extra:
  generator: false

  project:
    name: Infrastructure
    owner: SinLess Games LLC
    repository: Sinless777/Infrastructure
    production_domain: docs.sinlessgames.com
    public_domain: sinlessgames.com
    local_domain: local.sinlessgames.com

  infrastructure:
    primary_local_domain: local.sinlessgames.com
    public_domains:
      - sinlessgames.com
      - helixaibot.com
    environments:
      - dev
      - staging
      - prod

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Sinless777/Infrastructure
      name: Infrastructure repository on GitHub

# ------------------------------------------------------------------------------
# Assets
# ------------------------------------------------------------------------------

extra_css:
  - assets/stylesheets/extra.css

# ------------------------------------------------------------------------------
# Copyright
# ------------------------------------------------------------------------------

copyright: Copyright © SinLess Games LLC

# ------------------------------------------------------------------------------
# Navigation
# ------------------------------------------------------------------------------
#
# Strict mode fails when a nav path does not exist. If a future ADR or page has
# not been committed yet, remove or comment that nav entry before building.
# ------------------------------------------------------------------------------

nav:
  - Home: index.md

  - Start Here:
      - Overview: Start-Here/Readme.md
      - Getting Started: Start-Here/00-Getting-Started.md
      - Initialization and Setup: Start-Here/01-Initialization-and-Setup.md
      - Building the Infrastructure: Start-Here/02-Building-the-Infrastructure.md

  - Architecture:
      - Overview: Architecture/ARCHITECTURE.md
      - ACME Architecture: Architecture/ACME-Architecture.md
      - Decisions: Architecture/DECISIONS.md
      - ADRs:
          - ADR-0001: Architecture/ADRs/ADR-0001.md
          - ADR-0002: Architecture/ADRs/ADR-0002.md
          - ADR-0003: Architecture/ADRs/ADR-0003.md
          - ADR-0004: Architecture/ADRs/ADR-0004.md
          - ADR-0005: Architecture/ADRs/ADR-0005.md
          - ADR-0006: Architecture/ADRs/ADR-0006.md
          - ADR-0007: Architecture/ADRs/ADR-0007.md
          - ADR-0008: Architecture/ADRs/ADR-0008.md
          - ADR-0009: Architecture/ADRs/ADR-0009.md
          - ADR-0010: Architecture/ADRs/ADR-0010.md
          - ADR-0011: Architecture/ADRs/ADR-0011.md
          - ADR-0012: Architecture/ADRs/ADR-0012.md
          - ADR-0013: Architecture/ADRs/ADR-0013.md
          - ADR-0014: Architecture/ADRs/ADR-0014.md
          - ADR-0015: Architecture/ADRs/ADR-0015.md
          - ADR-0016: Architecture/ADRs/ADR-0016.md
          - ADR-0017: Architecture/ADRs/ADR-0017.md
          - ADR-0018: Architecture/ADRs/ADR-0018.md
          - ADR-0019: Architecture/ADRs/ADR-0019.md
          - ADR-0020: Architecture/ADRs/ADR-0020.md
          - ADR-0021: Architecture/ADRs/ADR-0021.md
          - ADR-0022: Architecture/ADRs/ADR-0022.md
          - ADR-0023: Architecture/ADRs/ADR-0023.md
          - ADR-0024: Architecture/ADRs/ADR-0024.md
          - ADR-0025: Architecture/ADRs/ADR-0025.md
          - ADR-0026: Architecture/ADRs/ADR-0026.md
          - ADR-0027: Architecture/ADRs/ADR-0027.md
          - ADR-0028: Architecture/ADRs/ADR-0028.md
          - ADR-0029: Architecture/ADRs/ADR-0029.md
          - ADR-0030: Architecture/ADRs/ADR-0030.md
          - ADR-0031: Architecture/ADRs/ADR-0031.md
          - ADR-0032: Architecture/ADRs/ADR-0032.md
          - ADR-0033: Architecture/ADRs/ADR-0033.md
          - ADR-0034: Architecture/ADRs/ADR-0034.md
          - ADR-0035: Architecture/ADRs/ADR-0035.md
          - ADR-0036: Architecture/ADRs/ADR-0036.md

  - Network:
      - Overview: Network/index.md
      - Layer 2/3 Diagram: Network/Layer_2-3_diagram.md
      - Port Map: Network/Port-Map.md
      - Rack Diagram: Network/Rack-Diagram.md
      - Rack Plan: Network/Rack-Plan.md
      - Items and Prices: Network/Items-prices.md

  - Resources:
      - Chaos Engineering: Resources/chaos-engineering.md
      - Cloud Platforms: Resources/cloud-platforms.md
      - Compliance: Resources/compliance.md
      - Developer Portals: Resources/Developer-Portals.md
      - DevSecOps: Resources/dev-sec-ops.md
      - Incident Response: Resources/Incident-Response.md
      - Kubernetes: Resources/Kubernetes.md
      - Supply Chain Security: Resources/Supply-Chain-Security.md
      - Threat Modeling: Resources/Threat-Modeling.md
      - Agentic Workflows:
          - Daily Repo Announcement: Resources/Agentic Workflows/daily-repo-announcement.md
          - Renovate Manager: Resources/Agentic Workflows/renovate-manager.md
          - Repo ChatOps: Resources/Agentic Workflows/repo-chatops.md
          - Repo Docs Drift: Resources/Agentic Workflows/repo-docs-drift.md
          - Repo Failed Run Triage: Resources/Agentic Workflows/repo-failed-run-triage.md
          - Repo Issue Triage: Resources/Agentic Workflows/repo-issue-triage.md
          - Repo Ops Orchestrator: Resources/Agentic Workflows/repo-ops-orchestrator.md
          - Repo PR Risk Review: Resources/Agentic Workflows/repo-pr-risk-review.md
          - Repo Routing Manager: Resources/Agentic Workflows/repo-routing-manager.md
          - Repo Safe Autofix: Resources/Agentic Workflows/repo-safe-autofix.md
          - Repo Security Manager: Resources/Agentic Workflows/repo-security-manager.md