mkdocs.yml

site_name: OpenMed
site_description: "Local-first OpenMed documentation for clinical NLP, de-identification, model discovery, and on-device or self-hosted healthcare workflows."
site_url: https://openmed.life/docs/
site_dir: site/docs
repo_url: https://github.com/maziyarpanahi/openmed
repo_name: maziyarpanahi/openmed
edit_uri: edit/master/docs/
copyright: "© {year} Maziyar Panahi — OpenMed SDK: Apache-2.0"
strict: true

nav:
  - Overview:
      - Welcome: index.md
      - Feature Map: feature-map.md
      - OpenMed 2.2.0 Release Notes: release/v2.2.0.md
      - OpenMed 2.2 Tested Standards Matrix: release/v2.2-standards-matrix.md
      - OpenMed 2.1.0 Release Notes: release/v2.1.0.md
      - OpenMed 2.0.0 Release Notes: release/v2.0.0.md
      - v1.6-v1.7 Feature Coverage: release/v1.6-v1.7-feature-coverage.md
      - Quick Start: getting-started.md
      - African Developer Onboarding: africa-onboarding.md
      - Low-Bandwidth & Proxy Install: low-bandwidth-install.md
      - Persona Quickstarts: quickstarts.md
      - Project Scaffold CLI: cli/openmed-init.md
      - China Onboarding: onboarding-china.md
      - India Onboarding: onboarding-india.md
  - Core Guides:
      - Building with an Agent: agent-usage.md
      - Analyze Text Helper: analyze-text.md
      - REST Service (MVP): rest-service.md
      - MCP Client Connections: mcp-clients.md
      - MCP Clinical Gateway Threat Model: security/mcp-threat-model.md
      - REST API Recipes: rest-recipes.md
      - REST Tracing: serving/tracing.md
      - Serving Resilience: serving/resilience.md
      - Serving Backpressure: serving/backpressure.md
      - KServe & Triton Model Repositories: serving/kserve-triton.md
      - Hardened Service Image: deploy/hardened-image.md
      - Offline & Air-Gapped Installation: offline-install.md
      - Async REST Jobs & Webhooks: serving/async-jobs.md
      - HMAC Request Signing: serving/request-signing.md
      - gRPC Service: serving/grpc.md
      - GraphQL Service: serving/graphql.md
      - REST Authentication: serving/authentication.md
      - Service Load Testing & Latency SLOs: serving/load-testing.md
      - Mutual TLS Authentication: serving/mtls.md
      - Helm Deployment: deploy/helm.md
      - Kubernetes Model Operator: deploy/operator.md
      - OpenHIM De-identification Mediator: deploy/openhim-mediator.md
      - African Facility-to-HMIS Reference: deploy/africa-reference-deployment.md
      - Multi-Arch Containers: deploy/multi-arch.md
      - ModelLoader & Pipelines: model-loader.md
      - Local Model-Cache Quotas: models/cache-quotas.md
      - Model Registry: model-registry.md
      - NER Families: ner-families.md
      - Model Manifest: model-manifest.md
      - Indic Encoder Backbones: indic-encoders.md
      - Indic NER Checkpoint Compatibility: indic-ner-checkpoints.md
      - Tokenizer Script Coverage: model-tokenizer-script-coverage.md
      - Advanced NER & Output Formatting: output-formatting.md
      - Cross-format Offset Properties: structured/offset-properties.md
      - Clinical Context & Extraction Depth: clinical/context-and-extraction.md
      - Concept Grounding & Interoperability Export: clinical/concept-grounding.md
      - Offline Terminology Grounding: grounding.md
      - SNOMED CT Terminology Bridge: interop/snomed-terminology-bridge.md
      - ICD-10-CM and SNOMED CT Crosswalks: clinical/code-crosswalk.md
      - Terminology Conflict Resolution: clinical/terminology-conflicts.md
      - Clinical Abbreviation Disambiguation: clinical/abbreviation-disambiguation.md
      - Clinical Coreference Resolution: clinical/coreference.md
      - Temporal Normalization: clinical/temporal-normalization.md
      - Medication Reconciliation: clinical/medication-reconciliation.md
      - Clinical Event Timeline Assembler: clinical/event-timeline.md
      - Terminology Snapshot Provenance: clinical/terminology-provenance.md
      - Consent Cache Invalidation: clinical/consent-cache.md
      - Clinical Timeline Provenance: clinical/timeline-provenance.md
      - Chinese Terminology Grounding: clinical/chinese-terminology-grounding.md
      - Chinese Segmentation Operations: chinese-segmentation-operations.md
      - Multilingual Clinical Relations: clinical/multilingual-relations.md
      - Medication Sig Parser: clinical/sig-parser.md
      - Medical Tokenizer: medical-tokenizer.md
      - Indic Unicode Normalization: indic-normalization.md
      - Configuration & Validation: configuration.md
      - Configuration Profiles: profiles.md
      - Extension Plugin SDK: plugin-sdk.md
      - Batch Processing: batch-processing.md
      - Batch Processing How-To: batch-howto.md
      - Legacy Indic Encoding: legacy-indic-encoding.md
      - Performance Profiling: profiling.md
      - Core Pipeline Observability: core-observability.md
      - Low-resource Benchmark: benchmarks/low-resource.md
      - Chinese and Indic Throughput: benchmarks/i18n-throughput.md
      - Zero-shot NER How-to: zero-shot-howto.md
      - Zero-shot Toolkit: zero-shot-ner.md
      - Examples & Copy/Paste Recipes: examples.md
      - Example Notebooks Gallery: examples/notebook-gallery.md
      - Document Adapter Provenance: document-adapter-provenance.md
      - PDF Reading Order: multimodal/pdf-reading-order.md
      - Redacted PDF Rendering And Fidelity: multimodal/pdf-redaction-fidelity.md
      - Email Ingestion and Redaction: multimodal/email-ingestion.md
      - EPUB Extraction: multimodal/epub-extraction.md
      - XLSX Cell Redaction: multimodal/xlsx-cell-redaction.md
      - ODT/ODF Text Extraction: multimodal/odt-extraction.md
      - PPTX Redaction: multimodal/pptx-redaction.md
      - RTF Extraction: multimodal/rtf-extraction.md
      - Testing & QA: testing.md
      - Eval Harness & Metrics: eval-harness.md
      - Clinical Validation Protocol: clinical-validation-protocol.md
      - Public Benchmark Leaderboard: eval/leaderboard.md
      - ARM SMS Latency Budget: benchmarks/arm-latency.md
      - Raspberry Pi & Jetson Edge Benchmark: runtimes/edge-sbc.md
      - Experiencer Refinement: clinical/experiencer-refinement.md
      - CPU INT8 Classification Fast Path: runtimes/cpu-fastpath.md
      - OpenVINO Runtime: runtimes/openvino.md
      - WebGPU Token-Classification Runtime: runtimes/webgpu.md
      - AWQ Grounding Embedder: runtimes/awq-grounding.md
      - Device Tiers & SLOs: tiers.md
      - AWQ Export: export-awq.md
      - GPTQ Export: export-gptq.md
      - GGUF Embedding Export: export-gguf.md
  - PII & De-identification:
      - De-identification API: api/deidentification.md
      - Structured Public Errors: api/errors.md
      - Service API Compatibility Gate: api/compatibility-gate.md
      - Offline File Redaction CLI: guides/file-redaction.md
      - Structured Release Risk & Expert Review: reidentification-risk.md
      - Structured Privacy and Re-identification Risk Lab: privacy/structured-risk-lab.md
      - SMS Short-Text De-identification: sms-short-text-deid.md
      - PII Anonymization: anonymization.md
      - CHW Form Export De-identification: chw-form-deid.md
      - Indic Name Matching: indic-name-matching.md
      - Per-Language De-identification: languages.md
      - India Health-ID De-identification: india-health-id-deidentification.md
      - Smart Entity Merging: pii-smart-merging.md
      - No-Raw-PHI Logging: security/no-raw-phi-logging.md
      - Tamper-evident Audit Log: security/tamper-evident-audit-log.md
      - Key Management and Rotation: security/key-management.md
      - LangChain Redaction Wrapper: integrations-langchain.md
      - Arrow Flight De-identification: integrations/arrow-flight.md
      - Haystack Redaction Component: integrations-haystack.md
      - LlamaIndex Redaction Postprocessor: integrations-llamaindex.md
      - Columnar Redactor: integrations/columnar-redactor.md
      - Lakehouse Table Redaction: integrations/lakehouse-redaction.md
      - Dask DataFrame De-identification: integrations/dask.md
      - Pandas-on-Spark De-identification: integrations/pandas-on-spark.md
      - Ray Data Batch De-identification: integrations/ray-map-batches.md
      - SQLAlchemy Write-time Redaction: integrations/sqlalchemy.md
      - DuckDB De-identification UDFs: duckdb-deidentification.md
      - Distributed SQL De-identification UDF: integrations/distributed-sql-udf.md
      - Warehouse Remote-Function Handler: integrations/warehouse-remote-function.md
      - PySpark De-identification UDFs: spark-deidentification.md
      - Prefect Batch De-identification: prefect-integration.md
      - spaCy Pipeline Component: spacy-component.md
      - HL7 v2 De-identification: hl7v2-deidentification.md
      - HL7 v2 Narrative Extraction: interop/hl7v2-narrative-extraction.md
      - X12 837 Claim Redaction: interop/x12-837-redaction.md
      - Compliance Posture: compliance.md
      - 21 CFR Part 11 Audit Trail: compliance/21-cfr-part-11-audit-trail.md
      - Public API Deprecation Policy: compliance/api-deprecation-policy.md
      - Pan-African Malabo Baseline: compliance/africa-malabo-baseline.md
      - Egypt PDPL & Morocco Law 09-08: compliance/north-africa-pdpl-0908-checklist.md
      - Africa Data-Residency Guide: compliance/africa-data-residency-guide.md
      - Africa Attestation Review Template: compliance/templates/africa-data-residency-attestation.md
      - African Context-sensitive Attributes: compliance/africa-context-sensitive-attributes.md
      - HIPAA Safe Harbor Attestation: compliance/hipaa-safe-harbor-attestation.md
      - ISO 27701/27001 Evidence Pack: compliance/iso-27701-control-evidence.md
      - Consent and Data-Use Tags: compliance/consent-data-use-tags.md
      - Breach Notification Runbook: compliance/breach-notification-runbook.md
      - Breach Report Template: compliance/templates/breach-report-template.md
      - FHIR Interop Helpers: fhir-interop.md
      - FHIR Bulk Data Privacy Gateway: interop/fhir-bulk-data.md
      - FHIR-to-OMOP Round-trip Conformance: interop/fhir-omop-matrix.md
      - FHIR Reference Integrity Reports: fhir/reference-integrity.md
      - FHIR Bulk Data Checkpoints: fhir/bulk-checkpoints.md
      - FHIR OperationOutcome Reports: fhir/operation-outcome.md
      - FHIR SDC Privacy Projection: fhir/sdc-privacy.md
      - Document Intake Quarantine: fhir/document-intake-quarantine.md
      - De-identified DHIS2 Export: dhis2-export.md
      - OpenMRS Adapter: openmrs-adapter.md
      - WHO SMART Guidelines Profiles: fhir-smart-guidelines.md
      - FHIR Clinical Exchange Workbench: interop/fhir-profiles.md
      - ICD-11 Offline Grounding: icd11-grounding.md
  - Apple Silicon & Mobile:
      - Export Format Support Matrix: export-matrix.md
      - Maple Preview on Device: maple-on-device.md
      - MLX Backend: mlx-backend.md
      - Torch MPS Performance: performance-mps.md
      - MLX Quantized Export: export-mlx-quant.md
      - ONNX and WebGPU Export: export-onnx-webgpu.md
      - Transformers.js Export: export-transformersjs.md
      - ONNX Runtime Web Loader: runtimes/onnxruntime-web.md
      - Low-RAM Sharded Weight Loading: runtimes/low-ram-loading.md
      - Android Quickstart: android-quickstart.md
      - Android Integration & Model Catalog: android-integration.md
      - Android ONNX Export: export-onnx-android.md
      - Android Tokenization: android-tokenization.md
      - Android Span Parity: android-parity.md
      - On-device Segmenters: on-device-segmenters.md
      - CoreML Packaging: coreml-export.md
      - Swift Package (OpenMedKit): swift-openmedkit.md
      - OpenMedKit Apple Platforms: runtimes/apple-platforms.md
      - Swift-Kotlin API Parity: swift-kotlin-parity.md
  - Project:
      - FAQ: faq.md
      - Troubleshooting & Common Errors: troubleshooting.md
      - Onboarding: onboarding.md
      - v1 to v2 Migration: migration.md
      - Contributing & Releases: contributing.md
      - Model Release Queue: model-release-queue.md
      - Nix Development: development.md
      - Reproducible Dependencies: contributing/reproducible-dependencies.md
      - Security & Disclosure: security/disclosure-policy.md
      - Redactor Threat Model: security/threat-model.md
      - Multilingual Ingestion Threat Model: security/threat-model-multilingual-ingestion.md
      - Adversarial PHI Red-Team Corpus: security/red-team-corpus.md
      - No-Telemetry Guarantee: security/no-telemetry.md
      - MCP Prompt Injection Guard: security/prompt-injection-guard.md
      - MCP Consent Receipts: security/mcp-consent-receipts.md
      - MCP Authorization Matrix: security/mcp-authorization-matrix.md
      - MCP Upstream Endpoint Policy: security/mcp-upstream-policy.md
      - HF Write Token Policy: security/hf-token-policy.md
      - Supply Chain Controls: security/supply-chain.md
      - Vulnerability Scanning: supply-chain/vulnerability-scanning.md
      - Software Bill of Materials: security/sbom.md
      - SLSA Build Provenance: supply-chain/provenance.md
      - Container Image SBOM: supply-chain/sbom.md
      - Container Image Signing: supply-chain/image-signing.md
      - Release Streams & Channels: release/semver-and-channels.md
      - Migrate from 2.1 to 2.2: migration/2.1-to-2.2.md
      - Migrate from 2.0 to 2.1: migration/2.0-to-2.1.md
      - Migrate from 1.9 to 2.0: migration/1.9-to-2.0.md
      - Migrate from 1.8 to 1.9: migration/1.8-to-1.9.md
      - PyPI Publishing: release/trusted-publishing.md
      - OpenMed 1.9.1 Release Notes: release/v1.9.1.md
      - OpenMed 1.9.0 Release Notes: release/v1.9.0.md
      - OpenMed 1.8.0 Release Notes: release/v1.8.0.md
      - OpenMed 1.7.0 Release Notes: release/v1.7.0.md
      - Generative Model Policy: generative-model-policy.md
      - API Reference: api-reference.md

extra_css:
  - stylesheets/openmed-system.css
  - stylesheets/openmed-brand.css

extra_javascript:
  - javascripts/openmed-docs.js

theme:
  name: material
  custom_dir: docs/overrides
  language: en
  logo: assets/openmed-mark.svg
  favicon: assets/openmed-favicon.svg
  font: false
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.tabs
    - navigation.tracking
    - navigation.footer
    - navigation.top
    - toc.integrate
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - announce.dismiss

extra:
  social_image: https://openmed.life/og.png
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/maziyarpanahi/openmed
      name: GitHub
    - icon: simple/huggingface
      link: https://huggingface.co/OpenMed
      name: Hugging Face
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/OpenMed_AI
      name: OpenMed on X
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/openmed-ai/
      name: LinkedIn

plugins:
  - search
  - i18n:
      docs_structure: suffix
      fallback_to_default: false
      reconfigure_material: true
      languages:
        - locale: en
          name: English
          default: true
          build: true
        - locale: zh
          name: 简体中文
          build: true
          nav:
            - Overview:
                - Welcome: index.md
                - Quick Start: getting-started.md
                - China Onboarding: onboarding-china.md
          nav_translations:
            Overview: 概览
            Welcome: 欢迎
            Quick Start: 快速开始
            China Onboarding: 中国用户上手指南
            Core Guides: 核心指南
            PII & De-identification: PII 与去标识化
            Apple Silicon & Mobile: Apple Silicon 与移动端
            Project: 项目
        - locale: hi
          name: हिन्दी
          build: true
          nav:
            - Overview:
                - Welcome: index.md
                - Quick Start: getting-started.md
                - India Onboarding: onboarding-india.md
          nav_translations:
            Overview: अवलोकन
            Welcome: स्वागत
            Quick Start: त्वरित शुरुआत
            India Onboarding: भारत के उपयोगकर्ताओं के लिए गाइड
            Core Guides: मुख्य गाइड
            PII & De-identification: PII और डी-आइडेंटिफिकेशन
            Apple Silicon & Mobile: Apple Silicon और मोबाइल
            Project: परियोजना
  - llmstxt:
      markdown_description: >
        OpenMed is a local-first healthcare NLP toolkit for clinical entity
        extraction, de-identification, model discovery, and on-device or
        self-hosted integrations.
      full_output: llms-full.txt
      sections:
        Getting started:
          - index.md: OpenMed documentation overview
          - getting-started.md: Installation and first local workflow
          - quickstarts.md: Persona quickstarts, including AI agent usage over MCP
        APIs and de-identification:
          - analyze-text.md: Top-level text analysis API
          - api-reference.md: Public Python API reference
          - api/deidentification.md: De-identification API reference
          - output-formatting.md: Output formats and agent-facing tool schemas
        Agents and tool surfaces:
          - agent-usage.md: Consumer API map, privacy invariants, and repository skills
          - mcp-clients.md: MCP client setup and transport guidance
          - rest-service.md: REST service endpoints and deployment
          - rest-recipes.md: Copy-ready REST API recipes
          - plugin-sdk.md: Detector plugin interfaces
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true
  - minify:
      minify_html: true
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false

hooks:
  - docs/_hooks.py

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      permalink_title: Link to this section
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

watch:
  - openmed
  - openmed/zero_shot

exclude_docs: |
  _hooks.py
  __pycache__/**
  overrides/**
  demo/web/README.md
  demo/web/models/**
  demo/web/vendor/**
  website/**
  brand/**