Skip to content

Commit

Permalink
fix: fix links format
Browse files Browse the repository at this point in the history
  • Loading branch information
AnjaMis committed Aug 7, 2024
1 parent 6be8b23 commit 7e535a6
Show file tree
Hide file tree
Showing 13 changed files with 26 additions and 26 deletions.
14 changes: 7 additions & 7 deletions docs/faq/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand All @@ -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?

Expand Down Expand Up @@ -72,7 +72,7 @@ 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)

Expand Down Expand Up @@ -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?

Expand All @@ -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.

Expand Down Expand Up @@ -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?

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/introduction/ai-factory.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,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)

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/introduction/protocol-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/getting-started/introduction/rules) section, we describe how the protocol allows you to **define and enforce any customized rules**.
In [Workflows](https://docs.okp4.network/getting-started/introduction/workflows) section, we describe how the protocol **orchestrates the resources according to the rules**.
In [Rules](./getting-started/introduction/rules) section, we describe how the protocol allows you to **define and enforce any customized rules**.
In [Workflows](./getting-started/introduction/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>.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/introduction/rules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ 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](https://docs.okp4.network/tutorials/keplr-1) first to get familiar with Keplr and CLI before getting started with Axone.
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.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/quickstart-guides/describe-resource.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,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:

Expand Down Expand Up @@ -112,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) 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).
Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started/quickstart-guides/describe-zone.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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:

Expand Down Expand Up @@ -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) 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).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 4
# Create the resource's governance

:::info
We recommend you first read the [Technical documentation of Governance](https://docs.okp4.network/technical-documentation/governance/introduction) before delving into practice in the Academy.
We recommend you first read the [Technical documentation of Governance](./technical-documentation/governance/introduction) before delving into practice in the Academy.
:::

Resource Consent is an agreement associated with the use of Resources within Zones. By resources, we mean Digital Resources (e.g., datasets) or Digital Services. It goes beyond simple approval and encompasses the permissions and restrictions on resource owners' access, usage, sharing, management, and handling of their resources. It allows parties to define boundaries and establish terms for others to interact with their digital resources. This is crucial for governance, ensuring resources are used appropriately per the relevant parties' expressed will and intentions.
Expand Down Expand Up @@ -47,7 +47,7 @@ We'll take 2 simple 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:

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/quickstart-guides/zone-governance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 6
# Create the zone's governance

:::info
We recommend you first read the [Technical documentation of Governance](https://docs.okp4.network/technical-documentation/governance/introduction) before delving into practice in the Academy.
We recommend you first read the [Technical documentation of Governance](./technical-documentation/governance/introduction) before delving into practice in the Academy.
:::

Zone Rules establish the boundaries of a specific area in the Dataverse, termed a Zone, within which governance is enforced. Each Zone is governed by its unique set of Rules tailored to its particular function or purpose.
Expand Down Expand Up @@ -44,7 +44,7 @@ We'll take one simple example in this tutorial for the Collaborative AI zone.
:::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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The digital signature and metadata ensure enhanced security by preventing forger

## Verifiable claims in the Axone protocol

The [Axone ontology](https://docs.okp4.network/getting-started/introduction/resources#ontology-how-its-represented-semantic-description) is used to describe the Dataverse. In the Dataverse, resources are identified by their DID. Resources are described by claims referenced in the ontology as Verifiable Presentations (VPs) whose subject is the resource's DID. In this way, each resource is described by a set of associated claims.
The [Axone ontology](./getting-started/introduction/resources#ontology-how-its-represented-semantic-description) is used to describe the Dataverse. In the Dataverse, resources are identified by their DID. Resources are described by claims referenced in the ontology as Verifiable Presentations (VPs) whose subject is the resource's DID. In this way, each resource is described by a set of associated claims.

It's important to note that the existence of a resource is conditional on the presence of at least one relevant claim. In other words, although the universe of potential resources is infinite, a resource only becomes concrete and tangible when a corresponding claim is established.

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/explorer-sc.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Before moving on to transactions with smart contracts, let's begin with a basic

:::info

You need to [set up a wallet with Keplr and own some $AXONE tokens](https://docs.okp4.network/tutorials/keplr-1).
You need to [set up a wallet with Keplr and own some $AXONE tokens](./tutorials/keplr-1).

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/prolog-1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ This example demonstrates how a Prolog code can define and enforce conditions fo

To continue, you should:

1. [Install the Axone daemon CLI and `jq`](https://docs.okp4.network/tutorials/cli-1)
1. [Install the Axone daemon CLI and `jq`](./tutorials/cli-1)
2. Create a wallet or import one from your seed:

```bash
Expand Down
4 changes: 2 additions & 2 deletions docs/whitepaper/solution.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ To tackle this, Axone aims at providing a **reliable and secure mechanism** to e
2. The Zone asks the dedicated smart contract if it's possible given the context and all the involved rules
3. The protocol employs logical inference to resolve matters based on the state of the blockchain
4. The protocol yields a modality as a response, such as "prohibited", "permitted", "possible", and so on.
Depending on the answer, the execution process could start.
Depending on the answer, the execution process could start.

### Orchestrate the resources according to the rules

Expand All @@ -199,4 +199,4 @@ Once a workflow is completed, the information gained needs to be put to use. App

For example, let's say a professional in healthcare uses the Axone protocol to combine various resources in a workflow. The output might be a comprehensive patient health report. This information can then be used by a healthcare application to provide more personalized care recommendations to patients.

For more detailed information on the roles and various use-cases, refer to the [Roles](https://docs.okp4.network/whitepaper/roles) and [Use Cases](https://docs.okp4.network/whitepaper/use-cases) pages respectively.
For more detailed information on the roles and various use-cases, refer to the [Roles](./whitepaper/roles) and [Use Cases](./whitepaper/use-cases) pages respectively.

0 comments on commit 7e535a6

Please sign in to comment.