diff --git a/README (1).md b/README (1).md deleted file mode 100644 index 5db25a43..00000000 --- a/README (1).md +++ /dev/null @@ -1,119 +0,0 @@ -# README - -[![banner](https://raw.githubusercontent.com/oceanprotocol/art/master/github/repo-banner%402x.png)](https://docs.oceanprotocol.com) - -## docs - -> 🐬 Ocean Protocol documentation. https://docs.oceanprotocol.com - -[![Build Status](https://github.com/oceanprotocol/docs/workflows/CI/badge.svg)](https://github.com/oceanprotocol/docs/actions) [![Netlify Status](https://api.netlify.com/api/v1/badges/218e617e-45da-47ab-8f2a-bcfedf80550f/deploy-status)](https://app.netlify.com/sites/docs-oceanprotocol/deploys) [![Maintainability](https://api.codeclimate.com/v1/badges/d39837421591f0bc2550/maintainability)](https://codeclimate.com/github/oceanprotocol/docs/maintainability) [![js oceanprotocol](https://img.shields.io/badge/js-oceanprotocol-7b1173.svg)](https://github.com/oceanprotocol/eslint-config-oceanprotocol) [![css bigchaindb](https://img.shields.io/badge/css-bigchaindb-39BA91.svg)](https://github.com/bigchaindb/stylelint-config-bigchaindb) - -*** - -**These docs are meant to be viewed on** [**docs.oceanprotocol.com**](https://docs.oceanprotocol.com)**. You can still browse them here but links or images might not work in some places.** - -**If you want to contribute to these docs, then keep reading.** - -*** - -* [Content]() -* [Development]() -* [Linting & Formatting]() - * [Editor Setup: VS Code]() -* [⬆️ Deployment]() -* [License]() - -### Content - -To write or update content, refer to the documentation of the documentation: - -* [**Documentation: Content →**](broken-reference) -* [**Documentation: API References →**](broken-reference) -* [**Documentation: GitHub Data Fetching →**](broken-reference) -* [**Documentation: Repository Component →**](broken-reference) - -### Development - -The site is a React app built with [Gatsby](https://www.gatsbyjs.org), pulling its content from local and external Markdown files, and from various APIs. - -To start, clone this repo and set your `GITHUB_TOKEN` (see [GitHub GraphQL API](broken-reference)): - -```bash -git clone git@github.com:oceanprotocol/docs.git -cd docs/ - -# add GITHUB_TOKEN -cp .env.sample .env -vi .env -``` - -Then install dependencies and start up the development server: - -```bash -# use Node.js/npm version defined in .nvmrc -nvm use - -npm i -npm start -``` - -Alternatively, you can use [Docker Compose](https://docs.docker.com/compose/) to do the same, but without using your local system: - -```bash -docker-compose up -``` - -Either one of these commands will expose a hot-reloading server under: - -* [localhost:8000](http://localhost:8000) -* [localhost:8000/\_\_\_graphql](http://localhost:8000/\_\_\_graphql) - -### Linting & Formatting - -To enforce a consistent code style, linting is setup for pretty much every file. Linting is part of the test suite, meaning builds on Travis will fail in case of linting errors. - -In this repo the following tools are setup for that: - -* ESLint with [eslint-config-oceanprotocol](https://github.com/oceanprotocol/eslint-config-oceanprotocol) -* [markdownlint](https://github.com/DavidAnson/markdownlint) -* [Prettier](https://prettier.io) - -```bash -# only run linting checks -npm run lint - -# auto-formatting of all js, css, md, yml files -npm run format -``` - -#### Editor Setup: VS Code - -If you use VS Code as your editor, you can install those extensions to get linting as you type, and auto-formatting as you save: - -* [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) -* [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) -* [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) - -### ⬆️ Deployment - -Every branch or Pull Request is automatically deployed by [Netlify](https://netlify.com) with their GitHub integration. A link to a preview deployment will appear under each Pull Request. - -The latest deployment of the `main` branch is automatically aliased to `docs.oceanprotocol.com`. - -### License - -``` -Copyright ((C)) 2022 Ocean Protocol Foundation Ltd. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -``` diff --git a/README.md b/README.md index 1971815e..183220a8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ -# Orientation +--- +title: Introduction +description: Ocean Protocol - Tools for the Web3 Data Economy +--- +In Ocean Protocol, each asset gets its own ERC721 **data NFT** and one(or more) ERC20 **datatokens**. This enables data wallets, data exchanges, and data co-ops by directly leveraging crypto wallets, exchanges, and more. + +OCEAN token is used for staking, and more. [Here](https://oceanprotocol.com/token) are details. + +Ocean Protocol provides tools for developers to _build data markets_, and to _manage data NFTs and datatokens_ for use in DeFi. + +**Build Data Markets.** Use Ocean Protocol software tools to build your own data marketplace, by either forking [Ocean Market](https://v4.market.oceanprotocol.com/) code or building up with Ocean components. + +**Manage datatokens and data NFTs for use in DeFi.** Use Ocean [JavaScript](https://github.com/oceanprotocol/ocean.js) or [Python](https://github.com/oceanprotocol/ocean.py) drivers to manage data NFTs and datatokens: + +- _Publish and access data services:_ downloadable files or compute-to-data. Use Ocean to deploy a new [ERC721](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md) and [ERC20](https://github.com/ethereum/EIPs/blob/7f4f0377730f5fc266824084188cc17cf246932e/EIPS/eip-20.md) datatoken contract for each data service, then mint datatokens. + +- _Transfer datatokens_ to another owner (or approve & transferFrom). + +- _Manage pools._ Deploy OCEAN-datatoken [Balancer](https://www.balancer.fi/) pools, buy & sell datatokens (swap), and add & remove liquidity. + +- _And more._ Use ERC20 support in [web3.js](https://web3js.readthedocs.io/), [web3.py](https://web3py.readthedocs.io/en/stable/examples.html#working-with-an-erc20-token-contract) and Solidity to connect datatokens with crypto wallets and other DeFi services. + +**Compute-to-Data** +Ocean's "Compute-to-Data" feature gives compute access to privately-held data, which never leaves the data owner’s premises. Ocean-based marketplaces enable the monetization of private data while preserving privacy. [Here](/tutorials/compute-to-data-architecture/) are details. diff --git a/SUMMARY.md b/SUMMARY.md index dddfb8f0..ab3edf95 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,7 +1,22 @@ # Table of contents * [Orientation](README.md) -* [README]() +* [Core Concepts](core-concepts/README.md) + * [Architecture Overview](core-concepts/architecture.md) + * [Asset pricing](core-concepts/asset-pricing.md) + * [Contributor Code of Conduct](core-concepts/code-of-conduct.md) + * [Compute-to-Data](core-concepts/compute-to-data.md) + * [Ways to Contribute](core-concepts/contributing.md) + * [Data NFTs and Datatokens](core-concepts/datanft-and-datatoken.md) + * [DID & DDO](core-concepts/did-ddo.md) + * [Fees](core-concepts/fees.md) + * [Funding](core-concepts/get-funding.md) + * [Legal Requirements when Contributing Code](core-concepts/legal-reqs.md) + * [Supported Networks](core-concepts/networks.md) + * [Projects using Ocean Protocol](core-concepts/projects-using-ocean.md) + * [Quickstart](core-concepts/quickstart.md) + * [Data NFTs and datatoken roles](core-concepts/roles.md) + * [Reporting Vulnerabilities](core-concepts/vulnerabilities.md) * [Building with ocean](building-with-ocean/README.md) * [Publish assets using hosting services](building-with-ocean/asset-hosting.md) * [Binance Smart Chain (BSC)](building-with-ocean/bsc-bridge.md) @@ -21,21 +36,3 @@ * [Polygon (ex Matic)](building-with-ocean/polygon-bridge.md) * [Use Your Wallet to Manage OCEAN Tokens](building-with-ocean/wallets-and-ocean-tokens.md) * [Wallet Basics](building-with-ocean/wallets.md) -* [Core Concepts](core-concepts/README.md) - * [Architecture Overview](core-concepts/architecture.md) - * [Asset pricing](core-concepts/asset-pricing.md) - * [Contributor Code of Conduct](core-concepts/code-of-conduct.md) - * [Compute-to-Data](core-concepts/compute-to-data.md) - * [Ways to Contribute](core-concepts/contributing.md) - * [Data NFTs and Datatokens](core-concepts/datanft-and-datatoken.md) - * [DID & DDO](core-concepts/did-ddo.md) - * [Fees](core-concepts/fees.md) - * [Funding](core-concepts/get-funding.md) - * [Introduction](core-concepts/introduction.md) - * [Legal Requirements when Contributing Code](core-concepts/legal-reqs.md) - * [Supported Networks](core-concepts/networks.md) - * [Projects using Ocean Protocol](core-concepts/projects-using-ocean.md) - * [Quickstart](core-concepts/quickstart.md) - * [Data NFTs and datatoken roles](core-concepts/roles.md) - * [Reporting Vulnerabilities](core-concepts/vulnerabilities.md) -* [Using Ocean Marketplace](using-ocean-marketplace.md) diff --git a/core-concepts/introduction.md b/core-concepts/introduction.md deleted file mode 100644 index 183220a8..00000000 --- a/core-concepts/introduction.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Introduction -description: Ocean Protocol - Tools for the Web3 Data Economy ---- - -In Ocean Protocol, each asset gets its own ERC721 **data NFT** and one(or more) ERC20 **datatokens**. This enables data wallets, data exchanges, and data co-ops by directly leveraging crypto wallets, exchanges, and more. - -OCEAN token is used for staking, and more. [Here](https://oceanprotocol.com/token) are details. - -Ocean Protocol provides tools for developers to _build data markets_, and to _manage data NFTs and datatokens_ for use in DeFi. - -**Build Data Markets.** Use Ocean Protocol software tools to build your own data marketplace, by either forking [Ocean Market](https://v4.market.oceanprotocol.com/) code or building up with Ocean components. - -**Manage datatokens and data NFTs for use in DeFi.** Use Ocean [JavaScript](https://github.com/oceanprotocol/ocean.js) or [Python](https://github.com/oceanprotocol/ocean.py) drivers to manage data NFTs and datatokens: - -- _Publish and access data services:_ downloadable files or compute-to-data. Use Ocean to deploy a new [ERC721](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md) and [ERC20](https://github.com/ethereum/EIPs/blob/7f4f0377730f5fc266824084188cc17cf246932e/EIPS/eip-20.md) datatoken contract for each data service, then mint datatokens. - -- _Transfer datatokens_ to another owner (or approve & transferFrom). - -- _Manage pools._ Deploy OCEAN-datatoken [Balancer](https://www.balancer.fi/) pools, buy & sell datatokens (swap), and add & remove liquidity. - -- _And more._ Use ERC20 support in [web3.js](https://web3js.readthedocs.io/), [web3.py](https://web3py.readthedocs.io/en/stable/examples.html#working-with-an-erc20-token-contract) and Solidity to connect datatokens with crypto wallets and other DeFi services. - -**Compute-to-Data** -Ocean's "Compute-to-Data" feature gives compute access to privately-held data, which never leaves the data owner’s premises. Ocean-based marketplaces enable the monetization of private data while preserving privacy. [Here](/tutorials/compute-to-data-architecture/) are details. diff --git a/using-ocean-marketplace.md b/using-ocean-marketplace.md deleted file mode 100644 index a5d54a4d..00000000 --- a/using-ocean-marketplace.md +++ /dev/null @@ -1,2 +0,0 @@ -# Using Ocean Marketplace -