mkdocs.yml

site_name: Nexus
site_description: The AI-Native Distributed Filesystem - Build production AI agents with enterprise-grade context, permissions, and multi-tenancy
site_author: Nexus Team
site_url: https://nexi-lab.github.io/nexus/

repo_name: nexi-lab/nexus
repo_url: https://github.com/nexi-lab/nexus
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright © 2024 Nexus Team • Built with ❤️ for AI Agents

# Theme configuration
theme:
  name: material

  # Color scheme
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  # Features
  features:
    - announce.dismiss
    - navigation.instant
    - navigation.instant.progress
    - navigation.instant.prefetch
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - toc.follow
    - toc.integrate
    - content.code.copy
    - content.code.annotate
    - content.code.select
    - content.tabs.link
    - content.action.edit
    - content.action.view
    - content.tooltips

  # Icon
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

  # Logo and favicon
  logo: assets/logo.png
  favicon: assets/logo.png

  # Font
  font:
    text: Roboto
    code: Roboto Mono

# Extensions
markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
      lang: en
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  - minify:
      minify_html: true

# Extra configuration
extra:
  version:
    provider: mike
    default: latest

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/nexi-lab/nexus
      name: Star us on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/nexus-ai-fs/
      name: Install from PyPI
    - icon: fontawesome/brands/slack
      link: https://nexus-community.slack.com
      name: Join our Community

  # Status badges
  tags:
    Production Ready: production
    Beta: beta
    Experimental: experimental

  # Announcement bar
  # announcement:
  #   text: "🚀 Nexus v0.4 is here! Multi-tenancy, PostgreSQL support, and more!"
  #   link: https://github.com/nexi-lab/nexus/releases

  # analytics:
  #   provider: google
  #   property: G-XXXXXXXXXX
  #   feedback:
  #     title: Was this page helpful?
  #     ratings:
  #       - icon: material/emoticon-happy-outline
  #         name: This page was helpful
  #         data: 1
  #         note: >-
  #           Thanks for your feedback!
  #       - icon: material/emoticon-sad-outline
  #         name: This page could be improved
  #         data: 0
  #         note: >-
  #           Thanks for your feedback! Help us improve by
  #           <a href="https://github.com/nexi-lab/nexus/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">creating an issue</a>.

# Extra CSS
extra_css:
  - stylesheets/extra.css

# Extra JavaScript
extra_javascript:
  - javascripts/extra.js

# Navigation structure
nav:
  - Home:
    - index.md
    - Getting Started:
      - getting-started/index.md
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Configuration: getting-started/configuration.md
      - Deployment Modes: getting-started/deployment-modes.md
    - Core Concepts:
      - What is Nexus?: concepts/what-is-nexus.md
      - Memory System: concepts/memory-system.md
      - Sandbox Management: concepts/sandbox-management.md
      - Agent Permissions: concepts/agent-permissions.md
      - ReBAC Explained: concepts/rebac-explained.md
      - Content-Addressable Storage: concepts/content-addressable-storage.md
      - Learning Loops: concepts/learning-loops.md
      - Workflows vs Triggers: concepts/workflows-vs-triggers.md
      - Plugin System: concepts/plugin-system.md
      - Mounts & Backends: concepts/mounts-and-backends.md
      - Skills System: concepts/skills-system.md
      - Multi-Tenancy: concepts/multi-tenancy.md
      - When to Use What: concepts/when-to-use-what.md
      - Architecture: architecture/KERNEL-ARCHITECTURE.md
      - Core Tenets: CORE_TENETS.md

  - Examples:
    - examples/index.md
    - File Operations: examples/file-operations.md
    - Directory Operations: examples/directory-operations.md
    - Permission Management: examples/permissions.md
    - Workspace & Sessions: examples/workspace-session.md
    - DeepAgents Integration: examples/deepagents.md
    - LangGraph Integration: examples/langgraph.md
    - "📘 LangGraph Migration Tutorial": examples/langgraph-migration.md
    - CrewAI Integration: examples/crewai.md
    - Claude Agent SDK: examples/claude-agent-sdk.md
    - OpenAI Agents SDK: examples/openai-agents.md
    - Google ADK Integration: examples/google-adk.md
    - Skill Seekers: examples/skill-seekers.md

  - Learning Paths:
    - Simple File Storage: learning-paths/simple-file-storage.md
    - Document Q&A System: learning-paths/document-qa.md
    - AI Agent Memory: learning-paths/ai-agent-memory.md
    - Workflow Automation: learning-paths/workflow-automation.md
    - Team Collaboration: learning-paths/team-collaboration.md
    - Multi-Tenant SaaS: learning-paths/multi-tenant-saas.md
    - Multi-Backend Storage: learning-paths/multi-backend-storage.md
    - Administration & Operations: learning-paths/administration-operations.md
    - Building Plugins: learning-paths/building-plugins.md

  - Glossary: glossary.md