eudi-doc-architecture-and-reference-framework/mkdocs.yml at main · eu-digital-identity-wallet/eudi-doc-architecture-and-reference-framework · 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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# ============================================================
# CANONICAL config — eudi-doc-architecture-and-reference-framework
# (eudi.dev). The theme / markdown / plugins blocks below are the
# shared baseline; docs.eudi.dev and conformance.eudi.dev mirror them.
# Compatible with MkDocs Material 9.7.x and Zensical (>= 0.0.45).
# ============================================================

site_name: European Digital Identity
site_author: European Commission - DG CNECT
site_description: >-
  Architecture and Reference Framework (ARF) of the European Digital
  Identity Wallet: main narrative, annexes with normative high-level
  requirements, technical specifications, and discussion topics.
site_url: https://eu-digital-identity-wallet.github.io/eudi-doc-architecture-and-reference-framework
repo_url: https://github.com/eu-digital-identity-wallet/eudi-doc-architecture-and-reference-framework
repo_name: eu-digital-identity-wallet/eudi-doc-architecture-and-reference-framework
edit_uri: edit/main/docs/
copyright: © European Commission, 2026. Licensed under CC BY 4.0.

# ---------------- SHARED THEME BLOCK (keep identical across repos) ----------------
theme:
  name: material
  custom_dir: overrides          # holds home.html (ARF) + any future partials
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom            # EC blue #004494 — defined in extra.css
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.path
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - navigation.tracking
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.annotate     # quick win: annotated code blocks
    - content.tabs.link         # quick win: linked content tabs
  logo: media/logo_eudi_white.svg
  favicon: media/favicon.ico

extra_css:
  - media/extra.css              # site-specific path; same file contents everywhere

# ---------------- SHARED MARKDOWN BLOCK (keep identical) ----------------
markdown_extensions:
  - footnotes
  - sane_lists
  - tables
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.tilde
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:           # quick win: content tabs (e.g. Android / iOS)
      alternate_style: true
  - toc:
      permalink: true
      permalink_title: Link to this section
      toc_depth: 3
  # --- ARF-specific: shared snippet of references appended to every page ---
  - pymdownx.snippets:
      auto_append:
        - includes/references.md
      check_paths: true

# ---------------- SHARED PLUGINS BLOCK (keep identical) ----------------
hooks:
  - hooks/main_doc_redirect.py

plugins:
  - search
  - autorefs   # resolves [Topic N][topic-N] cross-references from any page depth
  - tags
  - privacy
  - social
  - mike
  - git-revision-date-localized:   # quick win: "last updated" (pip: mkdocs-git-revision-date-localized-plugin; CI needs full git history, fetch-depth: 0)
      enable_creation_date: true
      type: timeago

extra:
  # PDF button in the header (rendered by overrides/partials/header.html).
  # Stable URL: always resolves to the asset of the latest GitHub release.
  pdf_url: https://github.com/eu-digital-identity-wallet/eudi-doc-architecture-and-reference-framework/releases/latest/download/architecture-and-reference-framework-main-and-annexes.pdf
  pdf_title: Download the ARF as PDF
  version:
    provider: mike
    alias: true

# ---------------- ARF-specific ----------------
watch:
  - includes

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

nav:
  - European Digital Identity Wallet: index.md
  - Architecture and Reference Framework:
      - About: about.md
      - Main Document:
          - main/index.md
          - "1 Introduction": main/01-introduction.md
          - "2 EUDI Wallet functionalities": main/02-eudi-wallet-functionalities.md
          - "3 Roles within the EUDI Wallet ecosystem": main/03-roles-within-the-eudi-wallet-ecosystem.md
          - "4 High-level architecture": main/04-high-level-architecture.md
          - "5 Data model and data exchange protocols": main/05-data-model-and-data-exchange-protocols.md
          - "6 Trust model": main/06-trust-model.md
          - "7 Wallet Solution Certification and Risk Management": main/07-wallet-solution-certification-and-risk-management.md
          - "8 Accessibility": main/08-accessibility.md
          - "9 Document development": main/09-document-development.md
          - "10 References": main/10-references.md
          - "11 Annexes": main/11-annexes.md
      - Annexes:
          - annexes/README.md
          - annexes/annex-1/annex-1-definitions.md
          - High-Level Requirements:
              - annexes/annex-2/annex-2.01-high-level-requirements.md
              - annexes/annex-2/annex-2.02-high-level-requirements-by-topic.md
              - annexes/annex-2/annex-2.03-high-level-requirements-by-category.md
          - Rulebooks:
              - annexes/annex-3/annex-3.01-pid-rulebook.md
              - annexes/annex-3/annex-3.02-mDL-rulebook.md
          - Design Guides:
              - annexes/annex-5/annex-5.01-design-guide.md
              - annexes/annex-5/annex-5.02-design-guide-data-sharing-scenarios.md
  - Discussion Topics:
      - discussion-topics/README.md
      - discussion-topics/a-privacy-risks-and-mitigations.md
      - discussion-topics/aa-support-of-electronic-payments-SCA-with-wallet.md
      - discussion-topics/ab-digital-signature-using-wallet.md
      - discussion-topics/b-re-issuance-and-batch-issuance-of-pids-and-attestations.md
      - discussion-topics/c-wallet-unit-attestation.md
      - discussion-topics/c-rr-wallet-unit-attestations.md
      - discussion-topics/d-embedded-disclosure-policies.md
      - discussion-topics/e-pseudonyms-including-user-authentication-mechanism.md
      - discussion-topics/e-rr-pseudonyms-including-user-authentication-mechanism.md
      - discussion-topics/f-digital-credential-api.md
      - discussion-topics/g-zero-knowledge-proof.md
      - discussion-topics/h-transaction-logs-kept-by-the-wallet.md
      - discussion-topics/i-natural-person-representing-another-natural-person.md
      - discussion-topics/j-wallet-to-wallet-interactions.md
      - discussion-topics/j-rr-wallet-to-wallet-interactions.md
      - discussion-topics/k-combined-presentation-of-attestations.md
      - discussion-topics/l+m-data-deletion-and-reporting-of-wrp-to-dpa.md
      - discussion-topics/n-export-and-data-portability.md
      - discussion-topics/o-catalogues-for-attestations.md
      - discussion-topics/p-secure-cryptographic-interface-between-the-Wallet-Instance-and-WSCA.md
      - discussion-topics/q-interface-user-wallet-instance.md
      - discussion-topics/r-authentication-of-user-to-device.md
      - discussion-topics/s-certificate-transparancy.md
      - discussion-topics/t-support-and-maintenance-by-the-wallet-provider.md
      - discussion-topics/u-eudi-wallet-trust-mark.md
      - discussion-topics/v-pid-rulebook.md
      - discussion-topics/w-transactional-data-for-payments-and-other-use-cases.md
      - discussion-topics/x-relying-party-registration.md
      - discussion-topics/x-rr-relying-party-registration.md
      - discussion-topics/z-device-bound-attestations.md
  - Technical Specifications:
      - technical-specifications/README.md
      - technical-specifications/ts1-eudi-wallet-trust-mark.md
      - technical-specifications/ts2-notification-publication-provider-information.md
      - technical-specifications/ts3-wallet-unit-attestation.md
      - technical-specifications/ts4-zkp.md
      - technical-specifications/ts5-common-formats-and-api-for-rp-registration-information.md
      - technical-specifications/ts6-common-set-of-rp-information-to-be-registered.md
      - technical-specifications/ts7-common-interface-for-data-deletion-request.md
      - technical-specifications/ts8-common-interface-for-reporting-of-wrp-to-dpa.md
      - technical-specifications/ts9-wallet-to-wallet-interactions.md
      - technical-specifications/ts10-data-portability-and-download-(export).md
      - technical-specifications/ts11-interfaces-and-formats-for-catalogue-of-attributes-and-catalogue-of-schemes.md
      - technical-specifications/ts12-electronic-payments-SCA-implementation-with-wallet.md
      - technical-specifications/ts13-zksnark.md
      - technical-specifications/ts14-zkps-from-mms.md
  - Reference Implementation: https://docs.eudi.dev/latest/
  - Functional Conformance: https://conformance.eudi.dev/latest/