As we add functionality to the Jupyter notebooks used to interact with contracts, we need to agree upon a structure for the documents directory that enables each of the contract families to add content.
My proposal is that we structure the usable notebook directory as follows:
the root directory would contain an index.ipynb that would be the default landing point
there would be a subdirectory under the root for each of the contract families
each contract family can manage the directory independently, but should at a minimum have a index.ipynb landing point
often the contract family directories would contain template and factories directories per the exchange family structure
the root directory would contain an instance directory that is shared by all of the contract families; this is where contract object specific files would be created; the intention is that the instance directory can be mapped from a host directory into a container so that a user can persist personal stat
all jupyter notebooks can assume that the environment variable PDO_JUPYTER_ROOT points to the root directory
each contract family will implement a "doc-install" target in their makefiles; the target will install all of the contract families notebooks into the PDO_JUPYTER_ROOT/ directory
cmickeyb
commented
3 months ago
As we add functionality to the Jupyter notebooks used to interact with contracts, we need to agree upon a structure for the documents directory that enables each of the contract families to add content.
My proposal is that we structure the usable notebook directory as follows: