mkdocs.yml

site_name: Nexus
site_description: Provider-agnostic credential brokering for autonomous agents. Built by Prescott Data.
site_url: https://prescott-data.github.io/nexus-framework/
repo_url: https://github.com/Prescott-Data/nexus-framework
repo_name: Prescott-Data/nexus-framework
edit_uri: edit/main/docs/

docs_dir: docs
site_dir: site

theme:
  name: material
  logo: assets/nexus-logo-blue.png
  favicon: assets/nexus-logo-blue.png
  palette:
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - navigation.path
    - navigation.footer
    - toc.follow
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.tooltips

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/header.js
  - javascripts/llm-assist.js

plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: ['.']
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home:
      - Overview: index.md
      - Website: https://developers.prescottdata.io
      - Community: https://discord.gg/AbskSXypq
      - Blog: https://developers.prescottdata.io/blog
  - Concepts:
      - Architecture: concepts/architecture.md
      - The Broker: concepts/broker.md
      - The Gateway: concepts/gateway.md
      - The Bridge: concepts/bridge.md
      - Connections: concepts/connections.md
      - Provider Types: concepts/provider-types.md
      - Auth Strategies: concepts/auth-strategies.md
      - Agent Identity: concepts/agent-identity.md
      - Security Model: concepts/security-model.md
      - Client Libraries: concepts/client-libraries.md
  - Getting Started:
      - Deploy in Five Minutes: getting-started/quickstart.md
      - Configuration: getting-started/configuration.md
      - Your First Connection: getting-started/first-connection.md
  - Guides:
      - Providers: guides/registering-a-provider.md
      - Integrating Agents: guides/integrating-agents.md
      - Go SDK: sdks/go.md
      - TypeScript SDK: sdks/typescript.md
      - Python SDK: sdks/python.md
      - Agent Sessions: guides/agent-sessions.md
      - Static Credential Flow: guides/static-credentials.md
      - OBO Delegation: guides/obo-delegation.md
      - MCP Server Integration: guides/mcp-integration.md
      - Handling Attention State: guides/attention-state.md
      - Troubleshooting: guides/troubleshooting.md
      - Security-as-Code: guides/security-as-code.md
      - Deploying Nexus: infrastructure/deploying-nexus.md
  - Reference:
      - API Reference: reference/api.md
      - CLI Reference: reference/cli.md
      - Audit Log: reference/audit-log.md
      - Security Model: reference/security-model.md
      - Changelog: CHANGELOG.md


extra:
  version: "0.2.3"
  social:
    - icon: material/web
      link: https://developers.prescottdata.io
      name: Prescott Data Developer Hub
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/prescottdata
      name: Prescott Data on X
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/prescott-data/
      name: Prescott Data on LinkedIn
    - icon: fontawesome/brands/github
      link: https://github.com/Prescott-Data/nexus-framework
      name: nexus-framework on GitHub
    - icon: fontawesome/brands/discord
      link: https://discord.gg/AbskSXypq
      name: Join our Discord