Merge pull request #363 from okp4/feat/academy-part-1

Feat/academy part 1

.markdownlint.yaml

@@ -4,3 +4,4 @@ no-inline-html: false
 no-emphasis-as-header: false
 no-duplicate-header: false
 ol-prefix: false
+no-emphasis-as-heading: false

docs/academy/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Academy",
+  "position": 4
+}

docs/academy/overview.mdx

@@ -0,0 +1,108 @@
+---
+sidebar_class_name: hidden
+---
+
+# Academy overview 
+
+Welcome to the OKP4 Academy, your gateway to the cutting-edge world of off-chain resource sharing and orchestration. In an era where the efficient utilization of resources is paramount, the OKP4 protocol emerges as a groundbreaking solution. OKP4 specializes in the seamless sharing and orchestration of off-chain resources.
+
+Throughout this concise journey, we will guide you through the core principles of the OKP4 protocol, providing you with a swift understanding of its functions. Prepare to immerse yourself in the realm of OKP4, where the focus lies on optimizing resource sharing and create new knowledge. Are you ready to explore the forefront of off-chain resource management? Follow us through this Academy to unravel the intricacies of OKP4.
+
+## Concepts of OKP4
+
+Delve into the core concepts behind the OKP4 Protocol.
+
+<div class="docs-card-container">
+  <div class="row row-cols-1 row-cols-md-2a g-3">
+    <div class="col">
+      <div class="card card-body h-100 d-flex flex-column">
+        <a
+          href="/technical-documentation/ontology/the-power-of-ontologies"
+          class="card-title card-link stretched-link"
+        >
+          <h2>Ontology</h2>
+        </a>
+        <p class="card-text">Explore the semantic data model driving the protocol.</p>
+      </div>
+    </div>
+    <div class="col">
+      <div class="card card-body h-100 d-flex flex-column">
+        <a
+          href="/technical-documentation/governance/introduction"
+          class="card-title card-link stretched-link"
+        >
+          <h2>Governance</h2>
+        </a>
+        <p class="card-text">Understand why and how the resources of the dataverse are governed.</p>
+      </div>
+    </div>
+  </div>
+</div>
+
+## Delving into the Protocol
+
+### The Smart Contracts
+
+Deepen your understanding of the OKP4 Protocol's Smart Contracts.
+
+<div class="docs-card-container">
+  <div class="row row-cols-1 row-cols-md-2a g-3">
+    <div class="col">
+      <div class="card card-body h-100 d-flex flex-column">
+        <a href="/contracts/okp4-objectarium" class="card-title card-link stretched-link">
+          <h2>Objectarium</h2>
+        </a>
+        <p class="card-text">Introducing the immutable on-chain Object Storage.</p>
+      </div>
+    </div>
+    <div class="col">
+      <div class="card card-body h-100 d-flex flex-column">
+        <a href="/contracts/okp4-cognitarium" class="card-title card-link stretched-link">
+          <h2>Cognitarium</h2>
+        </a>
+        <p class="card-text">Introducing the on-chain Semantic Storage layer.</p>
+      </div>
+    </div>
+    <div class="col">
+      <div class="card card-body h-100 d-flex flex-column">
+        <a href="/contracts/okp4-law-stone" class="card-title card-link stretched-link">
+          <h2>Law Stone</h2>
+        </a>
+        <p class="card-text">Introducing the Governance Interpreter.</p>
+      </div>
+    </div>
+  </div>
+</div>
+
+### OKP4's Cosmos Modules
+
+Unearth the features and functions of OKP4 Protocol's Cosmos Modules.
+
+<div class="docs-card-container">
+  <div class="row row-cols-1 row-cols-md-2a g-3">
+    <div class="col">
+      <div class="card card-body h-100 d-flex flex-column">
+        <a href="/modules/mint" class="card-title card-link stretched-link">
+          <h2>Mint</h2>
+        </a>
+        <p class="card-text">Unveil the mechanism of minting.</p>
+      </div>
+    </div>
+    <div class="col">
+      <div class="card card-body h-100 d-flex flex-column">
+        <a href="/modules/vesting" class="card-title card-link stretched-link">
+          <h2>Vesting</h2>
+        </a>
+        <p class="card-text">Understand the specifics of vesting in the protocol.</p>
+      </div>
+    </div>
+    <div class="col">
+      <div class="card card-body h-100 d-flex flex-column">
+        <a href="/modules/logic" class="card-title card-link stretched-link">
+          <h2>Logic</h2>
+        </a>
+        <p class="card-text">Discover the heart of Logical interpretation in the protocol.</p>
+      </div>
+    </div>
+  </div>
+</div>

docs/academy/resources.md

@@ -0,0 +1,5 @@
+---
+sidebar_class_name: hidden
+---
+
+# Resources: what can be shared

docusaurus.config.js

@@ -1,8 +1,26 @@
-// @ts-check
-
 const lightCodeTheme = require('prism-react-renderer/themes/github')
 const darkCodeTheme = require('prism-react-renderer/themes/dracula')
 
+function readingTimeMDXPlugin({ variable = 'readingTime', additionalTimePerImage = 1 } = {}) {
+  return async function transformer(tree, vfile) {
+    const readingTime = require('reading-time')
+    const { u } = await import('unist-builder')
+    const visit = require('unist-util-visit')
+
+    let imageCount = 0
+    visit(tree, 'jsx', node => {
+      if (node.value.includes('img')) {
+        imageCount++
+      }
+    })
+
+    const baseReadingTime = readingTime(vfile.contents).minutes
+    const adjustedReadingTime = baseReadingTime + imageCount * additionalTimePerImage
+
+    tree.children.unshift(u('export', { value: `const ${variable} = '${adjustedReadingTime}';` }))
+  }
+}
+
 async function createconfig() {
   const { remarkKroki } = await import('remark-kroki')
 
@@ -34,6 +52,7 @@ async function createconfig() {
             sidebarPath: require.resolve('./sidebars.js'),
             editUrl: ({ docPath }) => `https://github.com/okp4/docs/edit/main/docs/${docPath}`,
             remarkPlugins: [
+              readingTimeMDXPlugin,
               require('remark-math'),
               require('mdx-mermaid'),
               [
@@ -107,7 +126,7 @@ async function createconfig() {
             {
               href: 'https://chat.openai.com/g/g-zUzcYmVbX-okp4-druid-oracle-beta',
               position: 'left',
-              label: 'OKP4 GPT',
+              label: 'OKP4 GPT'
             },
             {
               type: 'docsVersionDropdown',

package.json

@@ -40,9 +40,12 @@
     "prism-react-renderer": "^1.3.5",
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
+    "reading-time": "^2.0.0-1",
     "rehype-katex": "5",
     "remark-math": "3",
-    "sass": "^1.68.0"
+    "sass": "^1.68.0",
+    "unist-builder": "^4.0.0",
+    "unist-util-visit": "^2.0.0"
   },
   "browserslist": {
     "production": [

sidebars.js

@@ -99,6 +99,18 @@ const sidebars = {
       label: 'FAQ'
     }
   ],
+  academy: [
+    {
+      type: 'category',
+      label: 'Academy TEST',
+      items: [
+        {
+          type: 'autogenerated',
+          dirName: 'academy'
+        }
+      ]
+    }
+  ],
   gpt: [
     {
       type: 'link',

src/scss/main.scss

@@ -248,3 +248,7 @@ svg {
     display: none;
   }
 }
+
+.hidden {
+  display: none !important;
+}

yarn.lock

@@ -2668,6 +2668,11 @@
   version "2.0.6"
   resolved "https://registry.npmjs.org/@types/unist/-/unist-2.0.6.tgz"
 
+"@types/unist@^3.0.0":
+  version "3.0.2"
+  resolved "https://registry.yarnpkg.com/@types/unist/-/unist-3.0.2.tgz#6dd61e43ef60b34086287f83683a5c1b2dc53d20"
+  integrity sha512-dqId9J8K/vGi5Zr7oo212BGii5m3q5Hxlkwy3WpYuKPklmBEvsbMYYyLxAQpSffdLl/gdW0XUpKWFvYmyoWCoQ==
+
 "@types/ws@^8.5.1":
   version "8.5.3"
   resolved "https://registry.npmjs.org/@types/ws/-/ws-8.5.3.tgz"
@@ -7395,6 +7400,11 @@ reading-time@^1.5.0:
   version "1.5.0"
   resolved "https://registry.npmjs.org/reading-time/-/reading-time-1.5.0.tgz"
 
+reading-time@^2.0.0-1:
+  version "2.0.0-1"
+  resolved "https://registry.yarnpkg.com/reading-time/-/reading-time-2.0.0-1.tgz#fe7a94e1d9199700f166b744925681cdb8851d06"
+  integrity sha512-5Eoo17ZGqH2L0jmMZUNKARiGAX3NCC0LR+mDHTX+nMPqFSRwMQrsxhI9NOSEfzH8E1W5vGAKFcyQAk3Rla1WuA==
+
 rechoir@^0.6.2:
   version "0.6.2"
   resolved "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz"
@@ -8508,6 +8518,13 @@ [email protected], unist-builder@^2.0.0:
   version "2.0.3"
   resolved "https://registry.npmjs.org/unist-builder/-/unist-builder-2.0.3.tgz"
 
+unist-builder@^4.0.0:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/unist-builder/-/unist-builder-4.0.0.tgz#817b326c015a6f9f5e92bb55b8e8bc5e578fe243"
+  integrity sha512-wmRFnH+BLpZnTKpc5L7O67Kac89s9HMrtELpnNaE6TAobq5DTZZs5YaTQfAZBA9bFPECx2uVAPO31c+GVug8mg==
+  dependencies:
+    "@types/unist" "^3.0.0"
+
 unist-util-find-after@^3.0.0:
   version "3.0.0"
   resolved "https://registry.npmjs.org/unist-util-find-after/-/unist-util-find-after-3.0.0.tgz"