feat: rename files, add Frontmatter sorting

ForkbombEu · Dec 10, 2024 · 723f24d · 723f24d
1 parent 21634e7
commit 723f24d
Show file tree

Hide file tree

Showing 188 changed files with 387 additions and 217 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -46,15 +46,15 @@ export default defineConfig({
       {
         text: "Guide",
         items: [
-          { text: "Organization admins", link: "/guides/1_orgadmin/" },
-          { text: "Wallet App", link: "/guides/2_wallet/" },
-          { text: "Verifier App", link: "/guides/3_verifier/" },
-          { text: "System admins", link: "/guides/4_sysadmin/" },
-          { text: "Signatures", link: "/guides/5_signature/" },
+          { text: "Organization admins", link: "/guides/Orgadmin/" },
+          { text: "Wallet App", link: "/guides/Wallet/" },
+          { text: "Verifier App", link: "/guides/Verifier/" },
+          { text: "System admins", link: "/guides/Sysadmin/" },
+          { text: "Signatures", link: "/guides/Signature/" },
         ],
       },
       { text: "Get started", link: "/get_started" },
-      { text: "Pricing", link: "/guides/9_pricing/" },
+      { text: "Pricing", link: "/guides/Pricing/" },
     ],
     logo: "https://raw.githubusercontent.com/ForkbombEu/DIDroom/45a5ffb737d81c33449bf2d394627a88ddbfc1d0/images/DIDroom_logo.svg",
     sidebar: generateSidebar(vitepressSidebarOptions),

diff --git a/docs/core-technologies.md b/docs/core-technologies.md
@@ -1,3 +1,8 @@
+---
+title: 🏗️ Core Technologies
+order: 20
+---
+
 # 🏗️ Core Technologies
 
 ## 🔐 Zenroom

diff --git a/docs/get_started.md b/docs/get_started.md
@@ -1,3 +1,10 @@
+---
+title: 🏁 Get started
+order: 40
+---
+
+
+
 # 🏁 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.

diff --git a/docs/guides/3_verifier/1_join_org.md b/docs/guides/3_verifier/1_join_org.md
diff --git a/docs/guides/4_sysadmin/setup_dashboard.md b/docs/guides/4_sysadmin/setup_dashboard.md
diff --git a/docs/guides/8_Acknowledgements/index.md → docs/guides/Acknowledgements/index.md b/docs/guides/8_Acknowledgements/index.md → docs/guides/Acknowledgements/index.md
@@ -1,3 +1,9 @@
+---
+title: Acknowledgements
+order: 80
+---
+
+
 # 🫶🏻 Acknowledgements
 
 ## NGI Trustchain

diff --git a/.../6_components/generate_keys_keypairoom.md → ...es/Components/generate_keys_keypairoom.md b/.../6_components/generate_keys_keypairoom.md → ...es/Components/generate_keys_keypairoom.md
@@ -1,3 +1,8 @@
+---
+title: (Re)generate keys with Keypairoom
+order: 10
+---
+
 # Keypairoom: (re)generate your Secret Keys 
 
 Keypairoom is component to **generate and regenerate a keyring**, containing multiple secret keys (along with the correspondet public keys) in a **deterministic and private way**. 
@@ -6,7 +11,7 @@ The cryptographic part consists of multiple [Zenroom](https://zenroom.org/) scri
 
 ## Privacy
 
-The challenges are processed inside the client applications (the [Wallet App](https://github.com/ForkbombEu/wallet) or the browser where you opened the [DIDroom Control Room](https://dashboard.didroom.com/). Note: 
+The challenges are processed inside the client applications (the [Wallet App](https://github.com/ForkbombEu/wallet) or the browser where you opened the [DIDroom Dashboard](https://dashboard.didroom.com/). Note: 
 - The Zenroom scripts processing the answers work **offline**. 
 - Your answers are **never communicated to any external service**. 
 - **No one can reconstruct them** based on their output: this is certain based on the math behind it, if you're curious you can read about it [here](https://github.com/ForkbombEu/client_zencode?tab=readme-ov-file#login-creation).

diff --git a/docs/guides/6_components/index.md → docs/guides/Components/index.md b/docs/guides/6_components/index.md → docs/guides/Components/index.md
@@ -1,9 +1,15 @@
+---
+title: Technology and Components
+order: 60
+---
+
+
 # 📑 Concepts/Components
 
 
 ## Issuance and Verification Flows 
 
-The flows contain the **general setup for the Issuance and Verification**, with focus on the parameters for a specific credential, such as name, description, logo, microservices issueing/verifying those. **The business logic and data structures** for the Issuance and Verification are **contained in templates**, which can be **selected inside the Issuance and Verification Flows**. The complexity within the protocols and cryptography and hidden behind the DIDroom Control room, the specs are in the pages [Issuance flow](./issuance.md) and [Verification flow](./verification.md). 
+The flows contain the **general setup for the Issuance and Verification**, with focus on the parameters for a specific credential, such as name, description, logo, microservices issueing/verifying those. **The business logic and data structures** for the Issuance and Verification are **contained in templates**, which can be **selected inside the Issuance and Verification Flows**. The complexity within the protocols and cryptography and hidden behind the DIDroom Dashboard, the specs are in the pages [Issuance flow](./issuance.md) and [Verification flow](./verification.md). 
 
 
 

diff --git a/docs/guides/6_components/issuance.md → docs/guides/Components/issuance.md b/docs/guides/6_components/issuance.md → docs/guides/Components/issuance.md
@@ -1,11 +1,17 @@
+---
+title: Issuance (OpenID4VCI)
+order: 20
+---
+
+
 # Issuance flow
 
 The Issuance Flow is compatible with the [OpenID4VCI](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html) specification
 
 
 ## Basics
 
-The *DIDroom4VP* flow involves these main components: 
+The *DIDroom4VCI* flow involves these main components: 
 - **Wallet**: [DIDroom Wallet](https://github.com/ForkbombEu/wallet)
 - **(Credential )Issuer**: a microservices contained in [DIDroom Microservices](https://github.com/ForkbombEu/DIDroom_microservices)
 - **Authorization Server**: a microservices contained in [DIDroom Microservices](https://github.com/ForkbombEu/DIDroom_microservices)

diff --git a/docs/guides/6_components/verification.md → docs/guides/Components/verification.md b/docs/guides/6_components/verification.md → docs/guides/Components/verification.md
@@ -1,3 +1,8 @@
+---
+title: Verification Flow
+order: 20
+---
+
 # Verification flow
 
 We are following very close the work of the OpenID Foundation on the [OpenID4VP](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html) communication protocol. Since at the time of writing, *OpenID4VP* is still a draft, we implemented the custom verification flow **DIDroom4VP**. 

diff --git a/docs/guides/orgadmin/auth_server.md → docs/guides/Orgadmin/auth_server.md b/docs/guides/orgadmin/auth_server.md → docs/guides/Orgadmin/auth_server.md
@@ -1,3 +1,8 @@
+---
+title: Setup Authorization Server
+order: 40
+---
+
 # Setup an authorization server metadata
 
 #### for 👩‍⚖️ Organization administrator

diff --git a/docs/guides/orgadmin/create.md → docs/guides/Orgadmin/create.md b/docs/guides/orgadmin/create.md → docs/guides/Orgadmin/create.md
@@ -1,3 +1,8 @@
+---
+title: Create an organization
+order: 10
+---
+
 # Create an organization
 
 #### for 👩‍⚖️ Organization administrator

diff --git a/docs/guides/orgadmin/credential_issuer.md → docs/guides/Orgadmin/credential_issuer.md b/docs/guides/orgadmin/credential_issuer.md → docs/guides/Orgadmin/credential_issuer.md
@@ -1,3 +1,8 @@
+---
+title: Setup Credential Issuer
+order: 30
+---
+
 # Setup a credential issuer metadata
 
 #### for 👩‍⚖️ Organization administrator

diff --git a/docs/guides/orgadmin/index.md → docs/guides/Orgadmin/index.md b/docs/guides/orgadmin/index.md → docs/guides/Orgadmin/index.md
@@ -1,8 +1,8 @@
 ---
-order: 2
-title: 👩‍⚖️ DIDroom Control Room
+order: 30
+title: 👩‍⚖️ DIDroom Dashboard
 ---
-# 👩‍⚖️ DIDroom Control Room
+# 👩‍⚖️ DIDroom Dashboard
 
 Welcome, System Administrator! This guide provides step-by-step instructions for 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.
 

diff --git a/docs/guides/orgadmin/issuance_flow.md → docs/guides/Orgadmin/issuance_flow.md b/docs/guides/orgadmin/issuance_flow.md → docs/guides/Orgadmin/issuance_flow.md
@@ -1,3 +1,8 @@
+---
+title: Credential issuance flows
+order: 20
+---
+
 # Create a fully working credential issuing flow
 
 #### for 👩‍⚖️ Organization administrator

diff --git a/docs/guides/orgadmin/support.md → docs/guides/Orgadmin/support.md b/docs/guides/orgadmin/support.md → docs/guides/Orgadmin/support.md
@@ -1,3 +1,8 @@
+---
+title: Support
+order: 50
+---
+
 # Support
 
 We offer: 

diff --git a/docs/guides/9_pricing/index.md → docs/guides/Pricing/index.md b/docs/guides/9_pricing/index.md → docs/guides/Pricing/index.md
@@ -1,3 +1,8 @@
+---
+title: Pricing
+order: 90
+---
+
 # 🫱🏽‍🫲🏿 Pricing 🫱🏾‍🫲🏼
 
 ## Pricing Tables
@@ -38,8 +43,8 @@ Below a description of the individual features.
 - Info: [Deploy Microservices](../4_sysadmin/deploy_microservices) 
 
 ### Control Room
-- Description: the DIDroom Control Room is the main web application to setup Organizations, users, Credential Issuance and Verification Flows and Microservices.
-- Info: [DIDroom Control Room](../1_orgadmin/index) 
+- Description: the DIDroom Dashboard is the main web application to setup Organizations, users, Credential Issuance and Verification Flows and Microservices.
+- Info: [DIDroom Dashboard](../1_orgadmin/index) 
 
 ### Admin Dashboard
 - Description: the DIDroom Admin Dashboard is the backend of the whole DIDroom ecosystem. It is based on [Starters SaaS](https://github.com/dyne/starters) which itself is powered by [Pocketbase](https://github.com/pocketbase/pocketbase)
@@ -53,7 +58,7 @@ Below a description of the individual features.
 - Info: we offer custom development and training for the customization 
 
 ### White labeling
-- Description: the [Wallet app](https://github.com/forkbombEu/wallet), the [Verifier App](https://github.com/forkbombEu/verifier) and the [DIDroom Control Room](https://github.com/ForkbombEu/signroom/tree/main/webapp) are white-label friendly. White-labeling is performed using [DIDroom-Components](https://github.com/ForkbombEu/didroom-components) and the [Playbook](https://forkbombeu.github.io/didroom-components/).  
+- Description: the [Wallet app](https://github.com/forkbombEu/wallet), the [Verifier App](https://github.com/forkbombEu/verifier) and the [DIDroom Dashboard](https://github.com/ForkbombEu/signroom/tree/main/webapp) are white-label friendly. White-labeling is performed using [DIDroom-Components](https://github.com/ForkbombEu/didroom-components) and the [Playbook](https://forkbombeu.github.io/didroom-components/).  
 - Info: we offer support for white-labeling and custom development  
 
 ### W3C-DID service

diff --git a/docs/guides/9_pricing/pricing.md.unused → docs/guides/Pricing/pricing.md.unused b/docs/guides/9_pricing/pricing.md.unused → docs/guides/Pricing/pricing.md.unused
diff --git a/docs/guides/5_signature/index.md → docs/guides/Signature/index.md b/docs/guides/5_signature/index.md → docs/guides/Signature/index.md
@@ -1,4 +1,9 @@
-# 🖊️ Signatures 
+---
+title: 🖊️ Signatures (*AdES)  
+order: 40
+---
+
+# Signatures
 
 The application can produce different types of signatures, using different technologies for different purposes. 
 

diff --git a/docs/guides/5_signature/2_multisignature.md → docs/guides/Signature/multisignature.md b/docs/guides/5_signature/2_multisignature.md → docs/guides/Signature/multisignature.md
@@ -1,3 +1,8 @@
+---
+title: Create a MultiSignature
+order: 20
+---
+
 # Multisignature Flow
 
 The Multisignature Flow is a an implementation of the cryptographic flow described in the [Reflow Multisignature](https://arxiv.org/abs/2105.14527) paper. This allows users to create a JSON object to be signed, invite users to sign it, set a deadline and wait for their signatures. The signature process uses the homomorphic capabilities of the BLS 12-381 curve - see [here](https://hackmd.io/@benjaminion/bls12-381) if you're curious. The responses are anonymous and the output is a cryptographical object verifiable by anyone.

diff --git a/docs/guides/5_signature/1_signature.md → docs/guides/Signature/signature.md b/docs/guides/5_signature/1_signature.md → docs/guides/Signature/signature.md
@@ -1,3 +1,9 @@
+---
+title: Create a Signature
+order: 10
+---
+
+
 # Signature
 
 The Signature features allow to you sign documents and files, according to the standards *PaDES, CaDES, JaDES or XaDES* using your secrets keys and a certificate. 

diff --git a/...guides/4_sysadmin/deploy_microservices.md → docs/guides/Sysadmin/deploy_microservices.md b/...guides/4_sysadmin/deploy_microservices.md → docs/guides/Sysadmin/deploy_microservices.md
@@ -1,3 +1,9 @@
+---
+title: Deploy microservices
+order: 20
+---
+
+
 # Deploy microservices
 
 #### for 🛠️ System Administrator

diff --git a/docs/guides/4_sysadmin/index.md → docs/guides/Sysadmin/index.md b/docs/guides/4_sysadmin/index.md → docs/guides/Sysadmin/index.md
@@ -1,3 +1,8 @@
+---
+title: 🖊️ System Administrator  
+order: 50
+---
+
 # 🛠️ System Administrator
 
 Welcome, System Administrator! This guide provides step-by-step instructions for setting up and managing the infrastructure that powers DiDRoom. Whether you're deploying a new instance, self-hosting the dashboard, or deploying microservices, this guide has you covered.

diff --git a/docs/guides/4_sysadmin/setup.md → docs/guides/Sysadmin/setup.md b/docs/guides/4_sysadmin/setup.md → docs/guides/Sysadmin/setup.md
@@ -1,3 +1,8 @@
+---
+title: Setup the Dashboard
+order: 10
+---
+
 # Setup the Dashboard
 
 #### for 🛠️ System Administrator
@@ -31,7 +36,7 @@ Pay attention at the `--recursive` that will clone also the sub repositories!
 :::
 
 
-### 2. Run the Dashboard (Admin Panel and DIDroom Control Room)
+### 2. Run the Dashboard (Admin Panel and DIDroom Dashboard)
 
 ```bash
 cd signroom
@@ -40,14 +45,14 @@ docker compose up --build
 
 This will run the DIDroom Dashboard which includes two interconnected web-applications:
 - **Admin Panel**: based on PocketBase, this application is accessible only to the sysadmin and it allows to configure and edit data structure and API configurations.
-- **DIDroom Control Room**: this the DIDroom web application accessible to all users, allows to manage credential issuance and verification flows and their deployment and the organizations
+- **DIDroom Dashboard**: this the DIDroom web application accessible to all users, allows to manage credential issuance and verification flows and their deployment and the organizations
 
 
 The two web applications run on two different ports and have different user accounts.
 
 
 
-### 3. Create an account and log in onto the DIDroom Control Room 
+### 3. Create an account and log in onto the DIDroom Dashboard 
 
 Go to:
 

diff --git a/.../7_terms-and-conditions/delete-account.md → ...es/Terms-and-conditions/delete-account.md b/.../7_terms-and-conditions/delete-account.md → ...es/Terms-and-conditions/delete-account.md
@@ -1,9 +1,15 @@
+---
+title: Delete account
+order: 10
+---
+
+
 # Delete account
 
 **Last Updated:** [20.09.2024]
 
 
-Please read below the privacy policies the DIDroom Wallet, DIDroom Wallet, and the DIDroom Control Room (Dashboard).
+Please read below the privacy policies the DIDroom Wallet, DIDroom Wallet, and the DIDroom Dashboard (Dashboard).
 
 
 ## Step 1

diff --git a/docs/guides/7_terms-and-conditions/index.md → docs/guides/Terms-and-conditions/index.md b/docs/guides/7_terms-and-conditions/index.md → docs/guides/Terms-and-conditions/index.md
@@ -1,3 +1,8 @@
+---
+title: Terms and conditions
+order: 70
+---
+
 # 🗎 Terms and conditions