docs/README.md

docs

🐍 Ocean Protocol's official documentation.

---

• Content
  • Editing docs
  • Adding docs
• Development
• Authors
• License

---

Content

...documentation concept...

The documentation is split in multiple parts whose content lives in this repo:

• Core concepts: high-level explanation of concepts, assumptions, and components
• Setup: getting started for various stakeholders and use cases
• Tutorials: detailed tutorials

Additionally, these docs live in their respective repos and are pulled into this site on build time:

• API reference
• Component docs

Editing docs

Adding docs

Development

The site is a React app built with Gatsby, pulling its content from various sources.

To start development, clone this repo, install all dependencies, and start the development server:

git clone git@github.com:oceanprotocol/docs.git
cd docs/

npm i
npm start

This will start a hot-reloading local server exposed under localhost:8000.

Authors

• Troy McConaghy (@ttmc) - Ocean Protocol
• Matthias Kretschmann (@kremalicious) - Ocean Protocol

License

Copyright 2018 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.