mkdocs.yml

site_name: recourse
site_description: "Policy-driven, observable resilience for Go services: retries, hedging, circuit breaking, and budgets."
site_url: https://aponysus.github.io/recourse/

repo_url: https://github.com/aponysus/recourse
repo_name: aponysus/recourse
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    scheme: slate
    primary: indigo
    accent: deep purple
  features:
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - content.code.copy
  icon:
    logo: material/book-open-page-variant

plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - toc:
      permalink: true

nav:
  - Overview: index.md
  - Design overview: design-overview.md
  - Why recourse: blog/why-recourse.md
  - Comparison: comparison.md
  - Getting started: getting-started.md
  - Gotchas & safety checklist: gotchas.md
  - Adoption guide: adoption-guide.md
  - Incident debugging: incident-debugging.md
  - Migration:
      - From cenkalti/backoff: migration/from-cenkalti-backoff.md
  - Concepts:
      - Policy keys: concepts/policy-keys.md
      - Key patterns and taxonomy: concepts/key-patterns.md
      - Policies & providers: concepts/policies.md
      - Classifiers: concepts/classifiers.md
      - Observability: concepts/observability.md
      - Budgets & backpressure: concepts/budgets.md
      - Hedging: concepts/hedging.md
      - Circuit Breaking: concepts/circuit-breaking.md
      - Remote Configuration: concepts/remote-configuration.md
      - Integrations: concepts/integrations.md
      - Architecture decisions:
          - Overview: concepts/architecture-decisions.md
          - "ADR 001: Low-cardinality policy keys": adr/001-low-cardinality-keys.md
          - "ADR 003: Policy normalization": adr/003-policy-normalization.md
  - Reference:
      - API compatibility policy: reference/compatibility.md
      - Defaults and safety model: reference/defaults-safety.md
      - Policy schema reference: reference/policy-schema.md
      - Reason codes & timeline fields: reference/reason-codes.md
      - Claims ledger: claims-ledger.md
  - Extending: extending.md
  - Contributing:
      - Onboarding: onboarding.md
      - ADR template: adr/template.md