docs/SUMMARY.md

145 lines
8.5 KiB
Markdown
Raw Permalink Normal View History

2022-07-03 12:47:26 +02:00
# Table of contents
2024-03-19 13:31:39 +01:00
- [Ocean docs](README.md)
2023-12-21 11:58:39 +01:00
- [🌊 Discover Ocean](discover/README.md)
- [Why Ocean?](discover/why-ocean.md)
- [What is Ocean?](discover/what-is-ocean.md)
- [What can you do with Ocean?](discover/benefits.md)
2023-12-21 14:54:32 +01:00
- [OCEAN: The Ocean token](discover/ocean-token.md)
2023-09-28 15:51:44 +02:00
- [Networks](discover/networks/README.md)
2023-12-21 15:14:36 +01:00
- [Network Bridges](discover/networks/bridges.md)
2023-09-28 15:51:44 +02:00
- [FAQ](discover/faq.md)
2023-12-21 14:54:32 +01:00
- [Glossary](discover/glossary.md)
- [📚 User Guides](user-guides/README.md)
2023-12-21 15:08:36 +01:00
- [Basic concepts](user-guides/basic-concepts.md)
- [Using Wallets](user-guides/wallets/README.md)
- [Set Up MetaMask](user-guides/wallets/metamask-setup.md)
2024-03-04 12:51:41 +01:00
- [Manage Your OCEAN](user-guides/wallets/wallets-and-ocean.md)
2023-12-21 15:05:18 +01:00
- [Using Ocean Market](user-guides/using-ocean-market.md)
2023-12-21 12:09:05 +01:00
- [Publish Data NFTs](user-guides/publish-data-nfts.md)
- [Buy NFT Data](user-guides/buy-data-nfts.md)
2023-12-21 15:05:18 +01:00
- [Compute-to-Data in Ocean Market](user-guides/compute-to-data/README.md)
2023-09-28 15:51:44 +02:00
- [Make a Boss C2D Algorithm](user-guides/compute-to-data/make-a-boss-c2d-algorithm.md)
- [Publish a C2D Algorithm NFT](user-guides/compute-to-data/publish-a-c2d-algorithm-nft.md)
- [Publish a C2D Data NFT](user-guides/compute-to-data/publish-a-c2d-data-nft.md)
- [Host Assets](user-guides/asset-hosting/README.md)
The Uploader Docs (#1256) * Adding initial page as a user guide on interacting witht the DBS * Updating steps and instructions for the DBS user guide * updating the navigation * updating arweave user guide * Adding links to the dbs upload instructions * Adding images * Adding images into the guide * CHanging DBS to Uploader in user guide * moved uploader (ex dbs) pages from gitbook * remove all refs to dbs * change DBSClient to UploaderClient * removed more dbs refs * Update README.md - adjust some links - fix some texts * updated images uploader * adding format to codeblocks * updated images * added uploader to asset hosting * fix some text * fix typo * fix link * replaced more images * added text to asset hosting section related to uploader * changed "Using Arweave with Uploader" * removed references to "storage management" * added missing link * move uploader.js section from main page * added to uploader's main readme * rewrite uploader ui docs * added expandable component to api calls in uploader.js * rewrite API main paragraph in uploader.js * fix some dbs refs * added more to uploader ui * moved uploader in the summary page * added arcade to "How to store an asset on Arweave with the Uploader UI" * added uploader links * Update uploader.md update arcade link * Update uploader.md * Updating diagrams * Update to mention IPFS support * Minor change in README.md --------- Co-authored-by: Lcdo-Jeremy <enzo-vezzaro@live.it> Co-authored-by: Ana Loznianu <ana@oceanprotocol.com> Co-authored-by: mihaisc <mihai@oceanprotocol.com>
2024-02-09 13:27:14 +01:00
- [Uploader](user-guides/asset-hosting/uploader.md)
2023-09-28 15:51:44 +02:00
- [Arweave](user-guides/asset-hosting/arweave.md)
- [AWS](user-guides/asset-hosting/aws.md)
- [Azure Cloud](user-guides/asset-hosting/azure-cloud.md)
- [Google Storage](user-guides/asset-hosting/google-storage.md)
- [Github](user-guides/asset-hosting/github.md)
- [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md)
- [💻 Developers](developers/README.md)
- [Architecture Overview](developers/architecture.md)
- [Contracts](developers/contracts/README.md)
- [Data NFTs](developers/contracts/data-nfts.md)
- [Datatokens](developers/contracts/datatokens.md)
- [Data NFTs and Datatokens](developers/contracts/datanft-and-datatoken.md)
- [Datatoken Templates](developers/contracts/datatoken-templates.md)
- [Roles](developers/contracts/roles.md)
- [Pricing Schemas](developers/contracts/pricing-schemas.md)
- [Fees](developers/contracts/fees.md)
- [Revenue](developers/contracts/revenue.md)
- [Fractional Ownership](developers/fractional-ownership.md)
- [Community Monetization](developers/community-monetization.md)
- [Metadata](developers/metadata.md)
- [Identifiers (DIDs)](developers/identifiers.md)
- [DDO Specification](developers/ddo-specification.md)
- [Storage Specifications](developers/storage.md)
- [Fine-Grained Permissions](developers/fg-permissions.md)
- [Retrieve datatoken/data NFT addresses & Chain ID](developers/retrieve-datatoken-address.md)
- [Get API Keys for Blockchain Access](developers/get-api-keys-for-blockchain-access.md)
- [Barge](developers/barge/README.md)
- [Local Setup](developers/barge/local-setup-ganache.md)
- [Build a Marketplace](developers/build-a-marketplace/README.md)
- [Forking Ocean Market](developers/build-a-marketplace/forking-ocean-market.md)
- [Customising a Market](developers/build-a-marketplace/customising-your-market.md)
- [Build and host your Data Marketplace](developers/build-a-marketplace/deploying-market.md)
- [Subgraph](developers/subgraph/README.md)
- [Get data NFTs](developers/subgraph/list-data-nfts.md)
- [Get data NFT information](developers/subgraph/get-data-nft-information.md)
- [Get datatokens](developers/subgraph/list-datatokens.md)
- [Get datatoken information](developers/subgraph/get-datatoken-information.md)
- [Get datatoken buyers](developers/subgraph/get-datatoken-buyers.md)
- [Get fixed-rate exchanges](developers/subgraph/list-fixed-rate-exchanges.md)
- [Get veOCEAN stats](developers/subgraph/get-veocean-stats.md)
- [Ocean.js](developers/ocean.js/README.md)
- [Configuration](developers/ocean.js/configuration.md)
- [Creating a data NFT](developers/ocean.js/creating-datanft.md)
- [Publish](developers/ocean.js/publish.md)
- [Mint Datatokens](developers/ocean.js/mint-datatoken.md)
- [Update Metadata](developers/ocean.js/update-metadata.md)
- [Asset Visibility](developers/ocean.js/asset-visibility.md)
- [Consume Asset](developers/ocean.js/consume-asset.md)
- [Run C2D Jobs](developers/ocean.js/cod-asset.md)
- [Ocean CLI](developers/ocean-cli/README.md)
2023-10-03 13:22:58 +02:00
- [Install](developers/ocean-cli/install.md)
- [Publish](developers/ocean-cli/publish.md)
- [Edit](developers/ocean-cli/edit.md)
- [Consume](developers/ocean-cli/consume.md)
- [Run C2D Jobs](developers/ocean-cli/run-c2d.md)
2023-09-28 15:51:44 +02:00
- [Compute to data](developers/compute-to-data/README.md)
- [Architecture](developers/compute-to-data/compute-to-data-architecture.md)
- [Datasets & Algorithms](developers/compute-to-data/compute-to-data-datasets-algorithms.md)
2023-10-19 14:09:17 +02:00
- [Workflow](developers/compute-to-data/compute-workflow.md)
2023-09-28 15:51:44 +02:00
- [Writing Algorithms](developers/compute-to-data/compute-to-data-algorithms.md)
- [Compute Options](developers/compute-to-data/compute-options.md)
- [Aquarius](developers/aquarius/README.md)
- [Asset Requests](developers/aquarius/asset-requests.md)
- [Chain Requests](developers/aquarius/chain-requests.md)
- [Other Requests](developers/aquarius/other-requests.md)
- [Provider](developers/provider/README.md)
- [General Endpoints](developers/provider/general-endpoints.md)
- [Encryption / Decryption](developers/provider/encryption-decryption.md)
- [Compute Endpoints](developers/provider/compute-endpoints.md)
- [Authentication Endpoints](developers/provider/authentication-endpoints.md)
The Uploader Docs (#1256) * Adding initial page as a user guide on interacting witht the DBS * Updating steps and instructions for the DBS user guide * updating the navigation * updating arweave user guide * Adding links to the dbs upload instructions * Adding images * Adding images into the guide * CHanging DBS to Uploader in user guide * moved uploader (ex dbs) pages from gitbook * remove all refs to dbs * change DBSClient to UploaderClient * removed more dbs refs * Update README.md - adjust some links - fix some texts * updated images uploader * adding format to codeblocks * updated images * added uploader to asset hosting * fix some text * fix typo * fix link * replaced more images * added text to asset hosting section related to uploader * changed "Using Arweave with Uploader" * removed references to "storage management" * added missing link * move uploader.js section from main page * added to uploader's main readme * rewrite uploader ui docs * added expandable component to api calls in uploader.js * rewrite API main paragraph in uploader.js * fix some dbs refs * added more to uploader ui * moved uploader in the summary page * added arcade to "How to store an asset on Arweave with the Uploader UI" * added uploader links * Update uploader.md update arcade link * Update uploader.md * Updating diagrams * Update to mention IPFS support * Minor change in README.md --------- Co-authored-by: Lcdo-Jeremy <enzo-vezzaro@live.it> Co-authored-by: Ana Loznianu <ana@oceanprotocol.com> Co-authored-by: mihaisc <mihai@oceanprotocol.com>
2024-02-09 13:27:14 +01:00
- [Uploader](developers/uploader/README.md)
- [Uploader.js](developers/uploader/uploader-js.md)
- [Uploader UI](developers/uploader/uploader-ui.md)
- [Uploader UI to Market](developers/uploader/uploader-ui-marketplace.md)
- [Developer FAQ](developers/dev-faq.md)
- [📊 Data Scientists](data-scientists/README.md)
- [Ocean.py](data-scientists/ocean.py/README.md)
- [Install](data-scientists/ocean.py/install.md)
- [Local Setup](data-scientists/ocean.py/local-setup.md)
- [Remote Setup](data-scientists/ocean.py/remote-setup.md)
- [Publish Flow](data-scientists/ocean.py/publish-flow.md)
- [Consume Flow](data-scientists/ocean.py/consume-flow.md)
- [Compute Flow](data-scientists/ocean.py/compute-flow.md)
- [Ocean Instance Tech Details](data-scientists/ocean.py/technical-details.md)
- [Ocean Assets Tech Details](data-scientists/ocean.py/ocean-assets-tech-details.md)
- [Ocean Compute Tech Details](data-scientists/ocean.py/ocean-compute-tech-details.md)
- [Datatoken Interface Tech Details](data-scientists/ocean.py/datatoken-interface-tech-details.md)
- [Join a Data Challenge](data-scientists/join-a-data-challenge.md)
- [Sponsor a Data Challenge](data-scientists/sponsor-a-data-challenge.md)
- [Data Value-Creation Loop](data-scientists/the-data-value-creation-loop.md)
- [What data is valuable?](data-scientists/data-engineers.md)
* [👀 Predictoor](predictoor/README.md)
* [💰 Data Farming](data-farming/README.md)
2023-11-06 12:25:06 +01:00
* [Passive DF (and veOCEAN)](data-farming/passivedf.md)
* [Guide to Passive DF](data-farming/passivedf-guide.md)
2023-11-06 12:25:06 +01:00
* [Liquid Staking](data-farming/liquid-staking.md)
2023-11-05 09:11:04 +01:00
* [Volume DF](data-farming/volumedf.md)
* [Guide to Volume DF](data-farming/volumedf-guide.md)
* [Delegation in Volume DF](data-farming/delegate.md)
2023-11-05 11:07:32 +01:00
* [Predictoor DF](data-farming/predictoordf.md)
* [Guide to Predictoor DF](data-farming/predictoordf-guide.md)
2023-11-06 08:13:06 +01:00
* [Claim Rewards](data-farming/claim-rewards.md)
2023-11-06 12:25:06 +01:00
* [Reward Schedule](data-farming/reward-schedule.md)
2023-11-05 11:07:32 +01:00
* [APYs](data-farming/apys.md)
2023-11-06 13:18:45 +01:00
* [Estimated APY vs Time](data-farming/apys-plot.md)
* [Guide to Estimating APY](data-farming/apys-guide.md)
2023-11-05 09:11:04 +01:00
* [FAQ](data-farming/faq.md)
2023-11-04 08:05:33 +01:00
* [🔨 Infrastructure](infrastructure/README.md)
* [Set Up a Server](infrastructure/setup-server.md)
* [Deploy a Marketplace](infrastructure/deploying-marketplace.md)
* [Deploy Aquarius](infrastructure/deploying-aquarius.md)
* [Deploy Provider](infrastructure/deploying-provider.md)
* [Deploy Ocean Subgraph](infrastructure/deploying-ocean-subgraph.md)
* [Deploy C2D](infrastructure/compute-to-data-minikube.md)
* [For C2D, Set Up Private Docker Registry](infrastructure/compute-to-data-docker-registry.md)
2023-10-04 02:48:27 +02:00
* [🤝 Contribute](contribute/README.md)
2023-10-12 09:38:08 +02:00
* [Collaborators](contribute/projects-using-ocean.md)
2023-10-04 02:48:27 +02:00
* [Contributor Code of Conduct](contribute/code-of-conduct.md)
* [Legal Requirements](contribute/legal-reqs.md)