panurus/mkdocs.yml at main · Built-by-Sign/panurus · 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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
site_name: Panurus
site_url: https://LFDT-Panurus.github.io/panurus/
site_description: Privacy-preserving token management for Hyperledger Fabric
site_author: LFDT Panurus
repo_url: https://github.com/LFDT-Panurus/panurus
repo_name: LFDT-Panurus/panurus
edit_uri: edit/main/docs/

validation:
  links:
    not_found: info
    anchors: info

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.expand
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

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
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

nav:
  - Home: README.md
  - Core Concepts:
      - Panurus Overview: tokensdk.md
      - Token API: tokenapi.md
      - Token API Usage: token_sdk_usage.md
      - Driver API: driverapi.md
      - Configuration: configuration.md
      - Services Overview: services.md
      - Upgradability: upgradability.md
      - Public Parameters Lifecycle: public_parameters.md
  - Drivers:
      - Fabtoken: drivers/fabtoken.md
      - DLog (Zero-Knowledge): drivers/dlogwogh.md
      - Extending Validator: drivers/extending_validator.md
      - Metrics: drivers/metrics.md
      - Benchmark:
          - Overview: drivers/benchmark/benchmark.md
          - Tools: drivers/benchmark/tools.md
          - Core Drivers:
              - DLog No-GH Overview: drivers/benchmark/core/dlognogh/dlognogh.md
              - DLog No-GH Architecture: drivers/benchmark/core/dlognogh/dlognogh_architecture.md
              - DLog No-GH Regression: drivers/benchmark/core/dlognogh/dlognogh_regression.md
              - Benchmark Sender Results: drivers/benchmark/core/dlognogh/transfer_BenchmarkSender_results.md
              - Validator Transfer Profile: drivers/benchmark/core/dlognogh/validator_transfer_profile.md
          - Services:
              - Idemix Identity: drivers/benchmark/services/identity/idemix.md
  - Services:
      - Auditor: services/auditor.md
      - Benchmark: services/benchmark.md
      - Certifier: services/certifier.md
      - Config: services/config.md
      - Identity: services/identity.md
      - Interop: services/interop.md
      - Network Ethereum: services/network-ethereum.md
      - Network Fabric: services/network-fabric.md
      - Network Fabricx: services/network-fabricx.md
      - Network: services/network.md
      - NFT Tx: services/nfttx.md
      - Selector: services/selector.md
      - Storage:
          - Overview: services/storage.md
          - Cleanup Service: services/storage/keystore_cleanup.md
          - Recovery Service: services/storage/recovery.md
      - Tokens: services/tokens.md
      - TTX: services/ttx.md
  - Security:
      - HTLC Deadlines and Clock Synchronisation: security/htlc_deadline_clock_assumptions.md
      - Selector Resource Limits: security/selector_resource_limits.md
  - Development:
      - Overview: development/development.md
      - General Guidelines: development/general.md
      - Idiomatic Go: development/idiomatic.md
      - Mocking: development/mock.md
      - Linting: development/linting.md
      - Makefile Guide: development/makefile.md
      - Monitoring: development/monitoring.md
      - Storage: development/storage.md
      - Testing: development/testing.md
      - Tokengen: development/tokengen.md
      - Tools: development/tools.md
      - Versioning: development/versioning.md
      - AI Agents: development/ai_agents.md
      - Update FSC Dependency: development/update-fsc.md
      - Documentation: development/documentation.md
  - Evolution: evolution_summary.md