mkdocs.yml

site_name: altimate-code
site_description: The open-source data engineering harness. 100+ tools for building, validating, optimizing, and shipping data products.
site_url: https://docs.altimate.sh
repo_url: https://github.com/AltimateAI/altimate-code
repo_name: AltimateAI/altimate-code

copyright: "© 2026 Altimate Inc. All rights reserved."

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/images/altimate-code-banner-sml.png
  favicon: assets/images/favicon.png
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - navigation.instant
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.code.copy
    - toc.follow
    - content.tooltips

extra_css:
  - assets/css/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/AltimateAI/altimate-code
    - icon: fontawesome/brands/discord
      link: https://altimate.ai/discord
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/altimate-engine/
  analytics:
    provider: google
    property: G-C89Y5E4JJT
  consent:
    title: Cookie consent
    description: >-
      We use cookies to measure usage and improve the documentation.

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - 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:
  - Getting Started:
      - Overview: getting-started/index.md
      - Quickstart: getting-started/quickstart-new.md
      - Setup: getting-started/quickstart.md
  - Examples:
      - Showcase: examples/index.md
  - Use:
      - Agents:
          - Agent Modes: data-engineering/agent-modes.md
          - Agent Config: configure/agents.md
      - Tools:
          - Overview: configure/tools/index.md
          - Built-in Tools: configure/tools/config.md
          - Core Tools: configure/tools/core-tools.md
          - SQL Tools: data-engineering/tools/sql-tools.md
          - Schema Tools: data-engineering/tools/schema-tools.md
          - FinOps Tools: data-engineering/tools/finops-tools.md
          - Lineage Tools: data-engineering/tools/lineage-tools.md
          - dbt Tools: data-engineering/tools/dbt-tools.md
          - Warehouse Tools: data-engineering/tools/warehouse-tools.md
          - Memory Tools: data-engineering/tools/memory-tools.md
          - Custom Tools: configure/tools/custom.md
      - Skills: configure/skills.md
      - Commands: configure/commands.md
      - Trace: configure/trace.md
      - Interfaces:
          - TUI: usage/tui.md
          - CLI: usage/cli.md
          - SQL Check: usage/check.md
          - Web UI: usage/web.md
          - CI: usage/ci-headless.md
          - IDE: usage/ide.md
          - GitHub: usage/github.md
          - GitLab: usage/gitlab.md
      - Guides:
          - Cost Optimization: data-engineering/guides/cost-optimization.md
          - Migration: data-engineering/guides/migration.md
          - Using with Claude Code: data-engineering/guides/using-with-claude-code.md
          - Using with Codex: data-engineering/guides/using-with-codex.md
          - ClickHouse: data-engineering/guides/clickhouse.md
  - Configure:
      - Overview: configure/index.md
      - Warehouses: configure/warehouses.md
      - LLMs:
          - Providers: configure/providers.md
          - Models: configure/models.md
          - Bedrock Custom Endpoints: configure/bedrock-custom-endpoints.md
      - MCPs & ACPs:
          - MCP Servers: configure/mcp-servers.md
          - ACP Support: configure/acp.md
      - Appearance:
          - Themes: configure/themes.md
          - Keybinds: configure/keybinds.md
      - Training:
          - Overview: data-engineering/training/index.md
          - Team Deployment: data-engineering/training/team-deployment.md
      - Additional Config:
          - LSP Servers: configure/lsp.md
          - Network: reference/network.md
          - Windows / WSL: reference/windows-wsl.md
      - Config File Reference: configure/config.md
  - Governance:
      - Overview: configure/governance.md
      - Rules: configure/rules.md
      - Permissions: configure/permissions.md
      - Context Management: configure/context-management.md
      - Formatters: configure/formatters.md
  - Reference:
      - Changelog: reference/changelog.md
      - Telemetry: reference/telemetry.md
      - Security FAQ: reference/security-faq.md
      - Troubleshooting: reference/troubleshooting.md
      - Extend:
          - SDK: develop/sdk.md
          - Server API: develop/server.md
          - Plugins: develop/plugins.md
          - Ecosystem: develop/ecosystem.md