relier/mkdocs.yml at main · getrelier/relier · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
site_name: Relier
site_description: Zero job loss. Every task completes, hands off, or lands in the DLQ with a traceable reason.
site_url: https://getrelier.github.io/relier
repo_url: https://github.com/getrelier/relier
repo_name: getrelier/relier
edit_uri: ""

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.footer
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - toc.follow
  logo: assets/images/logo.png
  favicon: assets/images/logo.ico
  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js
  - assets/js/mermaid-init.js
  - assets/js/flag-highlight.js

nav:
  - Home: index.md
  - Getting Started:
    - Quickstart: quickstart.md
    - A Quick Celery Primer: celery-primer.md
    - Core Concepts: concepts.md
    - Running Relier: running.md
    - Deployment: deployment.md
  - Guides:
    - Integration Recipes (FastAPI, Flask, Django): integrations.md
    - Patterns Cookbook: patterns.md
    - Rolling Deploys & Schema Migrations: rolling-deploys.md
    - Troubleshooting & FAQ: troubleshooting.md
  - Reference:
    - API Reference: api-reference.md
    - Configuration: configuration.md
    - CLI Reference: cli-reference.md
    - CLI Manual (rl man): rl.md
    - Metrics Reference: metrics.md
  - Deep Dive:
    - Architecture: architecture.md
    - Durability, HA, & Failure Boundaries: durability.md
    - Chaos Guide: chaos-guide.md
    - Benchmarks: benchmarks.md
    - Known Limitations: known-limitations.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - tables
  - toc:
      permalink: true
  - attr_list

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/getrelier/relier
      name: Relier on GitHub
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/relierdev
      name: Relier on X
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/relier/
      name: Relier on PyPI