mkdocs.yml

site_name: zae-limiter
site_url: https://zeroae.github.io/zae-limiter/
site_description: Rate limiting library backed by DynamoDB using the token bucket algorithm
site_author: ZeroAE
repo_url: https://github.com/zeroae/zae-limiter
repo_name: zeroae/zae-limiter
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.top
    - navigation.footer
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - search.suggest
    - search.highlight
  logo: assets/zae-limiter-icon-white.svg
  favicon: assets/zae-limiter.ico
  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            docstring_options:
              ignore_init_summary: true
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true
            separate_signature: true
            signature_crossrefs: true

extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/zeroae/zae-limiter
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/zae-limiter/

markdown_extensions:
  - attr_list
  - mkdocs-click
  - admonition
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: false
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true
  - md_in_html

nav:
  - Home: index.md
  - User Guide:
      - Getting Started: getting-started.md
      - Token Bucket Algorithm: guide/token-bucket.md
      - Basic Usage: guide/basic-usage.md
      - Configuration Hierarchy: guide/config-hierarchy.md
      - Hierarchical Limits: guide/hierarchical.md
      - LLM Integration: guide/llm-integration.md
      - Usage Snapshots: guide/usage-snapshots.md
      - Unavailability Handling: guide/unavailability.md
  - Operator Guide:
      - Deployment: infra/deployment.md
      - Production: infra/production.md
      - CloudFormation: infra/cloudformation.md
      - Migrations:
          - Framework: migrations.md
          - "Namespace Keys (v0.10.0)": migrations/namespace-keys.md
      - Troubleshooting: operations/index.md
      - Monitoring: monitoring.md
      - Auditing: infra/auditing.md
      - Performance: performance.md
  - Reference:
      - CLI: cli.md
      - API:
          - Overview: api/index.md
          - RateLimiter: api/limiter.md
          - Repository: api/repository.md
          - Models: api/models.md
          - Exceptions: api/exceptions.md
      - Benchmarks: benchmarks.md
  - Contributing:
      - Overview: contributing/index.md
      - Development Setup: contributing/development.md
      - LocalStack: contributing/localstack.md
      - Testing: contributing/testing.md
      - Architecture: contributing/architecture.md
  - ADRs:
      - ADR Format: adr/000-adr-format-standard.md
      - Foundational (v0.1.0-v0.4.0):
          - ADR-001 Single-Table DynamoDB: adr/001-single-table-dynamodb.md
          - ADR-002 Integer Arithmetic: adr/002-integer-arithmetic-millitokens.md
          - ADR-003 CloudFormation Infra: adr/003-cloudformation-infrastructure.md
          - ADR-004 StackOptions: adr/004-declarative-stack-options.md
          - ADR-005 Exception Hierarchy: adr/005-exception-hierarchy.md
          - ADR-006 Flat Schema Snapshots: adr/006-flat-schema-snapshots.md
          - ADR-007 Input Validation: adr/007-input-validation.md
          - ADR-008 Audit Logging: adr/008-security-audit-logging.md
          - ADR-009 Version Migration: adr/009-version-migration-system.md
          - ADR-010 Consumed Counter: adr/010-total-consumed-counter.md
          - ADR-011 API/CLI Parity: adr/011-api-cli-parity.md
          - ADR-012 CloudFormation Docs Parity: adr/012-cloudformation-docs-parity.md
          - ADR-013 Module Documentation Parity: adr/013-module-documentation-parity.md
      - Centralized Config (v0.5.0):
          - ADR-100 Overview: adr/100-centralized-config.md
          - ADR-101 Flat Schema: adr/101-flat-schema-config.md
          - ADR-102 Config Hierarchy: adr/102-config-hierarchy.md
          - ADR-103 Config Caching: adr/103-config-caching.md
          - ADR-104 Stored Limits Default: adr/104-stored-limits-default.md
          - ADR-105 Eventual Consistency: adr/105-eventual-consistency.md
          - ADR-106 Audit Entity IDs: adr/106-audit-entity-ids-for-config.md
          - ADR-107 IAM Roles: adr/107-iam-roles-for-application-access.md
      - Repository Protocol (v0.5.0):
          - ADR-108 Repository Protocol: adr/108-repository-protocol.md
          - ADR-109 Backend Capabilities: adr/109-backend-capability-matrix.md
          - ADR-110 Deprecation Strategy: adr/110-deprecation-constructor.md
      - Schema & Infra (v0.6.0+):
          - ADR-111 Flatten All Records: adr/111-flatten-all-records.md
          - ADR-112 Cascade Per Entity: adr/112-cascade-per-entity.md
          - ADR-113 Lambda Packaging: adr/113-lambda-packaging.md
      - Composite Items (v0.8.0):
          - ADR-114 Composite Bucket Items: adr/114-composite-bucket-items.md
          - ADR-115 ADD-Based Writes: adr/115-add-based-writes-lazy-refill.md
      - IAM Resources (v0.9.0):
          - ADR-116 IAM Role Naming: adr/116-iam-role-naming.md
          - ADR-117 Managed Policies by Default: adr/117-managed-policies-by-default.md
          - ADR-124 Rename IAM Policies: adr/124-policy-rename-clarity.md
      - Config Hierarchy & TTL (v0.8.0+):
          - ADR-118 Four-Level Config Hierarchy: adr/118-four-level-config-hierarchy.md
          - ADR-119 Bucket TTL Strategy: adr/119-bucket-ttl-strategy.md
          - ADR-120 Bucket Param Sync: adr/120-bucket-param-sync.md
      - Sync & Repository (v0.9.0+):
          - ADR-121 Native Sync (Unasync): adr/121-native-sync-unasync.md
          - ADR-122 Resolve Limits on Repository: adr/122-resolve-limits-on-repository.md
      - Pre-1.0 Hardening (v0.10.0+):
          - ADR-123 Local Secondary Indexes: adr/123-local-secondary-indexes.md