ANS/mkdocs.yml at main · g-clouds/ANS · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
site_name: Agent Network System (ANS)
site_url: https://g-clouds.github.io/ANS/
site_description: 'ANS: A Foundational Hybrid Architecture for Secure AI Agent Ecosystems'
repo_url: https://github.com/g-clouds/ANS
repo_name: g-clouds/ANS

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand # Expands sections in the nav by default
    - navigation.top # Back-to-top button
    - toc.integrate # Integrates the Table of Contents into the left navigation sidebar
    # - navigation.indexes # If you want section index pages to also show content
  palette:
    # Palette toggle for light/dark mode
    - scheme: default # Light mode
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate # Dark mode
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono

nav:
  - Whitepaper: index.md
  - Getting Started:
    - Overview: getting-started/index.md
    - JavaScript Quick Start: getting-started/js-quickstart.md
    - Python Quick Start: getting-started/python-quickstart.md
    - Java Quick Start: getting-started/java-quickstart.md
    - Full Backend Deployment: getting-started/deployment.md
  - Docs:
    - Overview: user-guide/index.md
    - ANSClient: user-guide/ans-client.md
    - anslookup CLI: user-guide/anslookup-cli.md
    - Verification: user-guide/verification.md
    - SDK Comparison: user-guide/sdk-comparison.md
    - Flashcards: flashcards/index.md
  - Developer Guides:
    - Overview: developer-guides/index.md
    - Agent Registration: developer-guides/agent-registration.md
    - Agent Lookup: developer-guides/agent-lookup.md
    - Agent Verification: developer-guides/agent-verification.md
    - Post-Quantum Cryptography (PQC): developer-guides/pqc-implementation-guide.md
    - PQC Validation Report: developer-guides/pqc-poc-validation.md
  - Use Cases:
    - Overview: use-cases/index.md
    - RISK- AI Wargame: use-cases/risk-wargame.md
    - MIMIC- Market Intelligence: use-cases/mimic-market-intelligence.md
    - A2A-ANS- AI Sales Team: use-cases/a2a-ans.md
    - Hang the DJ- Social Simulation: use-cases/hang-the-dj.md
    - AI Agent Swarms in Defence: use-cases/AI Agent Swarms in Defence.md
  - Engineering Notes:
    - Agent Verification Workflow: engineering-notes/agent-verification-workflow.md
    - Backend API Testing Strategy: engineering-notes/backend-api-testing-strategy.md
    - PQC Migration Roadmap: engineering-notes/pqc-migration-roadmap.md

# Extensions
markdown_extensions:
  - pymdownx.highlight: # For code highlighting
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      # make fences behave like GitHub Markdown
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom
  - admonition
  - toc:
      permalink: true
      toc_depth: 3
  - attr_list
  - md_in_html

# Optional: Add plugins if needed later
plugins:
  - search
  - mermaid2