Merge pull request #542 from axone-protocol/feat/add-getting-started

feat: add getting started

docs/connector/_category_.json

@@ -1,4 +1,4 @@
 {
   "label": "Connectors",
-  "position": 5
+  "position": 6
 }

docs/connector/overview.mdx

@@ -4,7 +4,4 @@ sidebar_position: 1
 
 # Connectors
 
-Introduction
-S3
-Jackal
-Create your own
+Work in Progress ⚙️

docs/create-ecosystem/_category_.json

@@ -1,4 +1,4 @@
 {
   "label": "Create an Ecosystem",
-  "position": 2
+  "position": 3
 }

docs/create-ecosystem/overview.mdx

@@ -4,4 +4,4 @@ sidebar_position: 1
 
 # Create an Ecosystem
 
-Helloworld
+Work in Progress ⚙️

docs/faq/faq.md

@@ -28,7 +28,7 @@ A Zone is a conceptual framework defined by a set of rules, within which the rec
 
 The primary objective of Zones is to facilitate the coordination of heterogeneous systems and resources. Zones aim to integrate all systems, both on-chain and off-chain.
 
-More information [here](https://docs.okp4.network/whitepaper/solution#protocol-overview)
+More information [here](./whitepaper/solution#protocol-overview)
 
 ## What types of resources can be shared?
 
@@ -41,7 +41,7 @@ For clarity, we categorize resources and services into different types:
 - Processing Services: Axone can manage various digital processing services, including algorithms and AI models.
 - Infrastructure Services: Additionally, Axone can handle any infrastructure services such as storage and computation or ID.
 
-For more in-depth information, you can refer to our dedicated documentation [here](https://docs.okp4.network/whitepaper/solution#the-dataverse).
+For more in-depth information, you can refer to our dedicated documentation [here](./whitepaper/solution#the-dataverse).
 
 ## Why do you distinguish Zones and digital resources?
 
@@ -72,9 +72,9 @@ An ontology, in the context of Axone, refers to a structured representation of k
 
 In Axone, this ontology is used to describe the metadata or characteristics of resources and services. Think of it as the "data about the data." This structured information makes it easier for users and systems to understand and interact with resources and services within the Axone network. It ensures that everyone speaks the same language when it comes to sharing and accessing digital resources.
 
-Dedicated documentation [here](https://docs.okp4.network/whitepaper/solution#ontology)
+Dedicated documentation [here](./whitepaper/solution#ontology)
 
-And deep-dive article [here](https://blog.okp4.network/okp4-knowledge-sharing-through-ontology-driven-dataverse-a-new-approach-to-knowledge-description-f9b81d4484c8)
+And deep-dive article [here](https://blog.axone.xyz/okp4-knowledge-sharing-through-ontology-driven-dataverse-a-new-approach-to-knowledge-description-f9b81d4484c8)
 
 ## What is the web2 alternative today?
 
@@ -212,7 +212,7 @@ Beyond that, and more related to use cases, the $AXONE is used by default for va
 
 The $AXONE token may also be used for security purposes, requiring data or service providers to lock some tokens in order to prove their good faith. The tokens may be used for curation on Datasets and Services, allowing users to lock tokens on specific resources to get a part of their revenue, when relevant.
 
-More details about Token Model [here](https://docs.okp4.network/whitepaper/token-model)
+More details about Token Model [here](./whitepaper/token-model)
 
 ## Can price volatility of the $AXONE token be a problem?
 
@@ -239,8 +239,8 @@ Axone is a sandbox for human coordination experiments in the off-chain world. Yo
 
 First, let me remind that the data is off-chain, only the data's metadata (its description) is on-chain and integrated in the ontology.
 
-When a consumer interacts with the Axone blockchain, they might request access to multiple datasets and algorithms. The protocol checks if the conditions set by the data or algorithm providers are satisfied. If they are, the transaction is validated on-chain (the [Pactum smart contract](https://docs.okp4.network/whitepaper/architecture#pactum-managing-agreements) ensures conditions are met, including retributions for providers), with the workflow being described like any service in the ontology (leveraging the [Cognitarium smart contract](https://docs.okp4.network/whitepaper/architecture#cognitarium-semantic-data-storage)).
-Subsequent to this validation, an [off-chain orchestration service](https://docs.okp4.network/whitepaper/architecture#orchestration), exemplified by workflow engines like [Argo](https://argoproj.github.io/argo-workflows/), takes over. This service acts as a gatekeeper for resources, relying exclusively on blockchain validation events to process the consumer's request. It's important to note that this orchestration service doesn't inherently trust any party; it solely trusts the blockchain's validation.
+When a consumer interacts with the Axone blockchain, they might request access to multiple datasets and algorithms. The protocol checks if the conditions set by the data or algorithm providers are satisfied. If they are, the transaction is validated on-chain (the [Pactum smart contract](./whitepaper/architecture#pactum-managing-agreements) ensures conditions are met, including retributions for providers), with the workflow being described like any service in the ontology (leveraging the [Cognitarium smart contract](./whitepaper/architecture#cognitarium-semantic-data-storage)).
+Subsequent to this validation, an [off-chain orchestration service](./whitepaper/architecture#orchestration), exemplified by workflow engines like [Argo](https://argoproj.github.io/argo-workflows/), takes over. This service acts as a gatekeeper for resources, relying exclusively on blockchain validation events to process the consumer's request. It's important to note that this orchestration service doesn't inherently trust any party; it solely trusts the blockchain's validation.
 
 The orchestration service's role is to create new insights or knowledge by utilizing resources from different providers. Once the processing is complete, the service reports back to the blockchain, ensuring that the execution status is logged reliably and that any due payments are processed.
 
@@ -272,7 +272,7 @@ Axone functions as a decentralized coordinator where:
 
 The protocol itself is primarily an infrastructure that allows a resource "provider" to reference and define usage rules (in Prolog, which offers better expressiveness compared to other languages), and for a "consumer" to make usage requests based on these rules. What the protocol guarantees is the transparency of the rules and the correct assessment (validation or not) of these rules. However, there is indeed the question of verifying the actual "real" sharing action. The current approach is an open-source off chain "orchestrator" developed by the Axone Association team that provides access to resources (based on requests validated onchain) and then reports the successful execution back on chain. So, yes, there's an element of centralization! We aim to have multiple orchestrators, deployed by external entities, and even decentralize that process at some point. Both "providers" and "consumers" will be able to choose the one they "trust" or deploy their own.
 
-More info [here](https://docs.okp4.network/whitepaper/architecture#trusted-parties-considerations)
+More info [here](./whitepaper/architecture#trusted-parties-considerations)
 
 ## How Axone ensures law enforcement BEFORE EXECUTION?
 

docs/getting-started/_category_.json

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

docs/getting-started/introduction/_category_.json

@@ -0,0 +1,5 @@
+{
+  "position": 2,
+  "label": "Intro to Axone",
+  "collapsible": true
+}

docs/introduction/ai-factory.mdx → docs/getting-started/introduction/ai-factory.mdx

@@ -2,9 +2,6 @@
 sidebar_position: 9
 ---
 
-import Quiz from 'react-quiz-component'
-import * as quiz from './ai-factory-quiz.json'
-
 # AI Factory: A Use Case Unveiling
 
 The rapid development of AI models redefines the boundaries of what is possible in many fields. The ability to use existing open-source models or create one's own AI models to meet specific needs is becoming accessible to everyone.
@@ -104,7 +101,7 @@ All Dataverse resources adhering to these rules are compatible with the Zone.
 
 :::caution
 
-Understanding the unique relationship between the consent of resources and the zone rules is essential. The licenses and zone rules must be compatible, as the powers of a zone recognizing a resource as being included and thus compatible with its operation require reciprocal confirmation of compliance from the helpful resource. Read the technical documentation about [Governance and the hierarchy of norms](https://docs.okp4.network/technical-documentation/governance/hierarchy-of-norms)
+Understanding the unique relationship between the consent of resources and the zone rules is essential. The licenses and zone rules must be compatible, as the powers of a zone recognizing a resource as being included and thus compatible with its operation require reciprocal confirmation of compliance from the helpful resource. Read the technical documentation about [Governance and the hierarchy of norms](../../technical-documentation/governance/hierarchy-of-norms)
 
 :::
 
@@ -213,5 +210,3 @@ It focuses on enhancing the transparency of AI models by providing explanations
 ### Dimensionality Reduction Tools Zone
 
 This Zone can facilitate the management of complex datasets by reducing their dimensionality. Contributors collaborate to apply reduction techniques while preserving essential information.
-
-<Quiz quiz={quiz} />

docs/introduction/protocol-concepts.md → docs/getting-started/introduction/protocol-concepts.md

@@ -45,8 +45,8 @@ As a decentralized orchestration layer for off-chain resources, Axone must ensur
 - Interpret the rules to ensure the law enforcement
 - Execute workflow and orchestrate the resources according to the rules
 
-In [Rules](https://docs.okp4.network/introduction/rules) section, we describe how the protocol allows you to **define and enforce any customized rules**.
-In [Workflows](https://docs.okp4.network/introduction/workflows) section, we describe how the protocol **orchestrates the resources according to the rules**.
+In [Rules](./rules) section, we describe how the protocol allows you to **define and enforce any customized rules**.
+In [Workflows](./workflows) section, we describe how the protocol **orchestrates the resources according to the rules**.
 
 Here, we'll concentrate on how Axone enables its functionalities <u>**in the decentralized way**</u>.
 

docs/introduction/rules.mdx → docs/getting-started/introduction/rules.mdx

@@ -6,7 +6,7 @@ sidebar_position: 2
 
 ## Rules: what can be defined?
 
-The Axone protocol's core feature is defining rules for sharing and managing off-chain digital resources like datasets and algorithms. These rules define the parameters and conditions under which resource sharing and interactions occur. A [Zone](https://docs.okp4.network/whitepaper/solution#zone-overview), a conceptual framework defined by a set of rules, ensures resource compatibility through dynamic evaluation of rules and consents. Resources aren't attached to zones but are recognized based on their conformity to these rules and consents. Understanding these definitions is key to utilizing the protocol effectively.
+The Axone protocol's core feature is defining rules for sharing and managing off-chain digital resources like datasets and algorithms. These rules define the parameters and conditions under which resource sharing and interactions occur. A [Zone](../../whitepaper/solution#zone-overview), a conceptual framework defined by a set of rules, ensures resource compatibility through dynamic evaluation of rules and consents. Resources aren't attached to zones but are recognized based on their conformity to these rules and consents. Understanding these definitions is key to utilizing the protocol effectively.
 
 So how does Axone ensure law enforcement before execution?
 

docs/introduction/who-is-it-for.mdx → docs/getting-started/introduction/who-is-it-for.mdx

@@ -2,9 +2,6 @@
 sidebar_position: 8
 ---
 
-import Quiz from 'react-quiz-component'
-import * as quiz from './who-is-it-for-quiz.json'
-
 # Who is it for?
 
 Axone is often described as a protocol that enables sharing Anything as a Service under any Conditions. To illustrate the infinite possibilities opened up by the protocol, this section provides further examples of the intended audience for the protocol.
@@ -173,5 +170,3 @@ In exploring the various actors within the protocol, we observe that most are bo
 The nuanced nature of Axone blurs the traditional boundaries between these roles. Entities seamlessly transition between these roles based on their context and specific objectives. As a protocol, Axone directly addresses builders and exploiters of digital resources, fostering a collaborative environment where each participant, specialized and competent in their domain, adds value to creating new knowledge.
 
 It is not uncommon to witness entities functioning as providers in specific scenarios while assuming the role of consumers in others. This fluidity underscores the adaptability and versatility inherent in Axone. As we navigate this decentralized digital landscape, Axone emerges as a facilitator, providing a framework for a myriad of actors to engage, collaborate, and collectively contribute to generating innovative knowledge.
-
-<Quiz quiz={quiz} />

docs/getting-started/overview.mdx

@@ -0,0 +1,40 @@
+---
+sidebar_position: 1
+---
+
+# Overview
+
+Explore the power of Axone by interacting with the protocol!
+
+:::info
+
+If you have never interacted with a Cosmos SDK world, you might want to check out these [guides](../tutorials/keplr-1) first to get familiar with Keplr and CLI before getting started with Axone.
+
+:::
+
+<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="/getting-started/introduction/resources"
+          class="card-title card-link stretched-link"
+        >
+          <h2>Intro to Axone</h2>
+        </a>
+        <p class="card-text">Find out more about Axone and its power, features and principles.</p>
+      </div>
+    </div>
+    <div class="col">
+      <div class="card card-body h-100 d-flex flex-column">
+        <a
+          href="/getting-started/quickstart-guides/describe-resource"
+          class="card-title card-link stretched-link"
+        >
+          <h2>Quick start</h2>
+        </a>
+        <p class="card-text">Start interacting with the Axone protocol!</p>
+      </div>
+    </div>
+  </div>
+</div>

docs/getting-started/quickstart-guides/_category_.json

@@ -0,0 +1,5 @@
+{
+  "position": 3,
+  "label": "Quickstart Guide",
+  "collapsible": true
+}

docs/technical-documentation/technical-implementation/describe-resource.mdx → docs/getting-started/quickstart-guides/describe-resource.mdx

@@ -4,9 +4,7 @@ sidebar_position: 3
 
 # Describe a resource
 
-Now that you know what a DID and a Verifiable Credential are, and what they mean for the Axone protocol, let's put them into practice!
-
-You're a digital resource provider and you want to share a dataset or a service. First, you need to describe your resource and register it in the Dataverse (i.e. in the Axone protocol).
+Welcome to the Axone Quickstart Guide. In this guide, you'll learn how to interact with the Axone Protocol and harness its powerful features to manage and share AI resources effectively. We'll start by describing a resource—a fundamental step that allows you to define and register any digital asset within the Axone ecosystem. This process sets the foundation for resource governance, collaboration, and seamless integration into AI workflows. Let's begin by understanding how to describe a resource accurately to unlock the full potential of Axone Protocol.
 
 Here are the 4 steps involved:
 
@@ -26,7 +24,7 @@ We'll take 2 examples in this tutorial:
 :::info
 Prerequisite:
 
-- [Install the Axone CLI](https://docs.okp4.network/tutorials/cli-1#installing-the-okp4-cli) to interact with the protocol
+- [Install the Axone CLI](../../tutorials/cli-1#installing-the-okp4-cli) to interact with the protocol
 - Ensure you have `npm` installed on your system. You can follow the installation guide [here](https://www.npmjs.com/get-npm).
 - Install the [json-cli](https://github.com/digitalbazaar/jsonld-cli) with the following command:
 
@@ -114,7 +112,7 @@ In the future, you will be able to use any key provider, such as Cheqd.
 
 ## Step 2: Create the credentials
 
-Find the credential templates you need in the [Ontology documentation](https://docs.okp4.network/ontology/schemas) according to the nature of the resource you describe.
+Find the credential templates you need in the [Ontology documentation](../../ontology/schemas/credential-dataset-description) according to the nature of the resource you describe.
 
 For the dataset, instantiate the template [credential-dataset-description](https://github.com/okp4/ontology/blob/main/src/example/dataset/crime-dataset-description.jsonld).  
 For the service, instantiate the template [credential-digital-service-description](https://github.com/okp4/ontology/blob/main/src/example/digital-service/ipfs-digital-service-description.jsonld).

docs/technical-documentation/technical-implementation/describe-zone.mdx → docs/getting-started/quickstart-guides/describe-zone.mdx

@@ -4,7 +4,7 @@ sidebar_position: 5
 
 # Describe a Zone
 
-A [zone](https://docs.okp4.network/whitepaper/solution#zone-overview) is a conceptual framework defined by a set of rules, within which the recognized digital resources are compatible with these rules, taking into account the associated consents. A resource is not attached to a zone. The recognition of resources within a Zone relies on the dynamic evaluation of the conformity of the rules and consents of the resources.
+A [zone](../../whitepaper/solution#zone-overview) is a conceptual framework defined by a set of rules, within which the recognized digital resources are compatible with these rules, taking into account the associated consents. A resource is not attached to a zone. The recognition of resources within a Zone relies on the dynamic evaluation of the conformity of the rules and consents of the resources.
 
 All the workflows initiated within the Axone protocol must be defined in the context of a specific Zone. When the workflow is submitted, the protocol will check if all rules of the zone and of the engaged resources are respected and will apply the business model of the zone.
 
@@ -23,7 +23,7 @@ We'll take the example of the Collaborative AI Zone in this tutorial.
 :::info
 Prerequisite:
 
-- [Install the Axone CLI](https://docs.okp4.network/tutorials/cli-1#installing-the-okp4-cli) to interact with the protocol
+- [Install the Axone CLI](../../tutorials/cli-1#installing-the-okp4-cli) to interact with the protocol
 - Ensure you have `npm` installed on your system. You can follow the installation guide [here](https://www.npmjs.com/get-npm).
 - Install the [json-cli](https://github.com/digitalbazaar/jsonld-cli) with the following command:
 
@@ -108,7 +108,7 @@ In the future, you will be able to use any key provider, such as Cheqd.
 
 ## Step 2: Create the credentials
 
-Find the credential templates you need in the [Ontology documentation](https://docs.okp4.network/ontology/schemas) according to the nature of the resource you describe.
+Find the credential templates you need in the [Ontology documentation](../../ontology/schemas/credential-dataset-description) according to the nature of the resource you describe.
 
 For the zone, instantiate the template [credential-zone-description](https://github.com/okp4/ontology/blob/main/src/example/zone/collab-ai-zone-description.jsonld).