From 2bf40dd39ec3745f0eddc7feab2d8ee878430947 Mon Sep 17 00:00:00 2001 From: ccamel Date: Wed, 27 Sep 2023 08:22:42 +0200 Subject: [PATCH] feat(technical): introduce overview page --- docs/index.mdx | 2 +- .../ontology/what-are-ontologies.md | 2 +- docs/technical-documentation/overview.mdx | 93 +++++++++++++++++++ docusaurus.config.js | 2 +- sidebars.js | 4 + 5 files changed, 100 insertions(+), 3 deletions(-) create mode 100644 docs/technical-documentation/overview.mdx diff --git a/docs/index.mdx b/docs/index.mdx index 9edcde4c095..942882e82ae 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -29,7 +29,7 @@ Welcome! OKP4 is a public PoS layer 1 blockchain built for trust-minimized data
- +

Technical Documentation

Deep dive into the OKP4 Protocol.

diff --git a/docs/technical-documentation/ontology/what-are-ontologies.md b/docs/technical-documentation/ontology/what-are-ontologies.md index c281ab81352..8d4d44d77ec 100644 --- a/docs/technical-documentation/ontology/what-are-ontologies.md +++ b/docs/technical-documentation/ontology/what-are-ontologies.md @@ -121,4 +121,4 @@ The construction of this ontology follows a number of steps which are described - It's crucial to recognize the distinction between OWL modeling and [UML](https://en.wikipedia.org/wiki/Unified_Modeling_Language) modeling. The latter, often rooted in Object-Oriented interpretations, varies from OWL's approach. For deeper insights, the following resources are recommended: - [Comparing UML and OWL in Depth](https://madoc.bib.uni-mannheim.de/1898/1/TR2008_004.pdf) - [Dispelling a Common Myth about OWL Properties](https://henrietteharmse.com/2018/06/22/a-common-misconception-regarding-owl-properties/) -- Given that OWL operates as a logical description language, certain inferences can be drawn using an OWL reasoner. Nevertheless, wherever feasible, it's preferable to clarify aspects that could otherwise be left for an OWL reasoner to deduce. \ No newline at end of file +- Given that OWL operates as a logical description language, certain inferences can be drawn using an OWL reasoner. Nevertheless, wherever feasible, it's preferable to clarify aspects that could otherwise be left for an OWL reasoner to deduce. diff --git a/docs/technical-documentation/overview.mdx b/docs/technical-documentation/overview.mdx new file mode 100644 index 00000000000..7c3689ca99f --- /dev/null +++ b/docs/technical-documentation/overview.mdx @@ -0,0 +1,93 @@ +--- +sidebar_position: 1 +--- + +# Overview + +## Fundamentals of OKP4 + +Delve into the core technical concepts behind the OKP4 Protocol. + +
+
+
+
+ +

Ontology

+
+

Explore the semantic data model driving the protocol.

+
+
+
+
+ +## Delving into the Protocol + +### The Smart Contracts + +Deepen your understanding of the OKP4 Protocol's Smart Contracts. + +
+
+
+
+ +

Objectarium

+
+

Introducing the immutable on-chain Object Storage.

+
+
+
+
+ +

Cognitarium

+
+

Introducing the on-chain Semantic Storage layer.

+
+
+
+
+ +

Law Stone

+
+

Introducing the Governance Interpreter.

+
+
+
+
+ +### OKP4's Cosmos Modules + +Unearth the features and functions of OKP4 Protocol's Cosmos Modules. + +
+
+
+
+ +

Mint

+
+

Unveil the mechanism of minting.

+
+
+
+
+ +

Vesting

+
+

Understand the specifics of vesting in the protocol.

+
+
+
+
+ +

Logic

+
+

Discover the heart of Logical interpretation in the protocol.

+
+
+
+
diff --git a/docusaurus.config.js b/docusaurus.config.js index 98d88eb5987..77bf2514902 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -87,7 +87,7 @@ async function createconfig() { activeBasePath: '/nodes' }, { - to: '/technical-documentation/ontology/the-power-of-ontologies', + to: '/technical-documentation/overview', position: 'left', label: 'Technical documentation', activeBasePath: '/technical-documentation' diff --git a/sidebars.js b/sidebars.js index f14513d4cf1..f138d48be41 100644 --- a/sidebars.js +++ b/sidebars.js @@ -33,6 +33,10 @@ const sidebars = { type: 'category', label: 'Technical documentation', items: [ + { + type: 'doc', + id: 'technical-documentation/overview', + }, { type: 'category', label: 'Ontology',