mkdocs.yml

site_name: Moonshot
repo_url: https://github.com/aiverify-foundation/moonshot

plugins:
  - search
  - mkdocstrings
  - swagger-ui-tag:
        defaultModelsExpandDepth: -1
        docExpansion: none

theme:
  features:
      - navigation.footer
      - navigation.top
      - toc.integrate
      - toc.follow

  name: material
  locale: en
  include_sidebar: false

markdown_extensions:
  - markdown.extensions.extra
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.mark
  - attr_list

nav: 
  - Home: index.md
  - Getting Started:
    - Quick Start Guide: getting_started/quick_start.md
    - Overview: getting_started/overview.md
    - Quick Install: getting_started/quick_install.md
    - Your First Test: getting_started/first_test.md
  - Tutorials:
    - Web UI: 
      - (UI) How to Create Custom Cookbook: tutorial/web-ui/create_cookbook.md
      - (UI) How to Create Connector Endpoint: tutorial/web-ui/create_endpoint.md
      - (UI) How to Run Benchmark Tests: tutorial/web-ui/benchmark.md
      - (UI) How to Run Red Teaming: tutorial/web-ui/redteam.md
    - CLI : 
      - (CLI) How to Create Custom Benchmark Tests: tutorial/cli/create_benchmark_tests.md
      - (CLI) How to Create Connector Endpoint: tutorial/cli/create_endpoint.md
      - (CLI) How to Run Benchmark Tests: tutorial/cli/run_benchmark_tests.md
      - (CLI) How to Run Red Teaming: tutorial/cli/run_red_teaming.md
    - Contributor:
      - Configure Moonshot Web-API : tutorial/contributor/configure_web_api.md
      - Create a New Custom Connector : tutorial/contributor/create_connector.md
  - User Guide: 
    - Moonshot Web UI: 
      - Get Started with Moonshot Web UI: user_guide/web_ui/web_ui_guide.md
      - Moonshot Interface:
        - Home: user_guide/web_ui/moonshot_interface/homepage.md
        - Endpoint: user_guide/web_ui/moonshot_interface/endpoint.md
        - Benchmarking: user_guide/web_ui/moonshot_interface/benchmarking.md
        - Red Teaming: user_guide/web_ui/moonshot_interface/redteaming.md
        - History: user_guide/web_ui/moonshot_interface/history.md
        - Utils: user_guide/web_ui/moonshot_interface/utils.md
      - Testing Workflow:
        - (UI) Choosing Relevant Tests: user_guide/web_ui/choosing_relevant_tests.md
        - (UI) Connecting to LLMs: user_guide/web_ui/connecting_to_llms.md
        - (UI) Running Benchmarks: user_guide/web_ui/running_benchmarks.md
        - (UI) Conducting Red Teaming: user_guide/web_ui/running_red_teaming.md
        - (UI) Creating Custom Cookbooks: user_guide/web_ui/creating_custom_cookbooks.md
    - CLI: 
      - (CLI) Connecting to LLMs: user_guide/cli/connecting_endpoints.md
      - (CLI) Running Benchmark: user_guide/cli/benchmarking.md
      - (CLI) Running Red Teaming: user_guide/cli/red_teaming.md 
      - (CLI) Adding Your Own Tests: user_guide/cli/add_your_own_tests.md
      - (CLI) CLI Command List: user_guide/cli/cli_command_list.md
  - API Reference:
    - Moonshot Library:
        - Bookmark API: api_reference/api_bookmark.md
        - Connector Endpoint API: api_reference/api_connector_endpoint.md
        - Connector API: api_reference/api_connector.md
        - Context Strategy API: api_reference/api_context_strategy.md
        - Cookbook API: api_reference/api_cookbook.md
        - Dataset API: api_reference/api_dataset.md
        - Environment Variable API: api_reference/api_environment_variables.md
        - Metric API: api_reference/api_metrics.md
        - Prompt Template API: api_reference/api_prompt_template.md
        - Recipe API: api_reference/api_recipe.md
        - Red Teaming API: api_reference/api_red_teaming.md
        - Result API: api_reference/api_result.md
        - Run API: api_reference/api_run.md
        - Runner API: api_reference/api_runner.md
        - Session API: api_reference/api_session.md
    - Web-API: api_reference/web_api_swagger.md
  - Resources:
      - Jupyter Notebook: resources/jupyter_notebook.md
      - Cookbook: resources/cookbooks.md
      - Recipes: resources/recipes.md
      - Datasets: resources/datasets.md
      - Metrics: resources/metrics.md
      - Attack Modules: resources/attack_modules.md
  - Contributor Guide: contributing.md
  - FAQ : faq.md