From 2318d610c45de5de30032ca14a0cf0835b93bbd2 Mon Sep 17 00:00:00 2001 From: Luca Giorgino <19236900+lucagiorgino@users.noreply.github.com> Date: Thu, 14 Mar 2024 09:04:41 +0100 Subject: [PATCH] Update docs e new page --- docs_mediterraneus/intro.md | 1 + .../running-the-protocol/connector-rs.md | 3 +- .../running-the-protocol/frontend-demo.md | 3 +- .../running-the-protocol/issuer-rs.md | 3 +- .../running-the-protocol/smart-contracts.md | 3 +- docusaurus.config.js | 29 +++++++------------ src/pages/publications.md | 9 ++++++ 7 files changed, 29 insertions(+), 22 deletions(-) create mode 100644 src/pages/publications.md diff --git a/docs_mediterraneus/intro.md b/docs_mediterraneus/intro.md index 46f0c03..97a1f7c 100644 --- a/docs_mediterraneus/intro.md +++ b/docs_mediterraneus/intro.md @@ -1,5 +1,6 @@ --- sidebar_position: 1 +slug: / --- # Mediterraneus diff --git a/docs_mediterraneus/running-the-protocol/connector-rs.md b/docs_mediterraneus/running-the-protocol/connector-rs.md index 9683e93..8bc7ed3 100644 --- a/docs_mediterraneus/running-the-protocol/connector-rs.md +++ b/docs_mediterraneus/running-the-protocol/connector-rs.md @@ -1,10 +1,11 @@ --- sidebar_position: 3 +description: Agent system that handles user identity and assets. --- # Connector -- [**mediterraneus-connector-rs**](https://github.com/Cybersecurity-LINKS/mediterraneus-connector-rs), the connector handles user identity and assets, +- [**mediterraneus-connector-rs**](https://github.com/Cybersecurity-LINKS/mediterraneus-connector-rs) ## Requirements diff --git a/docs_mediterraneus/running-the-protocol/frontend-demo.md b/docs_mediterraneus/running-the-protocol/frontend-demo.md index c03ee8d..b272f39 100644 --- a/docs_mediterraneus/running-the-protocol/frontend-demo.md +++ b/docs_mediterraneus/running-the-protocol/frontend-demo.md @@ -1,10 +1,11 @@ --- sidebar_position: 4 +description: Sample frontend application for interacting with the connector, issuer, and catalogue. --- # Frontend -- [**mediterraneus-frontend**](https://github.com/Cybersecurity-LINKS/mediterraneus-frontend), sample frontend application for interacting with the connector, issuer, and catalogue. +- [**mediterraneus-frontend**](https://github.com/Cybersecurity-LINKS/mediterraneus-frontend) # Running the Application diff --git a/docs_mediterraneus/running-the-protocol/issuer-rs.md b/docs_mediterraneus/running-the-protocol/issuer-rs.md index 8867009..3c2e13e 100644 --- a/docs_mediterraneus/running-the-protocol/issuer-rs.md +++ b/docs_mediterraneus/running-the-protocol/issuer-rs.md @@ -1,10 +1,11 @@ --- sidebar_position: 2 +description: Issuer of verifiable credentials using smart contracts to bind Externally Owned Accounts (EOAs) with Self-Sovereign Identities (SSI). --- # Issuer -- [**mediterraneus-issuer-rs**](https://github.com/Cybersecurity-LINKS/mediterraneus-issuer-rs), Issuer of verifiable credentials using smart contracts to bind Externally Owned Accounts (EOAs) with Self-Sovereign Identities (SSI). Sample implementation for the Mediterraneus Protocol, +- [**mediterraneus-issuer-rs**](https://github.com/Cybersecurity-LINKS/mediterraneus-issuer-rs) ## Requirements 1. [cargo](https://www.rust-lang.org/learn/get-started), with `rustc 1.74 or newer` diff --git a/docs_mediterraneus/running-the-protocol/smart-contracts.md b/docs_mediterraneus/running-the-protocol/smart-contracts.md index 36cda21..c5e6d72 100644 --- a/docs_mediterraneus/running-the-protocol/smart-contracts.md +++ b/docs_mediterraneus/running-the-protocol/smart-contracts.md @@ -1,10 +1,11 @@ --- sidebar_position: 1 +description: Smart contracts for the Mediterraneus protocol. --- # Smart contracts -- [**mediterraneus-smart-contracts**](https://github.com/Cybersecurity-LINKS/mediterraneus-smart-contracts), smart contracts for the Mediterraneus protocol, +- [**mediterraneus-smart-contracts**](https://github.com/Cybersecurity-LINKS/mediterraneus-smart-contracts) ## Requirements 1. [Solidity compiler (hardhat)](https://hardhat.org/) diff --git a/docusaurus.config.js b/docusaurus.config.js index 09abec2..1a1bd4f 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -103,6 +103,7 @@ const config = { src: 'img/logo.jpg', }, items: [ + {to: 'publications', label: 'Publications', position: 'left'}, { type: 'docSidebar', docsPluginId: 'docs-mediterraneus', @@ -133,7 +134,7 @@ const config = { items: [ { label: 'Mediterraneus', - to: '/mediterraneus/intro', + to: '/mediterraneus', }, { label: 'Embrave', @@ -141,23 +142,15 @@ const config = { }, ], }, - // { - // title: 'Community', - // items: [ - // { - // label: 'Stack Overflow', - // href: 'https://stackoverflow.com/questions/tagged/docusaurus', - // }, - // { - // label: 'Discord', - // href: 'https://discordapp.com/invite/docusaurus', - // }, - // { - // label: 'Twitter', - // href: 'https://twitter.com/docusaurus', - // }, - // ], - // }, + { + title: 'About', + items: [ + { + label: 'Publications', + href: '/publications', + }, + ], + }, { title: 'More', items: [ diff --git a/src/pages/publications.md b/src/pages/publications.md new file mode 100644 index 0000000..4491847 --- /dev/null +++ b/src/pages/publications.md @@ -0,0 +1,9 @@ +--- +title: Publications +description: Publications of the Cybersecurity Research Group at LINKS Foundation +hide_table_of_contents: true +--- + +# Publications + +To do \ No newline at end of file