mkdocs.yml

site_name: eMuleBB Suite Documentation
site_description: eMuleBB Suite — eD2K/Kad and BitTorrent clients, controller, REST, integration, and release documentation.
site_url: https://emulebb.github.io/emulebb-tooling/
repo_url: https://github.com/emulebb/emulebb-tooling
edit_uri: blob/main/docs/
docs_dir: docs
site_dir: .local/mkdocs-site

theme:
  name: material
  language: en
  logo: assets/brand/emulebb-mkdocs-logo.png
  favicon: assets/brand/emulebb-mkdocs-logo.png
  features:
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.share
    - toc.follow

extra_css:
  - assets/mkdocs.css

extra:
  analytics:
    provider: google
    property: G-8G02C2WFEB

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
      pygments_lang_class: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - tables
  - toc:
      permalink: true

plugins:
  - search

nav:
  - Home: INDEX.md
  - Quick Help: HELP.md
  - eMuleBB Suite:
      - Roadmap: active/SUITE-JOINT-ROADMAP.md
      - Brand & Naming: active/BRAND-AND-NAMING.md
      - Roadmap Summary: reference/ROADMAP-SUMMARY.md
      - Product Portfolio: active/PRODUCT-PORTFOLIO.md
      - Quality Gates: active/QUALITY-GATES.md
      - Test Strategy: active/TEST-STRATEGY.md
      - Suite Bundle & Installer: active/SUITE-INSTALLER.md
      - Suite Docker Delivery: active/SUITE-DOCKER.md
      - REST API Contract Lineage: active/API-V1-COMPATIBILITY.md
      - Metadata Fabric: active/SUITE-METADATA-FABRIC.md
      - Ecosystem Bootstrap Plan: active/plans/ECOSYSTEM-SUITE-BOOTSTRAP-PLAN.md
      - Suite Board (GitHub): https://github.com/orgs/emulebb/projects/3
  - Product Sections:
      - emulebb-mfc: products/emulebb-mfc/README.md
      - emulebb-mfc Frozen OpenAPI: products/emulebb-mfc/api/REST-API-OPENAPI.yaml
      - emulebb-rust: products/emulebb-rust/README.md
      - emulebb-rust Active Backlog: products/emulebb-rust/active/INDEX.md
      - emulebb-rust Release Scope: products/emulebb-rust/RELEASE-SCOPE.md
      - emulebb-rust Forward OpenAPI: products/emulebb-rust/api/REST-API-OPENAPI.yaml
      - emulebb-rust Architecture: products/emulebb-rust/design/architecture.md
      - emulebb-rust Indexer Design: products/emulebb-rust/design/kad-ed2k-indexer.md
      - TrackMuleBB: products/trackmulebb/README.md
      - TrackMuleBB Active Backlog: products/trackmulebb/active/INDEX.md
      - TrackMuleBB Rust Console UI: products/trackmulebb/design/PROPER-P2P-UI.md
      - TrackMuleBB Local Suite: products/trackmulebb/LOCAL-SUITE.md
  - eMuleBB Client (Windows):
      - Product Guide: reference/GUIDE-EMULEBB.md
      - Released Behavior Summary: reference/RELEASED-BEHAVIOR-SUMMARY.md
      - Setup Guide: reference/GUIDE-SETUP.md
      - Hyper-V Suite Isolation: reference/GUIDE-HYPERV-WINDOWS.md
      - Power User Manual: reference/GUIDE-POWER-USERS.md
      - Downloads And Search: reference/GUIDE-DOWNLOADS-SEARCH.md
      - Sharing Guide: reference/GUIDE-SHARING.md
      - Network Guide: reference/GUIDE-NETWORK.md
      - Preferences Guide: reference/GUIDE-PREFERENCES.md
      - Persistence Files: reference/GUIDE-PERSISTENCE-FILES.md
      - IP Filters: reference/GUIDE-IP-FILTERS.md
      - Long Paths: reference/GUIDE-LONGPATHS.md
      - Keyboard Shortcuts: reference/KEYBOARD-SHORTCUTS.md
      - Tools Menu: reference/GUIDE-TOOLS-MENU.md
      - Diagnostics: reference/GUIDE-DIAGNOSTICS.md
      - Troubleshooting: reference/GUIDE-TROUBLESHOOTING.md
      - Translations: reference/GUIDE-TRANSLATIONS.md
  - emulebb-rust (Core):
      - Rust Scope: active/EMULEBB-RUST-SCOPE.md
      - Product Section: products/emulebb-rust/README.md
      - Active Backlog: products/emulebb-rust/active/INDEX.md
      - Release Scope: products/emulebb-rust/RELEASE-SCOPE.md
      - Code Quality And Test Placement: products/emulebb-rust/reference/CODE-QUALITY.md
      - Running On macOS And Linux: reference/GUIDE-CROSS-PLATFORM.md
      - REST API — Forward OpenAPI: products/emulebb-rust/api/REST-API-OPENAPI.yaml
      - REST API — Notes: products/emulebb-rust/api/README.md
      - Design — Kad/eD2K Indexer: products/emulebb-rust/design/kad-ed2k-indexer.md
      - Design — Source Management & A4AF: products/emulebb-rust/design/source-management-and-a4af.md
      - Design — UDP Source Reask: products/emulebb-rust/design/udp-source-reask.md
      - Parity Matrix (2026-07-05): products/emulebb-rust/active/PARITY-MATRIX-2026-07-05.md
      - Parity Review (2026-07-05): products/emulebb-rust/active/PARITY-REVIEW-2026-07-05.md
      - Soak Runbook 0.1.0-beta.1: products/emulebb-rust/active/SOAK-RUNBOOK-0.1.0-beta.1.md
      - Source And Backlog (GitHub): https://github.com/emulebb/emulebb-rust
  - qBittorrentBB (Companion):
      - Torrent Export & DHT Harvest (GitHub): https://github.com/emulebb/qbittorrentbb/blob/master/docs/BB-TORRENT-EXPORT-AND-HARVEST.md
      - Source And Backlog (GitHub): https://github.com/emulebb/qbittorrentbb
  - TrackMuleBB (Controller):
      - Product Section: products/trackmulebb/README.md
      - Active Backlog: products/trackmulebb/active/INDEX.md
      - Rust Console UI: products/trackmulebb/design/PROPER-P2P-UI.md
      - MVP Unified Transfers — Design: products/trackmulebb/design/MVP-UNIFIED-TRANSFERS.md
      - Source And Backlog (GitHub): https://github.com/emulebb/trackmulebb
  - aMuTorrent (Controller — frozen 0.7.3, legacy):
      - Stack Integrations: reference/GUIDE-STACK-INTEGRATIONS.md
      - Controllers And REST: reference/GUIDE-CONTROLLERS-REST.md
      - Source And Backlog (GitHub): https://github.com/emulebb/amutorrent
  - API And Automation:
      - REST Quickstart: rest/REST-API-QUICKSTART.md
      - REST Contract: rest/REST-API-CONTRACT.md
      - Adapter Notes: rest/REST-API-ADAPTERS.md
      - emulebb-mfc Frozen OpenAPI: products/emulebb-mfc/api/REST-API-OPENAPI.yaml
      - Rust Forward OpenAPI: products/emulebb-rust/api/REST-API-OPENAPI.yaml
      - Legacy emulebb-mfc OpenAPI Alias: rest/REST-API-OPENAPI.yaml
      - Parity Inventory: rest/REST-API-PARITY-INVENTORY.md
      - Controller Surface Matrix: active/CONTROLLER-SURFACE-MATRIX.md
  - Active Release (eMuleBB 0.7.x):
      - Backlog Index: active/INDEX.md
      - 0.7.3 Release Dashboard: active/RELEASE-0.7.3.md
      - 0.7.3 Release Notes: active/RELEASE-0.7.3-NOTES.md
      - 0.7.3 Stable Changelog: active/RELEASE-0.7.3-STABLE-CHANGELOG.md
      - 0.7.3 RC2 Changelog: active/RELEASE-0.7.3-RC2-CHANGELOG.md
      - 0.7.3 RC3 Changelog: active/RELEASE-0.7.3-RC3-CHANGELOG.md
      - Current Execution Plan: active/plans/RELEASE-0.7.3-EXECUTION-PLAN.md
      - Release Checklist: active/RELEASE-0.7.3-CHECKLIST.md
      - Release Runbook: active/RELEASE-0.7.3-RUNBOOK.md
      - Release Test Strategy: active/RELEASE-TEST-STRATEGY.md
      - Release Test Campaigns: active/RELEASE-TEST-CAMPAIGNS.md
      - Installer Test Materialization Plan: active/plans/INSTALLER-TEST-MATERIALIZATION-AND-SCENARIO-MATRIX.md
      - Frozen Surfaces: active/FROZEN-SURFACES.md
      - Future Roadmap (emulebb-mfc): active/FUTURE-ROADMAP.md
      - emulebb-mfc 0.8.0 Lean Removal Plan: active/plans/MFC-0.8.0-LEAN-REMOVAL-PLAN.md
      - emulebb-mfc 0.8.0 Network Core Thread: active/plans/MFC-0.8.0-NETWORK-CORE-THREAD.md
      - emulebb-mfc 0.8.0 Performance Async Plan: active/plans/MFC-0.8.0-PERF-ASYNC-PLAN.md
      - emulebb-mfc 0.8.0 Process Loop Migration: active/plans/MFC-0.8.0-PROCESS-LOOP-MIGRATION.md
      - emulebb-mfc 0.8.0 Startup Time To Interactive: active/plans/MFC-0.8.0-STARTUP-TIME-TO-INTERACTIVE.md
  - Developer And Workspace:
      - Workspace Policy: WORKSPACE-POLICY.md
      - Documentation Policy: DOCS-POLICY.md
      - Agent Checklist: reference/AGENT-CHECKLIST.md
      - Backlog Process: reference/BACKLOG-PROCESS.md
      - Backlog Item Template: reference/BACKLOG-ITEM-TEMPLATE.md
      - Evidence Retention: reference/EVIDENCE-RETENTION.md
      - Workspace Repository Map: reference/WORKSPACE-REPO-MAP.md
      - Development Guide: reference/DEVELOPMENT-GUIDE.md
      - Test Tiers: reference/TEST-TIERS.md
      - Test Inventory: reference/TEST-INVENTORY.md
      - Test Curation: reference/TEST-CURATION.md
      - Test Campaign Architecture Plan: active/plans/TEST-CAMPAIGN-ARCHITECTURE-PLAN.md
      - CI Baseline: reference/CI-BASELINE.md
      - Release Branching And Packaging: reference/RELEASE-BRANCHING-AND-PACKAGING.md
      - eD2K Inventory: reference/ED2K-PROJECT-INVENTORY.md
      - eD2K Forums And Sites: reference/ED2K-FORUMS-AND-SITES.md
  - Dependencies:
      - Status: dependencies/DEP-STATUS.md
  - Ideas:
      - Cooperative DHT: ideas/IDEA-COOPERATIVE-DHT-COOPERATION.md
      - aMule Watchlist: ideas/IDEA-AMULE-WATCHLIST.md
      - Kad Protocol Modernization: ideas/IDEA-KAD-PROTOCOL-MODERNIZATION.md
      - IPv6 Kad Network: ideas/IDEA-IPV6-KAD-NETWORK.md
      - NAT Traversal And uTP: ideas/IDEA-NAT-TRAVERSAL-UTP.md
      - libtorrent Content Mesh: ideas/IDEA-LIBTORRENT-MESH.md
      - qBittorrentBB Mesh: ideas/IDEA-QBITTORRENTBB-MESH.md
      - emulebb-libtorrent Fork: ideas/IDEA-EMULEBB-LIBTORRENT-FORK.md
  - History:
      - History Archive: history/INDEX.md
      - Historical References: HISTORICAL-REFERENCES.md
      - Abandoned Boost / POCO Adoption: history/ideas/IDEA-BOOST.md
      - Abandoned CMake / Ninja / vcpkg Adoption: history/ideas/IDEA-CMAKE.md
      - Abandoned eMule 2026 Modernization Roadmap: history/ideas/IDEA-MODERNIZATION-2026.md
      - Abandoned emulebb-mfc Restructure Guidance: history/ideas/IDEA-RESTRUCTURE.md
  - Separate Family — p2p-overlord:
      - eMule Agent Guide: reference/GUIDE-P2P-OVERLORD-EMULE-AGENT.md
      - Product-Family Integration Plan: active/plans/P2P-OVERLORD-PRODUCT-FAMILY-INTEGRATION.md

not_in_nav: |
  /active/items/**
  /history/**
  /rest/REST-API-OPENAPI.yaml
  /products/emulebb-rust/active/items/**
  /products/emulebb-rust/history/**
  /products/trackmulebb/active/items/**

validation:
  nav:
    omitted_files: warn
    not_found: warn
  links:
    not_found: warn
    anchors: warn
    unrecognized_links: warn