mkdocs.yml

site_name: apcore — AI-Perceivable Core
site_description: A governed, protocol-neutral runtime and module standard for agent-callable application capabilities.
site_url: https://aiperceivable.github.io/apcore/
repo_url: https://github.com/aiperceivable/apcore
repo_name: aiperceivable/apcore

theme:
  name: material
  logo: assets/apcore-logo.svg
  favicon: assets/apcore-logo.svg
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.tabs
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - toc.follow

plugins:
  - search

markdown_extensions:
  - tables
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
  - attr_list
  - md_in_html

nav:
  - Start Here:
      - Project Overview: index.md
      - Core Concepts: concepts.md
      - Getting Started: getting-started.md
      - Glossary: glossary.md
  - Concepts & Architecture:
      - Project Positioning: POSITIONING.md
      - Architecture Design: architecture.md
      - Documentation Map: site-map.md
  - Guides:
      - Overview: guides/index.md
      - Foundations:
          - Creating Modules: guides/creating-modules.md
          - Schema Definition: guides/schema-definition.md
          - Testing Modules: guides/testing-modules.md
      - Governance & Extension:
          - ACL Configuration: guides/acl-configuration.md
          - Middleware System: guides/middleware.md
      - Professional Integration:
          - Multi-Language: guides/multi-language.md
          - Adapter Development: guides/adapter-development.md
          - Legacy Integration: guides/integrating-existing-projects.md
      - Cookbooks:
          - Approval Flow: guides/cookbook-approval-flow.md
          - Cancellation: guides/cookbook-cancellation.md
          - Streaming: guides/cookbook-streaming.md
          - Observability: guides/cookbook-observability.md
      - Troubleshooting: guides/troubleshooting.md
  - Features:
      - Overview: features/index.md
      - Foundational Protocols:
          - Module Interface: features/module-interface.md
          - Context Object: features/context-object.md
          - APCore Client: features/apcore-client.md
          - Bindings (Decorator/YAML): features/decorator-bindings.md
      - Execution & Workflow:
          - Core Executor: features/core-executor.md
          - Streaming Pipeline: features/streaming.md
          - Async Task Management: features/async-tasks.md
          - Cancellation Mechanism: features/cancellation.md
          - Config Bus: features/config-bus.md
      - Security & Governance:
          - ACL System: features/acl-system.md
          - Identity System: features/identity-system.md
          - Approval System: features/approval-system.md
          - Call Chain Guard: features/call-chain-guard.md
      - Reliability & Ops:
          - Observability: features/observability.md
          - Error & AI Guidance: features/error-system.md
          - Event System: features/event-system.md
          - System Modules (system.*): features/system-modules.md
      - Framework Internals:
          - Registry System: features/registry-system.md
          - Schema System: features/schema-system.md
          - Extension Points: features/extension-system.md
          - Middleware System: features/middleware-system.md
          - Multi-Module Discovery: features/multi-module-discovery.md
  - Framework Specs:
      - spec/index.md
      - Core Specs:
          - Canonical Protocol Spec: spec/protocol-spec.md
          - Conformance Definition: spec/conformance.md
          - Declarative Config Spec: spec/DECLARATIVE_CONFIG_SPEC.md
          - Type Mapping: spec/type-mapping.md
          - API Surface & Naming Conventions: spec/api-surface-conventions.md
          - Algorithm Reference: spec/algorithms.md
          - Security Considerations: spec/security-considerations.md
      - Design Docs:
          - Execution Pipeline Design: spec/design-execution-pipeline.md
          - Durability Boundary: spec/design-durability-boundary.md
          - Context-Annotations-ACL Design: spec/design-context-annotations-acl.md
      - RFCs & Logs:
          - Decision Log (2026-05): spec/2026-05-decision-log.md
          - Decision Log (2026-09): spec/2026-09-decision-log.md
          - "RFC — preview() Method": spec/rfc-preview-method.md
          - "RFC — Ephemeral Modules": spec/rfc-ephemeral-modules.md
          - "RFC — include: Config Composition": spec/rfc-config-include.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/aiperceivable/apcore