Motivation
We can greatly reduce dev user onboarding friction by having a readthedocs style documentation, the way that web3.py, eth-brownie, and many others do. There are probably even more excellent examples.
What: Specs
First-cut release of this documentation for both ocean.py and ocean.js
Should somehow reconcile all the dev user documentation currently in the READMEs / quickstarts. One possibility: port the quickstarts into the new style; and deprecate them from the READMEs. Ideally, there's good tests for this.
Should play well with docs.oceanprotocol.com. E.g. it feels like it's part of that, following a similar branding / colors.
Including play well with its API reference section. Sometimes readthedocs documentation has API sections too.
Should follow DRY - Don't Repeat Yourself. Eg don't have copies of the same example code in four places. Have it in one place, then auto import elsewhere. Also take advantage of python docstrings to auto-populate some of the docs. Perhaps helpful: docs subdirectory already in ocean.py; and associate Makefile in that directory and one directory up.
Motivation We can greatly reduce dev user onboarding friction by having a readthedocs style documentation, the way that web3.py, eth-brownie, and many others do. There are probably even more excellent examples.
What: Specs
docs
subdirectory already in ocean.py; and associate Makefile in that directory and one directory up.--
TODOs