forked from openwallet-foundation/acapy
-
Notifications
You must be signed in to change notification settings - Fork 9
/
mkdocs.yml
155 lines (155 loc) · 6.17 KB
/
mkdocs.yml
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
site_name: Hyperledger Aries ACA-Py Docs
repo_name: hyperledger/aries-cloudagent-python
repo_url: https://github.com/hyperledger/aries-cloudagent-python
theme:
name: material
custom_dir: overrides
logo: https://raw.githubusercontent.com/hyperledger/aries-acapy-docs/main/assets/Hyperledger_Aries_Logo_White.png
favicon: https://raw.githubusercontent.com/hyperledger/aries-cloudagent-python/main/docs/assets/aries-favicon.png
icon:
repo: fontawesome/brands/github
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- content.code.copy
- navigation.expand
- navigation.footer
- navigation.instant
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- toc.follow
# - toc.integrate
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
toc_depth: 3
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
plugins:
- search
- mike
extra:
version:
provider: mike
nav:
- Welcome!:
- Welcome: aca-py.org.md
- ACA-Py README: README.md
- Release Notes: CHANGELOG.md
- Features:
- Developer Introduction: features/DevReadMe.md
- DevContainer Support: features/devcontainer.md
- Supported Aries Interop Profiles and RFCs: features/SupportedRFCs.md
- The Admin API: features/AdminAPI.md
- ACA-Py Plugins: features/PlugIns.md
- Multitenant ACA-Py: features/Multitenancy.md
- Qualified DIDs: features/QualifiedDIDs.md
- DID Methods: features/DIDMethods.md
- DID Resolution: features/DIDResolution.md
- Publishing AnonCreds Objects To Other Ledgers/Verifiable Data Registries: features/AnonCredsMethods.md
- Configuring Multiple Indy Ledgers: features/Multiledger.md
- Automatically Endorsing Indy Transations: features/Endorser.md
- Using W3C JSON-LD Signed Credentials: features/JsonLdCredentials.md
- Using SD-JWTs: features/SelectiveDisclosureJWTs.md
- AnonCreds Presentation Validation: features/AnoncredsProofValidation.md
- Multiple Credential Types: features/Multicredentials.md
- Code Generation with the Open API: features/UsingOpenAPI.md
- ACA-Py as a DIDComm Mediator: features/Mediation.md
- Demos:
- Hyperledger Aries / AnonCreds Workshop: demo/Aries-Workshop.md
- The Alice-Faber Demo: demo/README.md
- Open API Tutorial: demo/AriesOpenAPIDemo.md
- Alice Gets a Phone: demo/AliceGetsAPhone.md
- Hyperledger Indy Endorser In Action: demo/Endorser.md
- Using W3C JSON-LD Credentials: demo/AliceWantsAJsonCredential.md
- DIY -- ACME Controller Workshop: demo/AcmeDemoWorkshop.md
- Aries Using Postman Demo: demo/AriesPostmanDemo.md
- Reusing a Connection Between Agents: demo/ReusingAConnection.md
- Getting Started:
- Becoming an Indy/Aries Developer: gettingStarted/README.md
- Hyperledger Indy Basics: gettingStarted/IndyBasics.md
- Hyperledger Aries Basics: gettingStarted/AriesBasics.md
- Decentralized Identity Demos: gettingStarted/DecentralizedIdentityDemos.md
- Aries - The Big Picture: gettingStarted/AriesBigPicture.md
- Aries Architecture: gettingStarted/AriesAgentArchitecture.md
- Aries Messaging: gettingStarted/AriesMessaging.md
- Aries Developer Demos: gettingStarted/AriesDeveloperDemos.md
- Agent Connections: gettingStarted/AgentConnections.md
- Issuing AnonCreds Credentials: gettingStarted/IssuingAnonCredsCredentials.md
- Presenting AnonCreds Proofs: gettingStarted/PresentingAnonCredsProofs.md
- Making Your Own ACA-Py Agent: gettingStarted/YourOwnAriesAgent.md
- Aries Developer Options: gettingStarted/IndyAriesDevOptions.md
- DIDComm Messaging: gettingStarted/DIDcommMsgs.md
- DIDComm Message Routing: gettingStarted/RoutingEncryption.md
- DIDComm Message Routing Example: gettingStarted/AriesRoutingExample.md
- TODO Connecting to an Indy Network: gettingStarted/ConnectIndyNetwork.md
- AnonCreds Credential Revocation: gettingStarted/CredentialRevocation.md
- Deploying:
- Deployment Model: deploying/deploymentModel.md
- Upgrading ACA-Py: deploying/UpgradingACA-Py.md
- Indy SDK to Askar Migration: deploying/IndySDKtoAskarMigration.md
- Controller Migration to use AnonCreds Rust: deploying/AnoncredsControllerMigration.md
- The Use of Poetry in ACA-Py: deploying/Poetry.md
- ACA-Py Container Images: deploying/ContainerImagesAndGithubActions.md
- Databases: deploying/Databases.md
- Persistent Queues and Caching: deploying/RedisPlugins.md
- The askar-anoncreds Wallet Type: deploying/AnonCredsWalletType.md
- Testing/Troubleshooting:
- Running and Creating Unit Tests: testing/UnitTests.md
- Managing Logging: testing/Logging.md
- ACA-Py Integration Tests: testing/INTEGRATION-TESTS.md
- Protocol Tracing: testing/AgentTracing.md
- Troubleshooting: testing/Troubleshooting.md
- Contributing:
- How to Contribute: CONTRIBUTING.md
- Maintainers: MAINTAINERS.md
- Hyperledger Code of Conduct: CODE_OF_CONDUCT.md
- Security Vulnerability Reporting: SECURITY.md
- Publishing an ACA-Py Release: PUBLISHING.md
- Updating the ACA-Py ReadTheDocs Site: UpdateRTD.md