mkdocs.yml

site_name: Mistaber Documentation
site_description: Formal symbolic reasoning system for computational halacha
site_url: https://docs.mistaber.ai/
repo_url: https://github.com/BrainyBlaze/mistaber
repo_name: BrainyBlaze/mistaber

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            show_source: true
            show_root_heading: true
            heading_level: 2
            members_order: source
            docstring_style: google
            show_signature_annotations: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md

  - Getting Started:
    - getting-started/index.md
    - What is Mistaber?: getting-started/what-is-mistaber.md
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
    - Scientific Contributions: getting-started/scientific-contributions.md
    - FAQ: getting-started/faq.md
    - Troubleshooting: getting-started/troubleshooting.md

  - Tutorials:
    - tutorials/index.md
    - Your First Query: tutorials/01-first-query.md
    - Understanding Worlds: tutorials/02-understanding-worlds.md
    - Writing Rules: tutorials/03-writing-rules.md
    - Encoding Machloket: tutorials/04-encoding-machloket.md
    - Extending Ontology: tutorials/05-extending-ontology.md
    - Case Studies:
      - Basar Bechalav: tutorials/case-studies/basar-bechalav.md
      - Fish & Dairy Dispute: tutorials/case-studies/fish-dairy-machloket.md
      - Bitul Shishim: tutorials/case-studies/bitul-shishim.md
    - Encoding Tutorials:
      - tutorials/encoding/index.md
      - Your First Encoding: tutorials/encoding/01-your-first-encoding.md
      - Handling Machloket: tutorials/encoding/02-handling-machloket.md
      - Complex Conditions: tutorials/encoding/03-complex-conditions.md
      - Testing Strategies: tutorials/encoding/04-testing-strategies.md
      - Review Process: tutorials/encoding/05-review-process.md

  - Encoding:
    - encoding/index.md
    - Getting Started: encoding/getting-started.md
    - Corpus Preparation: encoding/corpus-preparation.md
    - HLL Encoding: encoding/hll-encoding.md
    - Validation & Testing: encoding/validation-testing.md
    - Review & Approval: encoding/review-approval.md
    - Commit & Finalization: encoding/commit-finalization.md

  - Guidelines:
    - guidelines/index.md
    - Encoding Methodology: guidelines/encoding-methodology.md
    - Halachic Accuracy: guidelines/halachic-accuracy.md
    - Halachic Concepts: guidelines/halachic-concepts.md
    - Source Attribution: guidelines/source-attribution.md
    - Machloket Handling: guidelines/machloket-handling.md
    - World Scoping: guidelines/world-scoping.md
    - Predicate Selection: guidelines/predicate-selection.md
    - Testing Requirements: guidelines/testing-requirements.md
    - Review Standards: guidelines/review-standards.md
    - Contributing Encodings: guidelines/contributing-encoding.md

  - Reference:
    - reference/index.md
    - CLI Reference: reference/cli.md
    - Python API: reference/api.md
    - HLL Language: reference/hll-language.md
    - Predicate Registry: reference/predicates.md
    - ASP Rules: reference/asp-rules.md
    - Extension Protocol: reference/extension-protocol.md

  - Explanation:
    - explanation/index.md
    - Architecture:
      - System Overview: explanation/architecture/system-overview.md
      - Engine Internals: explanation/architecture/engine-internals.md
      - Compiler Pipeline: explanation/architecture/compiler-pipeline.md
      - Kripke Implementation: explanation/architecture/kripke-implementation.md
      - Ontology Structure: explanation/architecture/ontology-structure.md
      - Data Flows: explanation/architecture/data-flows.md
    - Formal Foundations:
      - Modal Logic: explanation/formal/modal-logic.md
      - Deontic Logic: explanation/formal/deontic-logic.md
      - Upper Ontology: explanation/formal/upper-ontology.md
      - Multi-World Semantics: explanation/formal/multi-world-semantics.md
      - Safek Calculus: explanation/formal/safek-calculus.md
      - Source Chain: explanation/formal/source-chain.md
    - Glossary: explanation/glossary.md

  - Dashboard:
    - dashboard/index.md
    - Getting Started: dashboard/getting-started.md
    - Sessions:
      - Creating Sessions: dashboard/sessions/creating-sessions.md
      - Session Workflow: dashboard/sessions/session-workflow.md
    - Encoding:
      - File Explorer: dashboard/encoding/file-explorer.md
      - Code Editor: dashboard/encoding/code-editor.md
      - Terminal: dashboard/encoding/terminal.md
    - Ontology:
      - Browsing the Ontology: dashboard/ontology/browsing-ontology.md
      - Ontology Sidebar: dashboard/ontology/ontology-sidebar.md
    - Coverage:
      - Coverage Overview: dashboard/coverage/coverage-overview.md
      - Heatmap & Metrics: dashboard/coverage/heatmap-metrics.md
    - Tools:
      - Query Executor: dashboard/tools/query-executor.md
      - Validation Views: dashboard/tools/validation-views.md
      - Keyboard Shortcuts: dashboard/tools/keyboard-shortcuts.md
    - Reference:
      - UI Glossary: dashboard/reference/ui-glossary.md

  - Plugin:
    - plugin/index.md
    - Installation: plugin/installation.md
    - Architecture: plugin/architecture.md
    - Skills:
      - plugin/skills/index.md
      - Corpus Preparation: plugin/skills/corpus-prep.md
      - HLL Encoding: plugin/skills/hll-encode.md
      - Validation: plugin/skills/validate.md
      - Review: plugin/skills/review.md
      - Commit: plugin/skills/commit.md
      - Workflow Guide: plugin/skills/workflow-guide.md
    - Hooks:
      - plugin/hooks/index.md
      - Session Init: plugin/hooks/session-init.md
      - Phase Gate: plugin/hooks/phase-gate.md
      - Encoding Guard: plugin/hooks/encoding-guard.md
      - Sefaria Logger: plugin/hooks/sefaria-logger.md
      - Validation Handler: plugin/hooks/validation-handler.md
      - Checkpoint Enforcement: plugin/hooks/checkpoint-enforcement.md
      - Git Commit Guard: plugin/hooks/git-commit-guard.md
    - Agents:
      - plugin/agents/index.md
      - Encoding Orchestrator: plugin/agents/encoding-orchestrator.md
    - Templates:
      - plugin/templates/index.md
      - Customization: plugin/templates/customization.md
    - Troubleshooting: plugin/troubleshooting.md

  - Development:
    - development/index.md
    - Contributing: development/contributing.md
    - Deployment: development/deployment.md
    - Code of Conduct: development/code-of-conduct.md
    - Changelog: development/changelog.md