-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: revamp the structure of docs site contents (#13)
* feat: revamp the structure of the contents * docs: new image for download microservices (#11) * chore: test pr preview_prs * install vhs * add ttyd * add it from snap * boom * order matters sometimes * path matters sometimes * powers matters sometimes * sometimes stupidy matters... * meh * mah * booh * docs: aknowledgements and microservices deployment * chore: separate deployments and add /dashboard section * yeyeye * docs: add image for zip download * Deploy preview for PR 11 🛫 * Remove preview for PR 11 🛬 * Update README.md * build: deps * up: patch * fix: paths --------- Co-authored-by: puria <puria@users.noreply.github.com> Co-authored-by: Andrea D'Intino <andrea@dyne.org>
- Loading branch information
3 people
authored
Apr 23, 2024
1 parent
8378fa1
commit 0d65165
Showing
40 changed files
with
530 additions
and
235 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 🚫 Oops! Looks like the document you were hunting for is playing hide and seek with us! Don't worry, our crack team of digital detectives is on the case. 🕵️♂️🔍 While they're hot on the trail, feel free to kick back, grab a snack, and try your search again in a bit. We promise it'll turn up sooner than you can say "404!" 🕰️🔎 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| # Aknowledgements | ||
| # 🫶🏻 Aknowledgements | ||
|
|
||
| <img align="left" src="./images/logo-ngi-trustchain-positive-rgb-PNG.png" width="365"> | ||
| <img align="left" src="/images/logo-ngi-trustchain-positive-rgb-PNG.png" width="365"> | ||
|
|
||
| Supported by [NGI TRUSTCHAIN](https://trustchain.ngi.eu/), which is made possible with financial support from the European Commission's [Next Generation Internet](https://ngi.eu/) programme. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,51 @@ | ||
| # 🏗️ Core Technologies | ||
|
|
||
| ## 🔐 Zenroom | ||
| Zenroom is responsible for all underlying cryptographic operations within the Didroom ecosystem. It provides a secure execution environment for cryptographic operations and smart contracts, ensuring privacy, security, and integrity in digital interactions. Notably, Zenroom runs isomorphically on the web, mobile, and servers across various platforms in a deterministic way. | ||
| ## 🔐 Zenroom | ||
|
|
||
| ::: tip RESOURCES | ||
| Zenroom is responsible for all underlying cryptographic operations within the Didroom ecosystem. It provides a secure execution environment for cryptographic operations and smart contracts, ensuring privacy, security, and integrity in digital interactions. Notably, Zenroom runs isomorphically on the web, mobile, and servers across various platforms in a deterministic way. | ||
|
|
||
| [Documentation](https://dev.zenroom.org/) | ||
|
|
||
| [GitHub](https://github.com/dyne/zenroom) | ||
|
|
||
| [Site](https://zenroom.org/) | ||
| ::: tip RESOURCES | ||
|
|
||
| ::: | ||
| [Documentation](https://dev.zenroom.org/) | ||
|
|
||
| [GitHub](https://github.com/dyne/zenroom) | ||
|
|
||
| [Site](https://zenroom.org/) | ||
|
|
||
| ::: | ||
|
|
||
| ## 📜 Slangroom | ||
| Slangroom enhances the Zencode language of Zenroom by allowing the addition of plugins. These plugins extend the functionality of Zencode by enabling actions that do not necessarily need to be performed within virtual machines. Slangroom's approach is super standard, making it easy to add custom functionalities within the Zencode natural language. Additionally, Slangroom is capable of running over web pages using WebAssembly. | ||
|
|
||
| ::: tip RESOURCES | ||
|
|
||
| [Documentation](https://dyne.org/slangroom) | ||
| Slangroom enhances the Zencode language of Zenroom by allowing the addition of plugins. These plugins extend the functionality of Zencode by enabling actions that do not necessarily need to be performed within virtual machines. Slangroom's approach is super standard, making it easy to add custom functionalities within the Zencode natural language. Additionally, Slangroom is capable of running over web pages using WebAssembly. | ||
|
|
||
| ::: tip RESOURCES | ||
|
|
||
| [GitHub](https://github.com/syne/slangroom) | ||
| [Documentation](https://dyne.org/slangroom) | ||
|
|
||
| ::: | ||
| [GitHub](https://github.com/syne/slangroom) | ||
|
|
||
| ::: | ||
|
|
||
| ## 🛠️ No-code-room (NCR) | ||
| No-code-room is a Single Executable Application (SEA) for Linux. It takes a filesystem with .zen (Zencode/Slangroom) contracts and creates API microservices using live-directory routing. NCR seamlessly generates REST services that are auto-documented with OpenAPI. Additionally, it creates small graphic interfaces on the fly, referred to as applets. | ||
| ::: tip RESOURCES | ||
|
|
||
| [GitHub](https://github.com/forkbombeu/ncr) | ||
| No-code-room is a Single Executable Application (SEA) for Linux. It takes a filesystem with .zen (Zencode/Slangroom) contracts and creates API microservices using live-directory routing. NCR seamlessly generates REST services that are auto-documented with OpenAPI. Additionally, it creates small graphic interfaces on the fly, referred to as applets. | ||
| ::: tip RESOURCES | ||
|
|
||
| [GitHub](https://github.com/forkbombeu/ncr) | ||
|
|
||
| ::: | ||
| ::: | ||
|
|
||
| ## 🔗 Dyne.org Decentralized Identifiers (DID) Service | ||
| In 2022, Dyne.org implemented a W3C-DID method approved by the W3C governing board and included in the official DID method list. The DID service supports federation and provides tools for the creation, resolution, and management of decentralized identifiers (DIDs). It includes support for ECDSA, EDDSA, Schnorr, Ethereum address, as well as a Dilithium quantum-proof public key. | ||
| ::: tip RESOURCES | ||
|
|
||
| [GitHub](https://github.com/dyne/w3c-did) | ||
| In 2022, Dyne.org implemented a W3C-DID method approved by the W3C governing board and included in the official DID method list. The DID service supports federation and provides tools for the creation, resolution, and management of decentralized identifiers (DIDs). It includes support for ECDSA, EDDSA, Schnorr, Ethereum address, as well as a Dilithium quantum-proof public key. | ||
| ::: tip RESOURCES | ||
|
|
||
| [GitHub](https://github.com/dyne/w3c-did) | ||
|
|
||
| [Online DIDs Explorer](https://explorer.did.dyne.org/) | ||
|
|
||
| [Online DIDs Explorer](https://explorer.did.dyne.org/) | ||
|
|
||
| [Specification](https://dyne.org/W3C-DID/) | ||
| [Specification](https://dyne.org/W3C-DID/) | ||
|
|
||
| [Site](https://forkbomb.solutions/component/w3c-did-federate-service/) | ||
| [Site](https://forkbomb.solutions/component/w3c-did-federate-service/) | ||
|
|
||
| ::: | ||
| ::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| # 🏁 Get started | ||
|
|
||
| Welcome to the Didroom Get Started guide! 🚀 We're thrilled to have you embark on this journey with us. Whether you're a seasoned **system administrator**, a savvy **organization administrator**, an enthusiastic **wallet holder**, or a meticulous **verifier**, this section is tailor-made to provide you with comprehensive, step-by-step instructions crafted specifically for your role within the Didroom ecosystem. | ||
|
|
||
| :::info 💜 | ||
| We assume you're already familiar with Didroom's solution, its components and how they works. | ||
|
|
||
| If it's not the case, please refer to the [introductory section](/intro.html) for an overview. | ||
| ::: | ||
|
|
||
| Below, you'll find detailed descriptions of each guide, carefully curated to empower you with the knowledge and tools you need to navigate the world of decentralized identity management 🔐 | ||
|
|
||
| --- | ||
|
|
||
| > [!CAUTION] System administrators | ||
| > For folks that wants to deploy and manage the infrastructure that powers Didroom. | ||
| > | ||
| > - [Setup an instance](/guides/sysadmin/setup) | ||
| > - [Self host the dashboard](/guides/sysadmin/setup_dashboard) | ||
| > - [Deploy microservices](/guides/sysadmin/deploy_microservices.md) | ||
| > [!IMPORTANT] Organization administrators | ||
| > For folks that wants to oversee the configuration and management of decentralized identity solutions within their organizations. Here you'll find instructions on how to use the Dashboard to configure settings, monitor your issuance flows, and access key functionalities. | ||
| > | ||
| > - [Setup a credential issuer](/guides/orgadmin/credential_issuer.md) | ||
| > - [Setup an authorization server](/guides/orgadmin/auth_server.md) | ||
| > - [Create issuance flows](/guides/orgadmin/issuance_flow.md) | ||
| > - [Create verification flows](/404) | ||
| > - [Generate microservices from the dashboard](/404) | ||
| > - [Add custom business logic for credential issuing](/404) | ||
| > - [Add custom business logic for authorization](/404) | ||
| > - [Create an organization](/guides/orgadmin/create.md) | ||
| > [!WARNING] Wallet holders | ||
| > | ||
| > For individuals that wants to use the Wallet Holder App to manage their decentralized identities and digital credentials securely. Here we walks you through the process of installing and using the Wallet Holder App to store, view, and share identity information with ease. | ||
| > | ||
| > - [Create an identity / keyring](/guides/wallet/register.md) | ||
| > - [Request a credential](/guides/wallet/get_credential.md) | ||
| > - [Present a credential](/guides/wallet/present_credential.md) | ||
| > - [Get part to an organization](/guides/wallet/join_org.md) | ||
| > - [Change language](/guides/wallet/change_language.md) | ||
| > - [Define preferences](/guides/wallet/preferences.md) | ||
| > - [Logout and wipe data](/guides/wallet/logout.md) | ||
| > [!TIP] Verifiers | ||
| > | ||
| > For individuals that wants to utilize the Verifier App to verify the authenticity and validity of decentralized identities and digital credentials. Here we outlines how to install and use the Verifier App to validate identity claims and ensure compliance with regulatory requirements. | ||
| > | ||
| > - [Register as a verifier](/guides/verifier/register.md) | ||
| > - [Verify a credential](/guides/verifier/verify.md) | ||
| > - [Select a verification flow](/guides/verifier/verification_flow.md) | ||
| > - [Get part of an organization](/guides/verifier/join_org.md) | ||
| <style> | ||
| :root { | ||
| --vp-custom-block-font-size: 19px; | ||
| .custom-block-title { | ||
| font-size: 26px; | ||
| padding-bottom: 8px; | ||
| } | ||
| .vp-doc ul { | ||
| list-style: disclosure-closed; | ||
| } | ||
| .vp-doc ul li { | ||
| padding-top: 2px; | ||
| } | ||
| } | ||
| </style> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # 📑 Concepts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # Guides |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Setup an authorization server metadata | ||
|
|
||
| #### for 👩⚖️ Organization administrator | ||
|
|
||
| <video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/create_authz_server.webm" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Create an organization | ||
|
|
||
| #### for 👩⚖️ Organization administrator | ||
|
|
||
| <video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/create_organization.webm" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Setup a credential issuer metadata | ||
|
|
||
| #### for 👩⚖️ Organization administrator | ||
|
|
||
| <video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/create_credential_issuer.webm" /> |
Oops, something went wrong.