mkdocs.yml

site_name: application-sdk
site_url: https://k.atlan.dev/application-sdk
repo_url: https://github.com/atlanhq/application-sdk
repo_name: application-sdk
site_description: Docs for application-sdk
site_author: App Framework Team
copyright: App Framework Team © 2025
docs_dir: docs

theme:
  name: material
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    primary: indigo
  logo: static/assets/logo.svg
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - navigation.path

extra:
  homepage: https://k.atlan.dev/application-sdk
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/atlanhq/application-sdk

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - def_list
  - tables
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.arithmatex:
      generic: true

extra_css:
  - static/stylesheets/extra.css

extra_javascript:
  - static/javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Setup:
      - Mac: setup/MAC.md
      - Linux: setup/LINUX.md
      - Windows: setup/WINDOWS.md
      - Troubleshooting: setup/troubleshooting.md
  - Guides:
      # Core concepts
      - Getting Started: guides/getting-started.md
      - Build Your First Connector: guides/build-your-first-app.md
      - Architecture: guides/architecture.md

      # Development guides
      - Creating an SQL Application: guides/sql-application-guide.md
      - Contract Toolkit: guides/contract-toolkit.md
      - Building a REST API Connector: guides/rest-api-application-guide.md
      - Custom Frontends with Atlantis: guides/atlantis.md
      - Secret Stores: guides/secretstores.md
      - PKL Contracts: guides/pkl-contracts.md
      - Deployment: guides/deployment.md
      - Multi-App Coordination: guides/multi-app-coordination.md
      - Runtime Interactions (Signal/Query/Update): guides/runtime-interactions.md

      # Best practices & testing
      - Best Practices: guides/best-practices.md
      - Integration Testing: guides/integration-testing.md
  - Concepts:
      - Apps: concepts/apps.md
      - Contracts: concepts/contracts.md
      - Credentials: concepts/credentials.md
      - Infrastructure: concepts/infrastructure.md
      - Storage: concepts/storage.md
      - State, Secrets, Pub/Sub & Bindings: concepts/state-secrets-pubsub.md
      - Entry Points: concepts/entry-points.md
      - Tasks: concepts/tasks.md
      - Server: concepts/server.md
      - Clients: concepts/clients.md
      - Common: concepts/common.md
      - Handlers: concepts/handlers.md
      - MCP: concepts/mcp.md
      - Monitoring: concepts/monitoring.md
      - Transformers: concepts/transformers.md
  - Migration:
      - What's New in v3: whats-new-v3.md
      - Upgrade Guide v3: upgrade-guide-v3.md
  - Agent Guides:
      - Project Structure: agents/project-structure.md
      - Development Commands: agents/dev-commands.md
      - Coding Standards: agents/coding-standards.md
      - Testing: agents/testing.md
      - Commits and PRs: agents/commits-prs.md
      - Documentation Updates: agents/docs-updates.md
      - Code Review: agents/review.md
      - DeepWiki MCP: agents/deepwiki.md
      - SDK Capability Manifest: agents/sdk-capabilities.md

  - Standards:
      - Coding: standards/coding.md
      - Commits: standards/commits.md
      - Logging: standards/logging.md
      - Exception Handling: standards/exceptions.md
      - Performance: standards/performance.md
      - Testing: standards/testing.md
      - Documentation: standards/documentation.md
      - Build & Security: standards/build-security.md
      - Setup: standards/setup.md
      - DeepWiki MCP: standards/deepwiki.md
      - Review Checklist: standards/review-checklist.md
      - Release Flow: standards/release-flow.md
      - v3 Readiness: standards/v3-readiness.md
  - Architecture Decisions:
      - Index: adr/index.md
      - adr/0001-per-app-handlers.md
      - adr/0002-per-app-workers.md
      - adr/0003-per-app-observability.md
      - adr/0004-build-time-type-safety.md
      - adr/0005-infrastructure-abstraction.md
      - adr/0006-schema-driven-contracts.md
      - adr/0007-apps-as-coordination-unit.md
      - adr/0008-payload-safe-bounded-types.md
      - adr/0009-separate-handler-worker-deployments.md
      - adr/0010-async-first-blocking-code.md
      - adr/0011-logging-level-guidelines.md
  - Reference:
      - CLI: reference/cli.md
      - HTTP API: reference/http-api.md
      - Configuration: configuration.md
  - Postmortems:
      - Shutdown Drain Delay (2026-03-27): rca-shutdown-drain-delay-2026-03-27.md
  - API Reference: https://k.atlan.dev/application-sdk/main/api