Merge pull request #20 from ForkbombEu/front-matter

fear: order by .md frontmatter needs title+order
ForkbombEu · Dec 10, 2024 · c62949f · c62949f
2 parents 7e9cacc + 32a37d8
commit c62949f
Show file tree

Hide file tree

Showing 214 changed files with 567 additions and 302 deletions.
diff --git a/bun.lockb b/bun.lockb
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -1,42 +1,40 @@
 import { defineConfig } from "vitepress";
 import { generateSidebar } from "vitepress-sidebar";
-import umlPlugin from 'markdown-it-plantuml';
+import umlPlugin from "markdown-it-plantuml";
 
 const vitepressSidebarOptions = {
-  documentRootPath: "docs",
+  documentRootPath: "/docs",
+  useTitleFromFrontmatter: true,
+  sortMenusByFrontmatterOrder: true,
+  frontmatterOrderDefaultValue: 999,
+  includeFolderIndexFile: false,
+  useFolderTitleFromIndexFile: true,
   manualSortFileNameByPriority: [
     "intro.md",
     "core-technologies.md",
     "solution.md",
     "get_started.md",
     "guides",
-    "sysadmin",
-    "setup.md",
-    "setup_dashboard.md",
-    "deploy_microservices.md",
-    "orgadmin",
   ],
-  useTitleFromFileHeading: true,
-  useFolderTitleFromIndexFile: true,
-  useFolderLinkFromIndexFile: true,
-  collapsed: false,
   includeDotFiles: false,
 };
 
 export default defineConfig({
   base: "/",
-  title: " ",
+  title: " | DIDroom Identity Solution ",
   description: "Empower your Identity strategy: customize, plug, deploy",
+  lang: 'en-US',
 
   lastUpdated: true,
   metaChunk: true,
 
   head: [
     [
-      'script',
+      "script",
       {},
-      `window.$crisp=[];window.CRISP_WEBSITE_ID="8dd97823-ddac-401e-991a-7498234e4f00";(function(){d=document;s=d.createElement("script");s.src="https://client.crisp.chat/l.js";s.async=1;d.getElementsByTagName("head")[0].appendChild(s);})();`
-    ]
+      `window.$crisp=[];window.CRISP_WEBSITE_ID="8dd97823-ddac-401e-991a-7498234e4f00";(function(){d=document;s=d.createElement("script");s.src="https://client.crisp.chat/l.js";s.async=1;d.getElementsByTagName("head")[0].appendChild(s);})();`,
+    ],
+	 ['link', { rel: 'icon', type: 'image/x-icon', href: './public/favicon/favicon.ico' }],
   ],
 
   themeConfig: {
@@ -45,21 +43,22 @@ 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/intro" },
+          { text: "Wallet App", link: "/guides/Wallet/wallet" },
+          { text: "Verifier App", link: "/guides/Verifier/verifier" },
+		  { text: "Credential issuance", link: "guides/Orgadmin/issuance_flow" },	  
+          { text: "Signatures", link: "/guides/Signature/signatures" },
+		  { text: "Sysadmins", link: "/guides/Sysadmin/sysadmin" },
         ],
       },
       { text: "Get started", link: "/get_started" },
-	  { text: "Pricing", link: "/guides/9_pricing/" },
+      { text: "Pricing", link: "/guides/Pricing/pricing" },
     ],
     logo: "https://raw.githubusercontent.com/ForkbombEu/DIDroom/45a5ffb737d81c33449bf2d394627a88ddbfc1d0/images/DIDroom_logo.svg",
     sidebar: generateSidebar(vitepressSidebarOptions),
     socialLinks: [
       { icon: "github", link: "https://github.com/forkbombeu/didroom" },
-      { icon: "linkedin", link: "https://linkedin.com/company/forkbomb" },
+      { icon: "linkedin", link: "https://linkedin.com/company/forkbomb" }
     ],
 
     footer: {
@@ -69,9 +68,9 @@ export default defineConfig({
         'Copyleft 🄯 2023-present <a href="https://forkbomb.solutions">Forkbomb B.V.</a>',
     },
   },
-    markdown: {
-		config(md) {
-			md.use(umlPlugin)
-    }
-  }
+  markdown: {
+    config(md) {
+      md.use(umlPlugin);
+    },
+  },
 });
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.
@@ -28,39 +35,39 @@ Below, you'll find detailed descriptions of each guide, carefully curated to emp
 > [!CAUTION] System administrators
 > For folks that wants to deploy and manage the infrastructure that powers Didroom.
 >
-> - [Setup an instance](/guides/4_sysadmin/setup)
-> - [Self host the dashboard](/guides/4_sysadmin/setup_dashboard)
-> - [Deploy microservices](/guides/4_sysadmin/deploy_microservices.md)
+> - [Setup an instance](/guides/Sysadmin/setup)
+> - [Self host the dashboard](/guides/Sysadmin/setup)
+> - [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/1_orgadmin/credential_issuer.md)
-> - [Setup an authorization server](/guides/1_orgadmin/auth_server.md)
-> - [Create issuance flows](/guides/1_orgadmin/issuance_flow.md)
+> - [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](/guides/404)
 > - [Generate microservices from the dashboard](/guides/404)
 > - [Add custom business logic for credential issuing](/guides/404)
 > - [Add custom business logic for authorization](/guides/404)
-> - [Create an organization](/guides/1_orgadmin/create.md)
+> - [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/2_wallet/1_register.md)
-> - [Request a credential](/guides/2_wallet/3_get_credential.md)
-> - [Present a credential](/guides/2_wallet/4_present_credential.md)
-> - [Get part to an organization](/guides/2_wallet/2_join_org.md)
-> - [Define preferences](/guides/2_wallet/5_preferences.md)
+> - [Create an identity / keyring](/guides/Wallet/sign-up.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)
+> - [Define preferences](/guides/Wallet/preferences.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.
 >
-> - [Get part of an organization](/guides/3_verifier/1_join_org.md)
-> - [Select a verification flow](/guides/3_verifier/2_verification_flow.md)
-> - [Verify a credential](/guides/3_verifier/3_verify.md)
+> - [Get part of an organization](/guides/Verifier/join_org.md)
+> - [Select a verification flow](/guides/Verifier/verification_flow.md)
+> - [Verify a credential](/guides/Verifier/verify.md)
 
 <style>
 :root {

diff --git a/docs/guides/1_orgadmin/issuance_flow.md b/docs/guides/1_orgadmin/issuance_flow.md
diff --git a/docs/guides/2_wallet/1_register.md b/docs/guides/2_wallet/1_register.md
diff --git a/docs/guides/2_wallet/index.md b/docs/guides/2_wallet/index.md
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/404.md b/docs/guides/404.md
@@ -1,3 +1,8 @@
+---
+title: 
+---
+
+
 # Coming soon!
 
 🚫 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!" 🕰️🔎
diff --git a/docs/guides/4_sysadmin/setup_dashboard.md b/docs/guides/4_sysadmin/setup_dashboard.md
diff --git a/docs/guides/7_terms-and-conditions/delete-account.md b/docs/guides/7_terms-and-conditions/delete-account.md
diff --git a/docs/guides/8_Acknowledgements/index.md → ...uides/Acknowledgements/acknowledgments.md b/docs/guides/8_Acknowledgements/index.md → ...uides/Acknowledgements/acknowledgments.md
@@ -1,3 +1,9 @@
+---
+title: Acknowledgements
+order: 10
+---
+
+
 # 🫶🏻 Acknowledgements
 
 ## NGI Trustchain

diff --git a/docs/guides/Acknowledgements/index.md b/docs/guides/Acknowledgements/index.md
@@ -0,0 +1,4 @@
+---
+title: Acknowledgements
+order: 80
+---
diff --git a/docs/guides/6_components/index.md → docs/guides/Components/Components.md b/docs/guides/6_components/index.md → docs/guides/Components/Components.md
@@ -1,9 +1,15 @@
+---
+title: Concepts/Components
+order: 1
+---
+
+
 # 📑 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/.../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/Components/index.md b/docs/guides/Components/index.md
@@ -0,0 +1,5 @@
+---
+title: 🧩 Technology
+order: 60
+---
+
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/1_orgadmin/auth_server.md → docs/guides/Orgadmin/auth_server.md b/docs/guides/1_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/1_orgadmin/create.md → docs/guides/Orgadmin/create.md b/docs/guides/1_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/1_orgadmin/credential_issuer.md → docs/guides/Orgadmin/credential_issuer.md b/docs/guides/1_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 b/docs/guides/Orgadmin/index.md
@@ -0,0 +1,4 @@
+---
+order: 30
+title: 👩‍⚖️ Issuance and Organization 
+---
diff --git a/docs/guides/1_orgadmin/index.md → docs/guides/Orgadmin/intro.md b/docs/guides/1_orgadmin/index.md → docs/guides/Orgadmin/intro.md
@@ -1,4 +1,8 @@
-# 👩‍⚖️ DIDroom Control Room
+---
+order: 1
+title: DIDroom Dashboard
+---
+# 👩‍⚖️ 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 b/docs/guides/Orgadmin/issuance_flow.md
@@ -0,0 +1,26 @@
+---
+title: Credential issuance flows
+order: 20
+---
+
+# Create a fully working credential issuing flow
+
+#### for 👩‍⚖️ Organization administrator
+
+## Discover the Templates
+
+Experiment with [Slangroom](https://dyne.org/slangroom)
+
+(Coming soon)
+
+## Configure the Microservices
+
+Coming soon
+
+## Issuance and Authorization Flows
+
+Coming soon
+
+## Watch video
+
+<video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/issuance_flow.webm" />