diff --git a/SUMMARY.md b/SUMMARY.md index b8ac39a9..f3471f58 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -28,13 +28,6 @@ - [Github](user-guides/asset-hosting/github.md) - [Join a Data Challenge](user-guides/join-a-data-challenge.md) - [Sponsor a Data Challenge](user-guides/sponsor-a-data-challenge.md) - - [Data Farming](rewards/user-guides/README.md) - - [Earn Passive Rewards](rewards/user-guides/how-to-veocean.md) - - [Estimate APYs](rewards/user-guides/how-to-estimate-apy.md) - - [Claim Rewards](rewards/user-guides/how-to-claim-rewards.md) - - [Curate with Volume DF](rewards/user-guides/how-to-volumedf.md) - - [Delegate Curation](rewards/user-guides/how-to-delegate.md) - - [Predict with Challenge DF](rewards/user-guides/how-to-challengedf.md) - [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md) - [💻 Developers](developers/README.md) - [Architecture Overview](developers/architecture.md) @@ -136,6 +129,13 @@ * [Complete User Guides](rewards/df-guides.md) * [Emissions & APYs](rewards/df-emissions-apys.md) * [veOCEAN & DF FAQ](rewards/df-faq.md) + - [User Guides](rewards/user-guides/README.md) + - [Earn Passive Rewards](rewards/user-guides/how-to-veocean.md) + - [Estimate APYs](rewards/user-guides/how-to-estimate-apy.md) + - [Claim Rewards](rewards/user-guides/how-to-claim-rewards.md) + - [Curate with Volume DF](rewards/user-guides/how-to-volumedf.md) + - [Delegate Curation](rewards/user-guides/how-to-delegate.md) + - [Predict with Challenge DF](rewards/user-guides/how-to-challengedf.md) * [🤝 Contribute](contribute/README.md) * [Partners & Collaborators](contribute/projects-using-ocean.md) * [Contributor Code of Conduct](contribute/code-of-conduct.md) diff --git a/developers/ocean.js/asset-visibility.md b/developers/ocean.js/asset-visibility.md index 9ab0a1bd..276c0810 100644 --- a/developers/ocean.js/asset-visibility.md +++ b/developers/ocean.js/asset-visibility.md @@ -4,7 +4,7 @@ In the Ocean Protocol ecosystem, each asset is associated with a state that is m By assigning specific states to assets, Ocean Protocol enables a structured approach to asset management and visibility. These states help regulate asset discoverability, ordering permissions, and the representation of assets in user profiles, ensuring a controlled and reliable asset ecosystem. -It is possible to remove assets from Ocean Protocol by modifying the state of the asset. Each asset has a state, which is stored in the NFT contract. Additional details regarding asset states can be found at this [link](../ddo-specification.md#state). There is also an assets purgatory that contains information about the purgatory status of an asset, as defined in the list-purgatory. For more information about the purgatory, please refer to: [https://docs.oceanprotocol.com/core-concepts/did-ddo#purgatory](https://docs.oceanprotocol.com/core-concepts/did-ddo#purgatory). +It is possible to remove assets from Ocean Protocol by modifying the state of the asset. Each asset has a state, which is stored in the NFT contract. Additional details regarding asset states can be found at this [link](../ddo-specification.md#state). There is also an assets purgatory that contains information about the purgatory status of an asset, as defined in the list-purgatory. For more information about the purgatory, please refer to the [DID and DDO Identifier docs](/developers/identifiers.md). We can utilize a portion of the previous tutorial on updating metadata and incorporate the steps to update the asset's state in the asset DDO. diff --git a/developers/ocean.js/creating-datanft.md b/developers/ocean.js/creating-datanft.md index f2675963..f8a9ec9d 100644 --- a/developers/ocean.js/creating-datanft.md +++ b/developers/ocean.js/creating-datanft.md @@ -75,4 +75,4 @@ node create_dataNFT.js * Checkout our [code examples](https://github.com/oceanprotocol/ocean.js/blob/main/CodeExamples.md#L0-L1) or [compute to data examples](https://github.com/oceanprotocol/ocean.js/blob/main/ComputeExamples.md#L417) to see how you can use ocean.js. * If you have any difficulties or if you have further questions about how to use ocean.js please reach out to us on [Discord](https://discord.gg/TnXjkR5). * If you notice any bugs or issues with ocean.js please [open an issue on github](https://github.com/oceanprotocol/ocean.js/issues/new?assignees=\&labels=bug\&template=bug\_report.md\&title=). -* Visit the [Ocean Protocol website](https://docs.oceanprotocol.com/) for general information about Ocean Protocol. +* Visit the [Ocean Protocol website](https://oceanprotocol.com/) for general information about Ocean Protocol. diff --git a/developers/ocean.py/compute-flow.md b/developers/ocean.py/compute-flow.md index ed2ec2cd..66d164a3 100644 --- a/developers/ocean.py/compute-flow.md +++ b/developers/ocean.py/compute-flow.md @@ -42,7 +42,7 @@ print(f"DATA_ddo did = '{DATA_ddo.did}'") ``` {% endcode %} -To customise the privacy and accessibility of your compute service, add the `compute_values` argument to `create_url_asset` to set values according to the [DDO specs](https://docs.oceanprotocol.com/core-concepts/did-ddo). The function assumes the documented defaults. +To customise the privacy and accessibility of your compute service, add the `compute_values` argument to `create_url_asset` to set values according to the [DDO specs](/developers/identifiers.md). The function assumes the documented defaults. ### 2. Alice publishes an algorithm diff --git a/developers/ocean.py/remote-setup.md b/developers/ocean.py/remote-setup.md index fd740f4a..5d88fa62 100644 --- a/developers/ocean.py/remote-setup.md +++ b/developers/ocean.py/remote-setup.md @@ -66,7 +66,7 @@ Ocean.py follows the exact `id` name for the network's name from the default Bro #### 1.4 Networks Supported -All [Ocean-deployed](https://docs.oceanprotocol.com/core-concepts/networks) chains (Eth mainnet, Polygon, etc) should be in Brownie's default `network-config.yaml` except Energy Web Chain (EWC). +All [Ocean-deployed](../../discover/networks/README.md) chains (Eth mainnet, Polygon, etc) should be in Brownie's default `network-config.yaml` except Energy Web Chain (EWC). For Windows users: it's possible that your `network-config.yaml` doesn't have all the network entries. In this case, just replace your local file's content with the `network-config.yaml` in Brownie's GitHub repo, [here](https://github.com/eth-brownie/brownie/blob/master/brownie/data/network-config.yaml). diff --git a/discover/faq.md b/discover/faq.md index 23f83042..0f344bb7 100644 --- a/discover/faq.md +++ b/discover/faq.md @@ -624,7 +624,7 @@ The Ethereum network has the highest liquidity for $OCEAN. As Google Drive is not supported in the Ocean ecosystem, what are the alternative options for storing a file and then publishing it? -Google Drive is an awesome product, but is designed for file sharing between a small group of users and is not properly working with our architecture. ⁣There are a bunch of other systems you can use that work smoothly with our stack. [Here](https://docs.oceanprotocol.com/developers/storage) are some alternatives. +Google Drive is an awesome product, but is designed for file sharing between a small group of users and is not properly working with our architecture. ⁣There are a bunch of other systems you can use that work smoothly with our stack. [Here](../developers/storage) are some alternatives. @@ -633,7 +633,7 @@ Google Drive is an awesome product, but is designed for file sharing between a s Do you have a tutorial for using Arweave as storing solution for assets? -You bet we have. [Here](https://docs.oceanprotocol.com/user-guides/asset-hosting/arweave) it is 😎 +You bet we have. [Here](../user-guides/asset-hosting/arweave) it is 😎 @@ -787,7 +787,7 @@ Yes, from the get-go! It doesn’t matter how data is priced, this works for all How are datatokens created, and how does the creator make money? -[Datatokens](https://docs.oceanprotocol.com/developers/contracts/datatokens) represent access rights to a specific dataset on the Ocean Protocol. Creators of datasets tokenize their data, creating these datatokens. Each datatoken is unique to a dataset. +[Datatokens](../developers/contracts/datatokens) represent access rights to a specific dataset on the Ocean Protocol. Creators of datasets tokenize their data, creating these datatokens. Each datatoken is unique to a dataset. @@ -795,7 +795,7 @@ Yes, from the get-go! It doesn’t matter how data is priced, this works for all Where can I find information about the number of datatokens created and track their progress? -To access this data, some technical expertise is required. You can find this information at the subgraph level. In our documentation, we provide a few examples of how to retrieve this data using JavaScript. Feel free to give it a shot by visiting this [page](https://docs.oceanprotocol.com/developers/subgraph/list-datatokens). If it doesn't meet your requirements, don't hesitate to reach out to us on Discord. +To access this data, some technical expertise is required. You can find this information at the subgraph level. In our documentation, we provide a few examples of how to retrieve this data using JavaScript. Feel free to give it a shot by visiting this [page](../developers/subgraph/list-datatokens). If it doesn't meet your requirements, don't hesitate to reach out to us on Discord. @@ -833,7 +833,7 @@ Production: How can I convert tokens from the BEP20 network to the ERC20 network? -We have a [tutorial](https://docs.oceanprotocol.com/discover/networks/bridges#binance-smart-chain-bsc-bridge) specific for this. Please double-check the addresses and make sure you are using the right smart contracts. ⁣ +We have a [tutorial](../discover/networks/bridges#binance-smart-chain-bsc-bridge) specific for this. Please double-check the addresses and make sure you are using the right smart contracts. ⁣ @@ -844,7 +844,7 @@ We have a [tutorial](https://docs.oceanprotocol.com/discover/networks/bridges#bi The OCEAN token address on the polygon network is [0x282d8efCe846A88B159800bd4130ad77443Fa1A1](https://polygonscan.com/address/0x282d8efCe846A88B159800bd4130ad77443Fa1A1). -Yes, the tokens can be bridged. Please follow this [tutorial](https://docs.oceanprotocol.com/discover/networks/bridges#polygon-ex-matic-bridge) to bridge to/from polygon. +Yes, the tokens can be bridged. Please follow this [tutorial](../discover/networks/bridges#polygon-ex-matic-bridge) to bridge to/from polygon. @@ -853,7 +853,7 @@ Yes, the tokens can be bridged. Please follow this [tutorial](https://docs.ocean Is there any reading material available on how privacy works in compute-to-data through the use of containers/kube? -I believe you'll find this [resource](https://docs.oceanprotocol.com/developers/compute-to-data/compute-to-data-architecture) highly beneficial. +I believe you'll find this [resource](../developers/compute-to-data/compute-to-data-architecture) highly beneficial. @@ -886,7 +886,7 @@ Ocean offers faucets for every test network where the smart contracts are deploy Each individual could publish their dataset themselves, to get a data NFT. From the data NFT, they can mint datatokens which are to access the data. They have sovereign control over this, as hold the keys to the data NFTs and datatokens, and have great flexibility in how to give others access. For example, they could send a datatoken to a DAO for the DAO can manage. Or they could grant datatoken-minting permissions to the DAO. The DAO could use this to assemble a dataset across 100 individuals. ⁣ ⁣ -Learn more about Data NFTs on the [Docs](https://docs.oceanprotocol.com/developers/contracts/data-nfts). +Learn more about Data NFTs on the [Docs](../developers/contracts/data-nfts). diff --git a/rewards/README.md b/rewards/README.md index 8dec4035..f5997321 100644 --- a/rewards/README.md +++ b/rewards/README.md @@ -21,7 +21,8 @@ We have used battle-tested contracts that safeguard billions (veCRV). With this [Farming 101](df-intro.md) introduces Data Farming, the various reward systems, how they work, and how to access them. By the end of the document, you should feel more familiar with Data Farming concepts and having a better idea of what subject you might want to learn about next. ## User Guides -If you are looking for step-by-step tutorials on how to access the Data Farming program and complete different actions, head over to the Data Farming [User Guides page](user-guides/README.md). + +If you are looking for step-by-step tutorials on how to access the Data Farming program and complete different actions, head over to the [Data Farming User Guides page](user-guides/README.md). ## veOCEAN diff --git a/rewards/df-faq.md b/rewards/df-faq.md index b1fe9274..0ce90426 100644 --- a/rewards/df-faq.md +++ b/rewards/df-faq.md @@ -331,6 +331,6 @@ You can find the statistics for the number of locked tokens [here](https://autob Is there a way to check the duration and amounts of veOCEAN locked on-chain for all wallets? -Yes, this information is available. Indeed, there is a technical aspect involved. You'll need to have some technical knowledge because you'll be required to query our subgraph. You can find a working example in our [documentation](https://docs.oceanprotocol.com/developers/subgraph/get-veocean-stats#get-the-veocean-holders-list). Feel free to run the script by clicking on the "run" button. +Yes, this information is available. Indeed, there is a technical aspect involved. You'll need to have some technical knowledge because you'll be required to query our subgraph. You can find a working example of how to get the list of holders [in our subgraph documentation](../developers/subgraph/get-veocean-stats#get-the-veocean-holders-list). Feel free to run the script by clicking on the "run" button. \ No newline at end of file