mkdocs.yml

# SPDX-License-Identifier: Apache-2.0
# Copyright 2025 Provability-Fabric Contributors

site_name: Provability-Fabric
site_description: Open-source framework for AI agent behavioral guarantees
site_author: Provability-Fabric Contributors
site_url: https://provability-fabric.org

repo_name: SentinelOps-CI/provability-fabric
repo_url: https://github.com/SentinelOps-CI/provability-fabric
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to system preference

plugins:
  - search
  - mermaid2

markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - meta
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - Getting Started: guides/getting-started.md
  - Proof-Carrying Science:
      - Overview: pcs/README.md
      - Quickstart: pcs/quickstart.md
      - Verification: pcs/verification.md
      - Admission benchmarks: pcs/admission-benchmarks.md
      - Clean checkout chain: pcs/clean-checkout-chain.md
      - Fixtures: pcs/fixtures.md
      - Release checklist: pcs/release-checklist.md
      - Glossary: pcs/glossary.md
  - Guides:
    - Deployment: guides/deployment-guide.md
    - Developer Guide: guides/developer-guide.md
    - Testing: guides/testing-guide.md
    - Examples: guides/examples.md
    - Demos: guides/demos.md
    - Quickstarts: guides/quickstarts.md
    - Platform: guides/platform.md
    - Reuse and extend: guides/reuse-and-extend.md
    - Extension points: guides/extension-points.md
    - Morph: guides/morph.md
    - Spec Assistant: guides/specassistant.md
  - Architecture:
    - Overview: architecture/overview.md
    - Decision Path: architecture/decision-path.md
    - Guarantees: architecture/guarantees.md
    - Policy: architecture/policy.md
    - Multi-Channel: architecture/policy/multi_channel.md
    - Multi-Tenant: architecture/multi-tenant.md
    - Cross-Region DR: architecture/cross-region-dr.md
  - Reference:
    - CLI: reference/cli-reference.md
    - API: reference/api-reference.md
    - WebSocket API: reference/api/websocket-api.md
    - Configuration: reference/configuration.md
    - Versioning: reference/versioning.md
    - CI: reference/ci-reference.md
    - Error Catalog: reference/error-catalog.md
    - Proof Quality Gates: reference/proof-quality-gates.md
  - Specs:
    - Plan DSL: specs/plan-dsl.md
    - Egress Certificate: specs/egress-certificate.md
    - DSSE Verify Contract: specs/dsse-verify-contract.md
    - Standards: specs/standards.md
    - CERT-V1 Quickstart: specs/standards/CERT-V1-quickstart.md
  - Evidence:
    - Overview: evidence/overview.md
    - Replay: evidence/replay.md
  - Security:
    - Overview: security/overview.md
    - Threat Model: security/threat_model.md
    - SLSA: security/slsa.md
    - Signing & Rotation: security/signing-rotation.md
    - Enclave Attestation: security/enclave-attestation.md
  - Runtime:
    - Attestation: runtime/attestation.md
    - Performance: runtime/perf.md
    - SLOs: runtime/slo.md
  - Adapters:
    - Overview: adapters/overview.md
    - Alpha-Beta-CROWN: adapters/alpha-beta-crown.md
    - Action DSL Sidecar: adapters/action-dsl-sidecar.md
  - Integrations:
    - OpenAI: integrations/openai.md
    - MCP:
      - Integration: integrations/mcp/integration.md
      - Quick Reference: integrations/mcp/quick-reference.md
      - Migration: integrations/mcp/migration-guide.md
  - Runbooks:
    - Index: runbooks/README.md
    - Deployment: runbooks/deployment.md
    - Rollback: runbooks/rollback.md
    - Incident Response: runbooks/incident-response.md
    - Break Glass: runbooks/break-glass.md
    - Operations: runbooks/operations.md
    - Surge: runbooks/surge.md
    - Approvals: runbooks/approvals.md
    - GuardTrip Triage: runbooks/guardtrip-triage.md
  - Features:
    - Real-Time Communication: features/real-time-communication.md
    - Dev Mode E4: features/dev-mode-e4.md
    - Authentication: features/authentication.md
    - Advanced Search: features/advanced-search.md
  - Compliance:
    - SOC2: compliance/soc2.md
    - Safety Case: compliance/safety_case.md
    - Insurance: compliance/insurance.md
  - Community:
    - Governance: community/governance.md
  - Dev:
    - Lean Build: dev/lean-build.md
  - Glossary: glossary.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/SentinelOps-CI/provability-fabric
    - icon: fontawesome/brands/discord
      link: https://discord.gg/provability-fabric
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/provabilityfab

extra_css:
  - stylesheets/extra.css

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