mkdocs.yml

site_name: Smart Router
site_description: Centralised RPC routing gateway with QoS-based selection, caching, and failover policies.
# Public docs host — drives <link rel="canonical"> and the og:url / sitemap base.
# Keep this on docs.magmadevs.com (not the github.io copy) so search engines treat
# the public host as authoritative.
site_url: https://docs.magmadevs.com/
# Header GitHub icon points at the Smart Router code repo.
repo_url: https://github.com/Magma-Devs/smart-router
repo_name: Magma-Devs/smart-router
# "Edit this page" still targets the docs repo (full URL overrides repo_url).
edit_uri: https://github.com/Magma-Devs/docs/edit/main/docs/

theme:
  name: material
  # SEO/social meta tags (OG + Twitter Card) live in overrides/main.html's
  # extrahead block, emitted per page from front-matter title/description.
  custom_dir: overrides

  # Magma brand — real logos shipped from design
  logo: assets/magma-devs-logo.png
  favicon: assets/magma-mark.svg
  font:
    text: Inter
    code: Geist Mono

  features:
    - navigation.sections
    - navigation.indexes
    - navigation.expand
    - navigation.top
    - navigation.tracking
    - navigation.path
    - navigation.footer
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - search.suggest
    - search.highlight
    - toc.follow

  icon:
    repo: fontawesome/brands/github

  palette:
    # Single light scheme — no toggle button (drpc-style clean header).
    scheme: default
    primary: custom
    accent: custom

# Declaring any plugin disables the implicit `search` plugin, so it must be
# listed explicitly here alongside the git-revision date stamp.
plugins:
  - search
  - git-revision-date-localized:
      type: date
      enable_creation_date: false

# Build hooks. llms_full.py concatenates every page into site/llms-full.txt
# (the LLM-ingestion corpus) in nav order at post-build, and emits a per-page
# Markdown twin next to each page (URL minus trailing slash + .md) — always in
# sync with content, no manual upkeep. The curated index is docs/llms.txt.
# asset_fingerprint.py appends `?v=<content hash>` to every local entry of
# extra_css / extra_javascript below, so a changed file is a new URL and the
# Cloudflare edge cache in front of the site can never serve a stale copy of it.
hooks:
  - hooks/llms_full.py
  - hooks/asset_fingerprint.py

# Community / support links — rendered as icons in the footer on every page.
extra:
  # Google Analytics 4 — Material injects gtag.js on every page automatically.
  analytics:
    provider: google
    property: G-GQQEQ7XVPL
    # "Was this page helpful?" widget. Emits GA4 feedback events per page so the
    # docs team can see which pages underperform. Only records once the visitor
    # has accepted analytics cookies (same consent gate as gtag).
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/thumb-up-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for the feedback.
        - icon: material/thumb-down-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks — <a href="https://github.com/Magma-Devs/docs/issues/new" target="_blank" rel="noopener">tell us what was missing</a>.
  # LinkedIn Insight Tag partner id — consumed by
  # overrides/partials/integrations/linkedin.html and fired under the same
  # consent gate as GA (see the analytics dispatcher override). Unset → no tag.
  linkedin_partner_id: "9287986"
  # Cookie-consent banner. Both GA and the LinkedIn Insight Tag are gated on
  # the `analytics` category — neither fires until the visitor accepts.
  consent:
    title: Cookie consent
    description: >-
      We use cookies to measure and improve these docs.
    cookies:
      analytics:
        name: Google Analytics & LinkedIn
        checked: false
    actions:
      - accept
      - reject
      - manage
  social:
    - icon: fontawesome/brands/telegram
      link: https://t.me/magmadevs
      name: Support & community on Telegram

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/consent-mode.js
  - javascripts/tablesort.js
  - javascripts/toc-title.js
  - javascripts/copy-page.js
  - javascripts/search-hint.js
  - javascripts/nav-top.js
  - javascripts/mobile-nav-search.js
  - javascripts/chains-data.js
  - javascripts/chains-explorer.js
  - javascripts/managed-popup.js

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - toc

# Nav lists only pages that exist. Add entries as content is written.
nav:
  - Quickstart:
      - Why Smart Router?: why.md
      - Quick start: index.md
  - Run Smart Router:
      - deployment/index.md
      - Local binary: deployment/local-binary.md
      - Docker Compose: deployment/docker-compose.md
      - Config wizard: deployment/wizard.md
      - Cache:
          - deployment/cache/index.md
          - Redis / Valkey backend: deployment/cache/redis.md
          - Secondary cache: deployment/cache/secondary.md
      - Dashboard: deployment/dashboard.md
  - Configure:
      - configuration/index.md
      - Connect your app: api/url.md
      - Config file: configuration/config-file.md
      - Authentication: configuration/authentication.md
      - Request headers: api/directives.md
      - RPC Node selection: configuration/projects/selection-policies.md
      - Sticky sessions: configuration/sticky-sessions.md
      - Cross-validation: configuration/failover/cross-validation.md
      - Failover & retry:
          - configuration/failover/index.md
          - Retry: configuration/failover/retry.md
          - Hedge: configuration/failover/hedge.md
          - Timeout: configuration/failover/timeout.md
          - Integrity: configuration/failover/integrity.md
          - Circuit breaker: configuration/failover/circuit-breaker.md
      - CLI flags: reference/cli.md
  - Supported chains:
      - reference/chains/index.md
      - Chain specs: reference/chains/specs.md
      - Examples:
          - reference/chains/examples/index.md
          - Ethereum: reference/chains/ethereum.md
          - Solana: reference/chains/solana.md
          - Bitcoin: reference/chains/bitcoin.md
          - Hyperliquid: reference/chains/hyperliquid.md
          - Cosmos: reference/chains/cosmos.md
          - Aptos: reference/chains/aptos.md
  - Observability:
      - reference/observability/index.md
      - Metrics: reference/metrics.md
      - Traces: reference/traces.md
      - Profiling: reference/profiling.md
      - Error codes: reference/error-codes.md